External ids

>>>

GET /api/v2/external_ids/:external_id
Get asset or project by external ID

Headers

Header name Description
Content-Type
required 		application/json
X-API-KEY
required 		YOUR_API_KEY

Params

Param name Description
external_id
required

External ID

Validations:

  • Must be a String

Examples

// External ID not found
GET /api/v2/external_ids/not-found-id
404
{
  "error": "external id not-found-id not found"
}
// External ID belongs to an asset
GET /api/v2/external_ids/external-id-test
200
{
  "external_id": "external-id-test",
  "id": "OvIi7s76K1G3uFydxOOV",
  "type": "asset"
}
// External ID belongs to a project
GET /api/v2/external_ids/external-id-test
200
{
  "external_id": "external-id-test",
  "id": "ePoKkPHXgjO29Qg5RlYG",
  "type": "project"
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

GET /api/v2/external_ids
Get all assets and projects which contain external ID

Headers

Header name Description
Content-Type
required 		application/json
X-API-KEY
required 		YOUR_API_KEY

Examples

// Successful request, no asset or project contains external id
GET /api/v2/external_ids
200
[]
// Successful request
GET /api/v2/external_ids
200
[
  {
    "external_id": "external-id-test-3",
    "id": "dznvr9RN-nqCDQqIFByZ",
    "type": "asset"
  },
  {
    "external_id": "external-id-test-2",
    "id": "IelGf5QCTG5ywB9OCLSa",
    "type": "project"
  },
  {
    "external_id": "external-id-test",
    "id": "zLRinoUz5WqQl4IXLazE",
    "type": "project"
  }
]

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters