Asset API Commands

The PrismUI API can send information about an asset and send it commands. The below commands use JSON elements to specify parameters and to send the response information. Each one is appended to the URL for the Runtime it is connecting to.

/ipfusion/Assets

This GET command retrieves a list of all available asset IDs within the project.

Responses

Code Description
200 The request succeeded and the asset list is returned.
404 Assets not found.

/ipfusion/Assets/{id}

This GET command retrieves the details and state for a given asset.

Parameters

Name Description
id The ID for the asset within the project.

Responses

Code Description
200 The request succeeded and the asset details are returned.
404 Asset does not exist.

/ipfusion/Assets/{id}/Events

This GET command retrieves the list of events available for a specified asset.

Parameters

Name Description
id The ID of the asset to get events for.

Responses

Code Description
200 The request succeeded and the event list is returned.
404 Asset does not exist.

/ipfusion/Assets/{id}/Command

This GET command retrieves the list of commands available for an asset.

Parameters

Name Description
id The ID of the asset within the project.

Responses

Code Description
200 The request succeeded and the command list is returned.
404 Asset does not exist.

/ipfusion/Assets/{id}/Command

This POST command executes a command against an asset.

Parameters

Name Description
id The ID of the asset within the project.

Responses

Code Description
200 The command has been received and is being processed. The status change may be seen on the SignalR Hub.
404 Asset does not exist.