curl --request POST \
  --url https://api.docusnap365.com/api/v1/assets/query \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "select": [
    "id",
    "name",
    "createdAt"
  ],
  "filter": {
    "logic": "And",
    "conditions": [
      {
        "path": "name",
        "op": "Contains",
        "value": "server"
      }
    ]
  },
  "sort": [
    {
      "path": "createdAt",
      "desc": true
    }
  ],
  "limit": 20
}
'

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "objectType": "<string>",
      "type": "<string>",
      "iconId": "<string>",
      "sourceType": "<string>",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "domainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version": 123,
      "status": "<string>",
      "isManually": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdByDisplayName": "<string>",
      "modifiedAt": "2023-11-07T05:31:56Z",
      "modifiedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "modifiedByDisplayName": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deletedByDisplayName": "<string>",
      "expands": {}
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true,
  "incompleteExpands": {}
}

{
  "type": "urn:ds365:error:unknown-path",
  "title": "Unknown field path",
  "status": 400,
  "detail": "Field 'hostname' is not configured for source 'objects'",
  "instance": "/api/v1/assets/query",
  "errorCode": "UNKNOWN_PATH",
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "errors": [
    {
      "code": "UNKNOWN_PATH",
      "path": "filter",
      "data": {
        "field": "hostname",
        "source": "objects",
        "origin": "filter"
      }
    }
  ]
}

{
  "type": "urn:ds365:error:forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "Missing required scopes: api_read",
  "instance": "/api/v1/assets",
  "errorCode": "FORBIDDEN",
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "errors": [
    {
      "code": "FORBIDDEN",
      "data": {
        "missingScopes": [
          "api_read"
        ]
      }
    }
  ]
}

