Asset

The Asset object

What an asset represents varies upon your business needs. Typical examples include

machinery for rental,
facilities or property for maintenance,
vehicles for keeping track of service.

The common denominator is that an asset typically represents a "thing of value". They can have a state, location and contact person, and they can also be coupled to a customer and project.

Most importantly, jobs can be created "on an asset" (using the assetUuid property), enabling you to track job history on an asset, e.g. service history on a machine or facility. See the section on listing jobs by asset (GET /job/list/asset/:assetid).

Example

Get assets

Get all assets

Query Parameters

inactive	If supplied, inactive assets will be included
limit	Limit the number of returned objects	Integer
offset	Skip the first N objects	Integer
modified	Include only objects modified since this date/timestamp	Timestamp	2015-10-05

Example

GET /asset

Response

List of asset objects.

Method: GET
URL: /asset
Authentication: Token
Response: List of Asset

Search assets

Search assets. Please note that the search representation contains only a subset of the detail and list representations.

Query Parameters

q

Search query. Required. The default search behavior is an ElasticSearch query, each search term ORed, with some fields boosted.

A query that starts with the # character searches the assetNo field.
Example: #CGW446
A query that starts with the ! character is treated as a raw ElasticSearch DSL Query String query, which can be used to satisfy a lot of different search needs.
Example: !trailer AND vehicle:false
See the ElasticSearch documentation for more information.

Example

GET /asset/search?q=LTF+crane
Content-type: application/json

Method: GET
URL: /asset/search
Authentication: Token
Response: AssetSearchEntry object

Get an asset

Get a specific asset by ID or UUID

Example

GET /asset/2039077

Response

An asset object.

Method: GET
URL: /asset/:id
Authentication: Token
Response: Asset object

Create an asset

Create an asset. The asset will be assigned a server-generated ID and UUID.

Example

POST /asset

{
	"assetNo": "123",
	"name": "Giant meat grinder"
}

Response

The created asset object.

Method: POST
URL: /asset
Authentication: Token
Request: Asset object
Response: Asset object

Update or create an asset

