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

ManufacturersRegistryController_searchManufacturers

Request

Bodyapplication/jsonrequired
pagenumber
pageSizenumber
sortingArray of objects(SortDto)
filtersobject(GridFilterParam)
curl -i -X POST \
  https://api-portal.complai.com/_mock/complai-api/api/v2/manufacturers-registry/search \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "page": 0,
    "pageSize": 0,
    "sorting": [
      {
        "field": "string",
        "sort": {}
      }
    ],
    "filters": {
      "items": [
        {
          "field": "string",
          "operator": "contains",
          "value": {},
          "options": {
            "caseInsensitive": true
          }
        }
      ],
      "logicOperator": "and"
    }
  }'

Responses

ManufacturersRegistryController_getManufacturer

Request

Path
manufacturerIdstringrequired
curl -i -X GET \
  'https://api-portal.complai.com/_mock/complai-api/api/v2/manufacturers-registry/{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_updateManufacturer

Request

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

Responses

ManufacturersRegistryController_deleteAsset

Request

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

Responses

ManufacturersRegistryController_createManufacturers

Request

Bodyapplication/jsonrequired
assetsArray of objects(AssetManufacturerUpdateDto)required
assets[].​idstring
assets[].​extIdstring
assets[].​namestringrequired
assets[].​assetTemplateIdstring or null
assets[].​countrystring
assets[].​statestring
assets[].​zipstring
assets[].​citystring
assets[].​addressstring
assets[].​contactstring
assets[].​contactEmailstring
assets[].​glnstring
assets[].​inventoryStatusstringrequired
Default "Active"
assets[].​metadataobject
assets[].​typenumber
assets[].​imagestring
curl -i -X POST \
  https://api-portal.complai.com/_mock/complai-api/api/v2/manufacturers-registry \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "assets": [
      {
        "id": "string",
        "extId": "string",
        "name": "string",
        "assetTemplateId": "string",
        "country": "string",
        "state": "string",
        "zip": "string",
        "city": "string",
        "address": "string",
        "contact": "string",
        "contactEmail": "string",
        "gln": "string",
        "inventoryStatus": "Active",
        "metadata": {},
        "type": 0,
        "image": "string"
      }
    ]
  }'

Responses

Bodyapplication/jsonArray [
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_deleteManufacturers

Request

Query
cleanAuditRoomsbooleanrequired
curl -i -X DELETE \
  'https://api-portal.complai.com/_mock/complai-api/api/v2/manufacturers-registry?cleanAuditRooms=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

ManufacturersRegistryController_updateManufacturerInventoryStatus

Request

Path
manufacturerIdstringrequired
Bodyapplication/jsonrequired
inventoryStatusstringrequired
shouldUpdateFormsbooleanrequired
curl -i -X PUT \
  'https://api-portal.complai.com/_mock/complai-api/api/v2/manufacturers-registry/{manufacturerId}/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

ManufacturersRegistryController_getAssetUsage

Request

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

Responses

Unauthorized user

ManufacturersRegistryController_importAssetsFromFile

Request

Query
delimiterstringrequired
typestringrequired
Enum"asset""company""base-asset"
curl -i -X POST \
  'https://api-portal.complai.com/_mock/complai-api/api/v2/manufacturers-registry/import?delimiter=string&type=asset' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/jsonArray [
idstringrequired
namestringrequired
inventoryStatusstringrequired
countrystring
statestring
zipstring
citystring
addressstring
contactstring
contactEmailstring
glnstring
metadataobjectrequired
assetTemplateIdstring
typenumberrequired
]
Response
application/json
[ { "id": "string", "name": "string", "inventoryStatus": "string", "country": "string", "state": "string", "zip": "string", "city": "string", "address": "string", "contact": "string", "contactEmail": "string", "gln": "string", "metadata": {}, "assetTemplateId": "string", "type": 0 } ]

ManufacturersRegistryController_prepareAssetSample

Request

Query
templateIdstring
allowForAllTemplatesboolean
typestringrequired
Enum"asset""company""base-asset"
curl -i -X GET \
  'https://api-portal.complai.com/_mock/complai-api/api/v2/manufacturers-registry/import/template?allowForAllTemplates=true&templateId=string&type=asset' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

ManufacturersRegistryController_upsertBaseAssetsAsync

Request

Bodyapplication/jsonrequired
assetsArray of objects(AssetManufacturerUpdateDto)required
assets[].​idstring
assets[].​extIdstring
assets[].​namestringrequired
assets[].​assetTemplateIdstring or null
assets[].​countrystring
assets[].​statestring
assets[].​zipstring
assets[].​citystring
assets[].​addressstring
assets[].​contactstring
assets[].​contactEmailstring
assets[].​glnstring
assets[].​inventoryStatusstringrequired
Default "Active"
assets[].​metadataobject
assets[].​typenumber
assets[].​imagestring
curl -i -X POST \
  https://api-portal.complai.com/_mock/complai-api/api/v2/manufacturers-registry/upsert/async \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "assets": [
      {
        "id": "string",
        "extId": "string",
        "name": "string",
        "assetTemplateId": "string",
        "country": "string",
        "state": "string",
        "zip": "string",
        "city": "string",
        "address": "string",
        "contact": "string",
        "contactEmail": "string",
        "gln": "string",
        "inventoryStatus": "Active",
        "metadata": {},
        "type": 0,
        "image": "string"
      }
    ]
  }'

Responses

Manufacturers by external ids

Operations by external ids related to manufacturers

Operations