latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Assets

Get asset by external ID

get/assets/external/{externalId}

Path parameters

externalIdstring required

External ID of the asset

Headers

x-organization-idinteger

Required if using a multi organizations token

Response

Successfully retrieved asset

Example response

{
  "asset": {
    "id": 963,
    "name": "Forklift",
    "globalUuid": "e2eb31cb-dd28-495a-92dd-6a435514f5ae",
    "currentOwnerId": 1,
    "barcode": "BWFPBNRHAW54CG",
    "description": "Forklift that is used to to move heavy equipments around the warehouse",
    "criticalityId": 150,
    "teamIds": [
      123,
      456
    ],
    "assetTypes": [
      "manual",
      "tool"
    ],
    "parentId": 852,
    "childrenIds": [
      321,
      987
    ],
    "locationId": 852,
    "serialNumber": "000123ABC",
    "thumbnail": {
      "id": 12345,
      "mimeType": "image/png",
      "fileName": "image.png",
      "url": "http://example.com/image.png",
      "createdAt": "2022-01-01T00:00:00.000Z",
      "width": 220,
      "height": 100
    },
    "attachments": [
      {
        "id": 12345,
        "mimeType": "image/png",
        "fileName": "image.png",
        "url": "http://example.com/image.png",
        "createdAt": "2022-01-01T00:00:00.000Z",
        "width": 220,
        "height": 100
      }
    ],
    "extraFields": {
      "My Custom Field": "000000000"
    },
    "vendorIds": [
      1
    ],
    "createdAt": "2022-01-01T00:00:00.000Z",
    "updatedAt": "2022-01-01T00:00:00.000Z",
    "creatorId": 851,
    "depreciation": {
      "id": 42,
      "depreciationStartDate": "2022-01-01T00:00:00.000Z",
      "purchaseDate": "2022-01-01T00:00:00.000Z",
      "usefulLifeYears": 10,
      "yearsDepreciated": 5,
      "createdAt": "2022-01-01T00:00:00.000Z",
      "archivedAt": "2022-01-01T00:00:00.000Z"
    },
    "manufacturer": "Manufacturer",
    "model": "Model",
    "externalId": "ext-asset-001",
    "status": {
      "id": 42,
      "status": "OFFLINE",
      "downtimeType": "PLANNED",
      "startedAt": "2022-01-01T12:34:56.123Z",
      "endedAt": "2022-01-01T12:34:56.123Z",
      "description": "Overheated - needs servicing.",
      "createdAt": "2022-01-01T12:34:56.123Z",
      "updatedAt": "2022-01-01T12:34:56.123Z",
      "deletedAt": "2022-01-01T12:34:56.123Z",
      "customStatus": {
        "label": "Decommissioned",
        "createdAt": "2022-01-01T12:34:56.123Z",
        "updatedAt": "2022-01-01T12:34:56.123Z",
        "deletedAt": "2022-01-01T12:34:56.123Z"
      },
      "customStatusId": 53
    }
  }
}