Base 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

BaseAssetsController_external_getAsset

Request

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

Responses

Bodyapplication/json
idstringrequired
extIdstringrequired
organizationIdstringrequired
namestringrequired
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
Response
application/json
{
  "id": "string",
  "extId": "string",
  "organizationId": "string",
  "name": "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"
  ]
}

BaseAssetsController_external_updateBaseAsset

Request

Path
baseAssetIdstringrequired
Bodyapplication/jsonrequired
namestringrequired
assetCodestring
metadataobject
curl -i -X PUT \
  'https://api-portal.complai.com/_mock/complai-api/api/v2/base-assets/external/{baseAssetId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "assetCode": "string",
    "metadata": {}
  }'

Responses

BaseAssetsController_external_deleteAsset

Request

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

Responses

Unauthorized user

Assets

Operations related to assets

Operations

Assets by external ids

Operations by external ids related to assets

Operations

Manufacturers

Operations related to manufacturers

Operations

Manufacturers by external ids

Operations by external ids related to manufacturers

Operations