Assets by external ids

Complai API (1.0.0)

This is Complai REST API documentation

Download OpenAPI description
complai-api.json
complai-api.yaml
Languages
Servers
Mock server
https://api-portal.complai.com/_mock/complai-api/
Mock server
https://api-portal.complai.com/_mock/complai-api/

Base Assets

Operations related to base assets

Operations

Base Assets by external ids

Operations by external ids related to base assets

Operations

Assets

Operations related to assets

Operations

Assets by external ids

Operations by external ids related to assets

Operations

AssetRegistryController_external_getAsset

Request

Path
assetIdstringrequired
curl -i -X GET \
  'https://api-portal.complai.com/_mock/complai-api/api/v2/assets-registry/external/{assetId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
idstringrequired
extIdstringrequired
organizationIdstringrequired
namestringrequired
inventoryStatusstringrequired
manufacturerIdstringrequired
manufacturerNamestringrequired
extManufacturerIdstringrequired
baseAssetIdstring or nullrequired
assetTemplateIdstring or nullrequired
assetTemplateNamestring or nullrequired
assetTemplateVersionstring or nullrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
hasHierarchyUsagebooleanrequired
assetCodestring or nullrequired
metadataobjectrequired
hierarchyChildrenArray of stringsrequired
imagestring or nullrequired
isPublishedbooleanrequired
typenumberrequired
Response
application/json
{
  "id": "string",
  "extId": "string",
  "organizationId": "string",
  "name": "string",
  "inventoryStatus": "string",
  "manufacturerId": "string",
  "manufacturerName": "string",
  "extManufacturerId": "string",
  "baseAssetId": "string",
  "assetTemplateId": "string",
  "assetTemplateName": "string",
  "assetTemplateVersion": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "hasHierarchyUsage": true,
  "assetCode": "string",
  "metadata": {},
  "hierarchyChildren": [
    "string"
  ],
  "image": "string",
  "isPublished": true,
  "type": 0
}

AssetRegistryController_external_updateAsset

Request

Path
assetIdstringrequired
curl -i -X PUT \
  'https://api-portal.complai.com/_mock/complai-api/api/v2/assets-registry/external/{assetId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bad request. Invalid payload has been provided

AssetRegistryController_external_deleteAsset

Request

Path
assetIdstringrequired
curl -i -X DELETE \
  'https://api-portal.complai.com/_mock/complai-api/api/v2/assets-registry/external/{assetId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Unauthorized user

AssetRegistryController_external_createAssets

Request

Bodyapplication/jsonrequired
assetsArray of objects(AssetUpdateDto)required
assets[].​idstring
assets[].​extIdstring
assets[].​baseAssetIdstring or nullrequired
assets[].​assetTemplateIdstring or nullrequired
assets[].​namestringrequired
assets[].​inventoryStatusstringrequired
Default "Active"
assets[].​manufacturerIdstringrequired
assets[].​assetCodestring
assets[].​metadataobject
assets[].​typenumber
assets[].​imagestring
curl -i -X POST \
  https://api-portal.complai.com/_mock/complai-api/api/v2/assets-registry/external \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "assets": [
      {
        "id": "string",
        "extId": "string",
        "baseAssetId": "string",
        "assetTemplateId": "string",
        "name": "string",
        "inventoryStatus": "Active",
        "manufacturerId": "string",
        "assetCode": "string",
        "metadata": {},
        "type": 0,
        "image": "string"
      }
    ]
  }'

Responses

Bodyapplication/json
idstringrequired
extIdstringrequired
organizationIdstringrequired
namestringrequired
inventoryStatusstringrequired
manufacturerIdstringrequired
manufacturerNamestringrequired
extManufacturerIdstringrequired
baseAssetIdstring or nullrequired
assetTemplateIdstring or nullrequired
assetTemplateNamestring or nullrequired
assetTemplateVersionstring or nullrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
hasHierarchyUsagebooleanrequired
assetCodestring or nullrequired
metadataobjectrequired
hierarchyChildrenArray of stringsrequired
imagestring or nullrequired
isPublishedbooleanrequired
typenumberrequired
Response
application/json
{
  "id": "string",
  "extId": "string",
  "organizationId": "string",
  "name": "string",
  "inventoryStatus": "string",
  "manufacturerId": "string",
  "manufacturerName": "string",
  "extManufacturerId": "string",
  "baseAssetId": "string",
  "assetTemplateId": "string",
  "assetTemplateName": "string",
  "assetTemplateVersion": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "hasHierarchyUsage": true,
  "assetCode": "string",
  "metadata": {},
  "hierarchyChildren": [
    "string"
  ],
  "image": "string",
  "isPublished": true,
  "type": 0
}

AssetRegistryController_external_updateAssetInventoryStatus

Request

Path
assetIdstringrequired
Bodyapplication/jsonrequired
inventoryStatusstringrequired
shouldUpdateFormsbooleanrequired
curl -i -X PUT \
  'https://api-portal.complai.com/_mock/complai-api/api/v2/assets-registry/external/{assetId}/inventory-status' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "inventoryStatus": "string",
    "shouldUpdateForms": true
  }'

Responses

Bad request. Invalid payload has been provided

AssetRegistryController_external_getAssetUsage

Request

Path
assetIdstringrequired
curl -i -X GET \
  'https://api-portal.complai.com/_mock/complai-api/api/v2/assets-registry/external/{assetId}/usage' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Unauthorized user

AssetRegistryController_external_upsertAssetsAsync

Request

Query
partialIngestboolean
Bodyapplication/jsonrequired
assetsArray of objects(AssetUpdateDto)required
assets[].​idstring
assets[].​extIdstring
assets[].​baseAssetIdstring or nullrequired
assets[].​assetTemplateIdstring or nullrequired
assets[].​namestringrequired
assets[].​inventoryStatusstringrequired
Default "Active"
assets[].​manufacturerIdstringrequired
assets[].​assetCodestring
assets[].​metadataobject
assets[].​typenumber
assets[].​imagestring
curl -i -X POST \
  'https://api-portal.complai.com/_mock/complai-api/api/v2/assets-registry/external/upsert/async?partialIngest=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "assets": [
      {
        "id": "string",
        "extId": "string",
        "baseAssetId": "string",
        "assetTemplateId": "string",
        "name": "string",
        "inventoryStatus": "Active",
        "manufacturerId": "string",
        "assetCode": "string",
        "metadata": {},
        "type": 0,
        "image": "string"
      }
    ]
  }'

Responses

Manufacturers

Operations related to manufacturers

Operations

Manufacturers by external ids

Operations by external ids related to manufacturers

Operations