Complai API (1.0.0)

This is Complai REST API documentation

Download OpenAPI description
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

Manufacturers

Operations related to manufacturers

Operations

Manufacturers by external ids

Operations by external ids related to manufacturers

Operations

ManufacturersRegistryController_external_getManufacturer

Request

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

Responses

Bodyapplication/json
idstringrequired
extIdstringrequired
namestringrequired
assetTemplateIdstring or nullrequired
assetTemplateNamestring or nullrequired
assetTemplateVersionstring or nullrequired
countrystring or nullrequired
statestring or nullrequired
zipstring or nullrequired
citystring or nullrequired
addressstring or nullrequired
contactstring or nullrequired
contactEmailstring or nullrequired
glnstring or nullrequired
metadataobjectrequired
organizationIdstringrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
inventoryStatusstringrequired
imagestring or nullrequired
typenumberrequired
Response
application/json
{ "id": "string", "extId": "string", "name": "string", "assetTemplateId": "string", "assetTemplateName": "string", "assetTemplateVersion": "string", "country": "string", "state": "string", "zip": "string", "city": "string", "address": "string", "contact": "string", "contactEmail": "string", "gln": "string", "metadata": {}, "organizationId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "inventoryStatus": "string", "image": "string", "type": 0 }

ManufacturersRegistryController_external_updateManufacturer

Request

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

Responses

ManufacturersRegistryController_external_deleteAsset

Request

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

Responses

ManufacturersRegistryController_external_getAssetUsage

Request

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

Responses

Unauthorized user