Share

Search Endpoint

GET /search-results?limit=100&offset=0&page=1&query=STRING&revision=1

This endpoint returns a list of records based on the query supplied. Refer to the full documentation in the Search page for all supported queries.

Note: this endpoint returns data in compressed format. The response header returns Content-Encoding: gzip.

Supported options

Return only items Latest Version (including Unreleased), and non-Revision Controlled items

GET https://tenant_name.autodeskplm360.net/api/v3/search-results?limit=100&offset=0&page=1&query=STRING&revision=1

Return all revisions, and non-Revision Controlled items

GET https://tenant_name.autodeskplm360.net/api/v3/search-results?limit=100&offset=0&page=1&query=STRING&revision=2

Return only Working versions (including Unreleased), and non-Revision Controlled items

GET https://tenant_name.autodeskplm360.net/api/v3/search-results?limit=100&offset=0&page=1&query=STRING&revision=3

Bulk item details

By passing a specific value for the Accept header, application/vnd.autodesk.plm.items.bulk+json , the endpoint will return item details in the payload for the matching items. The page size is limited to 100.

Examples:

GET https://tenant_name.autodeskplm360.net/api/v3/search-results?limit=100&offset=0&page=1&query=STRING&revision=1
Header: 
Accept: application/vnd.autodesk.plm.items.bulk+json
{
  "__self__": "/api/v3/search-results",
  "offset": 0,
  "limit": 100,
  "totalCount": 108,
  "first": {
    "link": "/api/v3/search-results",
    "title": "First",
    "deleted": false,
    "count": 100
  },
  "next": {
    "link": "/api/v3/search-results",
    "title": "Next",
    "deleted": false,
    "count": 8
  },
  "last": {
    "link": "/api/v3/search-results",
    "title": "Last",
    "deleted": false,
    "count": 8
  },
  "items": [(item details payload)]
}

Back to top

Was this information helpful?