Get Asset Integration Map
GET/api/inspect/v1/asset/integration/map
This API retrieves an asset integration map to assist with system integration. The map contains asset-related entities, such as spot templates, spot fields, and spot field options, linked to their respective IDs. These mappings are useful for system-to-system integrations, where ID references are required to link assets, spots, and fields with specific configurations. The API returns mappings based on their visible labels, names, or other text identifiers.
Request
Query Parameters
The unique identifier of the company for which the assets are to be fetched. This parameter specifies the context of the integration map and limits the results to the assets belonging to this company.
[Optional] A comma-separated list of asset IDs for which the integration map is to be fetched. This parameter ensures that the integration map is generated only for the specified assets.
Responses
- 200
- 400
- 401
- 403
- 404
- 500
200 OK. The request was successful, and the integration map was returned. The response includes a mapping of asset-related entities, such as spot templates, spot fields, and spot field options, to their respective unique identifiers.
- application/json
- Schema
- Example (from schema)
Schema
data
object
The data object containing the integration map for each asset with asset name as key.
property name*
AssetNameMap
The name of the asset mapped to its details.
fields
object
A map of spot field names to spot field details. This mapping links each field within the asset to its identifier and associated options.
property name*
SpotFieldNameMap
The name of the spot field mapped to its details.
The unique identifier (UUID) of the spot field.
options
object
A map of spot field option names to their unique identifiers. This allows mapping of the field options (such as dropdown values) to their corresponding IDs.
The name of the spot field option mapped to its unique identifier (UUID).
The unique identifier (UUID) of the asset.
templates
object
A map of spot template names to spot template IDs. This mapping links each spot template in the asset to its respective identifier.
The name of the spot template mapped to its unique identifier (UUID).
{
"data": {
"Asset 1": {
"fields": {
"Assignee": {
"id": "assignees",
"options": {}
},
"Category": {
"options": {
"Corrosion": "corrosion",
"Crack": "crack",
"Delamination": "delamination",
"Others": "others",
"Paint Loss": "paint_loss",
"Dampness": "dampness",
"Deformation": "deformation",
"Leakage": "leakage",
"Spalling": "spalling"
},
"id": "category"
},
"Remarks": {
"id": "remarks",
"options": {}
},
"Reporter": {
"id": "reporter",
"options": {}
},
"Severity": {
"id": "severity",
"options": {
"Major": "major",
"Minor": "minor",
"None": "none"
}
},
"Status": {
"id": "status",
"options": {
"Closed": "6",
"In Progress": "2",
"Open": "1",
"Rejected": "4",
"Resolved": "3"
}
},
"Width": {
"id": "78d33df3-2835-4447-b920-39045ed7ec35",
"options": {}
}
},
"id": "ff95d178-084f-4e53-b5b5-93b858a8f3bb",
"templates": {
"Photo Spot Template": "8bd565ec-73f6-11ef-a3e0-fc6503e05a24",
"360° Spot Template": "8bd566a0-73f6-11ef-a3e0-fc6503e05a24",
"Building Template": "8a8ffd32-73f6-11ef-a3e0-fc6503e05a24"
}
}
}
}
400 Bad Request. The request is invalid. This might happen if required parameters, such as companyID or assetIDs, are missing or formatted incorrectly.
- application/json
- Schema
- Example (from schema)
Schema
A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.
A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.
{
"error": "Forbidden",
"errorDescription": "permission denied"
}
401 Unauthorized. Authentication is required and was not provided or is invalid. Ensure that the correct credentials or tokens are included in the request.
- application/json
- Schema
- Example (from schema)
Schema
A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.
A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.
{
"error": "Forbidden",
"errorDescription": "permission denied"
}
403 Forbidden. The client does not have permission to access the requested asset integration map. Ensure that the client has sufficient privileges for the specified companyID and assets.
- application/json
- Schema
- Example (from schema)
Schema
A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.
A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.
{
"error": "Forbidden",
"errorDescription": "permission denied"
}
404 Not Found. The specified asset or company does not exist. Verify that the correct companyID and assetIDs are provided.
- application/json
- Schema
- Example (from schema)
Schema
A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.
A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.
{
"error": "Forbidden",
"errorDescription": "permission denied"
}
500 Internal Server Error. An error occurred on the server while processing the request. Retry the operation or contact support if the issue persists.
- application/json
- Schema
- Example (from schema)
Schema
A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.
A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.
{
"error": "Forbidden",
"errorDescription": "permission denied"
}