API Reference
Discover how to integrate with the Open Assets API and build integrated apps.
The Open Asset API is a set of REST APIs. This API is resource oriented and endpoint are grouped by their respective resource object.
All endpoints accept application/json requests and return application/json responses. The only exception to this rule are endpoints that accept files. The content type for these endpoint is multipart/form-data. However, they will return application/json responses;
Authentication
The Open Assets API requires authentication. This enables the API to secure itself from unwanted actors. This document will assume you have already created an Api Key. If you have not please see Managing Api Keys.
Authenticating a request requires you to add a HTTP Header to each request. The custom header should be named x-api-key and the value should be the value of the Api Key. For example:
curl --request GET \
--url 'http://api.open-assets.co.uk/assets/{id}'
--header 'x-api-key: ab5GO4.Njg4NDU3OWEtMjI1Ny00Njg4LTljNzQtZDQ3ZDIyMDE0ZjgwLjhPQlU5QUpEN1Y2bXhvSHFlNTRwR3lZclZJd3NUTkRTK3JsaVlqQy9iZDA9' \
Sandbox Environment
Open Assets runs on multiple environments. Production API is hosted at api.open-assets.co.uk. All of the endpoints shown below show examples using the production endpoints.
However, for testing and development purposes Open Assets supplies a Sandbox environment for external developers to test and develop integration against. This sandbox environment does not effect any production data or accounts. All usage will not be billable and new features will be hosted here first.
The Sandbox endpoint can be found at https://api-sandbox.open-assets.co.uk. To use the sandbox environment you will need to generate a sandbox Api Key. The instruction to do so are the same as production, except it should be creating using the Sandbox version of the appopen in new window. Click here to login to the
| Environment | API URL | App |
|---|---|---|
| Production | https://api.open-assets.co.uk | Production Appopen in new window |
| Sandbox | https://api-sandbox.open-assets.co.uk | Sandbox Appopen in new window |
Errors
Open API uses standard HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted etc.). Codes in the 5xx range indicate an error with Stripe's servers (these are rare).
If a 4xx error code is returned an error object will be return in the response body as JSON. The additionalInfo is dynamic and will return information related to the message. Often this will be validation errors, such as:
{
"message": "Input validation errors. See additionalInfo for more details",
"additionalInfo": [
{
"propertyName": "RequestBody.Attributes.SerialNumber",
"errorMessage": "'Request Body Attributes Serial Number' must not be empty.",
"attemptedValue": null
}
]
}
Otherwise, details related to the message will be supplied.
{
"message": "The asset already exists",
"additionalInfo": {
"id": "AOI-HEID67-HSG4EV-MP4QS7"
}
}
Endpoints
Below is the full set of available APIs Open Assets has to offer. Some common use cases have been details in the developer docs under Example Use Cases. However, these are not the only use cases for this API.
If you need any support using the Open Assets API please context us on support@open-assets.co.uk and we'd be happy to help.
Account
Account Endpoints
POST/account/password/reset
PUT/account/password
POST/account/password/reset/verify
PUT/account
POST/account/email/verify
Send Reset Account Password Link
Start reset a password for an account.
Request Object
emailemailrequired
Email address of the account to send the password reset email to.
Returns
Sends a OoB link to an email address.
Request Object
{
"email": "user@example.com"
}Request
curl --request POST \
--url https://api.open-assets.co.uk/account/password/reset \
--header 'content-type: application/json' \
--data '{"email":"user@example.com"}'Reset Account Password
Reset a password for an account.
Request Object
oobCodestringrequired
Out of band code. A unique code sent to the users email address after requesting a password reset.
newPasswordpasswordrequired
New password to change to
Request Object
{
"oobCode": "rd6nd-ZPje_v1nEJrKVJNqrN9RqJeNa6",
"newPassword": "pa$word"
}Request
curl --request PUT \
--url https://api.open-assets.co.uk/account/password \
--header 'content-type: application/json' \
--data '{"oobCode":"rd6nd-ZPje_v1nEJrKVJNqrN9RqJeNa6","newPassword":"pa$word"}'Verify Reset Account Password Code
Verify reset password code.
Request Object
emailemailrequired
Email address of the account that is resetting the password
oobCodestringrequired
Out of band code. A unique code sent to the users email address after requesting a password reset.
Request Object
{
"email": "user@example.com",
"oobCode": "rd6nd-ZPje_v1nEJrKVJNqrN9RqJeNa6"
}Request
curl --request POST \
--url https://api.open-assets.co.uk/account/password/reset/verify \
--header 'content-type: application/json' \
--data '{"email":"user@example.com","oobCode":"rd6nd-ZPje_v1nEJrKVJNqrN9RqJeNa6"}'Create Account
Register an account
Request Object
emailemailrequired
Email address of the new account. Must match the
email address the oobCode was sent to
passwordpasswordrequired
Account password
firstNamestringrequired
The first name of the account owner
lastNamestringrequired
The last name of the account owner
oobCodestringrequired
Out of band code. This code would have been sent to the users email address via an invite
Headers
access-control-allow-originstringrequired
Returns
Sign up. Note: an email address must be invited first.
Request Object
{
"email": "user@example.com",
"password": "pa$word",
"firstName": "Jonny",
"lastName": "Assets",
"oobCode": "rd6nd-ZPje_v1nEJrKVJNqrN9RqJeNa6"
}Request
curl --request PUT \
--url https://api.open-assets.co.uk/account \
--header 'access-control-allow-origin: SOME_STRING_VALUE' \
--header 'content-type: application/json' \
--data '{"email":"user@example.com","password":"pa$word","firstName":"Jonny","lastName":"Assets","oobCode":"rd6nd-ZPje_v1nEJrKVJNqrN9RqJeNa6"}'Response Object: (HTTP Code: 200)
{
"token": {
"expiration": "2019-08-24T14:15:22Z",
"accessToken": "string",
"refreshToken": "string",
"refreshTokenExpiration": "2019-08-24T14:15:22Z",
"refreshTokenExpiresWithSession": true
}
}Verify Account Email
Verify an email address has be preregistered.
Request Object
emailemailrequired
Email address to verify
Request Object
{
"email": "user@example.com"
}Request
curl --request POST \
--url https://api.open-assets.co.uk/account/email/verify \
--header 'content-type: application/json' \
--data '{"email":"user@example.com"}'Response Object: (HTTP Code: 200)
{
"firstName": "string",
"lastName": "string",
"email": "string",
"signUpAllowed": true
}Action
Actions can be used to create a list of things that need to be actioned. Users can create actions manually or they can be created automatically via Auto Action Rulesets.
Action Endpoints
POST/assets/{id}/actions
GET/assets/{id}/actions
GET/actions
PUT/actions/{id}/resolve
PUT/assets/{id}/actions/{actionId}
Create Asset Action
Create actions assigned to an asset.
Application Right: AssetActionsWrite
Request Object
titlestringrequired
The title of the action
descriptionstringrequired
The description details of the action
scheduledFordate-timeoptional
When the action is scheduled for
assignedToUserIdsstringoptional
The ids of the users assigned to the action
Request Object
{
"title": "string",
"description": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"assignedToUserIds": [
"XXX_184TBUKB00_4ZHN6E"
]
}Request
curl --request POST \
--url https://api.open-assets.co.uk/assets/{id}/actions \
--header 'content-type: application/json' \
--data '{"title":"string","description":"string","scheduledFor":"2019-08-24T14:15:22Z","assignedToUserIds":["XXX_184TBUKB00_4ZHN6E"]}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}Get Asset Actions
Get actions assigned to an asset.
Application Right: AssetViewActions
Query String
querystringoptional
Open Asset ID, Primary Identifier or Agreement Reference to filter by
takeint32optional
How many results to return. Default: 10. Max: 200
skipint32optional
How many results to skip. Default: 0
resolvedbooleanoptional
Should include resolved actions
scheduledbooleanoptional
Should include scheduled actions
assignedTostringoptional
Filter by an assigned user
expandarray[string]optional
Specify which properties should be included in the response.
Possible Values
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/assets/{id}/actions?query=SOME_STRING_VALUE&take=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&resolved=SOME_BOOLEAN_VALUE&scheduled=SOME_BOOLEAN_VALUE&assignedTo=SOME_STRING_VALUE&expand=SOME_ARRAY_VALUE'Response Object: (HTTP Code: 200)
{
"totalCount": 0,
"results": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
}Get Actions
Get actions assigned to any of your companies assets.
Application Right: AssetViewActions
Query String
querystringoptional
Registration or Serial Number search query
takeint32optional
How many results to return. Default: 10. Max: 200
skipint32optional
How many results to skip. Default: 0
resolvedbooleanoptional
Should include resolved actions
scheduledbooleanoptional
Should include scheduled actions
assignedTostringoptional
Filter by an assigned user
expandarray[string]optional
Specify which properties should be included in the response.
Possible Values
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/actions?query=SOME_STRING_VALUE&take=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&resolved=SOME_BOOLEAN_VALUE&scheduled=SOME_BOOLEAN_VALUE&assignedTo=SOME_STRING_VALUE&expand=SOME_ARRAY_VALUE'Response Object: (HTTP Code: 200)
{
"totalCount": 0,
"results": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
}Resolve Asset Action
Request Object
{
"resolvedComment": "string"
}Request
curl --request PUT \
--url https://api.open-assets.co.uk/actions/{id}/resolve \
--header 'content-type: application/json' \
--data '{"resolvedComment":"string"}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}Update Asset Action
Update actions assigned to an asset.
Application Right: AssetActionsWrite
Request Object
titlestringrequired
The title of the action
descriptionstringrequired
The description details of the action
scheduledFordate-timeoptional
When the action is scheduled for
assignedToUserIdsstringoptional
The ids of the users assigned to the action
Request Object
{
"title": "string",
"description": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"assignedToUserIds": [
"XXX_184TBUKB00_4ZHN6E"
]
}Request
curl --request PUT \
--url https://api.open-assets.co.uk/assets/{id}/actions/{actionId} \
--header 'content-type: application/json' \
--data '{"title":"string","description":"string","scheduledFor":"2019-08-24T14:15:22Z","assignedToUserIds":["XXX_184TBUKB00_4ZHN6E"]}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}Agreement Type
When registering an asset an Agreement Kind can be assigned, which represents the the insightTypeKind of agreement held between the two parties.
Agreement Type Endpoints
GET/agreement-types/{id}
GET/agreement-types
Get Agreement Type
Request
curl --request GET \
--url https://api.open-assets.co.uk/agreement-types/{id}Response Object: (HTTP Code: 200)
{
"id": 0,
"name": "string"
}Api Key
Api Keys can be used to access resources in the Open Assets API. Each Api Key can have a different set of Application Rights.
Api Key values should be kept in a safe place and not made publicly available. If you suspect your Api Key has been comprimised it is recommended that you delete the Api Key immediately and create a new one to replace it.
Api Key Endpoints
POST/api-keys
GET/api-keys
DELETE/api-keys/{id}
GET/api-keys/{id}
Create Api Key
Create a new API Key.
Application Right: ApiKeyManage
Request Object
namestringrequired
Custom name for the Api Key
rightsstringrequired
The ids of the Application Rights to assign to this Api Key.
Possible Values
Returns
If successful, an Api Key with the keys value will be returned. It is important this value is stored in a safe place. It can not be returned from the Open Assets API again. If unsuccessful, an Error is returned.
Request Object
{
"name": "Contract system api key",
"rights": [
"ApiKeyManage"
]
}Request
curl --request POST \
--url https://api.open-assets.co.uk/api-keys \
--header 'content-type: application/json' \
--data '{"name":"Contract system api key","rights":["ApiKeyManage"]}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"keyPrefix": "string",
"rights": [
{
"id": "string",
"name": "string",
"description": "string"
}
],
"keyValue": "string"
}Get Api Keys
Get all API Keys.
Application Right: ApiKeyManage
Returns
If successful, an array of all Api Keys is returned. Note: the Api Keys will not include the Api Key value only a description. This is only returned via the create endpoint. If unsuccessful, an Error is returned.
Request
curl --request GET \
--url https://api.open-assets.co.uk/api-keysResponse Object: (HTTP Code: 200)
[
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"keyPrefix": "string",
"rights": [
{
"id": "string",
"name": "string",
"description": "string"
}
]
}
]Delete Api Key
Delete an API Key. This operation cannot be recovered. The Api Key value will sop working immediately.
Application Right: ApiKeyManage
Request
curl --request DELETE \
--url https://api.open-assets.co.uk/api-keys/{id}Get Api Key
Get API Key by Id.
Application Right: ApiKeyManage
Returns
If successful, an Api Key is returned. Note: the Api Keys will not include the Api Key value only a description. This is only returned via the create endpoint. If unsuccessful, an Error is returned.
Request
curl --request GET \
--url https://api.open-assets.co.uk/api-keys/{id}Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"keyPrefix": "string",
"rights": [
{
"id": "string",
"name": "string",
"description": "string"
}
]
}App Right
An App Right is the most granular level of security. App rights are assigned to users through roles and assigned directly to Api Keys when creating them. Most endpoints are secured using an App Right. Meaning the user of Api Key must posses that right to be able to access the endpoint. See Managing API Keys for the full list of App Rights.
App Right Endpoints
GET/rights
App Role
An App Role is a group of App Rights. App Roles simplify the process of selecting the right set of App Rights for a user.
App Role Endpoints
GET/roles
Asset
An asset is the primary resource the Open Asset API acts on. An asset holds all the details related to your companies view of that asset in the real world. The assets Id is a globally unique identifier for the asset. Multiple companies can operate on an asset with the same identifier. However, each company has it own personal version of the assets that you are free to change at anytime.
Assets are correlated by a set of real world identifiers. When you create an asset, depending on the insightTypeKind there will be one or many required identification fields they fields are used to match your asset with any existing one in the system. Once created the real world identifiers cannot be modified. If a mistake was made during creation you should create a new asset. See Asset identification for more information.
Asset Endpoints
POST/assets/{id}/children
GET/assets/{id}/children
POST/assets
GET/assets
DELETE/assets/{id}/children/{childId}
GET/assets/{id}
PUT/assets/{id}
PUT/assets/{id}/status
Attach Assets
Attach an asset to another as a child. Nested parent child parent relationships are no supported. Meaning assets that have children cannot be added as a child to another assets.
Application Right: AssetWrite
Request Object
idsstringrequired
Open Asset IDs of all new child assets
Request Object
{
"ids": [
"XXX_184TBUKB00_4ZHN6E"
]
}Request
curl --request POST \
--url https://api.open-assets.co.uk/assets/{id}/children \
--header 'content-type: application/json' \
--data '{"ids":["XXX_184TBUKB00_4ZHN6E"]}'Response Object: (HTTP Code: 200)
[
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
},
"parent": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"state": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"order": 0
},
"description": "Black Audi A3",
"metadata": {
"property1": "string",
"property2": "string"
},
"category": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "Industrial Machine",
"parentId": "XXX_184TBUKB00_4ZHN6E",
"enabledReportTypes": [
{
"id": 0,
"name": "string",
"description": "string",
"enabledInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"enabledInsightTypeIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
]
}
],
"useParentEnabledReportTypes": true
},
"tags": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string"
}
]
}
]Get Asset Children
Get vehicle asset.
Application Right: AssetRead
Query String
expandarray[string]optional
Specify which properties should be included in the response.
Possible Values
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/assets/{id}/children?expand=SOME_ARRAY_VALUE'Response Object: (HTTP Code: 200)
[
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
},
"parent": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"state": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"order": 0
},
"description": "Black Audi A3",
"metadata": {
"property1": "string",
"property2": "string"
},
"category": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "Industrial Machine",
"parentId": "XXX_184TBUKB00_4ZHN6E",
"enabledReportTypes": [
{
"id": 0,
"name": "string",
"description": "string",
"enabledInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"enabledInsightTypeIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
]
}
],
"useParentEnabledReportTypes": true
},
"tags": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string"
}
]
}
]Create Asset
Create an asset.
Application Right: AssetWrite
Request Object
parentIdstringoptional
stateIdstringoptional
descriptionstringoptional
As description of the asset
categoryIdstringoptional
identifierAttributesobjectrequired
primaryIdentifierstringoptional
The primary identifier associated with the asset as specified by the manufacturer or governing association for the asset insightTypeKind.
For example, this could be the serial number or VIN of the asset. See Attribute Guidelines for more details.
*Required to be an identifiable asset
attribute1stringoptional
The main attribute that aids in the recognition of the asset.
Often this is the commonly used full brand name of the manufacturer or creator of the asset. See Attribute Guidelines for more details.
*Required to be an identifiable asset
attribute2stringoptional
A second attribute of the asset to aid the in the recognition of the asset.
Often this is the model name of the asset. See Attribute Guidelines for more details.
*Optional for an identifiable asset The asset model name
metadataobjectoptional
A dictionary of custom metadata associated with this asset
tagsstringoptional
An array of tag Ids associated with this asset
Query String
expandarray[string]optional
Specify which properties should be included in the response.
Possible Values
Request Object
{
"parentId": "XXX_184TBUKB00_4ZHN6E",
"stateId": "XXX_184TBUKB00_4ZHN6E",
"description": "John Deere 6150R Tractor",
"categoryId": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
},
"metadata": {
"property1": "string",
"property2": "string"
},
"tags": [
"XXX_184TBUKB00_4ZHN6E"
]
}Request
curl --request POST \
--url 'https://api.open-assets.co.uk/assets?expand=SOME_ARRAY_VALUE' \
--header 'content-type: application/json' \
--data '{"parentId":"XXX_184TBUKB00_4ZHN6E","stateId":"XXX_184TBUKB00_4ZHN6E","description":"John Deere 6150R Tractor","categoryId":"XXX_184TBUKB00_4ZHN6E","identifierAttributes":{"primaryIdentifier":"700251","attribute1":"Boeing","attribute2":"787"},"metadata":{"property1":"string","property2":"string"},"tags":["XXX_184TBUKB00_4ZHN6E"]}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
},
"parent": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"state": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"order": 0
},
"description": "Black Audi A3",
"metadata": {
"property1": "string",
"property2": "string"
},
"category": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "Industrial Machine",
"parentId": "XXX_184TBUKB00_4ZHN6E",
"enabledReportTypes": [
{
"id": 0,
"name": "string",
"description": "string",
"enabledInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"enabledInsightTypeIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
]
}
],
"useParentEnabledReportTypes": true
},
"tags": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string"
}
]
}Get Assets
Get vehicle asset.
Application Right: AssetRead
Query String
querystringoptional
Registration or Serial Number search query
takeint32optional
How many results to return. Default: 25. Max: 200
skipint32optional
How many results to skip. Default: 0
stateIdsstringoptional
Filter by an assets state. Comma delimited allowed
expandarray[string]optional
Expand nested properties
Possible Values
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/assets?query=SOME_STRING_VALUE&take=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&stateIds=SOME_STRING_VALUE&expand=SOME_ARRAY_VALUE'Response Object: (HTTP Code: 200)
{
"totalCount": 0,
"results": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
},
"parent": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"state": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"order": 0
},
"description": "Black Audi A3",
"metadata": {
"property1": "string",
"property2": "string"
},
"category": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "Industrial Machine",
"parentId": "XXX_184TBUKB00_4ZHN6E",
"enabledReportTypes": [
{
"id": 0,
"name": "string",
"description": "string",
"enabledInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"enabledInsightTypeIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
]
}
],
"useParentEnabledReportTypes": true
},
"tags": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string"
}
]
}
]
}Detach Asset
Request
curl --request DELETE \
--url https://api.open-assets.co.uk/assets/{id}/children/{childId}Get Asset
Get asset.
Application Right: AssetRead
Query String
expandarray[string]optional
Specify which properties should be included in the response.
Possible Values
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/assets/{id}?expand=SOME_ARRAY_VALUE'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
},
"parent": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"state": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"order": 0
},
"description": "Black Audi A3",
"metadata": {
"property1": "string",
"property2": "string"
},
"category": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "Industrial Machine",
"parentId": "XXX_184TBUKB00_4ZHN6E",
"enabledReportTypes": [
{
"id": 0,
"name": "string",
"description": "string",
"enabledInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"enabledInsightTypeIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
]
}
],
"useParentEnabledReportTypes": true
},
"tags": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string"
}
]
}Update Asset
Create or update a companies version of an asset with the option to register interest.
Application Right: AssetWrite
Request Object
parentIdstringoptional
stateIdstringoptional
descriptionstringoptional
As description of the asset
categoryIdstringoptional
activebooleanoptional
Whether the asset is active in the companies asset portfolio.
metadataobjectoptional
A dictionary of custom metadata associated with this asset
tagsstringoptional
An array of tag Ids associated with this asset
Query String
expandarray[string]optional
Expand nested properties
Possible Values
Request Object
{
"parentId": "XXX_184TBUKB00_4ZHN6E",
"stateId": "XXX_184TBUKB00_4ZHN6E",
"description": "John Deere 6150R Tractor",
"categoryId": "XXX_184TBUKB00_4ZHN6E",
"active": true,
"metadata": {
"property1": "string",
"property2": "string"
},
"tags": [
"XXX_184TBUKB00_4ZHN6E"
]
}Request
curl --request PUT \
--url 'https://api.open-assets.co.uk/assets/{id}?expand=SOME_ARRAY_VALUE' \
--header 'content-type: application/json' \
--data '{"parentId":"XXX_184TBUKB00_4ZHN6E","stateId":"XXX_184TBUKB00_4ZHN6E","description":"John Deere 6150R Tractor","categoryId":"XXX_184TBUKB00_4ZHN6E","active":true,"metadata":{"property1":"string","property2":"string"},"tags":["XXX_184TBUKB00_4ZHN6E"]}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
},
"parent": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"state": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"order": 0
},
"description": "Black Audi A3",
"metadata": {
"property1": "string",
"property2": "string"
},
"category": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "Industrial Machine",
"parentId": "XXX_184TBUKB00_4ZHN6E",
"enabledReportTypes": [
{
"id": 0,
"name": "string",
"description": "string",
"enabledInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"enabledInsightTypeIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
]
}
],
"useParentEnabledReportTypes": true
},
"tags": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string"
}
]
}Update Asset Status Property
Update a the state of an asset.
Application Right: AssetWrite
Request Object
statusIdstringrequired
Query String
expandarray[string]optional
Expand nested properties
Possible Values
Request Object
{
"statusId": "XXX_184TBUKB00_4ZHN6E"
}Request
curl --request PUT \
--url 'https://api.open-assets.co.uk/assets/{id}/status?expand=SOME_ARRAY_VALUE' \
--header 'content-type: application/json' \
--data '{"statusId":"XXX_184TBUKB00_4ZHN6E"}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
},
"parent": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"state": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"order": 0
},
"description": "Black Audi A3",
"metadata": {
"property1": "string",
"property2": "string"
},
"category": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "Industrial Machine",
"parentId": "XXX_184TBUKB00_4ZHN6E",
"enabledReportTypes": [
{
"id": 0,
"name": "string",
"description": "string",
"enabledInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"enabledInsightTypeIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
]
}
],
"useParentEnabledReportTypes": true
},
"tags": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string"
}
]
}Asset Audit Log
All actions carried out on an asset are logged. The actions range from creation and updates to registration and release of interest. Asset audit logs detail these actions. are the
Asset Audit Log Endpoints
GET/assets/{id}/audit-logs
Get Asset Audit Logs
Get and assets audit logs.
Application Right: AssetWrite
Query String
takeint32optional
How many results to return. Default: 10. Max: 200
skipint32optional
How many results to skip. Default: 0
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/assets/{id}/audit-logs?take=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE'Response Object: (HTTP Code: 200)
{
"totalCount": 0,
"results": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"action": "string",
"timestampUtc": "2019-08-24T14:15:22Z",
"user": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
}
]
}Asset Category
Asset Categories are an integral part of reporting and grouping assets together. There are several predefined categories that are supplied by Open Assets. Custom sub categories can be added to the system, visible only to you and your company. See Managing categories for more information on creating sub categories.
Asset Category Endpoints
POST/asset-categories
GET/asset-categories
DELETE/asset-categories/{id}
PUT/asset-categories/{id}
Create Asset Category
Create an asset category.
Application Right: CompanyUpdate
Request Object
namestringrequired
name of the category
parentIdstringoptional
enabledReportTypesobjectoptional
The asset reports that can be run by assets with this category. If null the parent
idint32required
The asset reports that can be run by assets with this category. If null the parent
enabledInsightTypeIdsstringoptional
useParentEnabledReportTypesbooleanrequired
If true, this category will use the report insightTypeKind settings from it's parent. The request
must have a valid ParentId to use this setting
Request Object
{
"name": "string",
"parentId": "XXX_184TBUKB00_4ZHN6E",
"enabledReportTypes": [
{
"id": 0,
"enabledInsightTypeIds": [
"XXX_184TBUKB00_4ZHN6E"
]
}
],
"useParentEnabledReportTypes": true
}Request
curl --request POST \
--url https://api.open-assets.co.uk/asset-categories \
--header 'content-type: application/json' \
--data '{"name":"string","parentId":"XXX_184TBUKB00_4ZHN6E","enabledReportTypes":[{"id":0,"enabledInsightTypeIds":["XXX_184TBUKB00_4ZHN6E"]}],"useParentEnabledReportTypes":true}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "Industrial Machine",
"parentId": "XXX_184TBUKB00_4ZHN6E",
"enabledReportTypes": [
{
"id": 0,
"name": "string",
"description": "string",
"enabledInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"enabledInsightTypeIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
]
}
],
"useParentEnabledReportTypes": true
}Get Asset Categories
Request
curl --request GET \
--url https://api.open-assets.co.uk/asset-categoriesResponse Object: (HTTP Code: 200)
[
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "Industrial Machine",
"parentId": "XXX_184TBUKB00_4ZHN6E",
"enabledReportTypes": [
{
"id": 0,
"name": "string",
"description": "string",
"enabledInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"enabledInsightTypeIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
]
}
],
"useParentEnabledReportTypes": true
}
]Delete Asset Category
Request
curl --request DELETE \
--url https://api.open-assets.co.uk/asset-categories/{id}Update Asset Category
Update an asset category.
Application Right: CompanyUpdate
Request Object
namestringrequired
name of the category
parentIdstringoptional
enabledReportTypesobjectoptional
The asset reports that can be run by assets with this category. If null the parent
idint32required
The asset reports that can be run by assets with this category. If null the parent
enabledInsightTypeIdsstringoptional
useParentEnabledReportTypesbooleanrequired
If true, this category will use the report insightTypeKind settings from it's parent. The request
must have a valid ParentId to use this setting
Request Object
{
"name": "string",
"parentId": "XXX_184TBUKB00_4ZHN6E",
"enabledReportTypes": [
{
"id": 0,
"enabledInsightTypeIds": [
"XXX_184TBUKB00_4ZHN6E"
]
}
],
"useParentEnabledReportTypes": true
}Request
curl --request PUT \
--url https://api.open-assets.co.uk/asset-categories/{id} \
--header 'content-type: application/json' \
--data '{"name":"string","parentId":"XXX_184TBUKB00_4ZHN6E","enabledReportTypes":[{"id":0,"enabledInsightTypeIds":["XXX_184TBUKB00_4ZHN6E"]}],"useParentEnabledReportTypes":true}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "Industrial Machine",
"parentId": "XXX_184TBUKB00_4ZHN6E",
"enabledReportTypes": [
{
"id": 0,
"name": "string",
"description": "string",
"enabledInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"enabledInsightTypeIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
]
}
],
"useParentEnabledReportTypes": true
}Asset Identity
The Asset Identity contains all the information required to uniquely identify an asset.
Whilst multiple companies can have their own version of an asset, the identity ensures
they are aligned by a common Open Asset ID (property name: id).
The Asset Identity is the foundation that all Open Assets features are built on. It provides users and third party partners the confidence that they are all acting on the same asset, without giving away company specific information that may be private.
Asset Identity Endpoints
GET/asset-identity/{id}/status
GET/asset-identity/{id}
POST/asset-identity/{id}
Get Asset Identity Status
Request
curl --request GET \
--url https://api.open-assets.co.uk/asset-identity/{id}/statusResponse Object: (HTTP Code: 200)
{
"identity": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"identifiable": true,
"editable": true
}Get Asset Identity
Request
curl --request GET \
--url https://api.open-assets.co.uk/asset-identity/{id}Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}Update Asset Identity
Update an assets identity via it's 3 part identifiers.
Application Right: AssetRead
Request Object
primaryIdentifierstringoptional
The primary identifier associated with the asset as specified by the manufacturer or governing association for the asset insightTypeKind.
For example, this could be the serial number or VIN of the asset. See Attribute Guidelines for more details.
*Required to be an identifiable asset
attribute1stringoptional
The main attribute that aids in the recognition of the asset.
Often this is the commonly used full brand name of the manufacturer or creator of the asset. See Attribute Guidelines for more details.
*Required to be an identifiable asset
attribute2stringoptional
A second attribute of the asset to aid the in the recognition of the asset.
Often this is the model name of the asset. See Attribute Guidelines for more details.
*Optional for an identifiable asset The asset model name
Request Object
{
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}Request
curl --request POST \
--url https://api.open-assets.co.uk/asset-identity/{id} \
--header 'content-type: application/json' \
--data '{"primaryIdentifier":"700251","attribute1":"Boeing","attribute2":"787"}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}Asset Identity Search
Asset Identity Search Endpoints
POST/asset-identity-search
GET/asset-identity-search/{id}
Create Asset Identity Search
Start a search for assets identities by their Primary Identifier. This endpoint uses external
resources and in extreme cases it may take a long time to complete. In these rare cases the
endpoint will timeout after approximately 30s where a 202 Accepted response will be the response.
The Id in the response can be to poll the Get Asset Identity Search until a 200 OK response is returned.
Application Right: AssetRead
Request Object
primaryIdentifierTypestringrequired
Possible Values
primaryIdentifierSearchTermstringrequired
The primary identity to use in the search
Request Object
{
"primaryIdentifierType": "SerialNumber",
"primaryIdentifierSearchTerm": "string"
}Request
curl --request POST \
--url https://api.open-assets.co.uk/asset-identity-search \
--header 'content-type: application/json' \
--data '{"primaryIdentifierType":"SerialNumber","primaryIdentifierSearchTerm":"string"}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"searchTerm": "string",
"results": [
{
"identity": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"details": "string"
}
],
"errorType": "string",
"errorMessage": "string"
}Response Object: (HTTP Code: 202)
{
"id": "XXX_184TBUKB00_4ZHN6E"
}Get Asset Identity Search
Request
curl --request GET \
--url https://api.open-assets.co.uk/asset-identity-search/{id}Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"searchTerm": "string",
"results": [
{
"identity": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"details": "string"
}
],
"errorType": "string",
"errorMessage": "string"
}Response Object: (HTTP Code: 202)
{
"id": "XXX_184TBUKB00_4ZHN6E"
}Asset Identity Validation
Asset Identity Validation Endpoints
POST/asset-identity/{id}/validation/evidence
GET/asset-identity/{id}/validation
Create Asset Identity Validation Evidence
Get an assets identity by id.
Application Right: AssetRead
Request Object
typestringrequired
Possible Values
sourcestringoptional
Request Object
{
"type": "Other",
"source": "string"
}Request
curl --request POST \
--url https://api.open-assets.co.uk/asset-identity/{id}/validation/evidence \
--header 'content-type: application/json' \
--data '{"type":"Other","source":"string"}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"type": "string",
"source": "string",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"gatheredBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
}Get Asset Identity Validation
Request
curl --request GET \
--url https://api.open-assets.co.uk/asset-identity/{id}/validationResponse Object: (HTTP Code: 200)
{
"evidenceExists": true,
"evidence": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"type": "string",
"source": "string",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"gatheredBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
}
]
}Asset Insights
Asset Insights Endpoints
POST/assets/{id}/insights
GET/insights/{id}
GET/insights
GET/assets/{id}/insights/summery
GET/insight-types
GET/asset-reports/{assetReportId}/insights
Create Asset Insights
Create an asset insight.
Application Right: AssetWrite
Request Object
insightTypeIdstringrequired
insightValueobjectoptional
Request Object
{
"insightTypeId": "XXX_184TBUKB00_4ZHN6E",
"insightValue": {
"agreementActive": true,
"agreementTypeId": 0,
"agreementControllerReference": "string",
"agreementReference": "string",
"agreementTerm": 0,
"agreementStartDate": "2019-08-24T14:15:22Z"
}
}Request
curl --request POST \
--url https://api.open-assets.co.uk/assets/{id}/insights \
--header 'content-type: application/json' \
--data '{"insightTypeId":"XXX_184TBUKB00_4ZHN6E","insightValue":{"agreementActive":true,"agreementTypeId":0,"agreementControllerReference":"string","agreementReference":"string","agreementTerm":0,"agreementStartDate":"2019-08-24T14:15:22Z"}}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"value": {
"agreementActive": true,
"agreementControllerReference": "string",
"agreementReference": "string",
"agreementTerm": 0,
"agreementStartDate": "2019-08-24",
"agreementType": {
"id": 0,
"name": "string"
},
"agreementController": {
"reference": "string",
"name": "string",
"companyRegistrationNumber": "string",
"address": "string",
"postcode": "string"
}
},
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"insightType": {
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
},
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"report": {
"id": "XXX_184TBUKB00_4ZHN6E",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"runTimestampUtc": "2019-08-24T14:15:22Z",
"reportType": {
"id": 0,
"name": "string",
"description": "string",
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"reportTypeProvider": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"description": "string",
"logoUrl": "string"
}
},
"state": "Processing",
"errorType": "None",
"errorMessages": [
"string"
],
"input": {
"vrm": "string"
},
"unavailableInsightIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"insights": [
{}
],
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
},
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"generatedActions": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
},
"generatedActions": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
}Get Asset Insight
Get asset insights.
Application Right: AssetWrite
Query String
expandarray[string]optional
Specify which properties should be included in the response.
Possible Values
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/insights/{id}?expand=SOME_ARRAY_VALUE'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"value": {
"agreementActive": true,
"agreementControllerReference": "string",
"agreementReference": "string",
"agreementTerm": 0,
"agreementStartDate": "2019-08-24",
"agreementType": {
"id": 0,
"name": "string"
},
"agreementController": {
"reference": "string",
"name": "string",
"companyRegistrationNumber": "string",
"address": "string",
"postcode": "string"
}
},
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"insightType": {
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
},
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"report": {
"id": "XXX_184TBUKB00_4ZHN6E",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"runTimestampUtc": "2019-08-24T14:15:22Z",
"reportType": {
"id": 0,
"name": "string",
"description": "string",
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"reportTypeProvider": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"description": "string",
"logoUrl": "string"
}
},
"state": "Processing",
"errorType": "None",
"errorMessages": [
"string"
],
"input": {
"vrm": "string"
},
"unavailableInsightIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"insights": [
{}
],
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
},
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"generatedActions": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
},
"generatedActions": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
}Get Asset Insights
Get asset insights.
Application Right: AssetWrite
Query String
openAssetIdstringoptional
Filter by an asset
querystringoptional
Filter by an asset
stateIdsstringoptional
Filter by an assets state. Comma delimited allowed
insightTypeIdsstringoptional
Filter by insight types. Comma delimited Id's are allowed
mostRecentOnlybooleanoptional
Only include the most recent insight for each asset
takeint32optional
How many results to return. Default: 25. Max: 200
skipint32optional
How many results to skip. Default: 0
expandarray[string]optional
Specify which properties should be included in the response.
Possible Values
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/insights?openAssetId=SOME_STRING_VALUE&query=SOME_STRING_VALUE&stateIds=SOME_STRING_VALUE&insightTypeIds=SOME_STRING_VALUE&mostRecentOnly=SOME_BOOLEAN_VALUE&take=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&expand=SOME_ARRAY_VALUE'Response Object: (HTTP Code: 200)
{
"totalCount": 0,
"results": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"value": {
"agreementActive": true,
"agreementControllerReference": "string",
"agreementReference": "string",
"agreementTerm": 0,
"agreementStartDate": "2019-08-24",
"agreementType": {
"id": 0,
"name": "string"
},
"agreementController": {
"reference": "string",
"name": "string",
"companyRegistrationNumber": "string",
"address": "string",
"postcode": "string"
}
},
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"insightType": {
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
},
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"report": {
"id": "XXX_184TBUKB00_4ZHN6E",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"runTimestampUtc": "2019-08-24T14:15:22Z",
"reportType": {
"id": 0,
"name": "string",
"description": "string",
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"reportTypeProvider": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"description": "string",
"logoUrl": "string"
}
},
"state": "Processing",
"errorType": "None",
"errorMessages": [
"string"
],
"input": {
"vrm": "string"
},
"unavailableInsightIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"insights": [
{}
],
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
},
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"generatedActions": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
},
"generatedActions": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
}
]
}Get Asset Insight Summery
Get the most recent insights for an asset.
Application Right: AssetWrite
Query String
expandarray[string]optional
Specify which properties should be included in the response.
Possible Values
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/assets/{id}/insights/summery?expand=SOME_ARRAY_VALUE'Response Object: (HTTP Code: 200)
{
"insights": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"value": {
"agreementActive": true,
"agreementControllerReference": "string",
"agreementReference": "string",
"agreementTerm": 0,
"agreementStartDate": "2019-08-24",
"agreementType": {
"id": 0,
"name": "string"
},
"agreementController": {
"reference": "string",
"name": "string",
"companyRegistrationNumber": "string",
"address": "string",
"postcode": "string"
}
},
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"insightType": {
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
},
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"report": {
"id": "XXX_184TBUKB00_4ZHN6E",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"runTimestampUtc": "2019-08-24T14:15:22Z",
"reportType": {
"id": 0,
"name": "string",
"description": "string",
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"reportTypeProvider": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"description": "string",
"logoUrl": "string"
}
},
"state": "Processing",
"errorType": "None",
"errorMessages": [
"string"
],
"input": {
"vrm": "string"
},
"unavailableInsightIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"insights": [
{}
],
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
},
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"generatedActions": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
},
"generatedActions": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
}
]
}Get Asset Insight Types
Request
curl --request GET \
--url https://api.open-assets.co.uk/insight-typesResponse Object: (HTTP Code: 200)
[
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
]Get Asset Report Insights
Get asset insights from a report.
Application Right: AssetWrite
Query String
takeint32optional
How many results to return. Default: 25. Max: 200
skipint32optional
How many results to skip. Default: 0
expandarray[string]optional
Specify which properties should be included in the response.
Possible Values
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/asset-reports/{assetReportId}/insights?take=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&expand=SOME_ARRAY_VALUE'Response Object: (HTTP Code: 200)
{
"totalCount": 0,
"results": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"value": {
"agreementActive": true,
"agreementControllerReference": "string",
"agreementReference": "string",
"agreementTerm": 0,
"agreementStartDate": "2019-08-24",
"agreementType": {
"id": 0,
"name": "string"
},
"agreementController": {
"reference": "string",
"name": "string",
"companyRegistrationNumber": "string",
"address": "string",
"postcode": "string"
}
},
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"insightType": {
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
},
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"report": {
"id": "XXX_184TBUKB00_4ZHN6E",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"runTimestampUtc": "2019-08-24T14:15:22Z",
"reportType": {
"id": 0,
"name": "string",
"description": "string",
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"reportTypeProvider": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"description": "string",
"logoUrl": "string"
}
},
"state": "Processing",
"errorType": "None",
"errorMessages": [
"string"
],
"input": {
"vrm": "string"
},
"unavailableInsightIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"insights": [
{}
],
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
},
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"generatedActions": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
},
"generatedActions": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
}
]
}Asset Report Configuration
Asset Report Configuration Endpoints
GET/asset-report-type-configurations
PUT/asset-report-type-configurations
Get Asset Report Type Configurations
Request
curl --request GET \
--url https://api.open-assets.co.uk/asset-report-type-configurationsResponse Object: (HTTP Code: 200)
[
{
"assetReportTypeId": 0,
"enabled": true,
"reportType": {
"id": 0,
"name": "string",
"description": "string",
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"reportTypeProvider": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"description": "string",
"logoUrl": "string"
}
}
}
]Update Asset Report Configuration
Create or update an asset report type configuration.
Application Right: AssetWrite
Request Object
assetReportTypeIdint32required
enabledbooleanrequired
Request Object
{
"assetReportTypeId": 0,
"enabled": true
}Request
curl --request PUT \
--url https://api.open-assets.co.uk/asset-report-type-configurations \
--header 'content-type: application/json' \
--data '{"assetReportTypeId":0,"enabled":true}'Response Object: (HTTP Code: 200)
{
"assetReportTypeId": 0,
"enabled": true,
"reportType": {
"id": 0,
"name": "string",
"description": "string",
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"reportTypeProvider": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"description": "string",
"logoUrl": "string"
}
}
}Asset Reports
Asset Reports Endpoints
POST/assets/{id}/asset-reports
GET/asset-reports/{assetReportId}
GET/asset-reports/{assetReportId}/raw
GET/asset/{id}/asset-reports
GET/assets/{id}/asset-report-types
GET/assets/{id}/asset-report-types/{assetReportTypeId}/input-suggestion
POST/asset-report-types/{assetReportTypeId}/input-validation
GET/asset-report-types/{id}
GET/asset-report-types
Create Asset Report
Run an asset report to generate insights.
Application Right: AssetWrite
Request Object
reportTypeIdint32required
inputobjectoptional
Headers
idempotency-keystringoptional
Request Object
{
"reportTypeId": 0,
"input": {
"vrm": "string"
}
}Request
curl --request POST \
--url https://api.open-assets.co.uk/assets/{id}/asset-reports \
--header 'content-type: application/json' \
--header 'idempotency-key: SOME_STRING_VALUE' \
--data '{"reportTypeId":0,"input":{"vrm":"string"}}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"runTimestampUtc": "2019-08-24T14:15:22Z",
"reportType": {
"id": 0,
"name": "string",
"description": "string",
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"reportTypeProvider": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"description": "string",
"logoUrl": "string"
}
},
"state": "Processing",
"errorType": "None",
"errorMessages": [
"string"
],
"input": {
"vrm": "string"
},
"unavailableInsightIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"insights": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"value": {
"agreementActive": true,
"agreementControllerReference": "string",
"agreementReference": "string",
"agreementTerm": 0,
"agreementStartDate": "2019-08-24",
"agreementType": {
"id": 0,
"name": "string"
},
"agreementController": {
"reference": "string",
"name": "string",
"companyRegistrationNumber": "string",
"address": "string",
"postcode": "string"
}
},
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"insightType": {
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
},
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"report": {},
"generatedActions": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
}
],
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
},
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"generatedActions": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
}Response Object: (HTTP Code: 202)
{
"id": "XXX_184TBUKB00_4ZHN6E"
}Get Asset Report
Get an asset report.
Application Right: AssetWrite
Query String
expandarray[string]optional
Specify which properties should be included in the response.
Possible Values
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/asset-reports/{assetReportId}?expand=SOME_ARRAY_VALUE'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"runTimestampUtc": "2019-08-24T14:15:22Z",
"reportType": {
"id": 0,
"name": "string",
"description": "string",
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"reportTypeProvider": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"description": "string",
"logoUrl": "string"
}
},
"state": "Processing",
"errorType": "None",
"errorMessages": [
"string"
],
"input": {
"vrm": "string"
},
"unavailableInsightIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"insights": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"value": {
"agreementActive": true,
"agreementControllerReference": "string",
"agreementReference": "string",
"agreementTerm": 0,
"agreementStartDate": "2019-08-24",
"agreementType": {
"id": 0,
"name": "string"
},
"agreementController": {
"reference": "string",
"name": "string",
"companyRegistrationNumber": "string",
"address": "string",
"postcode": "string"
}
},
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"insightType": {
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
},
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"report": {},
"generatedActions": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
}
],
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
},
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"generatedActions": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
}Response Object: (HTTP Code: 202)
{
"id": "XXX_184TBUKB00_4ZHN6E"
}Get Asset Report Raw Response
Request
curl --request GET \
--url https://api.open-assets.co.uk/asset-reports/{assetReportId}/rawResponse Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"runTimestampUtc": "2019-08-24T14:15:22Z",
"reportType": {
"id": 0,
"name": "string",
"description": "string",
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"reportTypeProvider": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"description": "string",
"logoUrl": "string"
}
},
"response": {}
}Response Object: (HTTP Code: 202)
{
"id": "XXX_184TBUKB00_4ZHN6E"
}Get Asset Reports
Get asset insights.
Application Right: AssetWrite
Query String
takeint32optional
How many results to return. Default: 25. Max: 200
skipint32optional
How many results to skip. Default: 0
expandarray[string]optional
Specify which properties should be included in the response.
Possible Values
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/asset/{id}/asset-reports?take=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&expand=SOME_ARRAY_VALUE'Response Object: (HTTP Code: 200)
{
"totalCount": 0,
"results": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"runTimestampUtc": "2019-08-24T14:15:22Z",
"reportType": {
"id": 0,
"name": "string",
"description": "string",
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"reportTypeProvider": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"description": "string",
"logoUrl": "string"
}
},
"state": "Processing",
"errorType": "None",
"errorMessages": [
"string"
],
"input": {
"vrm": "string"
},
"unavailableInsightIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"insights": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"value": {
"agreementActive": true,
"agreementControllerReference": "string",
"agreementReference": "string",
"agreementTerm": 0,
"agreementStartDate": "2019-08-24",
"agreementType": {
"id": 0,
"name": "string"
},
"agreementController": {
"reference": "string",
"name": "string",
"companyRegistrationNumber": "string",
"address": "string",
"postcode": "string"
}
},
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"insightType": {
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
},
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"report": {},
"generatedActions": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
}
],
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
},
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"generatedActions": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"title": "string",
"description": "string",
"resolved": true,
"resolvedComment": "string",
"scheduledFor": "2019-08-24T14:15:22Z",
"createdTimestampUtc": "2019-08-24T14:15:22Z",
"updatedTimestampUtc": "2019-08-24T14:15:22Z",
"assignedTo": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
],
"asset": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
}
]
}
]
}Get Asset Category Report Types For Asset
Get the report types available to an asset based on the category it has been assigned
Application Right: AssetRead
Request
curl --request GET \
--url https://api.open-assets.co.uk/assets/{id}/asset-report-typesResponse Object: (HTTP Code: 200)
{
"category": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "Industrial Machine",
"parentId": "XXX_184TBUKB00_4ZHN6E",
"enabledReportTypes": [
{
"id": 0,
"name": "string",
"description": "string",
"enabledInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"enabledInsightTypeIds": [
"XXX_184TBUKB00_4ZHN6E"
],
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
]
}
],
"useParentEnabledReportTypes": true
},
"enabledReportTypes": [
{
"id": 0,
"name": "string",
"description": "string",
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"reportTypeProvider": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"description": "string",
"logoUrl": "string"
},
"enabledInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
]
}
]
}Get Asset Report Input Suggestion
Request
curl --request GET \
--url https://api.open-assets.co.uk/assets/{id}/asset-report-types/{assetReportTypeId}/input-suggestionResponse Object: (HTTP Code: 200)
{
"suggestion": {
"vrm": "string"
}
}Get Asset Report Input Validation
Validate the input values for an asset report.
Application Right: AssetWrite
Request Object
inputobjectoptional
Request Object
{
"input": {
"vrm": "string"
}
}Request
curl --request POST \
--url https://api.open-assets.co.uk/asset-report-types/{assetReportTypeId}/input-validation \
--header 'content-type: application/json' \
--data '{"input":{"vrm":"string"}}'Response Object: (HTTP Code: 200)
{
"isValid": true,
"validationErrors": [
{
"propertyName": "string",
"errorMessage": "string",
"attemptedValue": null
}
]
}Get Asset Report Type
Request
curl --request GET \
--url https://api.open-assets.co.uk/asset-report-types/{id}Response Object: (HTTP Code: 200)
{
"id": 0,
"name": "string",
"description": "string",
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"reportTypeProvider": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"description": "string",
"logoUrl": "string"
}
}Get Asset Report Types
Gets all asset report types as an array.
Application Right: AssetRead
Query String
includeDisabledbooleanoptional
Should include disabled reports in response. Default: false
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/asset-report-types?includeDisabled=SOME_BOOLEAN_VALUE'Response Object: (HTTP Code: 200)
[
{
"id": 0,
"name": "string",
"description": "string",
"availableInsightTypes": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"kind": "Manufacture",
"name": "string",
"displayName": "string",
"description": "string"
}
],
"reportTypeProvider": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"description": "string",
"logoUrl": "string"
}
}
]Asset Share Snapshot File
Asset share snapshot files are the mechanism to use to share and distribute an asset with others. Each snapshot includes a report detailing the state of the assets details and due diligence records at the point of te snapshot. All files associated with due diligence records are also included.
Asset Share Snapshot File Endpoints
POST/assets/{id}/share-snapshot-file
GET/assets/{id}/share-snapshot-file
DELETE/assets/{id}/share-snapshot-file/{assetShareSnapshotFileId}
Create Asset Share Snapshot File
Create an asset share snapshot file
Application Right: AssetShareSnapshotExport
Query String
snapshotTimestampdate-timeoptional
When to take the snapshot from
Request
curl --request POST \
--url 'https://api.open-assets.co.uk/assets/{id}/share-snapshot-file?snapshotTimestamp=SOME_STRING_VALUE'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"assetId": "XXX_184TBUKB00_4ZHN6E",
"fileUrl": "https://files.open-assets.co.uk/zip/OAI_184TBUKB06_4ZHN6E__2022-05-01__snapshot__ef7Y.zip",
"snapshotTimestampUtc": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
}Get Asset Share Snapshot Files
Get all asset share snapshot files for an asset
Application Right: AssetShareSnapshotExport
Query String
expandarray[string]optional
Expand nested properties
Possible Values
takeint32optional
How many results to return. Default: 25. Max: 200
skipint32optional
How many results to skip. Default: 0
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/assets/{id}/share-snapshot-file?expand=SOME_ARRAY_VALUE&take=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE'Response Object: (HTTP Code: 200)
[
{
"id": "XXX_184TBUKB00_4ZHN6E",
"assetId": "XXX_184TBUKB00_4ZHN6E",
"fileUrl": "https://files.open-assets.co.uk/zip/OAI_184TBUKB06_4ZHN6E__2022-05-01__snapshot__ef7Y.zip",
"snapshotTimestampUtc": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
}
]Asset State
Asset State Endpoints
POST/asset-states
GET/asset-states
PUT/asset-states/{id}
Create Asset State
Create an asset state.
Application Right: CompanyUpdate
Request Object
namestringoptional
orderint32required
Request Object
{
"name": "string",
"order": 0
}Request
curl --request POST \
--url https://api.open-assets.co.uk/asset-states \
--header 'content-type: application/json' \
--data '{"name":"string","order":0}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"order": 0
}Get Asset States
Request
curl --request GET \
--url https://api.open-assets.co.uk/asset-statesResponse Object: (HTTP Code: 200)
[
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"order": 0
}
]Update Asset State
Create an asset state.
Application Right: CompanyUpdate
Request Object
namestringoptional
orderint32required
Request Object
{
"name": "string",
"order": 0
}Request
curl --request PUT \
--url https://api.open-assets.co.uk/asset-states/{id} \
--header 'content-type: application/json' \
--data '{"name":"string","order":0}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"order": 0
}Auto Action Ruleset
An auto action ruleset can be used to automatically create actions. If an event matches the ruleset an action will be created for the associated asset to the event with the details assigned to the `GeneratedAction1 property
Auto Action Ruleset Endpoints
POST/auto-action-ruleset
GET/auto-action-ruleset
DELETE/auto-action-ruleset/{id}
PUT/auto-action-ruleset/{id}
Create Auto Action Ruleset
Create an auto action ruleset to automatically create actions.
Application Right: AssetViewActions
Request Object
namestringoptional
A user defined name
rulesetstringoptional
The predicate that determines if an event like an insight being generated should automatically create an insight.
enabledbooleanrequired
Is the ruleset enabled
actionTemplateobjectoptional
titlestringoptional
descriptionstringoptional
assignedToUserIdsstringoptional
Request Object
{
"name": "string",
"ruleset": "Insight.Exported eq true and Asset.StateId eq 'STA_18FV4YR20F_D522TA' and Asset.CategoryId eq 'CAT_184RKEZY0A_LCQKBN'",
"enabled": true,
"actionTemplate": {
"title": "string",
"description": "string",
"assignedToUserIds": [
"XXX_184TBUKB00_4ZHN6E"
]
}
}Request
curl --request POST \
--url https://api.open-assets.co.uk/auto-action-ruleset \
--header 'content-type: application/json' \
--data '{"name":"string","ruleset":"Insight.Exported eq true and Asset.StateId eq '\''STA_18FV4YR20F_D522TA'\'' and Asset.CategoryId eq '\''CAT_184RKEZY0A_LCQKBN'\''","enabled":true,"actionTemplate":{"title":"string","description":"string","assignedToUserIds":["XXX_184TBUKB00_4ZHN6E"]}}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"ruleset": "Insight.Exported eq true and Asset.StateId eq 'STA_18FV4YR20F_D522TA' and Asset.CategoryId eq 'CAT_184RKEZY0A_LCQKBN'",
"enabled": true,
"actionTemplate": {
"title": "string",
"description": "string",
"assignedToUserIds": [
"XXX_184TBUKB00_4ZHN6E"
]
},
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
}Get Auto Action Rulesets
Get all auto action rulesets.
Application Right: AssetViewActions
Request Object
namestringoptional
A user defined name
rulesetstringoptional
The predicate that determines if an event like an insight being generated should automatically create an insight.
enabledbooleanrequired
Is the ruleset enabled
actionTemplateobjectoptional
titlestringoptional
descriptionstringoptional
assignedToUserIdsstringoptional
Request Object
{
"name": "string",
"ruleset": "Insight.Exported eq true and Asset.StateId eq 'STA_18FV4YR20F_D522TA' and Asset.CategoryId eq 'CAT_184RKEZY0A_LCQKBN'",
"enabled": true,
"actionTemplate": {
"title": "string",
"description": "string",
"assignedToUserIds": [
"XXX_184TBUKB00_4ZHN6E"
]
}
}Request
curl --request GET \
--url https://api.open-assets.co.uk/auto-action-ruleset \
--header 'content-type: application/json' \
--data '{"name":"string","ruleset":"Insight.Exported eq true and Asset.StateId eq '\''STA_18FV4YR20F_D522TA'\'' and Asset.CategoryId eq '\''CAT_184RKEZY0A_LCQKBN'\''","enabled":true,"actionTemplate":{"title":"string","description":"string","assignedToUserIds":["XXX_184TBUKB00_4ZHN6E"]}}'Response Object: (HTTP Code: 200)
[
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"ruleset": "Insight.Exported eq true and Asset.StateId eq 'STA_18FV4YR20F_D522TA' and Asset.CategoryId eq 'CAT_184RKEZY0A_LCQKBN'",
"enabled": true,
"actionTemplate": {
"title": "string",
"description": "string",
"assignedToUserIds": [
"XXX_184TBUKB00_4ZHN6E"
]
},
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
}
]Delete Auto Action Ruleset
Request
curl --request DELETE \
--url https://api.open-assets.co.uk/auto-action-ruleset/{id}Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"ruleset": "Insight.Exported eq true and Asset.StateId eq 'STA_18FV4YR20F_D522TA' and Asset.CategoryId eq 'CAT_184RKEZY0A_LCQKBN'",
"enabled": true,
"actionTemplate": {
"title": "string",
"description": "string",
"assignedToUserIds": [
"XXX_184TBUKB00_4ZHN6E"
]
},
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
}Update Auto Action Ruleset
Update an auto action ruleset to enable or disable it.
Application Right: AssetViewActions
Request Object
namestringoptional
enabledbooleanrequired
actionTemplateobjectoptional
titlestringoptional
descriptionstringoptional
assignedToUserIdsstringoptional
Request Object
{
"name": "string",
"enabled": true,
"actionTemplate": {
"title": "string",
"description": "string",
"assignedToUserIds": [
"XXX_184TBUKB00_4ZHN6E"
]
}
}Request
curl --request PUT \
--url https://api.open-assets.co.uk/auto-action-ruleset/{id} \
--header 'content-type: application/json' \
--data '{"name":"string","enabled":true,"actionTemplate":{"title":"string","description":"string","assignedToUserIds":["XXX_184TBUKB00_4ZHN6E"]}}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"ruleset": "Insight.Exported eq true and Asset.StateId eq 'STA_18FV4YR20F_D522TA' and Asset.CategoryId eq 'CAT_184RKEZY0A_LCQKBN'",
"enabled": true,
"actionTemplate": {
"title": "string",
"description": "string",
"assignedToUserIds": [
"XXX_184TBUKB00_4ZHN6E"
]
},
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
}Company
A Company represents the top level account details. All users are part of a company and all assets created are assigned to the company of the user creating them. A company holds details and setting related to the company on the Open Assets platform.
Company Endpoints
GET/company
PUT/company
POST/company/user-invites
GET/company/user-invites
DELETE/company/user-invites/{email}
GET/company/users
PUT/company/users/{id}
PUT/company/credentials/hpi
PUT/company/credentials/hpi/validate
Get My Company
Get your company.
Request
curl --request GET \
--url https://api.open-assets.co.uk/companyResponse Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"hpiCredentialsCustomerCode": "string",
"hpiCredentialsInitials": "string",
"hpiCredentialsFailed": true,
"hpiFinancialInterestSearchType": "string",
"product": "string",
"productTier": "string"
}Update My Company
Update your company.
Application Right: CompanyUpdate
Request Object
namestringrequired
New company name to update to.
Request Object
{
"name": "Stark Industries Ltd"
}Request
curl --request PUT \
--url https://api.open-assets.co.uk/company \
--header 'content-type: application/json' \
--data '{"name":"Stark Industries Ltd"}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"hpiCredentialsCustomerCode": "string",
"hpiCredentialsInitials": "string",
"hpiCredentialsFailed": true,
"hpiFinancialInterestSearchType": "string",
"product": "string",
"productTier": "string"
}Create Company User Invite
Invite a user.
Application Right: AdminInviteUser
Request Object
firstNamestringrequired
First name of the user to invite
lastNamestringrequired
Last name of the user to invite
emailemailrequired
Email address of the user to invite
rolesstringrequired
The roles the user will have once the invite is accepted
Possible Values
Request Object
{
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"roles": [
"AccountAdmin"
]
}Request
curl --request POST \
--url https://api.open-assets.co.uk/company/user-invites \
--header 'content-type: application/json' \
--data '{"firstName":"string","lastName":"string","email":"user@example.com","roles":["AccountAdmin"]}'Response Object: (HTTP Code: 200)
{
"firstName": "string",
"lastName": "string",
"email": "string",
"companyId": "XXX_184TBUKB00_4ZHN6E",
"roles": [
"AccountAdmin"
]
}Get User Invites
Request
curl --request GET \
--url https://api.open-assets.co.uk/company/user-invitesResponse Object: (HTTP Code: 200)
[
{
"firstName": "string",
"lastName": "string",
"email": "string",
"companyId": "XXX_184TBUKB00_4ZHN6E",
"roles": [
"AccountAdmin"
]
}
]Delete User Invite
Request
curl --request DELETE \
--url https://api.open-assets.co.uk/company/user-invites/{email}Get My Company Users
Request
curl --request GET \
--url https://api.open-assets.co.uk/company/usersResponse Object: (HTTP Code: 200)
[
{
"id": "XXX_184TBUKB00_4ZHN6E",
"email": "string",
"firstName": "string",
"lastName": "string",
"companyId": "XXX_184TBUKB00_4ZHN6E",
"disabled": true,
"roles": [
"AccountAdmin"
],
"rights": [
"ApiKeyManage"
],
"features": [
"SamlProvider"
]
}
]Update Company User
Update your company.
Application Right: CompanyUpdate
Request Object
disableAccountbooleanoptional
A boolean representing if the account should be disabled or enables
firstNamestringrequired
New first name of the user
lastNamestringrequired
New last name of the user
rolesstringrequired
New role(s) the user should have. This will override any previous roles.
Possible Values
Request Object
{
"disableAccount": true,
"firstName": "string",
"lastName": "string",
"roles": [
"AccountAdmin"
]
}Request
curl --request PUT \
--url https://api.open-assets.co.uk/company/users/{id} \
--header 'content-type: application/json' \
--data '{"disableAccount":true,"firstName":"string","lastName":"string","roles":["AccountAdmin"]}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"email": "string",
"firstName": "string",
"lastName": "string",
"companyId": "XXX_184TBUKB00_4ZHN6E",
"disabled": true,
"roles": [
"AccountAdmin"
],
"rights": [
"ApiKeyManage"
],
"features": [
"SamlProvider"
]
}Update Hpi Credentials
Update company HPI credentials.
Application Right: CompanyUpdate
Request Object
customerCodestringrequired
The customer code for your account with HPI
passwordpasswordrequired
The password for your account with HPI
initialsstringrequired
The initials used when Open Assets uses you HPI account
Request Object
{
"customerCode": "string",
"password": "pa$word",
"initials": "string"
}Request
curl --request PUT \
--url https://api.open-assets.co.uk/company/credentials/hpi \
--header 'content-type: application/json' \
--data '{"customerCode":"string","password":"pa$word","initials":"string"}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"hpiCredentialsCustomerCode": "string",
"hpiCredentialsInitials": "string",
"hpiCredentialsFailed": true,
"hpiFinancialInterestSearchType": "string",
"product": "string",
"productTier": "string"
}Validate Hpi Credentials
Validate company HPI credentials.
Application Right: CompanyUpdate
Request Object
customerCodestringrequired
The customer code for your account with HPI
passwordpasswordrequired
The password for your account with HPI
initialsstringrequired
The initials used when Open Assets uses you HPI account
Request Object
{
"customerCode": "string",
"password": "pa$word",
"initials": "string"
}Request
curl --request PUT \
--url https://api.open-assets.co.uk/company/credentials/hpi/validate \
--header 'content-type: application/json' \
--data '{"customerCode":"string","password":"pa$word","initials":"string"}'Response Object: (HTTP Code: 200)
{
"isValid": true
}Controller
Controller Endpoints
GET/controller
PUT/controller/{reference}
Get Controllers
Get controllers
Application Right: CompanyUpdate
Query String
querystringoptional
reference or name of the controller
takeint32optional
How many results to return. Default: 25. Max: 200
skipint32optional
How many results to skip. Default: 0
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/controller?query=SOME_STRING_VALUE&take=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE'Response Object: (HTTP Code: 200)
{
"totalCount": 0,
"results": [
{
"reference": "string",
"name": "string",
"companyRegistrationNumber": "string",
"address": "string",
"postcode": "string"
}
]
}Update Controller
Create or update a controller using a custom reference
Application Right: CompanyUpdate
Request Object
namestringrequired
Name of controller
companyRegistrationNumberstringoptional
The companies registration number. As provided by Companies House
addressstringoptional
The address of the controller
postcodestringoptional
The postcode of the associated to the address
Request Object
{
"name": "Acme Inc",
"companyRegistrationNumber": "string",
"address": "string",
"postcode": "string"
}Request
curl --request PUT \
--url https://api.open-assets.co.uk/controller/{reference} \
--header 'content-type: application/json' \
--data '{"name":"Acme Inc","companyRegistrationNumber":"string","address":"string","postcode":"string"}'Response Object: (HTTP Code: 200)
{
"reference": "string",
"name": "string",
"companyRegistrationNumber": "string",
"address": "string",
"postcode": "string"
}Financial Interest Enquiry
A Financial Interest Enquiry is the first stage to locating an Asset Financial Interest Report. The enquiry returns all the assets that match the primary identifier provided on the call to create a Financial Interest Enquiry. Once created you you can see all the matched assets and select one to generate a report for. See Asset Financial Interest Reports for more information.
Financial Interest Enquiry Endpoints
GET/financial-interest-enquiries/{enquiryId}/report/{assetId}
POST/financial-interest-enquiries/{id}/complete
POST/financial-interest-enquiries
GET/financial-interest-enquiries
GET/financial-interest-enquiries/{id}
Get Asset Financial Interest Enquiry Report
Get an asset financial interest report from an enquiry
Application Right: AssetFinancialInterestEnquiry
Request
curl --request GET \
--url https://api.open-assets.co.uk/financial-interest-enquiries/{enquiryId}/report/{assetId}Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
},
"historicalRecords": [
{
"companyName": "Wayne Enterprises",
"agreementReference": "W098736",
"dateRegistered": "2019-08-24",
"dateReleased": "2019-08-24"
}
],
"outstandingInterest": {
"isActive": true,
"companyName": "Stark Industries",
"contactEmail": "tony@starkindustries.com",
"agreementReference": "IRON083673",
"parent": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"children": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
]
},
"createdTimestampUtc": "2019-08-24T14:15:22Z"
}Complete Financial Interest Enquiry
Request
curl --request POST \
--url https://api.open-assets.co.uk/financial-interest-enquiries/{id}/completeResponse Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"searchTerm": "700251",
"completed": true,
"selectedAssetReport": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
},
"historicalRecords": [
{
"companyName": "Wayne Enterprises",
"agreementReference": "W098736",
"dateRegistered": "2019-08-24",
"dateReleased": "2019-08-24"
}
],
"outstandingInterest": {
"isActive": true,
"companyName": "Stark Industries",
"contactEmail": "tony@starkindustries.com",
"agreementReference": "IRON083673",
"parent": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"children": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
]
},
"createdTimestampUtc": "2019-08-24T14:15:22Z"
},
"assets": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
],
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
},
"createdTimestampUtc": "2019-08-24T14:15:22Z"
}Create Financial Interest Enquiry
Create a financial interest enquiry based on a case insensitive search of the assets primary identifier.
Application Right: AssetFinancialInterestEnquiry
Request Object
querystringrequired
This primary identifier or Open Asset ID for the asset.
If a primary identifier is supplied it should represent either the serial number, the VIN or any other primary identifier for the asset. Querying via primary identifier may return multiple results. In order to get an asset financial interest report, a call to the GetAssetFinancialInterestReport is required with the user selected asset Id from the response.
If an Open Asset ID is supplied the response will only return 1 asset and the SelectedAssetReport will be populated.
Request Object
{
"query": "string"
}Request
curl --request POST \
--url https://api.open-assets.co.uk/financial-interest-enquiries \
--header 'content-type: application/json' \
--data '{"query":"string"}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"searchTerm": "700251",
"completed": true,
"selectedAssetReport": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
},
"historicalRecords": [
{
"companyName": "Wayne Enterprises",
"agreementReference": "W098736",
"dateRegistered": "2019-08-24",
"dateReleased": "2019-08-24"
}
],
"outstandingInterest": {
"isActive": true,
"companyName": "Stark Industries",
"contactEmail": "tony@starkindustries.com",
"agreementReference": "IRON083673",
"parent": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"children": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
]
},
"createdTimestampUtc": "2019-08-24T14:15:22Z"
},
"assets": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
],
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
},
"createdTimestampUtc": "2019-08-24T14:15:22Z"
}Get Financial Interest Enquiries
Search past financial interest enquiries
Application Right: AssetFinancialInterestEnquiry
Query String
querystringoptional
Filter by the primary identifier or Open Asset ID
takeint32optional
How many results to return. Default: 10. Max: 200
skipint32optional
How many results to skip. Default: 0
afterdate-timeoptional
Select results after this date
beforedate-timeoptional
Select results before this date
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/financial-interest-enquiries?query=SOME_STRING_VALUE&take=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE&after=SOME_STRING_VALUE&before=SOME_STRING_VALUE'Response Object: (HTTP Code: 200)
{
"totalCount": 0,
"results": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"searchTerm": "700251",
"completed": true,
"selectedAssetReport": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
},
"historicalRecords": [
{
"companyName": "Wayne Enterprises",
"agreementReference": "W098736",
"dateRegistered": "2019-08-24",
"dateReleased": "2019-08-24"
}
],
"outstandingInterest": {
"isActive": true,
"companyName": "Stark Industries",
"contactEmail": "tony@starkindustries.com",
"agreementReference": "IRON083673",
"parent": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"children": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
]
},
"createdTimestampUtc": "2019-08-24T14:15:22Z"
},
"assets": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
],
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
},
"createdTimestampUtc": "2019-08-24T14:15:22Z"
}
]
}Get Financial Interest Enquiry
Request
curl --request GET \
--url https://api.open-assets.co.uk/financial-interest-enquiries/{id}Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"searchTerm": "700251",
"completed": true,
"selectedAssetReport": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
},
"historicalRecords": [
{
"companyName": "Wayne Enterprises",
"agreementReference": "W098736",
"dateRegistered": "2019-08-24",
"dateReleased": "2019-08-24"
}
],
"outstandingInterest": {
"isActive": true,
"companyName": "Stark Industries",
"contactEmail": "tony@starkindustries.com",
"agreementReference": "IRON083673",
"parent": {
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
},
"children": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
]
},
"createdTimestampUtc": "2019-08-24T14:15:22Z"
},
"assets": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"identifierAttributes": {
"primaryIdentifier": "700251",
"attribute1": "Boeing",
"attribute2": "787"
}
}
],
"createdBy": {
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
},
"createdTimestampUtc": "2019-08-24T14:15:22Z"
}Financial Interest Registration
Financial Interest Registration Endpoints
GET/financial-interest-registration/{id}
PUT/financial-interest-registration/{id}
POST/financial-interest-registration/{id}/release
Get Financial Interest Registration
Update your financial interest in an asset. If the registration does not exist it will be created.
Application Right: AssetWrite
Query String
expandarray[string]optional
Specify which properties should be included in the response.
Possible Values
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/financial-interest-registration/{id}?expand=SOME_ARRAY_VALUE'Response Object: (HTTP Code: 200)
{
"agreementTerm": 0,
"agreementStartDate": "2019-08-24",
"agreementReference": "string",
"status": "Active",
"releaseReason": "CreatedInError",
"agreementType": {
"id": 0,
"name": "string"
}
}Update Financial Interest Registration
Update your financial interest in an asset. If the registration does not exist it will be created.
Application Right: AssetWrite
Request Object
agreementTermint32optional
The agreement term in months
agreementStartDatedateoptional
The start date of the agreement
agreementReferencestringrequired
A custom reference given to the agreement
agreementTypeIdint32optional
The Id of the agreement insightTypeKind. See Agreement Types for more information
activebooleanrequired
Is the interest in this asset currently active
releaseReasonstringoptional
Possible Values
Query String
expandarray[string]optional
Specify which properties should be included in the response.
Possible Values
Request Object
{
"agreementTerm": 36,
"agreementStartDate": "2019-08-24",
"agreementReference": "GF278917",
"agreementTypeId": 3,
"active": true,
"releaseReason": "CreatedInError"
}Request
curl --request PUT \
--url 'https://api.open-assets.co.uk/financial-interest-registration/{id}?expand=SOME_ARRAY_VALUE' \
--header 'content-type: application/json' \
--data '{"agreementTerm":36,"agreementStartDate":"2019-08-24","agreementReference":"GF278917","agreementTypeId":3,"active":true,"releaseReason":"CreatedInError"}'Response Object: (HTTP Code: 200)
{
"agreementTerm": 0,
"agreementStartDate": "2019-08-24",
"agreementReference": "string",
"status": "Active",
"releaseReason": "CreatedInError",
"agreementType": {
"id": 0,
"name": "string"
}
}Release Financial Interest
Release interest in asset.
Application Right: AssetWrite
Request Object
reasonstringrequired
Possible Values
releaseInterestInAllChildrenbooleanrequired
If true, all financial interest registrations in children will be release as well
Request Object
{
"reason": "CreatedInError",
"releaseInterestInAllChildren": true
}Request
curl --request POST \
--url https://api.open-assets.co.uk/financial-interest-registration/{id}/release \
--header 'content-type: application/json' \
--data '{"reason":"CreatedInError","releaseInterestInAllChildren":true}'Response Object: (HTTP Code: 200)
{
"agreementTerm": 0,
"agreementStartDate": "2019-08-24",
"agreementReference": "string",
"status": "Active",
"releaseReason": "CreatedInError",
"agreementType": {
"id": 0,
"name": "string"
}
}Hpi Asset Category
HPI Asset Categories are the categories available when registering interest in an asset via HPI.
Hpi Asset Category Endpoints
GET/hpi-asset-categories
Saml Id Provider
Saml Id Provider Endpoints
GET/saml/id-provider
POST/saml/id-provider
Get Saml Id Provider
Get the SAML IdP for the company
Returns
Returns a SAML IdP
Request
curl --request GET \
--url https://api.open-assets.co.uk/saml/id-providerResponse Object: (HTTP Code: 200)
{
"entityId": "string",
"assertionConsumerServiceUrl": "string",
"issuer": "string",
"singleSignOnUrl": "string",
"certificateBase64": "string",
"testUrl": "string",
"successfulTestCompleted": true
}Update Saml Id Provider
This endpoint is used to update the SAML IdP
Request Object
issuerstringrequired
The name of the issuer sending the SAMLResponse
singleSignOnUrlstringrequired
The URL to redirect to for Single Sign-On (SSO)
certificateBase64stringrequired
The Base64 representation of the signature certificate
Returns
Returns a SAML IdP
Request Object
{
"issuer": "string",
"singleSignOnUrl": "string",
"certificateBase64": "string"
}Request
curl --request POST \
--url https://api.open-assets.co.uk/saml/id-provider \
--header 'content-type: application/json' \
--data '{"issuer":"string","singleSignOnUrl":"string","certificateBase64":"string"}'Response Object: (HTTP Code: 200)
{
"entityId": "string",
"assertionConsumerServiceUrl": "string",
"issuer": "string",
"singleSignOnUrl": "string",
"certificateBase64": "string",
"testUrl": "string",
"successfulTestCompleted": true
}Session
Sessions refer to a period in time at which the API can be used. For instance a session is created when logging into the main app using a username and password. The session returns an access token that can be used to authorize requests.
If you are using the API directly it is strongly recommended that you use API keys. They are more secure and allow for more granular access. See API Keys from more information or Managing API Keys for information on how to create them in the app.
Session Endpoints
POST/account/session
DELETE/account/session
PUT/account/session
Create Session
This endpoint is used to create a new session. When you create a new session the access token id valid for 60 minutes
Request Object
rememberMebooleanrequired
If true, the access and refresh token cookies in the response will remain across browser sessions. If false, the cookies will expire when the browser is closed.
emailemailrequired
Account email address
passwordpasswordrequired
Account password
Headers
access-control-allow-originstringrequired
Returns
Returns a session with an access token, refresh token and the expiration for each.
Request Object
{
"rememberMe": true,
"email": "user@example.com",
"password": "pa$word"
}Request
curl --request POST \
--url https://api.open-assets.co.uk/account/session \
--header 'access-control-allow-origin: SOME_STRING_VALUE' \
--header 'content-type: application/json' \
--data '{"rememberMe":true,"email":"user@example.com","password":"pa$word"}'Response Object: (HTTP Code: 200)
{
"token": {
"expiration": "2019-08-24T14:15:22Z",
"accessToken": "string",
"refreshToken": "string",
"refreshTokenExpiration": "2019-08-24T14:15:22Z",
"refreshTokenExpiresWithSession": true
}
}Delete Session
Delete a session (Logout)
Returns
Removes all authentication cookies.
Request
curl --request DELETE \
--url https://api.open-assets.co.uk/account/sessionRefresh Session
Refresh a session. Refreshes the Id Token using a Refresh token.
Request Object
stringoptional
Headers
access-control-allow-originstringrequired
Request Object
"string"Request
curl --request PUT \
--url https://api.open-assets.co.uk/account/session \
--header 'access-control-allow-origin: SOME_STRING_VALUE' \
--header 'content-type: application/json' \
--data '"string"'Response Object: (HTTP Code: 200)
{
"token": {
"expiration": "2019-08-24T14:15:22Z",
"accessToken": "string",
"refreshToken": "string",
"refreshTokenExpiration": "2019-08-24T14:15:22Z",
"refreshTokenExpiresWithSession": true
}
}Session Details
Session Details Endpoints
GET/session-details
Get My Session Details
Get your company.
Request
curl --request GET \
--url https://api.open-assets.co.uk/session-detailsResponse Object: (HTTP Code: 200)
{
"company": {
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string",
"hpiCredentialsCustomerCode": "string",
"hpiCredentialsInitials": "string",
"hpiCredentialsFailed": true,
"hpiFinancialInterestSearchType": "string",
"product": "string",
"productTier": "string"
},
"user": {
"id": "XXX_184TBUKB00_4ZHN6E",
"email": "string",
"firstName": "string",
"lastName": "string",
"companyId": "XXX_184TBUKB00_4ZHN6E",
"disabled": true,
"roles": [
"AccountAdmin"
],
"rights": [
"ApiKeyManage"
],
"features": [
"SamlProvider"
]
}
}Session Provider
Session Provider Endpoints
GET/account/session/provider
Get Session Provider
This endpoint is used to check which login provider should be used
Query String
emailstringrequired
Email address to get te provider for
redirectUrlstringoptional
URL path to redirect to after login
Returns
Returns session provider details
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/account/session/provider?email=SOME_STRING_VALUE&redirectUrl=SOME_STRING_VALUE'Response Object: (HTTP Code: 200)
{
"providerType": "Password",
"email": "string",
"redirectUrl": "string"
}Tag
Tag Endpoints
POST/assets/{id}/tags
DELETE/assets/{id}/tags
POST/tags
GET/tags
DELETE/tags/{id}
PUT/tags/{id}
Attach Asset Tag
Request Object
{
"tagId": "XXX_184TBUKB00_4ZHN6E"
}Request
curl --request POST \
--url https://api.open-assets.co.uk/assets/{id}/tags \
--header 'content-type: application/json' \
--data '{"tagId":"XXX_184TBUKB00_4ZHN6E"}'Remove Asset Tag
Request Object
{
"tagId": "XXX_184TBUKB00_4ZHN6E"
}Request
curl --request DELETE \
--url https://api.open-assets.co.uk/assets/{id}/tags \
--header 'content-type: application/json' \
--data '{"tagId":"XXX_184TBUKB00_4ZHN6E"}'Create Tag
Create a tag
Application Right: CompanyUpdate
Request Object
namestringrequired
Name of the tag to create
Request Object
{
"name": "Priority:High"
}Request
curl --request POST \
--url https://api.open-assets.co.uk/tags \
--header 'content-type: application/json' \
--data '{"name":"Priority:High"}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string"
}Get Tags
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/tags?query=SOME_STRING_VALUE'Response Object: (HTTP Code: 200)
[
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string"
}
]Delete Tag
Delete a tag and remove it from all assets it is currently assigned to
Application Right: CompanyUpdate
Request
curl --request DELETE \
--url https://api.open-assets.co.uk/tags/{id}Update Tag
Update a tag
Application Right: CompanyUpdate
Request Object
namestringrequired
Name to update the tag to
Request Object
{
"name": "Priority:Low"
}Request
curl --request PUT \
--url https://api.open-assets.co.uk/tags/{id} \
--header 'content-type: application/json' \
--data '{"name":"Priority:Low"}'Response Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"name": "string"
}User
A User represents the details related to the account authorised to use the Open Assets system. This can be a user or Api Key.
User Endpoints
GET/users/me
Get User
Get your user.
Request
curl --request GET \
--url https://api.open-assets.co.uk/users/meResponse Object: (HTTP Code: 200)
{
"id": "XXX_184TBUKB00_4ZHN6E",
"email": "string",
"firstName": "string",
"lastName": "string",
"companyId": "XXX_184TBUKB00_4ZHN6E",
"disabled": true,
"roles": [
"AccountAdmin"
],
"rights": [
"ApiKeyManage"
],
"features": [
"SamlProvider"
]
}User Profile
User Profile Endpoints
GET/user-profiles
Get User Profiles
Get user profiles in your company.
Application Right: CompanyGetUsers
Query String
querystringoptional
First or last name or user id
takeint32optional
How many results to return. Default: 10. Max: 200
skipint32optional
How many results to skip. Default: 0
Request
curl --request GET \
--url 'https://api.open-assets.co.uk/user-profiles?query=SOME_STRING_VALUE&take=SOME_INTEGER_VALUE&skip=SOME_INTEGER_VALUE'Response Object: (HTTP Code: 200)
{
"totalCount": 0,
"results": [
{
"id": "XXX_184TBUKB00_4ZHN6E",
"firstName": "Pepé",
"lastName": "Le Pew"
}
]
}