Integrated System API Commands

The PrismUI API can receive information for a system 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.

/api/IntegratedSystems

This GET command retrieves a list of Integrated System IDs for each system in the project.

Responses

Code Response
200 The request succeeded and the ID list is returned.
404 No systems found.

/api/IntegratedSystems/{id}

This GET command retrieves the details and state of the provided Integrated System ID.

Parameters

Name Description
id The unique Integrated System ID from the project.

Responses

Code Description
200 The request succeeded and the system information is returned.
404 The system does not exist.

/api/IntegratedSystems/{id}/Assets

This GET command returns the list of asset IDs from the specified system.

Parameters

Name Description
id The ID of the Integrated System within the project.

Responses

Code Description
200 The request succeeded and the list of assets is returned.
404 The system does not exist.

/api/IntegratedSystems/{id}/Commands

This GET command retrieves the list of available commands for the specified Integrated System.

Parameters

Name Description
id The ID of the Integrated System within the project.

Responses

Code Description
200 The requested succeeded and the list of commands is returned.
404 The system does not exist.

/api/IntegratedSystems/{id}/Command

This POST command executes a command against a given Integrated System.

Parameters

Name Description
id The ID of the Integrated System within the project.
request Object containing details about the command request. For example: 

                                    {
                                        "commandName": "string",
                                        "commandParameters": [
                                            "string"
                                        ]
                                    }

Responses

Code Description
200 The command has been received and is processing. Status change may be seen on the SignalR Hub.
404 The system does not exist.

/api/IntegratedSystems/{id}/Events

This GET command retrieves a list of available events for a specified Integrated System.

Parameters

Name Description
id The ID of the Integrated System within the project.

Responses

200 The request succeeded and the command list is returned.
404 The system does not exist.