Update an existing asset or create it (if it doesn't exist and :id is a UUID).

Example

PUT /asset/0847ed17-b060-4599-a38c-be9a8b9cbb34

{
	"assetNo": "123",
	"name": "Giant meat grinder"
}

Response

The updated asset object.

Method: PUT
URL: /asset/:id
Authentication: Token
Request: Asset object
Response: Asset object

Delete an asset

Delete an asset.

Example

DELETE /asset/0847ed17-b060-4599-a38c-be9a8b9cbb34

Method: DELETE
URL: /asset/:id
Authentication: Token
Response: Status code only

Link to an external document on an asset

To attach/link to an external document, accessible by a URL (i.e. a document uploaded to Dropbox or similar storage service), update the documents list of the asset.

Example

PUT /asset/123456
Content-type: application/json

{
	"documents": [
		{
			"contentUrl": "http://www.cbu.edu.zm/downloads/pdf-sample.pdf", 
			"mimeType": "application/pdf", 
			"fileName": "pdf-sample.pdf",
			"description": "Very important instructions"
		}
	]
}

The example above adds the URL as a "document" on the asset. The mimeType property ensures the correct icon is displayed (you can also use the thumbUrl property to specify your own).

Upload and attach a document to an asset

This operation is divided into two or (optionally) three requests:

Upload the document content (i.e. an image or PDF file),
(Optional) Update the document meta data (i.e. description),
Attach the document to the asset.

1. Upload the document content

The actual document content (the image, PDF file or whatever) is uploaded using a standard (multipart/form-data) file upload using file as the form parameter name.

POST /document/content
Content-type: multipart/form-data

Example using curl

curl -i 'https://app.coredination.net/api/1/document/content' \
	-H 'API-Key: {my-api-key}' \
	-F file=@myimage.jpg

HTTP/1.1 100 Continue

HTTP/1.1 200 OK
Content-Type: application/json
{
  "success": true,
  "document": {
    "uuid": "8acac590-cc94-45aa-a237-18a9d268f431",
    "thumbUrl": "/vault/thumbnail/8acac590-cc94-45aa-a237-18a9d268f431",
    "size": 7911,
    "mimeType": "image/jpeg",
    "lastModified": 1447890986622,
    "contentUrl": "/vault/document/8acac590-cc94-45aa-a237-18a9d268f431",
    "creationTimeStamp": 1447890986484,
    "creatorId": null,
    "description": null,
    "fileName": "myimage.jpg",
    "groupId": 17,
    "id": 26174165,
    "internal": false
  }
}

The response should contain the success flag set to true, indicating that the upload and backend storage was successful. It also contains the Document (meta data entity) itself, which you later need to refer to, so hang on to its UUID from here on.

Method: POST
URL: /document/content
Authentication: Token
Response: Upload DTO

2. (Optional) Update the document meta data

If you want to change any of the meta data (i.e. description, filename, the internal flag) of the document, you can update it using a PUT request:

Example

PUT /document/8acac590-cc94-45aa-a237-18a9d268f431
Content-type: application/json

{
	"description": "Top secret map of asset site",
	"internal": true
}

The response will contain the updated document (meta data).

Method: PUT
URL: /document/:did
Authentication: Token
Response: Document object

3. Attach the document to the asset

Attaching the document is a simple PUT request without content.

Example

PUT /asset/cbfc4b6f-ee81-4591-8e88-fd359cb2f967/document/8acac590-cc94-45aa-a237-18a9d268f431

The response has no content and should just return status code 200 (OK).

Method: PUT
URL: /asset/:id/document/:did
Authentication: Token
Response: Status code only

Detach a document from an asset

Detaching a document from an asset is a simple DELETE request without content.

Example

DELETE /asset/cbfc4b6f-ee81-4591-8e88-fd359cb2f967/document/8acac590-cc94-45aa-a237-18a9d268f431

The response has no content and should just return status code 200 (OK).

Method: DELETE
URL: /asset/:id/document/:did
Authentication: Token
Response: Status code only

The AssetType object

An asset type is essentially just an ID/UUID with the typical creator/group properties, plus a name and a template for creating assets of that type.

Example

Get asset types

Get all asset types

Example

GET /asset/type

Response

List of asset type objects.

Method: GET
URL: /asset/type
Authentication: Token
Response: List of AssetType

Get an asset type

Get a specific asset type by ID or UUID

Example

GET /asset/type/2039077

Response

An asset type object.

Method: GET
URL: /asset/type/:id
Authentication: Token
Response: AssetType object

Create an asset type

Create an asset type. The asset type will be assigned a server-generated ID and UUID.

Example

POST /asset/type

{
	"name": "Meat grinder",
	"assetTemplate": {
		// ...
	}
}

Response

The created asset type object.

Method: POST
URL: /asset/type
Authentication: Token
Request: AssetType object
Response: AssetType object

Update or create an asset type

Update an existing asset type or create it (if it doesn't exist and :id is a UUID).

Example

PUT /asset/type/0847ed17-b060-4599-a38c-be9a8b9cbb34

{
	"name": "Meat grinder",
	"assetTemplate": {
		// ...
	}
}

Response

The updated asset type object.

Method: PUT
URL: /asset/type/:id
Authentication: Token
Request: AssetType object
Response: AssetType object

Delete an asset type

Delete an asset type.

Example

DELETE /asset/type/0847ed17-b060-4599-a38c-be9a8b9cbb34

Method: DELETE
URL: /asset/type/:id
Authentication: Token
Response: Status code only

Asset

The Asset object

Example

States

Asset States

Get assets

Query Parameters

Example

Response

Search assets

Query Parameters

Example

Get an asset

Example

Response

Create an asset

Example

Response

Update or create an asset

Example

Response

Delete an asset

Example

Additional content

Link to an external document on an asset

Example

Upload and attach a document to an asset

1. Upload the document content

Example using curl

2. (Optional) Update the document meta data

Example

3. Attach the document to the asset

Example

Detach a document from an asset

Example

Asset types

The AssetType object

Example

Get asset types

Example

Response

Get an asset type

Example

Response

Create an asset type

Example

Response

Update or create an asset type

Example

Response

Delete an asset type

Example