{
  "type": "urn:ds365:error:rest-request-quota-exceeded",
  "title": "Request quota exceeded",
  "status": 429,
  "detail": "The request quota of 10000 requests per period is exhausted until 2026-12-01T00:00:00.0000000+00:00.",
  "instance": "/api/v1/assets",
  "errorCode": "REST_REQUEST_QUOTA_EXCEEDED",
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "errors": [
    {
      "code": "REST_REQUEST_QUOTA_EXCEEDED",
      "data": {
        "requestsLimit": 10000,
        "requestsUsed": 10000,
        "quotaResetAt": "2026-12-01T00:00:00+00:00"
      }
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errorCode": "<string>",
  "traceId": "<string>",
  "errors": [
    {
      "code": "<string>",
      "path": "<string>",
      "data": {}
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errorCode": "<string>",
  "traceId": "<string>",
  "errors": [
    {
      "code": "<string>",
      "path": "<string>",
      "data": {}
    }
  ]
}

Query

Assets abfragen

Fragt Assets mit Filter, Sortierung, Feldauswahl, Seitengröße und Expands ab.

Für select, filter und sort stehen nur die Felder des Assets zur Verfügung (siehe AssetDto). Expands ergänzen verwandte Daten; data.-Pfade in einem Expand werden gegen die Typen aufgelöst.

Mit select enthalten die Elemente der Antwort nur die gewählten Eigenschaften, und die Expands stehen auf der obersten Ebene des Elements. Ohne select ist ein Element das vollständige Asset mit seinen Expands in expands.

Eine Seite hat limit Elemente (Standard 50). Gibt es mehr, ist hasMore wahr, und nextCursor setzt mit POST /cursor/continue fort. Ein Expand, der zu einem Asset mehr Zeilen hat als sein limit, steht in incompleteExpands; er wird mit POST /assets/expand fortgesetzt.

Braucht das Recht api_read (Lesen).

POST

assets

query

curl --request POST \
  --url https://api.docusnap365.com/api/v1/assets/query \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "select": [
    "id",
    "name",
    "createdAt"
  ],
  "filter": {
    "logic": "And",
    "conditions": [
      {
        "path": "name",
        "op": "Contains",
        "value": "server"
      }
    ]
  },
  "sort": [
    {
      "path": "createdAt",
      "desc": true
    }
  ],
  "limit": 20
}
'

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "objectType": "<string>",
      "type": "<string>",
      "iconId": "<string>",
      "sourceType": "<string>",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "domainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version": 123,
      "status": "<string>",
      "isManually": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdByDisplayName": "<string>",
      "modifiedAt": "2023-11-07T05:31:56Z",
      "modifiedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "modifiedByDisplayName": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deletedByDisplayName": "<string>",
      "expands": {}
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true,
  "incompleteExpands": {}
}

{
  "type": "urn:ds365:error:unknown-path",
  "title": "Unknown field path",
  "status": 400,
  "detail": "Field 'hostname' is not configured for source 'objects'",
  "instance": "/api/v1/assets/query",
  "errorCode": "UNKNOWN_PATH",
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "errors": [
    {
      "code": "UNKNOWN_PATH",
      "path": "filter",
      "data": {
        "field": "hostname",
        "source": "objects",
        "origin": "filter"
      }
    }
  ]
}

{
  "type": "urn:ds365:error:forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "Missing required scopes: api_read",
  "instance": "/api/v1/assets",
  "errorCode": "FORBIDDEN",
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "errors": [
    {
      "code": "FORBIDDEN",
      "data": {
        "missingScopes": [
          "api_read"
        ]
      }
    }
  ]
}

{
  "type": "urn:ds365:error:rest-request-quota-exceeded",
  "title": "Request quota exceeded",
  "status": 429,
  "detail": "The request quota of 10000 requests per period is exhausted until 2026-12-01T00:00:00.0000000+00:00.",
  "instance": "/api/v1/assets",
  "errorCode": "REST_REQUEST_QUOTA_EXCEEDED",
  "traceId": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "errors": [
    {
      "code": "REST_REQUEST_QUOTA_EXCEEDED",
      "data": {
        "requestsLimit": 10000,
        "requestsUsed": 10000,
        "quotaResetAt": "2026-12-01T00:00:00+00:00"
      }
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errorCode": "<string>",
  "traceId": "<string>",
  "errors": [
    {
      "code": "<string>",
      "path": "<string>",
      "data": {}
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errorCode": "<string>",
  "traceId": "<string>",
  "errors": [
    {
      "code": "<string>",
      "path": "<string>",
      "data": {}
    }
  ]
}

Autorisierungen

x-api-key

string

header

erforderlich

Der API-Schlüssel der Subscription. Jede Operation nennt in x-pat-scopes das Recht, das sie braucht: api_read (in der Oberfläche Lesen) oder api_write (Lesen und Schreiben). Der Schlüssel wird unter Verwaltung › Integrationen › API-Schlüssel angelegt.

Body

application/json

select

string[]

Die Felder, die geliefert werden. Ohne Angabe alle Felder des Assets.

filter

Filtergruppe · object

Show child attributes

sort

Sortierfeld · object[]

Die Sortierung. Ohne Angabe nach Id. Die Id ist immer der letzte Sortierschlüssel, wenn sie nicht ausdrücklich sortiert wird.

Show child attributes

limit

integer<int32>

Standard:50

Die Seitengröße.

expands

Expand-Definition · object[]

Verwandte Daten, die zu jedem Asset gelesen werden. Ein unbekannter Name wird ohne Fehler übersprungen.

Show child attributes

Antwort

Eine Seite Assets.

items

(Asset · object | Expand-Zeile · object)[]

erforderlich

Die Assets, bei einem Expand-Cursor die Zeilen des Expands.

Ein Asset. Mit select auf POST /assets/query enthält ein Element nur die gewählten Eigenschaften und die nach oben gezogenen Expands unter ihrem Namen (object_data als Objekt, die übrigen als Liste).

Asset
Expand-Zeile

Show child attributes

nextCursor

string | null

Vorhanden, wenn es weitere Elemente gibt. Gilt eine Stunde lang, für denselben Benutzer und dieselbe Subscription.

hasMore

boolean

Wahr, wenn es weitere Elemente gibt.

incompleteExpands

object | null

Expands mit mehr Zeilen als ihr limit, mit dem Schlüssel name:parentId.

Show child attributes