Cortex Service Public API — Technical Reference
API version: 1
Base URL: /api/public
Authentication: HTTP Basic over TLS (for all endpoints except health and auth config)
Content type: application/json
Endpoints: 15
Schemas: 35
Introduction
Use this API to integrate your system with Cortex Service.
All endpoints are rooted at //api/public. For example, the full URL of the health endpoint is /api/public/v1/health.
Authentication
Most endpoints require HTTP Basic authentication. Credentials must be base64-encoded and sent in the Authorization header, over TLS. The health check and the OIDC config endpoint are the only exceptions and do not require credentials.
GET /api/public/v1/work-orders/list HTTP/1.1
Host: <your-cortex-instance>
Authorization: Basic <base64-encoded username:password>
Content-Type: application/jsonConventions used in this document
Required fields are marked with a * in the Req. column of parameter and schema tables. Types that reference another schema are shown by the schema name (for example, AssetCreateDto); the full field-level definition appears in the Schemas section. Array types use the notation array<Type>.
Error responses
Unless otherwise stated, endpoints return the following standard error shape. Each endpoint lists the specific status codes it can return.
{
"statusCode": 400,
"message": [
"<field> must be a <type>"
],
"error": "Bad Request"
}Endpoints
The sections below list each endpoint grouped by resource tag. For every endpoint you will find the HTTP method, full path, parameters, request body schema, and all documented response codes with their payload schemas.
Health
GET /v1/health
Check Service Bus Health Status. Returns the health status of the Service Bus connection. Possible responses are Ok or Error.
Full URL: /api/public/v1/health — Authentication: None (public)
Responses:
200 — The Service Bus is connected and healthy. Response schema:
object(Ok)500 — The Service Bus is not connected.
Work Orders
POST /v1/work-orders
Create a new work order.
Full URL: /api/public/v1/work-orders — Authentication: Basic authentication (HTTP over TLS)
Request body: Required: yes | Content type: application/json | Schema: WorkOrderCreateDto
Responses:
201 — The work order has been successfully created. Response schema:
WorkOrderDto400 — Invalid input data.
401 — Unauthorized
404 — The entity with the specified ID was not found.
500 — Failed to perform operation due to validation errors or server issues.
POST /v1/work-orders/list
This endpoint retrieves a filtered list of work orders based on the provided query parameters. You can filter by specific IDs, apply pagination with an offset and count, and optionally include closed work orders in the result set. Note that this endpoint only retrieves a basic list of work orders. You can query for additional details by including the extendedData=true query parameter.
Full URL: /api/public/v1/work-orders/list — Authentication: Basic authentication (HTTP over TLS)
Parameters:
Name | In | Type | Description | Example |
|---|---|---|---|---|
offset | query | number | Number of items to skip before starting to collect results | 0 |
count | query | number | Number of items to return | 10 |
Request body: Required: no | Content type: application/json | Schema: WorkOrderGetBodyDto
Responses:
201 — List of filtered work orders. Response schema:
array<WorkOrderDto>orarray<WorkOrderWithDetailsDto>400 — Invalid input data.
401 — Unauthorized
404 — The entity with the specified ID was not found.
500 — Failed to perform operation due to validation errors or server issues.
PUT /v1/work-orders/close
Close a work order by ID.
Full URL: /api/public/v1/work-orders/close — Authentication: Basic authentication (HTTP over TLS)
Request body: Required: yes | Content type: application/json | Schema: WorkOrderCloseDto
Responses:
201 — The work order has been successfully closed. Response schema:
array<WorkOrderDto>400 — Invalid input data.
401 — Unauthorized
404 — The entity with the specified ID was not found.
500 — Failed to perform operation due to validation errors or server issues.
Assets
POST /v1/assets/list
Retrieve a list of assets based on the provided filters and pagination options.
Full URL: /api/public/v1/assets/list — Authentication: Basic authentication (HTTP over TLS)
Parameters:
Name | In | Type | Description | Example |
|---|---|---|---|---|
offset | query | number | Number of items to skip before starting to collect results | 0 |
count | query | number | Number of items to return | 10 |
Request body: Required: no | Content type: application/json | Schema: AssetsFilterParamsDto
Responses:
201 — List of filtered assets. Response schema:
array<AssetDto>orarray<PartialAssetDto>400 — Invalid input data.
401 — Unauthorized
404 — The entity with the specified ID was not found.
500 — Failed to perform operation due to validation errors or server issues.
POST /v1/assets
Create a new asset.
Full URL: /api/public/v1/assets — Authentication: Basic authentication (HTTP over TLS)
Request body: Required: yes | Content type: application/json | Schema: AssetCreateDto
Responses:
201 — The asset has been successfully created. Response schema:
AssetUpsertResultDto400 — Invalid input data.
401 — Unauthorized
404 — The entity with the specified ID was not found.
500 — Failed to perform operation due to validation errors or server issues.
PUT /v1/assets
Update asset by ID.
Full URL: /api/public/v1/assets — Authentication: Basic authentication (HTTP over TLS)
Request body: Required: yes | Content type: application/json | Schema: AssetUpdateDto
Responses:
200 — The asset has been successfully updated. Response schema:
AssetDto400 — Invalid input data.
401 — Unauthorized
POST /v1/assets/bulk
Bulk create assets.
Full URL: /api/public/v1/assets/bulk — Authentication: Basic authentication (HTTP over TLS)
Request body: Required: yes | Content type: application/json | Schema: AssetsBulkCreateDto
Responses:
201 — The assets have been successfully created. Response schema:
AssetUpsertResultDto400 — Invalid input data (max 1000 assets).
401 — Unauthorized
500 — Failed to perform operation due to validation errors or server issues.
PUT /v1/assets/bulk
Bulk update assets.
Full URL: /api/public/v1/assets/bulk — Authentication: Basic authentication (HTTP over TLS)
Request body: Required: yes | Content type: application/json | Schema: AssetsBulkUpdateDto
Responses:
200 — The assets have been successfully updated. Response schema:
AssetUpsertResultDto400 — Invalid input data (max 1000 assets).
401 — Unauthorized
500 — Failed to perform operation due to validation errors or server issues.
PUT /v1/assets/archive
Archive asset by ID.
Full URL: /api/public/v1/assets/archive — Authentication: Basic authentication (HTTP over TLS)
Request body: Required: yes | Content type: application/json | Schema: UpdateWithForeignDataDto
Responses:
200 — The asset has been successfully archived. Response schema:
AssetDto401 — Unauthorized
500 — Failed to perform operation due to validation errors or server issues.
Asset Types
GET /v1/asset-types
Retrieve a list of asset types based on the provided filters and pagination options.
Full URL: /api/public/v1/asset-types — Authentication: Basic authentication (HTTP over TLS)
Parameters:
Name | In | Type | Description | Example |
|---|---|---|---|---|
offset | query | number | Number of items to skip before starting to collect results | 0 |
count | query | number | Number of items to return | 10 |
foreignSystem | query | string | External mapping system identifier | ExternalCRM |
foreignIds | query | array<string> | Ids from external system | ["10"] |
ids | query | array<number> | Ids to query the data | [10] |
maintenanceTaskIds | query | array<number> | Filter by maintenance task IDs | [1] |
maintenanceTaskForeignIds | query | array<string> | Filter by external system maintenance task IDs | ["10"] |
fetchArchived | query | boolean | Whether to fetch archived records | false |
onlyChangedSince | query | string | Filter to only show records changed since this ISO string | 2024-01-01T12:00:00Z |
Responses:
200 — List of filtered asset types. Response schema:
array<AssetTypeDto>401 — Unauthorized
404 — The entity with the specified ID was not found.
500 — Failed to perform operation due to validation errors or server issues.
Maintenance Tasks
GET /v1/maintenance-tasks
Retrieve a list of maintenance tasks and pagination options.
Full URL: /api/public/v1/maintenance-tasks — Authentication: Basic authentication (HTTP over TLS)
Parameters:
Name | In | Type | Description | Example |
|---|---|---|---|---|
offset | query | number | Number of items to skip before starting to collect results | 0 |
count | query | number | Number of items to return | 10 |
foreignSystem | query | string | External mapping system identifier | ExternalCRM |
foreignIds | query | array<string> | Ids from external system | ["10"] |
ids | query | array<number> | Ids to query the data | [10] |
Responses:
200 — List of filtered maintenance tasks. Response schema:
array<MaintenanceTaskDto>401 — Unauthorized
404 — The entity with the specified ID was not found.
500 — Failed to perform operation due to validation errors or server issues.
Technician Groups
GET /v1/technician-groups
Retrieve a list of technician groups and pagination options.
Full URL: /api/public/v1/technician-groups — Authentication: Basic authentication (HTTP over TLS)
Parameters:
Name | In | Type | Description | Example |
|---|---|---|---|---|
offset | query | number | Number of items to skip before starting to collect results | 0 |
count | query | number | Number of items to return | 10 |
foreignSystem | query | string | External mapping system identifier | ExternalCRM |
foreignIds | query | array<string> | Ids from external system | ["10"] |
ids | query | array<number> | Ids to query the data | [10] |
userIds | query | array<number> | User IDs to filter by | [10] |
userForeignIds | query | array<string> | User foreign system IDs to filter by | ["some-user-id-1"] |
fetchArchived | query | boolean | Fetch archived groups (default false) | false |
Responses:
200 — List of filtered technician groups. Response schema:
array<TechnicianGroupDto>401 — Unauthorized
404 — The entity with the specified ID was not found.
500 — Failed to perform operation due to validation errors or server issues.
Areas
GET /v1/areas
Retrieve a list of areas and pagination options.
Full URL: /api/public/v1/areas — Authentication: Basic authentication (HTTP over TLS)
Parameters:
Name | In | Type | Description | Example |
|---|---|---|---|---|
offset | query | number | Number of items to skip before starting to collect results | 0 |
count | query | number | Number of items to return | 10 |
foreignSystem | query | string | External mapping system identifier | ExternalCRM |
foreignIds | query | array<string> | Ids from external system | ["10"] |
ids | query | array<number> | Ids to query the data | [10] |
Responses:
200 — List of filtered areas. Response schema:
array<MainAreaDto>401 — Unauthorized
404 — The entity with the specified ID was not found.
500 — Failed to perform operation due to validation errors or server issues.
AuthenticationOidc
GET /v1/authentication/config
Full URL: /api/public/v1/authentication/config — Authentication: None (public)
Responses:
200 — Success
Schemas
All data models referenced in request and response bodies are defined below, in alphabetical order.
AssetCreateDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
inventoryId | string | Customer internal inventory identifier (e.g., ERP) | ERP-001 | |
installationDate | string (date-time) | Installation date of the asset | 2025-09-15T12:00:00Z | |
purchaseDate | string (date-time) | Purchase date of the asset | 2025-08-01T12:00:00Z | |
purchaseReference | string | Purchase reference of the asset | Purchase-Ref-001 | |
warrantyDate | string (date-time) | Warranty date of the asset | 2026-01-01T12:00:00Z | |
specialInstructions | string | Special instructions for the asset | Handle with care | |
genericText1 | string | Generic text field 1 | Generic Text 1 | |
genericText2 | string | Generic text field 2 | Generic Text 2 | |
genericText3 | string | Generic text field 3 | Generic Text 3 | |
identifier | string | Asset identifier (custom field) | ASSET-001 | |
serialNumber | string | Serial number of the asset | SN123456 | |
foreignSystem | string | External system name | Maximo | |
name | string | * | Name of the asset | Generator |
assetTypeId | number | ID of the asset type | ||
assetTypeForeignId | string | Foreign system asset type id | ||
latitude | number | * | Latitude of the asset location (-90 to 90) | 37.7749 |
longitude | number | * | Longitude of the asset location (-180 to 180) | -122.4194 |
mainAreaName | string | * | Name of the main area where the asset is located | Main Office |
subAreaName | string | * | Name of the sub-area where the asset is located | Warehouse |
Required fields: name, latitude, longitude, mainAreaName, subAreaName
AssetDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
archived | string | Indicates if the data is archived | 2025-10-01T12:00:00Z | |
foreignSystem | string | External system name | Maximo | |
id | number | * | Unique ID of the asset | 1 |
name | string | * | Name of the asset | Asset Name |
serialNumber | string | * | Serial number of the asset | SN123456 |
identifier | string | * | Unique identifier of the asset | ASSET-001 |
assetTypeId | AssetTypeIdDto | * | ID of the asset type with foreign id | |
lastModified | string (date-time) | * | Timestamp of the last modification | 2025-10-01T12:00:00Z |
inventoryId | string | Customer internal inventory identifier | ERP-001 | |
installationDate | string (date-time) | Installation date of the asset | 2025-09-15T12:00:00Z | |
purchaseDate | string (date-time) | Purchase date of the asset | 2025-08-01T12:00:00Z | |
purchaseReference | string | Purchase reference of the asset | Purchase-Ref-001 | |
warrantyDate | string (date-time) | Warranty date of the asset | 2026-01-01T12:00:00Z | |
specialInstructions | string | Special instructions for the asset | Handle with care | |
genericText1 | string | Generic text field 1 | Generic Text 1 | |
genericText2 | string | Generic text field 2 | Generic Text 2 | |
genericText3 | string | Generic text field 3 | Generic Text 3 | |
location | GeoLocationDto | Location details of the asset | ||
assetType | AssetTypeDto | Asset type details | ||
maintenanceStatus | array<AssetMaintenanceStatusDto> | Maintenance status details | ||
assetStatus | string (enum) | Current status: ok, failure | ok | |
fixationStatus | AssetFixationStatusDto | Fixation status of the asset | ||
photometricStatus | AssetPhotometricStatusDto | Photometric status of the asset | ||
observationStatus | AssetObservationStatusDto | Observation status of the asset |
Required fields: id, name, serialNumber, identifier, assetTypeId, lastModified
AssetFixationStatusDto
Name | Type | Description |
|---|---|---|
currentStatus | string (enum) | Current fixation status rating. Values: good, warning, problem |
averageITC | string (enum) | Average initial torque condition. Values: veryTight, tight, loose, veryLoose, noFixation |
worstITC | string (enum) | Worst initial torque condition. Values: veryTight, tight, loose, veryLoose, noFixation |
AssetIdDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
assetId | number | * | The asset ID associated with the work order | 10 |
foreignId | string | Foreign ID | abc-123 |
Required fields: assetId
AssetMaintenanceStatusDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
maintenanceTaskId | MaintenanceTaskIdDto | * | ID with foreign id of the maintenance task | |
previousMaintenance | string (date-time) | * | Date of the previous maintenance | 2025-01-01T00:00:00Z |
nextMaintenance | string (date-time) | * | Date of the next maintenance | 2025-06-01T00:00:00Z |
maintenanceStatus | string (enum) | * | Current maintenance cycle status. Values: noMaintenanceCycle, recentlyUpdated, good, awaitingMaintenance, maintenanceOverdue, noData | recentlyUpdated |
Required fields: maintenanceTaskId, previousMaintenance, nextMaintenance, maintenanceStatus
AssetObservationStatusDto
Name | Type | Description |
|---|---|---|
numOfOpenObservations | number | Number of open observations |
numOfOpenObservationsWithAttentionFlag | number | Number of open observations with attention flag |
observationStatistics | array<ObservationStatisticsDto> | Observation statistics |
AssetPhotometricStatusDto
Name | Type | Req. | Description |
|---|---|---|---|
degradationPerSide | array<number> | * | Degradation per side |
maintenanceDoneAfterLastMeasurement | boolean | Indicates if maintenance was done after the last measurement | |
belowAuthorityThreshold | boolean | Indicates if the photometric status is below the authority threshold | |
belowMaintenanceThreshold | boolean | Indicates if the photometric status is below the maintenance threshold |
Required fields: degradationPerSide
AssetTypeDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
archived | string | Indicates if the data is archived | 2025-10-01T12:00:00Z | |
id | number | * | Unique identifier of the asset type | 1 |
description | string | * | Description of the asset type | Heavy-duty industrial equipment |
manufacturer | string | * | Manufacturer of the asset type | ACME Corp |
model | string | * | Model of the asset type | Model X |
partNumber | string | Part number of the asset type | 12345-67890 | |
fixationPoints | number | Number of fixation points | 4 | |
labels | array<string> | * | Labels associated with the asset type | ["industrial", "heavy-duty"] |
maintenanceTasks | array<AssetTypeMaintenanceTaskDto> | * | Maintenance tasks for the asset type | |
lastModified | object | Last modification date | 2023-10-17T11:06:57.022Z |
Required fields: id, description, manufacturer, model, labels, maintenanceTasks
AssetTypeIdDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
assetTypeId | number | * | The ID of the related asset type | 10 |
foreignId | string | Foreign ID | abc-123 |
Required fields: assetTypeId
AssetTypeMaintenanceTaskDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
archived | string | Indicates if the data is archived | 2025-10-01T12:00:00Z | |
maintenanceTaskId | MaintenanceTaskIdDto | * | ID with external system id of the maintenance task | |
intervalInDays | number | * | Interval in days for the maintenance task | 30 |
Required fields: maintenanceTaskId, intervalInDays
AssetUpdateDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
inventoryId | string | Customer internal inventory identifier | ERP-001 | |
installationDate | string (date-time) | Installation date | 2025-09-15T12:00:00Z | |
purchaseDate | string (date-time) | Purchase date | 2025-08-01T12:00:00Z | |
purchaseReference | string | Purchase reference | Purchase-Ref-001 | |
warrantyDate | string (date-time) | Warranty date | 2026-01-01T12:00:00Z | |
specialInstructions | string | Special instructions | Handle with care | |
genericText1 | string | Generic text field 1 | Generic Text 1 | |
genericText2 | string | Generic text field 2 | Generic Text 2 | |
genericText3 | string | Generic text field 3 | Generic Text 3 | |
foreignSystem | string | External system name | Maximo | |
foreignId | string | Foreign identifier | maximo-wo-1 | |
id | number | Entity id | ||
identifier | string | Asset identifier | ASSET-001 | |
serialNumber | string | Serial number | SN123456 | |
assetTypeId | number | ID of the asset type | ||
assetTypeForeignId | string | Foreign asset type id | ||
latitude | number | Latitude | 37.7749 | |
longitude | number | Longitude | -122.4194 | |
mainAreaName | string | Main area name | Main Office | |
subAreaName | string | Sub-area name | Warehouse | |
name | string | Name of the asset | Generator |
AssetUpsertResultDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
finished | boolean | * | Indicates whether the operation is finished | true |
progress | number | * | Progress of the operation as percentage | 75 |
totalCount | number | * | Total number of assets involved | 100 |
success | boolean | Indicates whether the operation was successful | true | |
errors | array<string> | List of error messages | ["Error 1", "Error 2"] | |
deleted | number | Number of assets deleted | 20 | |
inserted | number | Number of assets inserted | 30 | |
updated | number | Number of assets updated | 50 |
Required fields: finished, progress, totalCount
AssetsBulkCreateDto
Name | Type | Req. | Description |
|---|---|---|---|
assets | array<AssetCreateDto> | * | List of assets to be created |
Required fields: assets
AssetsBulkUpdateDto
Name | Type | Req. | Description |
|---|---|---|---|
assets | array<AssetUpdateDto> | * | List of assets to be updated |
Required fields: assets
AssetsFilterParamsDto
Name | Type | Description | Example |
|---|---|---|---|
onlyChangedSince | string | Date (ISO format) to fetch entities changed since | 2025-10-17T13:15:54.019Z |
foreignSystem | string | External system name | Maximo |
foreignIds | array<string> | Ids from external system | ["10"] |
extendedData | boolean | Indicates if you want extended details | |
ids | array<number> | Optional array of asset IDs | [1, 2, 3] |
subAreaIds | array<number> | Optional array of sub-area IDs | [100, 200] |
subAreaForeignIds | array<string> | Optional array of sub-area foreign IDs | ["100"] |
assetTypeIds | array<number> | Optional array of asset type IDs | [10, 20] |
assetTypeForeignIds | array<string> | Optional array of asset type foreign IDs | ["10"] |
fetchArchived | boolean | Optional flag to fetch archived assets | true |
ClosedByUserIdDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
closedByUserId | number | * | Unique user ID of the person who closed the item | 10 |
foreignId | string | Foreign ID | abc-123 |
Required fields: closedByUserId
CreatedByUserIdDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
createdByUserId | number | * | Unique ID of the user who created the entry | 10 |
foreignId | string | Foreign ID | abc-123 |
Required fields: createdByUserId
GeoLocationDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
subAreaId | SubAreaIdDto | * | ID with external system id of the sub-area | |
latitude | number | * | Latitude of the geo-location | 37.7749 |
longitude | number | * | Longitude of the geo-location | -122.4194 |
Required fields: subAreaId, latitude, longitude
MainAreaDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
foreignSystem | string | External system name | Maximo | |
foreignId | string | Foreign identifier | maximo-wo-1 | |
archived | string | Indicates if the data is archived | 2025-10-01T12:00:00Z | |
id | number | * | Unique ID of the area | 1 |
name | string | * | Name of the area | Main Area Description |
lastModified | string (date-time) | Timestamp of the last modification | 2025-10-01T12:00:00Z | |
subAreas | array<SubAreaStorageFormatDto> | * | Sub-areas associated with the main area |
Required fields: id, name, subAreas
MainAreaIdDto
Required fields: mainAreaId
MaintenanceTaskDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
foreignSystem | string | External system name. | Maximo | |
foreignId | string | Foreign identifier of the entity. | maximo-wo-1 | |
archived | string | Indicates if the data is archived | 2025-10-01T12:00:00Z | |
id | number | * | The unique ID of the maintenance task | 1 |
description | string | * | The description of the maintenance task | Check the air filters |
proofType | string (enum) | * | The type of proof required for this task. Values: unknown, validationTask, torqueTask | torqueTask |
checkList | array<string> | A checklist containing names, all sorted in order, relevant for this maintenance task. | ["Check the air filters", "Check the oil filter"] |
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
maintenanceTaskId | number | * | The ID of the maintenance task | 10 |
foreignId | string | Foreign ID | abc-123 |
Name | Type | Req. | Description |
|---|---|---|---|
severity | string (enum) | * | Severity of the observation. Values: noSafetyEffect, minor, medium, major, critical, notDetermined |
state | string (enum) | * | State of the observation. Values: new, pending, planned, resolved, closed |
count | number | * | Count of observations with the given severity and state |
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
archived | string | Indicates if the data is archived | 2025-10-01T12:00:00Z | |
id | number | * | Unique ID of the asset | 1 |
name | string | * | Name of the asset | Asset Name |
serialNumber | string | * | Serial number of the asset | SN123456 |
identifier | string | * | Unique identifier of the asset | ASSET-001 |
assetTypeId | AssetTypeIdDto | * | ID of the asset type with foreign id | |
lastModified | string (date-time) | * | Timestamp of the last modification | 2025-10-01T12:00:00Z |
inventoryId | string | Customer internal inventory identifier (e.g., ERP) | ERP-001 | |
installationDate | string (date-time) | Installation date of the asset | 2025-09-15T12:00:00Z | |
purchaseDate | string (date-time) | Purchase date of the asset | 2025-08-01T12:00:00Z | |
purchaseReference | string | Purchase reference of the asset | Purchase-Ref-001 | |
warrantyDate | string (date-time) | Warranty date of the asset | 2026-01-01T12:00:00Z | |
specialInstructions | string | Special instructions for the asset | Handle with care | |
genericText1 | string | Generic text field 1 | Generic Text 1 | |
genericText2 | string | Generic text field 2 | Generic Text 2 | |
genericText3 | string | Generic text field 3 | Generic Text 3 | |
location | GeoLocationDto | Location details of the asset |
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
subAreaId | number | * | The ID of the related sub area | 10 |
foreignId | string | Foreign ID | abc-123 |
Required fields: subAreaId
SubAreaStorageFormatDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
foreignSystem | string | External system name. | Maximo | |
foreignId | string | Foreign identifier of the entity. | maximo-wo-1 | |
archived | string | Indicates if the data is archived | 2025-10-01T12:00:00Z | |
id | number | * | Unique ID of the area | 1 |
name | string | * | Name of the area | Main Area Description |
lastModified | string (date-time) | Timestamp of the last modification | 2025-10-01T12:00:00Z | |
mainAreaId | MainAreaIdDto | * | ID of the main area this sub-area belongs to |
Required fields: id, name, mainAreaId
TechnicianGroupDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
foreignSystem | string | External system name. | Maximo | |
foreignId | string | Foreign identifier of the entity. | maximo-wo-1 | |
id | number | * | The unique identifier of the group. | 1 |
name | string | * | The name of the group. | Admin Group |
archived | object | Indicates whether the group is archived. | 2025-10-01T12:00:00Z |
Required fields: id, name
TechnicianGroupIdDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
technicianGroupId | number | * | The internal ID of the technician group. | 10 |
foreignId | string | Foreign ID | abc-123 |
Required fields: technicianGroupId
UpdateWithForeignDataDto
Name | Type | Req. | Description |
|---|---|---|---|
foreignSystem | string | External system name. | |
foreignId | string | ||
id | number | Entity id |
WorkOrderCloseDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
foreignSystem | string | External system name. | Maximo | |
foreignId | string | Foreign identifier of the entity. | maximo-wo-1 | |
id | number | Work order id for close | 123 | |
closedByUserId | number | User id who closed work order (optional) | 123 | |
closedByUserForeignId | string | User id who closed work order (optional) | 123 |
WorkOrderCreateDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
foreignSystem | string | External system name. | Maximo | |
foreignId | string | Foreign identifier of the entity. | maximo-wo-1 | |
technicianGroupId | number | The ID of the technician group assigned to the work order | 1 | |
technicianGroupForeignId | string | The external system ID of the technician group assigned to the work order | 1 | |
maintenanceTaskId | number | The ID of the maintenance task | 101 | |
maintenanceTaskForeignId | string | * | The external system ID of the maintenance task | 101 |
permitNumber | string | * | The permit number for the work order | PERMIT-12345 |
externalRef | string | * | An external reference for the work order | EXT-98765 |
selectedAssetIds | array<number> | An array of selected asset IDs (optional) | [101] | |
selectedAssetForeignIds | array<string> | An array of selected asset external system IDs (optional) | ["101"] | |
subAreaId | number | The ID of the sub-area where the work order is scheduled (optional) | 10 | |
subAreaForeignId | string | The external system ID of the sub-area where the work order is scheduled (optional) | 10 |
Required fields: scheduledDate, maintenanceTaskForeignId, permitNumber, externalRef
WorkOrderDetailsStateDto
Name | Type | Req. | Description |
|---|---|---|---|
assetId | AssetIdDto | * | Stores the unique ID of an asset associated with the work order, paired with the foreign system's ID. |
doneTimestamp | string (date-time) | Time when work order was done | |
formerMaintenanceState | string (enum) | Asset maintenance cycle state. Values: noMaintenanceCycle, recentlyUpdated, good, awaitingMaintenance, maintenanceOverdue, noData |
Required fields: assetId
WorkOrderDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
foreignSystem | string | External system name. | Maximo | |
foreignId | string | Foreign identifier of the entity. | maximo-wo-1 | |
maintenanceTaskId | MaintenanceTaskIdDto | * | ID with external system id of the maintenance task | |
subAreaId | SubAreaIdDto | * | ID with external system id of the sub-area | |
technicianGroupId | TechnicianGroupIdDto | * | The technician group identifier, including both internal and external system IDs. | |
id | number | * | The unique ID of the work order | 1 |
summary | string | * | The summary associated with the work order | Some summary text here. |
externalRef | string | * | External reference for the work order | EXT12345 |
maintenanceTaskProofType | string (enum) | * | The type of maintenance task proof. Values: unknown, validationTask, torqueTask | torqueTask |
creationDate | string (date-time) | * | The creation date of the work order | 2025-10-13T12:00:00Z |
scheduledDate | string (date-time) | * | The scheduled date of the work order | 2025-10-20T12:00:00Z |
closedDate | string (date-time) | * | The closed date of the work order (if applicable) | 2025-10-25T12:00:00Z |
closedByUserId | ClosedByUserIdDto | * | Stores the unique ID of the user who closed the work order, paired with the foreign system's ID | |
createdByUserId | CreatedByUserIdDto | * | Stores the unique ID of the user who created the work order, paired with the foreign system's ID | |
totalCount | number | * | The total count of items in the work order | 10 |
doneCount | number | * | The count of completed items in the work order | 5 |
proofTypeDescription | string | * | Description of the proof type | Photo Proof |
subAreaName | string | * | Sub area name of the asset | Area 51 |
maintenanceTaskDescription | string | * | Description of the maintenance task | Fixing a generator |
createdByName | string | * | Name of the creator | John Doe |
closedByName | string | * | Name of the person who closed the work order | Jane Smith |
technicianGroupName | object | * | Name of the technician group | Team Alpha |
WorkOrderGetBodyDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
extendedData | boolean | Indicates if you want extra, extended details in the response. Set to true to receive additional data. | ||
foreignIds | array<string> | Ids from external system to query the data | ["10"] | |
foreignSystem | string | External system name. | Maximo | |
ids | array<number> | Work orders ids | [10] | |
withClosed | boolean | Whether to include closed work orders in the result set | True |
WorkOrderWithDetailsDto
Name | Type | Req. | Description | Example |
|---|---|---|---|---|
foreignSystem | string | External system name. | Maximo | |
foreignId | string | Foreign identifier of the entity. | maximo-wo-1 | |
maintenanceTaskId | MaintenanceTaskIdDto | * | ID with external system id of the maintenance task | |
subAreaId | SubAreaIdDto | * | ID with external system id of the sub-area | |
technicianGroupId | TechnicianGroupIdDto | * | The technician group identifier, including both internal and external system IDs. | |
id | number | * | The unique ID of the work order | 1 |
summary | string | * | The summary associated with the work order | Some summary text here. |
externalRef | string | * | External reference for the work order | EXT12345 |
maintenanceTaskProofType | string (enum) | * | The type of maintenance task proof. Values: unknown, validationTask, torqueTask | torqueTask |
creationDate | string (date-time) | * | The creation date of the work order | 2025-10-13T12:00:00Z |
scheduledDate | string (date-time) | * | The scheduled date of the work order | 2025-10-20T12:00:00Z |
closedDate | string (date-time) | * | The closed date of the work order (if applicable) | 2025-10-25T12:00:00Z |
closedByUserId | ClosedByUserIdDto | * | Stores the unique ID of the user who closed the work order, paired with the foreign system's ID | |
createdByUserId | CreatedByUserIdDto | * | Stores the unique ID of the user who created the work order, paired with the foreign system's ID | |
totalCount | number | * | The total count of items in the work order | 10 |
doneCount | number | * | The count of completed items in the work order | 5 |
proofTypeDescription | string | * | Description of the proof type | Photo Proof |
subAreaName | string | * | Sub area name of the asset | Area 51 |
maintenanceTaskDescription | string | * | Description of the maintenance task | Fixing a generator |
createdByName | string | * | Name of the creator | John Doe |
closedByName | string | * | Name of the person who closed the work order | Jane Smith |
technicianGroupName | object | * | Name of the technician group | Team Alpha |
detailsState | array<WorkOrderDetailsStateDto> | * | Array of details for the work order |
Source of truth: this PDF reflects the OpenAPI specification at the time of generation. For the latest interactive definitions, use the Swagger UI on your Cortex Service instance or the demo-api instance. If you spot any discrepancies, treat the live Swagger UI as authoritative.