Parameter

Optionale Parameter zur Selektierung, Suche und Filterung

Die Docusnap365-API unterstützt optionale Abfrageparameter, mit denen der Inhalt und die Menge der zurückgegebenen Daten gesteuert werden kann. Die nachfolgenden Abfragen beziehen sich auch den Endpunkt https://api.docusnap365.com. Zwecks Lesbarkeit wurde dieser bei den nachfolgenden Abfrage weggelassen.

“Select” Parameter

Mit dem Abfrageparameter “select”, können spezifische Eigenschaften abgefragt werden. Beispielsweise werden als Rückgabe nur die Eigenschaften “id, name, serial” der Hardware Liste benötigt.

GET /api/v1/subscription/{subscriptionId}/segment/hardware?select=["id","name","serial"]

Basisdaten Parameter

Mit den Abfrageparametern für Basisdaten, können die Ergebnisse nach Tags, Organisationen, Domänen , Platfformen und Standorte gefiltert werden. Die Abfrageparameter sind “organizations”, “sites”, “domains”, “tags”, “platform”.

GET /api/v1/subscription/{subscriptionId}/segment/hardware?organizations="OrgId"
GET /api/v1/subscription/{subscriptionId}/segment/hardware?organizations="OrgId"&sites="SiteId"