Reverse lookup

Provided an annotation filter and an annotated resource type (file/3D), returns ids of annotated resources having annotations matching the filter. A typical use case is looking up files with annotations linking to a specific asset. Only ids of annotated resources that the client has access to will be returned.

In beta. Available only when the cdf-version header with the beta suffix value is provided.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

A request to look up annotated resource ids based on having annotations matching a filter.

required
object (AnnotationsV2ReverseLookupFilterSchema)

A filter for reverse lookups

limit
integer [ 1 .. 1000 ]
Default: 100
cursor
string or null [ 1 .. 255 ] characters

A cursor pointing to another page of results

Responses
200

Successful reverse lookup of annotated resource ids

400

The response for a failed request.

post/annotations/reverselookup
Request samples
application/json
{
  • "filter": {
    • "annotatedResourceType": "file",
    • "status": "approved",
    • "data": {
      }
    },
  • "limit": 100,
  • "cursor": "MzE1NjAwMDcxNzQ0ODI5"
}
Response samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "nextCursor": null,
  • "annotatedResourceType": "file"
}
➔ Next to Suggest annotations