Assets

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

AssetRegistryController_searchAssets

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/assets-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

Bodyapplication/json
dataArray of stringsrequired
countnumberrequired
Example: 10
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 10
}

AssetRegistryController_getAsset

Request

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

Request

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

Responses

Bad request. Invalid payload has been provided

AssetRegistryController_deleteAsset

Request

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

Responses

Unauthorized user

AssetRegistryController_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 \
  -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_deleteAssets

Request

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

Responses

Unauthorized user

AssetRegistryController_publishAsset

Request

Bodyapplication/jsonrequired
assetIdsArray of stringsrequired
curl -i -X PUT \
  https://api-portal.complai.com/_mock/complai-api/api/v2/assets-registry/publish \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "assetIds": [
      "string"
    ]
  }'

Responses

Unauthorized user

AssetRegistryController_unpublishAsset

Request

Bodyapplication/jsonrequired
assetIdsArray of stringsrequired
curl -i -X PUT \
  https://api-portal.complai.com/_mock/complai-api/api/v2/assets-registry/unpublish \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "assetIds": [
      "string"
    ]
  }'

Responses

Unauthorized user

AssetRegistryController_updateAssetInventoryStatus

Request

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

Request

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

Responses

Unauthorized user

AssetRegistryController_importAssetsFromFile

Request

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

Responses

Unauthorized user

AssetRegistryController_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/assets-registry/import/template?allowForAllTemplates=true&templateId=string&type=asset' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Unauthorized user

AssetRegistryController_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/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

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