Get started
IoT Catalyst Studio APIs allow you to programmatically retrieve and modify the configuration of IoT Catalyst and provides access to historical data. It is widely used to:
- Create new applications to work with IoT Catalyst
- Integrate IoT Catalyst with third-party softwares
- Automate routine tasks
The IoT Catalyst API is a web based API and is shipped as part of the web frontend. It uses the JSON-RPC 2.0 protocol.
JSON-RPC 2.0 adoption means two things:
- The API consists of a set of separate methods
- Requests and responses between the clients and the API are encoded using the JSON format.
More info about the protocol and JSON can be found in the JSON-RPC 2.0 specification and the JSON format homepage.
API Structure
The API consists of a number of methods that are nominally grouped into separate APIs. Each of the methods performs one specific task.
For example, the Container.GetAll method belongs to the Container API and is used to get the list of all the IoT Catalyst Containers.
Invoking the APIs
Once you've set up the frontend, you can use remote HTTP requests to call the API. To do that you need to send HTTP POST requests to the API endpoint file located in the frontend directory. For example, if your IoT Catalyst Studio frontend is reachable at HTTPS://{IoTCatalystStudioEndpoint}, the HTTP request to call will look like this:
POST HTTPS://{IoTCatalystStudioEndpoint}/api/v2 HTTP/1.1
Content-Type: application/json-rpc
{"jsonrpc":"2.0","method":"apiinfo.version","id":1,"auth":null,"params":{}}
The request must have the Content-Type header set to one of these values: application/json-rpc, application/json or application/jsonrequest.
Security
Before you can access any data inside of IoT Catalyst you'll need to log in and obtain an authentication token. This can be done using the APISecurity.requestToken method.
Let us suppose that you want to log in as a standard IoT Catalyst Admin user. Then your JSON request will look like this: Let's take a closer look at the request object. It has the following properties: jsonrpc - the version of the JSON-RPC protocol used by the API; the IoT Catalyst API implements JSON-RPC version 2.0; method - the API method being called; params - parameters that will be passed to the API method; id - an arbitrary identifier of the request; auth - a user authentication token; since we don't have one yet, it's set to null.
HTTPS
POST /api/v2 HTTP/1.1
Host: {IoTCatalystStudioEndpoint}
Content-Type: application/json
cache-control: no-cache
{
"jsonrpc": "2.0",
"method": "APISecurity.requestToken",
"params": {
"userid": "admin",
"password": "***********"
},
"auth": "",
"id": "0"
}
JAVASCRIPT
var settings = {
"async": true,
"crossDomain": true,
"url": "HTTPS://{IoTCatalystStudioEndpoint}/api/v2",
"method": "POST",
"headers": {
"Content-Type": "application/json",
"cache-control": "no-cache"
},
"processData": false,
"data": "{\"jsonrpc\": \"2.0\", \"method\": \"APISecurity.requestToken\",
\"params\": { \"userid\": \"admin\", \"password\": \"**********\" },
\"auth\": \"\", \"id\": \"0\"}"
}
$.ajax(settings).done(function (response) {
console.log(response);
});
Response Format
if everything goes well, IoT Catalyst API response will be this (obviously the APIToken value will be different)
{
"success": true,
"message": "Token issued successfully",
"rows_affected": 0,
"data": {
"APIToken": "**************************************"
},
"id": "0",
"jsonrpc": "0.1"
}
Error Handling
Up to that point everything we've tried has worked fine. But what happens if we try to make an incorrect call to the API? Let's try to create another token by calling APISecurity.requestToken but omitting the mandatory userid parameter.
{
"success": false,
"message": "Missing required param [userid]",
"rows_affected": 0,
"data": [],
"id": "0",
"jsonrpc": "0.1"
}
apiinfo.version
Request the actual version of the IoT Catalyst API
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
apiinfo.getAPIMethods
Request the actual version of the IoT Catalyst API
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
APISecurity.requestToken
Request a new IoT Catalyst API Token
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| userid | ^[^']+$ | userid of a valid IoT Catalyst user | yes |
| password | ^[^']+$ | password of the valid IoT Catalyst user | yes |
APISecurity.requestTokenByPassport
Request a new IoT Catalyst API Token using a valid IoT Catalyst passport
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| passport | ^[^']+$ | passport of a valid IoT Catalyst component | yes |
| idComponentType | ^[1-9]\d*$ | Specifies the type of IoT Catalyst Component | no |
| idComponent | ^[1-9]\d*$ | Specifies the id of the IoT Catalyst entity the requester depends on | no |
| idParentComponent | ^[1-9]\d*$ | Specifies the id of the IoT Catalyst entity the requester depends on | no |
| info | ^[^']+$ | additional info to qualify the request | no |
APISecurity.getAllTokens
Get the list off all API Tokens present in IoT Catalyst (not yet cleaned)
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
APISecurity.delete
Delete one token present in IoT Catalyst (not yet cleaned)
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| token | ^[^']+$ | The token to delete | yes |
APISecurity.verifyToken
verify if a Iot Catalyst Token is valid
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| token | ^[^']+$ | The token to verify | yes |
ACL.getUserACL
Retrieves a specific ACL
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idLogin | ^[1-9]\d*$ | The Id of the Login associated to the ACL to retrieve | yes |
ACL.getAllUserACLs
Retrieves all the ACLs
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
ACL.updateUserACL
Updates an ACL
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| User_idLogin | ^[1-9]\d*$ | The id of the Login related to the ACL to update | yes |
| User_DigitalThing_Use_ACL | ^[0-1]+$ | 0 or 1 to indicate it this Login should use an ACL or not for DigitalThings | yes |
| User_Container_Use_ACL | ^[0-1]+$ | 0 or 1 to indicate it this Login should use an ACL or not for Containers | yes |
| User_Hypervisor_Use_ACL | ^[0-1]+$ | 0 or 1 to indicate it this Login should use an ACL or not for Hypervisors | yes |
| User_API_Use_ACL | ^[0-1]+$ | 0 or 1 to indicate it this Login should use an ACL or not for APIs | yes |
| User_Dashboard_Use_ACL | ^[0-1]+$ | 0 or 1 to indicate it this Login should use an ACL or not for Dashboards | yes |
ACL.getUserACLByIdLogin
Retrieves a specific ACL
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idLogin | ^[1-9]\d*$ | The Id of the Login associated to the ACL to retrieve | yes |
ACL.getUserACLByUserId
Retrieves a specific ACL
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| userid | ^[^']+$ | userid of an active IoT Catalyst user | yes |
ACL.addEntityToACL
Adds an entity to an owner identified by its id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| entity_type | (^DIGITALTHING$|^CONTAINER$|^HYPERVISOR$|^DASHBOARD$) | userid of an active IoT Catalyst user | yes |
| entity_id | ^[1-9]\d*$ | id of the IoT Catalyst Entity to manage | yes |
| owner_type | (^USER$|^GROUP$) | userid of an active IoT Catalyst user | yes |
| owner_id | ^[1-9]\d*$ | id of the IoT Catalyst Owner to assign the entity to | yes |
ACL.addEntityToUserACLByUserId
Adds an entity to an owner identified by the userid
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| entity_type | (^DIGITALTHING$|^CONTAINER$|^HYPERVISOR$|^DASHBOARD$) | userid of an active IoT Catalyst user | yes |
| entity_id | ^[1-9]\d*$ | id of the IoT Catalyst Entity to manage | yes |
| userid | ^[^']+$ | userid of an active IoT Catalyst user | yes |
ACL.addHypervisorToUserACLByNameAndUserId
Adds visibility on a Hypervisor to an owner identified by the userid
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| hypervisor_name | ^[a-zA-Z0-9_]* | Name of the IoT Catalyst Hypervisor to add to the user's ACL | yes |
| userid | ^[^']+$ | userid of an active IoT Catalyst user | yes |
ACL.addDigitalThingToUserACLByNameAndUserId
Adds visibility on a DigitalThing to an owner identified by the userid
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| digitalthing_name | ^[a-zA-Z0-9_]* | Name of the IoT Catalyst DigitalThing to add to the user's ACL | yes |
| userid | ^[^']+$ | userid of an active IoT Catalyst user | yes |
ACL.addContainerToUserACLByNameAndUserId
Adds visibility on a Container to an owner identified by the userid
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| container_name | ^[a-zA-Z0-9_]* | Name of the IoT Catalyst Container to add to the user's ACL | yes |
| userid | ^[^']+$ | userid of an active IoT Catalyst user | yes |
ACL.getAuthorizedEntitiesByIdLogin
Retrieves all the entities visible to a specific user account specified by the provided idLogin
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idLogin | ^[1-9]\d*$ | The Id of the Login of which retrieve the allowed entities | yes |
ACL.getAuthorizedEntitiesByUserid
Retrieves all the entities visible to a specific user account specified by the provided userid
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| userid | ^[^']+$ | userid of a valid IoT Catalyst user | yes |
ACL.getAuthorizedEntitiesByAPIToken
Retrieves all the entities visible to a specific user account specified by the user that is using the provided APIToken
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| apitoken | ^[^']+$ | The IoT Catalyst Token associated to a IoT Catalyst user | yes |
AnomalyManager.performContainerUnpredictableStatusCheck
Identifies Containers in an unpredictable status registering a new anomaly on every check
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
AnomalyManager.getAll
Get all the anomaly or the anomaly filtered by a type (if specified)
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| anomaly_group | (^Provisioning$|^Filesystem$) | If not blank, could be of value Provisioning|Filesystem | no |
AnomalyManager.getAllBySeverity
Get all the anomaly or the anomaly filtered by a severity and anomaly type
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| severity | (^minor$|^major$|^critical$) | minor|major|critical | yes |
| idAnomalyType | ^[1-9]\d*$ | ID Anomaly Type | no |
AnomalyManager.getAllDetectedAnomalyGroupsAndTypes
Get all the distinct anomaly groups and types of the detected anomalies
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
AnomalyManager.fixAnomaly
Try to fix the selected anomaly choosing the right system fixing routine
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idAnomaly | ^[1-9]\d*$ | The id of the Anomaly to fix | yes |
Adapter.delete
Deletes an IoT Catalyst Adapter by its Id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idAdapter | ^[1-9]\d*$ | Id of the IoT Catalyst Adapter | yes |
Adapter.get
Retrieves an IoT Catalyst Adapter by Id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idAdapter | ^[1-9]\d*$ | Id of the IoT Catalyst Adapter | yes |
Adapter.getByName
Retrieves an IoT Catalyst Adapter by its name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[^'^ ]{1,255}$ | yes |
Adapter.getAllSettings
Gets all the settings of a specific IoT Catalyst Adapter
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idAdapter | ^[1-9]\d*$ | Id of the IoT Catalyst Adapter | yes |
Adapter.getAllSettingsByAdapterName
Gets all the settings of a specific IoT Catalyst Adapter
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[^'^ ]{1,255}$ | Name of the Adapter | yes |
Adapter.updateAdapterSetting
Updates a specific setting of a specific IoT Catalyst Adapter
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idAdapter | ^[1-9]\d*$ | Id of the IoT Catalyst Adapter | yes |
| idSetting | ^[1-9]\d*$ | Id of the Setting | yes |
| value | ^[^']+$ | yes |
Adapter.getAll
Retrieves the list of all the IoT Catalyst Adapters
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| None |
|---|
Adapter.ProvisionContainerToAdapter
This method executes the provisioning of a given Container to the selected Adapter
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idAdapter | ^[1-9]\d*$ | Id of the IoT Catalyst Adapter | yes |
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
| adapter_settings_xml | ^[^']+$ | no | |
| notify_hypervisor | (^0$|^1$) | Notify the Hypervisor that hosts the targeted Container [0 = No, 1 = Yes] | no |
Adapter.UnprovisionContainerFromAdapter
This method executes the unprovisioning of a given Container from the selected Adapter
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idAdapter | ^[1-9]\d*$ | Id of the IoT Catalyst Adapter | yes |
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
| adapter_settings_xml | ^[^']+$ | no | |
| notify_hypervisor | (^0$|^1$) | Notify the Hypervisor that hosts the targeted Container [0 = No, 1 = Yes] | no |
Adapter.ProvisionContainerToAdapterByNames
This method executes the provisioning of a given Container to the selected Adapter
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| adapterName | ^[a-zA-Z0-9_]*$ | Name of IoT Catalyst Adapter | yes |
| containerName | ^[a-zA-Z0-9_]*$ | Name of the IoT Catalyst Container | yes |
| adapter_settings_xml | ^[^']+$ | no | |
| notify_hypervisor | (^0$|^1$) | Notify the Hypervisor that hosts the targeted Container [0 = No, 1 = Yes] | no |
Adapter.UnprovisionContainerFromAdapterByNames
This method executes the unprovisioning of a given Container from the selected Adapter
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| adapterName | ^[a-zA-Z0-9_]*$ | Name of IoT Catalyst Adapter | yes |
| containerName | ^[a-zA-Z0-9_]*$ | Name of the IoT Catalyst Container | yes |
| adapter_settings_xml | ^[^']+$ | no | |
| notify_hypervisor | (^0$|^1$) | Notify the Hypervisor that hosts the targeted Container [0 = No, 1 = Yes] | no |
Adapter.computeContainerToAdapterOperations
This method computes all the Adapter operations available to a given mounted Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| containers_list | ^([0-9]+(,[0-9]+)*)?$ | A comma separated list of the IoT Catalyst Containers e.g. 1,4,5 | yes |
| idAdapter | ^[1-9]\d*$ | no | |
| on_error | (^SKIP$|^RAISE_ERROR$) | values accepted SKIP or RAISE_ERROR [default RAISE_ERROR] | no |
Adapter.getAdapterZIPArchiveByidContainer
This method returns the base64 encoded ZIP archive of the adapter folder for the requested idContainer
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
| adapterName | ^[a-zA-Z0-9_]*$ | Name of IoT Catalyst Adapter | yes |
Adapter.RevokeAdapterProvisionCommand
This method tries to revoke an Adapter provision command
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idAdapterProvisionCommandRegistry | ^[1-9]\d*$ | Id of the adapter provision command to revoke as saved in the AdapterProvisionCommandRegistry | yes |
AdapterManager.computeAllowedAdaptersOperationsForMountedContainers
This method computes all the allowed Adapter operations for a list of mounted containers
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| containers_list | ^([0-9]+(,[0-9]+)*)?$ | A comma separated list of the IoT Catalyst Containers e.g. 1,4,5 | yes |
| idAdapter | (^ALL$|^[1-9]\d*$) | The specific id of the adapter to compute allowed operations for. To perform a computation for all the IoT Catalyst Adapters use ALL value | yes |
| on_error | (^SKIP$|^RAISE_ERROR$) | values accepted SKIP or RAISE_ERROR [default RAISE_ERROR] | yes |
Architecture.getAllSupportedArchitecture
Retrieves all the supportyed architectures for edge devices
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
Command.ack
This method sends an acknowledgement of an IoT Catalyst Command received or executed by Containers, Hypervisors, and Executors
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| COMMAND_ACK_TYPE | (^CONTAINER$|^ADAPTER$|^EXECUTOR$) | Ack type [CONTAINER,ADAPTER,EXECUTOR] | yes |
| COMMAND_ACK_JSON | . | Ack body in JSON format | yes |
Command.appendInfoMessageByHash
This method appends a message to an existing command targeting Containers, Hypervisors, and Executors
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| command_ack_type | (^CONTAINER$|^ADAPTER$|^EXECUTOR$) | Ack type [CONTAINER,ADAPTER,EXECUTOR] | yes |
| hash | . | Hash that identifies the provision command to update | yes |
| message | . | Message to append to the existing provision command message field | yes |
Container.provisionByIds
Creates an IoT Catalyst Container referencing existing entities by provided ids
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| container_name | ^[a-zA-Z0-9_]*$ | Name of the new Container | yes |
| container_description | ^[a-zA-Z0-9_ :,.]*$ | Brief description of the new Container | yes |
| idContainerGroup | ^[1-9]\d*$ | Id of the IoT Catalyst Container Group | no |
| idDigitalThing | ^[1-9]\d*$ | Id of the IoT Catalyst DigitalThing that will be used to forge this new Container | yes |
| idHypervisor | ^[1-9]\d*$ | Id of the IoT Catalyst Hypervisor that will mount the new Container | yes |
| idStatus | ^[0-1]{1}$ | Id of the status to assign to the Container at launch time [0 STOPPED , 1 STARTED] | yes |
| settings_xml | . | Setting for the new container in XML format | yes |
| adapter_settings_xml | . | Container Adapter specific setting in XML format | yes |
| firstMount | ^[0-1]{1}$ | Setting for the new container if firstMount is required [0 No , 1 Yes] default 1 | no |
| sync | ^[0-1]{1}$ | Determines the behaviour of the first mount, whether synchronized or not. [0 Async default, 1 Sync] default 0 | no |
| notify_hypervisor | (^0$|^1$) | Notify the Hypervisor [0 = No, 1 = Yes]. If yes, the notified Hypervisor will try to immediately mount the container | no |
Container.getLastAssignedHypervisor
Get the last Hypervisor that was the last to unmount successfully the selected Container. (The container must have been assigned at least once and in actual unmounted status to make this method return something).
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container for last assigned Hypervisor lookup | yes |
Container.notifyMountCommandByIdContainer
Creates an IoT Catalyst Container referencing existing entities by provided ids
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container for which you intend notify the occurred mount process | yes |
Container.storeState
Save IoT Catalyst Container state status file
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container for which you intend notify the occurred mount process | yes |
| encoded_package | . | State zip file encoded in Base64 | yes |
Container.provisionByNames
Creates an IoT Catalyst Container referencing existing entities by provided names
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| container_name | ^[a-zA-Z0-9_]*$ | Name of the new Container | yes |
| container_description | ^[a-zA-Z0-9_ :,.]*$ | Brief description of the new Container | yes |
| containergroup_name | ^[a-zA-Z0-9_]* | Name of the IoT Catalyst Container Group | no |
| digitalthing_name | ^[a-zA-Z0-9_]* | Name of the IoT Catalyst DigitalThing that will be used to forge this new Container | yes |
| hypervisor_name | ^[a-zA-Z0-9_]* | Name of the IoT Catalyst Hypervisor that will mount the new Container | yes |
| idStatus | ^[0-1]{1}$ | Id of the status to assign to the Container at launch time [0 STOPPED , 1 STARTED] | yes |
| settings_xml | ^[^']+$ | Setting for the new container in XML format | yes |
| adapter_settings_xml | . | Container Adapter specific setting in XML format | yes |
| firstMount | ^[0-1]{1}$ | Setting for the new container if firstMount is required [0 No , 1 Yes] default 0 | no |
| sync | ^[0-1]{1}$ | Determines the behaviour of the first mount, whether synchronized or not. [0 Async default, 1 Sync] default 0 | no |
| notify_hypervisor | (^0$|^1$) | Notify the Hypervisor [0 = No, 1 = Yes]. If yes, the notified Hypervisor will try to immediately mount the container | no |
Container.provisionByNamesJSON
Creates an IoT Catalyst Container referencing existing entities by provided names
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| container_name | ^[a-zA-Z0-9_]*$ | Name of the new Container | yes |
| container_description | ^[a-zA-Z0-9_ :,.]*$ | Brief description of the new Container | yes |
| containergroup_name | ^[a-zA-Z0-9_]* | Name of the IoT Catalyst Container Group | no |
| digitalthing_name | ^[a-zA-Z0-9_]* | Name of the IoT Catalyst DigitalThing that will be used to forge this new Container | yes |
| hypervisor_name | ^[a-zA-Z0-9_]* | Name of the IoT Catalyst Hypervisor that will mount the new Container | yes |
| idStatus | ^[0-1]{1}$ | Id of the status to assign to the Container at launch time [0 STOPPED , 1 STARTED] | yes |
| container_settings | ^[^']+$ | Setting for the new container in JSON format | no |
| adapter_settings | . | Container Adapter specific setting in JSON format | no |
| firstMount | ^[0-1]{1}$ | Setting for the new container if firstMount is required [0 No , 1 Yes] default 0 | no |
| sync | ^[0-1]{1}$ | Determines the behaviour of the first mount, whether synchronized or not. [0 Async default, 1 Sync] default 0 | no |
| notify_hypervisor | (^0$|^1$) | Notify the Hypervisor [0 = No, 1 = Yes]. If yes, the notified Hypervisor will try to immediately mount the container | no |
Container.getLiveStatusByName
Tries to gather the actual live status of an IoT Catalyst Container identified by its name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| container_name | ^[a-zA-Z0-9_]*$ | Name of the targeted Container | yes |
Container.getLiveStatusById
Tries to gather the actual live status of an IoT Catalyst Container identified by its Id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[0-9]*$ | Id of the targeted Container | yes |
Container.delete
Deletes an IoT Catalyst Container by id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
Container.get
Retrieves an IoT Catalyst Container by id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
Container.getByName
Retrieves an IoT Catalyst Container by name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[^'^ ]{1,255}$ | yes |
Container.getDetailsByName
Retrieves an IoT Catalyst Container by name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[^'^ ]{1,255}$ | Name of the container to look for | yes |
Container.getDetailsByPassport
Retrieves an IoT Catalyst Container by associated passport
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| passport | ^[^']+$ | Passport associated to the container to look for | yes |
Container.getAllIds
Retrieves all the ids of IoT Catalyst Containers sorted by id (default) or by name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| sort_by | ^[^'^ ]{1,255}$ | id or name | no |
Container.getIdByHypervisorDigitalThingNames
Retrieves an IoT Catalyst Container by the HypervisorName and associated DigitalThingName
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| nameHypervisor | ^[^'^ ]{1,255}$ | yes | |
| nameDigitalThing | ^[^'^ ]{1,255}$ | yes |
Container.getAllByDigitalThingName
Retrieves all the IoT Catalyst Containers matching the provided DigitalThingName value
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| nameDigitalThing | ^[^'^ ]{1,255}$ | yes |
Container.countByDigitalThingName
Retrieves all the IoT Catalyst Containers matching the provided DigitalThingName value
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| nameDigitalThing | ^[^'^ ]{1,255}$ | yes |
Container.getAllByHypervisorDigitalThingNames
Retrieves all the IoT Catalyst Containers matching the provided HypervisorName and DigitalThingName values
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| nameHypervisor | ^[^'^ ]{1,255}$ | yes | |
| nameDigitalThing | ^[^'^ ]{1,255}$ | yes |
Container.getAll
Retrieves all the IoT Catalyst Containers
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| type | (^raw$|^datatable$|$) | Choose how data will be rendered raw | datatable. If not specified standard rendering is applied (simple) | no |
Container.getAllByArchitecture
Retrieves a list of all the IoT Catalyst Containers of the given architecture
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| architecture | ^[a-zA-Z0-9_-]+$ | The architecture to look for e.g. p37-win-amd64 | yes |
Container.getAllAvailablePreviewDetailed
Retrieves a list of all the available IoT Catalyst Containers
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| None |
|---|
Container.getAllAvailablePreviewDetailedFilteredByAPIToken
Retrieves a list of all the available IoT Catalyst Containers accessible by the user authenticated by the provided token
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| apitoken | ^[^']+$ | The IoT Catalyst Token associated to a IoT Catalyst user | yes |
Container.getforHM
Retrieves an IoT Catalyst Container with the given id (version for HM system)
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
Container.getByNameforHM
Retrieves an IoT Catalyst Container with the given name (version for HM system)
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| container_name | ^(?=.*[a-zA-Z])[a-zA-Z0-9_-]*$ | yes |
Container.getAllforHM
Retrieves all the IoT Catalyst Containers sorted by id (default) or by name (version for HM system)
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| sort_by | (^id$|^name$) | id or name value | no |
Container.getAvailable
Retrieves only the IoT Catalyst Container not cancelled
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
Container.getAllDetailed
Gets a detailed view of all the IoT Catalyst Containers
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
Container.getAllPreview
Gets a simplified view of all the IoT Catalyst Containers
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
Container.getAllByHypervisorName
Retrieves all the IoT Catalyst Containers managed by the specified Hypervisor
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| nameHypervisor | ^[^'^ ]{1,255}$ | yes |
Container.getDetailedByUserACL
Gets detailed view of a an IoT Catalyst Container associated to a Login ACL
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
| idLogin | ^[1-9]\d*$ | Id of the IoT Catalyst Login | yes |
Container.getAllDetailedByUserACL
Gets detailed view of a all the IoT Catalyst COntainer associated to a Login ACL
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idLogin | ^[1-9]\d*$ | Id of the IoT Catalyst Login | yes |
Container.getPreview
Gets a simplified view of a specific IoT Catalyst Container searched by its id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
Container.getPreviewByName
Gets a simplified view of a specific IoT Catalyst Container searched by its name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[^'^ ]{1,255}$ | Name of the IoT Catalyst Container | yes |
Container.search
Search for IoT Catalyst Containers matching a list of criteria
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| search_type | ^[a-z]+$ | type of the search detailed|normal | yes |
| fields | ^[\*a-z,]+$ | comma separated list of the fields to extract | yes |
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | no |
| idHypervisor | ^[1-9]\d*$ | Id of the IoT Catalyst Hypervisor | no |
| idLocation | ^[1-9]\d*$ | Id of the IoT Catalyst Location | no |
| idContainerGroup | ^[1-9]\d*$ | Id of the IoT Catalyst ContainerGroup | no |
| idLogin | ^[1-9]\d*$ | Id of the IoT Catalyst idLogin for ACL lookup | no |
| where_base_clause | ^[,a-zA-Z=()0-9><_']+$ | where clause to be applied | no |
| order_by_clause | ^[a-z,A-Z 0-9]+$ | order by clause to be applied | no |
Container.getDigitalThingInfo
Gets info of the IoT Catalyst Digital Thing associated to the IoT Catalyst Containers
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
Container.assignHypervisor
Assign an IoT Catalyst Container to a given IoT Catalyst Hypervisor
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
| idHypervisor | ^[1-9]\d*$ | Id of the IoT Catalyst Hypervisor | yes |
Container.startByName
Start an IoT Catalyst Container selected by its name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[^'^ ]{1,255}$ | Name of the IoT Catalyst Container | yes |
Container.stopByName
Stop an IoT Catalyst Container selected by its name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[^'^ ]{1,255}$ | Name of the IoT Catalyst Container | yes |
Container.restartByName
Restart an IoT Catalyst Container selected by its name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[^'^ ]{1,255}$ | Name of the IoT Catalyst Container | yes |
Container.getStatusByName
Request an update of the status of an IoT Catalyst Container selected by its name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[^'^ ]{1,255}$ | Name of the IoT Catalyst Container | yes |
Container.firstMount
Proceedes with the first mount operation of an IoT Catalyst Container to an IoT Catalyst Hypervisor assigning a default startup status
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
| idHypervisor | ^[1-9]\d*$ | Id of the IoT Catalyst Hypervisor | yes |
| status | (^stopped$|^started$) | Specifies the initial default status of the provisioned IoT atalyst Container stopped | started | yes |
| sync | (^0$|^1$) | Wait until the mount process is completed [0 No , 1 Yes] | no |
| notify_hypervisor | (^0$|^1$) | Notify the Hypervisor [0 = No, 1 = Yes]. If yes, the notified Hypervisor will try to immediately mount the container | no |
Container.unmount
Unmounts an IoT Catalyst Container from an IoT Catalyst Hypervisor using the provided ids
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
| idHypervisor | ^[1-9]\d*$ | Id of the IoT Catalyst Hypervisor | yes |
| sync | (^0$|^1$) | Wait until the mount process is completed [0 No , 1 Yes] | no |
| notify_hypervisor | (^0$|^1$) | Notify the Hypervisor of the unmount activity [0 = No, 1 = Yes]. If yes, the notified Hypervisor will try to immediately unmount the container | no |
Container.mount
Mounts an IoT Catalyst Container on an IoT Catalyst Hypervisor using the provided ids
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
| idHypervisor | ^[1-9]\d*$ | Id of the IoT Catalyst Hypervisor | yes |
| status | (^stopped$|^started$) | Initial status of the IoT Catalyst Container when mounted stopped|started | yes |
| sync | (^0$|^1$) | Wait until the mount process is completed [0 No , 1 Yes] | no |
| notify_hypervisor | (^0$|^1$) | Notify the Hypervisor of the mount activity [0 = No, 1 = Yes]. If yes, the notified Hypervisor will try to immediately mount the container | no |
Container.undoFirstMount
Undo the first mount of the IoT Catalyst Container with the given id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
Container.fixProvisioningMountError
Resets the provisioning status of an IoT Catalyst Container if a mount operation has failed
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
Container.resetHypervisor
Sets to 0 the idHypervisor associated to the IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
Container.getSettings
Gets the list of all the settings associated to the IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
Container.getSettingByNames
Gets the list of all the settings associated to the IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| setting_name | ^[a-zA-Z0-9_]*$ | yes | |
| container_name | ^[^'^ ]{1,255}$ | Name of the IoT Catalyst Container | yes |
Container.getAllSettingsByContainerName
Gets the list of all the settings associated to the IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[^'^ ]{1,255}$ | Name of the IoT Catalyst Container | yes |
Container.getSettingsFromList
Gets the settings with the ids specified in the comma separated list of the IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
| idsList | ^([0-9]+(,[0-9]+)*)?$ | comma separated list of the settings to get e.g. 3,4,56 | yes |
Container.updateSetting
Set a value of a specific setting of the IoT Catalyst Container specified
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainerSetting | ^[1-9]\d*$ | yes | |
| value | ^[^']+$ | yes |
Container.updateAllSettings
Updates all the settings of the specified IoT Catalyst Container. Settings should be provided in the expected JSON format
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| settingsCollection | ^[^']+$ | The settings collection as a stringified JSON example: [{"idSetting":"12344","name":"Setting1", "value":"value1"}] | yes |
Container.updateSettingByName
Set a value of a specific setting of the IoT Catalyst Container specified by its name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| settingName | ^[a-zA-Z0-9_]*$ | yes | |
| containerName | ^[a-zA-Z0-9_]*$ | yes | |
| value | ^[^']+$ | yes |
Container.getProvisionCommandsHistory
Gets the provision command history for the IoT Catalyst Container specified
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
Container.getProvisionCommandsHistoryPreview
Gets a brief preview of the provision command history for the IoT Catalyst Container specified
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
Container.RevokeProvisionCommand
Revoke a Provisioning Command for the specified IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idProvisionCommand | ^[1-9]\d*$ | yes |
Container.revokeLastProvisionCommandByContainerName
Revoke last Provisioning Command for the specified IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| container_name | ^[a-zA-Z0-9_]*$ | yes |
Container.getLastProvisionCommandByContainerName
Revoke a Provisioning Command for the specified IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| container_name | ^[a-zA-Z0-9_]*$ | yes |
Container.getLastProvisionCommandByIdContainer
Gets the last Provisioning Command for the specified IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | id of the target Container | yes |
Container.getHandshakingHistoryPreview
Gets a brief preview of the handshakings history for the IoT Catalyst Container specified
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
Container.deleteHandshake
Deletes a single Handshaking record
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHandshakingLog | ^[1-9]\d*$ | yes |
Container.deleteHandshakingLogEntry
Deletes a single Handshaking record
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHandshakingLog | ^[1-9]\d*$ | yes |
Container.deepDelete
Executes the deep deletion of a given IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
Container.deepDeleteByName
Executes the deep deletion of a given IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[a-zA-Z0-9_]*$ | Name of the Container | yes |
Container.detachById
Executes the forced detach of the selected IoT Catalyst Container. No operation are performed towards the Hypervisor. Hypervisor should be rebooted or deleted after this operation
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
Container.detachByName
Executes the forced detach of the selected IoT Catalyst Container. No operation are performed towards the Hypervisor. Hypervisor should be rebooted or deleted after this operation
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| container_name | ^[a-zA-Z0-9_]*$ | Name of the IoT Catalyst Container | yes |
Container.getAvailableContainerWithAllFeature_Autocomplete
Retrieves the list of all the features composing the bill of features of the given Container (Autocomplete call for Flow Designer)
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| containerName | ^[a-zA-Z0-9_]*$ | Name of the IoT Catalyst Container (min. 2 character) | yes |
Container.getAvailableContainerWithActionTypeFeature_Autocomplete
Retrieves the list of all the action class features composing the bill of features of the given Container (Autocomplete call for Flow Designer)
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| containerName | ^[a-zA-Z0-9_]*$ | Name of the IoT Catalyst Container (min. 2 character) | yes |
Container.getAvailableContainerByNameWithDataOrEventTypeFeature
Retrieves the list of all the data or event class features composing the bill of features of the given Container if exist
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| containerName | ^[a-zA-Z0-9_]*$ | Name of the IoT Catalyst Container | yes |
Container.getAvailableContainerByNameWithActionTypeFeature
Retrieves the list of all the action class features composing the bill of features of the given Container if exist
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| containerName | ^[a-zA-Z0-9_]*$ | Name of the IoT Catalyst Container | yes |
Container.existByName
Verify by name if Container exist
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| containerName | ^[a-zA-Z0-9_]*$ | Name of the IoT Catalyst Container | yes |
Container.getAllDetailedFeaturesByContainerName
Retrieves the list of all the detailed features (data,events,updatables,function and actions) composing the bill of features of the given Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| container_name | ^[a-zA-Z0-9_]*$ | Name of the IoT Catalyst Container | yes |
Container.getAllDetailedFeaturesByIdContainer
Retrieves the list of all the detailed features (data,events,updatables,function and actions) composing the bill of features for the given Container specified by its id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
Container.getAllFeatures
Retrieves the list of all the detailed features (data,events,updatables,function and actions) composing the bill of features for the given Container specified by its id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
Container.getAllFunctionsByIdContainer
Retrieves the list of all the available functions provided by a IoT Catalyst Container with a given id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
| format | (^raw$|^pretty$|^datatable$|$) | Raw array or Pretty JSON (raw|pretty|datatable) | no |
Container.getAllFunctionsForDesignerByIdContainer
Retrieves the list of all the available functions provided by a IoT Catalyst Container with a given id. Data format is a JSON array
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
| format | (^raw$|^pretty$) | Raw array or Pretty JSON (raw|pretty) | no |
Container.getAllFunctions
Retrieves the list of all the available functions provided by an IoT Catalyst Container identified by the associated Hypervisor and Digital Thing
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| nameHypervisor | ^[a-zA-Z0-9_]*$ | Name of the Hypervisor hosting the Container | yes |
| nameDigitalThing | ^[a-zA-Z0-9_]*$ | Name of the DigitalThing associated to the Container | no |
| format | (^raw$|^pretty$) | Raw array or Pretty JSON (raw|pretty) | no |
Container.getAllFunctionsByHypervisorName
Retrieves the list of all the available functions provided by several IoT Catalyst Container associated to the same specified IoT Catalyst Hypervisor
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| nameHypervisor | ^[a-zA-Z0-9_]*$ | Name of the Hypervisor hosting the Container | yes |
| format | (^raw$|^pretty$) | Raw array or Pretty JSON (raw|pretty) | no |
Container.getAllFunctionsByContainerName
Retrieves the list of all the available functions provided by a IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| nameContainer | ^[a-zA-Z0-9_]*$ | Name of the Container | yes |
| format | ^[a-zA-Z0-9_]*$ | Raw array or Pretty JSON (raw|pretty) | no |
Container.callFunction
Sends a function request to a given IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container | yes |
| functionId | ^[1-9]\d*$ | Id of the Function requested | yes |
| dataload | ^[^']+$ | dataload as a stringified JSON example: [{"name":"param1", "value":"value1"},{"name":"param2", "value":"value2"}] | yes |
Container.callFunctionByNames
Sends an action request to a chosen IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| containerName | ^[a-zA-Z0-9_]*$ | Name of the Container | yes |
| functionName | ^[a-zA-Z0-9_]*$ | Name of the Function requested | yes |
| dataload | ^[^']+$ | dataload as a stringified JSON example: [{"name":"param1", "value":"value1"}] | no |
Container.updateStudioAdapterSetting
Updates a setting value of the IoT Catalyst Adapter specific to a given IoT Catalyst Container. Updates the stored setting and notifies the update to the running Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container | yes |
| setting_name | ^[^']+$ | The name of the IoT Catalyst Studio setting to update for the specified Container | yes |
| setting_value | ^[^']+$ | The value to assign to the IoT Catalyst Studio setting to update for the specified Container | yes |
| applyChangeToRunningContainer | ^[0-1]{1}$ | if yes the change to the setting is immediately propagated to the running container {0 : no, 1 : yes} | no |
Container.updateStudioAdapterSettingByContainerName
Updates a setting value of the IoT Catalyst Adapter specific to a given IoT Catalyst Container. Updates the stored setting and notifies the update to the running Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| container_name | ^[a-zA-Z0-9_]*$ | Name of the Container | yes |
| setting_name | ^[^']+$ | The name of the IoT Catalyst Studio setting to update for the specified Container | yes |
| setting_value | ^[^']+$ | The value to assign to the IoT Catalyst Studio setting to update for the specified Container | yes |
| applyChangeToRunningContainer | ^[0-1]{1}$ | if yes the change to the setting is immediately propagated to the running container {0 : no, 1 : yes} | no |
Container.refreshContainerZIPArchive
Updates to ZIP archive of an IoT Catalyst Container recalculating all the dependencies
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container | yes |
Container.getZIPArchiveByIdContainer
Retrieves the ZIP archive of an IoT Catalyst Container recalculating all the dependencies
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container | yes |
Container.getZIPArchiveByName
Retrieves the ZIP archive of an IoT Catalyst Container recalculating all the dependencies
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[a-zA-Z0-9_]*$ | Name of the Container | yes |
Container.getAllActionsByIdContainer
Retrieves the list of all the available actions provided by a IoT Catalyst Container with a given id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
| format | (^raw$|^pretty$|^datatable$|$) | Raw array or Pretty JSON (raw|pretty|datatable) | no |
Container.getAllActionsByHypervisorDigitalThingNames
Retrieves the list of all the available actions provided by an IoT Catalyst Container identified by the associated Hypervisor and Digital Thing
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| nameHypervisor | ^[a-zA-Z0-9_]*$ | Name of the Hypervisor hosting the Container | yes |
| nameDigitalThing | ^[a-zA-Z0-9_]*$ | Name of the DigitalThing associated to the Container | no |
| format | (^raw$|^pretty$) | Raw array or Pretty JSON (raw|pretty) | no |
Container.getAllFunctionsByHypervisorName
Retrieves the list of all the available actions provided by several IoT Catalyst Container associated to the same specified IoT Catalyst Hypervisor
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| nameHypervisor | ^[a-zA-Z0-9_]*$ | Name of the Hypervisor hosting the Container | yes |
| format | (^raw$|^pretty$) | Raw array or Pretty JSON (raw|pretty) | no |
Container.getAllActionsByHypervisorName
Retrieves the list of all the available actions provided by several IoT Catalyst Container associated to the same specified IoT Catalyst Hypervisor
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| nameHypervisor | ^[a-zA-Z0-9_]*$ | Name of the Hypervisor hosting the Container | yes |
| format | (^raw$|^pretty$) | Raw array or Pretty JSON (raw|pretty) | no |
Container.getAllActionsByContainerName
Retrieves the list of all the available actions provided by a IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| nameContainer | ^[a-zA-Z0-9_]*$ | Name of the Container | yes |
| format | ^[a-zA-Z0-9_]*$ | Raw array or Pretty JSON (raw|pretty) | no |
Container.sendActionRequest
Sends an action request to a given IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container | yes |
| actionId | ^[1-9]\d*$ | Id of the Action requested | yes |
| gpio_mask | ^[^']+$ | gpio_mask as a stringified JSON | no |
| dataload | ^[^']+$ | dataload as a stringified JSON example: [{"name":"param1", "value":"value1"}] | no |
Container.sendActionRequestByNames
Sends an action request to a chosen IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| containerName | ^[a-zA-Z0-9_]*$ | Name of the Container | yes |
| actionName | ^[a-zA-Z0-9_]*$ | Name of the Action requested | yes |
| gpio_mask | ^[^']+$ | gpio_mask as a stringified JSON | no |
| dataload | ^[^']+$ | dataload as a stringified JSON example: [{"name":"param1", "value":"value1"}] | no |
Container.getAllUDF
Request all the IoT Catalyst Updatable Feature (set point) of a given IoT Catalyst Container with last stored values
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container | yes |
Container.getAllUDFByContainerName
Request all the IoT Catalyst Updatable Feature (set point) of a given IoT Catalyst Container with last stored values
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| containerName | ^[a-zA-Z0-9_]*$ | Name of the IoT Catalyst Container | yes |
Container.sendUpdateUDFRequest
Sends an update request for a specific IoT Catalyst Updatable Feature (set point) of a given IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container | yes |
| UDFId | ^[1-9]\d*$ | Id of the updatable feature to set | yes |
| UDFName | ^[^']+$ | Name of the UDF to set | yes |
| UDFValue | ^[^']+$ | Value to set | yes |
Container.sendUpdateUDFRequestByContainerName
Sends an update request for a specific IoT Catalyst Updatable Feature (set point) of a given IoT Catalyst Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| containerName | ^[a-zA-Z0-9_]*$ | Name of the IoT Catalyst Container | yes |
| UDFId | ^[1-9]\d*$ | Id of the updatable feature to set | yes |
| UDFName | ^[^']+$ | Name of the UDF to set | yes |
| UDFValue | ^[^']+$ | Value to set | yes |
Container.remount
This method performs the auto unmount and mount operations of a Container without changing the Hypervisor the Container is assigned to
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container | yes |
Container.restoreProvisionCommandTo
This method restores a container to the state specified by a specific provision command
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container | yes |
| idProvisionCommandRegistry | ^[1-9]\d*$ | Id of the provision command saved in the ProvisionCommandRegistry to restore the Container's provision status to | yes |
Container.updateContainerArchive
This method updates the Container business logic with the last data found of the associated DigitalThing as stored in IoT Catalyst Studio library
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container | yes |
Container.getProvisionedAdapters
This method gets the list of all the Adapters the given Container is actually provisioned to
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container | yes |
Container.deleteHandshakingLogsByIdContainer
This method deletes all the handshaking log entries for the selected container. It is not reversible
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container | yes |
Container.provisionAdapterByNames
This method executes the provisioning of a given Adapter to the selected Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| container_name | ^[a-zA-Z0-9_]*$ | Name of the IoT Catalyst Container | yes |
| adapter_name | ^[a-zA-Z0-9_]*$ | Name of IoT Catalyst Adapter | yes |
| container_adapter_settings_JSON | . | no | |
| notify_hypervisor | (^0$|^1$) | Notify the Hypervisor [0 = No, 1 = Yes]. If yes, the notified Hypervisor will try to immediately mount the new adapter associated to the targeted container | no |
Container.unprovisionAdapterByNames
This method executes the unprovisioning of a given Adapter from the selected Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| container_name | ^[a-zA-Z0-9_]*$ | Name of the IoT Catalyst Container | yes |
| adapter_name | ^[a-zA-Z0-9_]*$ | Name of IoT Catalyst Adapter | yes |
| notify_hypervisor | (^0$|^1$) | Notify the Hypervisor [0 = No, 1 = Yes]. If yes, the notified Hypervisor will try to immediately unmount the adapter associated to the targeted container | no |
Container.getContainerType
This method is used to get the Container's Digital Type
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container | yes |
Container.getAllUpdatableFeaturesByIdContainerDatatable
This method is used to get the Container's Updatable features
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container | yes |
Container.getAdapterProvisionCommandsHistoryPreview
This method is used to get the Container's Updatable features
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the Container | yes |
| format | (^raw$|^pretty$|^datatable$|$) | Raw array or Pretty JSON (raw|pretty|datatable) | no |
ContainerAdapterSetting.updateByNames
Updates a selected container's level adapter setting of a given container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| adapter_name | ^[a-zA-Z0-9_]*$ | Name of the IoT Catalyst Adapter | yes |
| setting_name | ^[a-zA-Z0-9_]*$ | Id of the IoT Catalyst Container Adapter Setting | yes |
| setting_value | . | New value to set | yes |
| container_name | ^[a-zA-Z0-9_]*$ | Name of the targeted IoT Catalyst Container | yes |
| should_remount | ^[0-1]{1}$ | Set to 0 (no) or 1 (yes) if the IoT Catalyst Container should be flagged with "requires remount" after the update | yes |
ContainerAdapterSetting.getAllByIdContainerIdAdapter
Fetches all the ContainerAdapterSettings associated to the requested Container for the given Adapter
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idContainer | ^[1-9]\d*$ | Id of the IoT Catalyst Container | yes |
| idAdapter | ^[1-9]\d*$ | Id of the IoT Catalyst Adapter | yes |
ContainerAdapterSetting.getAllByNames
Fetches all the ContainerAdapterSettings associated to the requested Container for the given Adapter
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| container_name | ^[a-zA-Z0-9_]*$ | Name of the targeted IoT Catalyst Container | yes |
| adapter_name | ^[a-zA-Z0-9_]*$ | Name of the IoT Catalyst Adapter | yes |
DigitalThing.updateDescription
Updates the description field of a given DigitalThing
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idDigitalThing | ^[1-9]\d*$ | Id of the IoT Catalyst Digital Thing | yes |
| description | ^[a-zA-Z 0-9]+$ | New description of the IoT Catalyst Digital Thing | yes |
DigitalThing.getById
Get all the data of a Digital Thing retrieved by its id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idDigitalThing | ^[1-9]\d*$ | Id of the IoT Catalyst Digital Thing to retrieve | yes |
DigitalThing.existsByNameAndArchitecture
Checks existence of a Digital Thing retrieved by its name and architecture
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[^'^ ]{1,255}$ | Name of the IoT Catalyst Digital Thing to retrieve | yes |
| architecture | ^[^'^ ]{1,255}$ | Architecture of the IoT Catalyst Digital Thing to retrieve | yes |
DigitalThing.getAll
Get all the Digital Things
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| type | (^raw$|^datatable$|$) | Choose how data will be rendered raw | datatable. If not specified standard rendering is applied (simple) | no |
DigitalThing.getAllPreview
Get all the Digital Things extracting only the most relevant info
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
DigitalThing.getAllDetailed
Get all the Digital Things info
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| None |
|---|
DigitalThing.getAllDetailedWithJSONFeatures
Get all the Digital Things info
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
DigitalThing.getAllDetailedWithJSONFeaturesFilteredByAPIToken
Get all the DigitalThings accessible by the user authenticated by the provided token
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| apitoken | ^[^']+$ | The IoT Catalyst Token associated to a IoT Catalyst user | yes |
DigitalThing.getByName
Get all the data of a Digital Thing retrieved by its name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[^'^ ]{1,255}$ | Name of the IoT Catalyst Digital Thing to retrieve | yes |
DigitalThing.getByNameAndArchitecture
Gets a Digital Thing retrieved by its name and architecture
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[^'^ ]{1,255}$ | Name of the IoT Catalyst Digital Thing to retrieve | yes |
| architecture | ^[^'^ ]{1,255}$ | Architecture of the IoT Catalyst Digital Thing to retrieve | yes |
DigitalThing.getAllFeaturesByName
Get all the data of a Digital Thing retrieved by its name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[^'^ ]{1,255}$ | Name of the IoT Catalyst Digital Thing to retrieve | yes |
DigitalThing.getAllDevkitsByDesignerName
Get all the Devkits of a Designer retrieved by its name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| designer | ^[^'^ ]{1,255}$ | Designer Name of the IoT Catalyst Devkits to retrieve | yes |
DigitalThing.update
Update a Digital Thing retrieved by its name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[^'^ ]{1,255}$ | Name of the IoT Catalyst Digital Thing to update | yes |
| description | ^[a-zA-Z 0-9]+$ | New description of the IoT Catalyst Digital Thing | yes |
| file_content | . | base64 encoded string containing the zip folder of the Digital Thing | yes |
| perform_containers_update | (^yes$|^no$) | If yes, IoT Catalyst will try to update all the containers that use the updated Digital Thing | yes |
DigitalThing.add
Update a Digital Thing retrieved by its name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[^'^ ]{1,255}$ | Name of the IoT Catalyst Digital Thing to add to the IoT Catalyst Library | yes |
| description | ^[a-zA-Z 0-9]+$ | Description of the IoT Catalyst Digital Thing | yes |
| file_content | . | base64 encoded string containing the zip folder of the Digital Thing | yes |
DigitalThing.createBootstrapArchive
Creates a bootstrap archive of a new DigitalThing that can be used as the starting point for the development of a new DigitalThing
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| architecture | ^[a-zA-Z0-9_-]+$ | The architecture to look for e.g. p37-win-amd64 | yes |
| designer | ^[^'^ ]{1,255}$ | One of the supported designer e.g. "Generic" | yes |
| name | ^[^'^ ]{1,255}$ | Name of the IoT Catalyst Digital Thing to add to the IoT Catalyst Library | yes |
| description | ^[a-zA-Z 0-9]+$ | Description of the IoT Catalyst Digital Thing | yes |
DigitalThing.getAllSupportedDesigners
Retrieves the list of all supported DigitalThings designers
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
Download.getFileByCategoryName
Gets all Local Files by category name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| categoryName | ^[a-zA-Z0-9]+$ | File Category name to retrieve | yes |
Download.getFileByNames
Gets all Local Files by file name and category name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| fileName | ^[a-zA-Z0-9.]+$ | Name file to retrieve | yes |
| categoryName | ^[a-zA-Z0-9]+$ | File Category name to retrieve | yes |
Executor.StartHypervisor
Creates a request to a remote Executor to start its managed Hypervisor
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHypervisor | ^[1-9]\d*$ | Id of the Hypervisor | yes |
Executor.StopHypervisor
Creates a request to a remote Executor to stop its managed Hypervisor
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHypervisor | ^[1-9]\d*$ | Id of the Hypervisor | yes |
Executor.UpdateHypervisor
Creates a request to a remote Executor to update its managed Hypervisor
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| HypervisorIds | ^[0-9,]+$ | Comma separated Ids of the Hypervisors for sending the update request to | yes |
| reuseMasterUpdatePackage | (^yes$|^no$) | Reuse existing master archive if present (IoT Catalyst will not create a new updating archive for a given architecture if it is already present in the central repository | no |
| notifyUpdateRequest | (^yes$|^no$) | If yes, IoT Catalyst will create a new command request in the executor command registry and will notify the command to the targeted Hypervisor(s) | no |
Executor.StartHypervisorByName
Creates a request to a remote Executor to start its managed Hypervisor
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| hypervisor_name | (?=.*[a-zA-Z])[a-zA-Z0-9_ ]*$ | Name of the Hypervisor | yes |
Executor.StopHypervisorByName
Creates a request to a remote Executor to stop its managed Hypervisor
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| hypervisor_name | (?=.*[a-zA-Z])[a-zA-Z0-9_ ]*$ | Name of the Hypervisor | yes |
ExecutorCommandRegistry.getEndpointURL
Gets the endpoint URL of the registry server used to manage registry operations
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| None |
|---|
ExecutorCommandRegistry.getByIdHypervisor
Gets the registry of all the command sent to the hypervisor's updater component
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHypervisor | ^[1-9]\d*$ | Id of the Hypervisor | yes |
| type | (^raw$|^datatable$|$) | Choose how data will be rendered raw | datatable. If not specified standard rendering is applied | no |
ExecutorCommandRegistry.createExecutionRequest
Creates a new entry in the executor registry for the idHypervisor received in input
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHypervisor | ^[1-9]\d*$ | Id of the Hypervisor | yes |
| command_type | (^START$|^STOP$|^UPDATE$|^EXECUTE$) | The command type. (START,STOP,UPDATE or EXECUTE) | yes |
| command | ^[^']+$ | The command that will be executed (only for command_type=EXECUTE) | no |
Feature.getAllDetailedByContainerName
Gets feature matching the filter criteria
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| container_name | ^[a-zA-Z 0-9_]+$ | Name of the Container to be used as search criteria | yes |
Feature.getByContainerAndFeatureNames
Gets feature matching the filter criteria
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| container_name | ^[a-zA-Z 0-9_]+$ | Name of the Container to be used as search criteria | yes |
| feature_name | ^[a-zA-Z 0-9_]+$ | Name of the Feature to search | yes |
Feature.getPayloadByIdFeatureJSON
Gets the payload of the given feature matching the filter criteria
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idFeature | ^[1-9]\d*$ | Id of the Feature | yes |
Feature.getAvailableFeaturesByContainerNameAndFeatureClass
Gets the feature data matching the filter criteria
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| containerName | ^[a-zA-Z 0-9_]+$ | Name of the Container to be used as search criteria | yes |
| featureClass | (^DATA-EVENT$|^ACTION$) | Class of the Feature to search es. DATA-EVENT or ACTION | yes |
Feature.getAllFeaturesByContainerNameAndFeatureNameAndClass
Gets the feature data matching the filter criteria (include payload for class feature ACTION)
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| containerName | ^[a-zA-Z 0-9_]+$ | Name of the Container to be used as search criteria | yes |
| featureName | ^[a-zA-Z 0-9_]+$ | Name of the Feature to be used as search criteria | yes |
| featureClass | (^DATA-EVENT$|^ACTION$) | Class of the Feature to search es. DATA-EVENT or ACTION | yes |
Feature.getFeaturesByContainerNameAndFeatureName
Gets the feature data matching the filter criteria
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| containerName | ^[a-zA-Z 0-9_]+$ | Name of the Container to be used as search criteria | yes |
| featureName | ^[a-zA-Z 0-9_]+$ | Name of the Feature to be used as search criteria | yes |
General.settings
Request all the current IoT Catalyst Settings
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| None |
|---|
General.environmentVariables
Request all the current IoT Catalyst Settings
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| None |
|---|
Hypervisor.get
Retrieves an IoT Catalyst Hypervisor with the given id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHypervisor | ^[1-9]\d*$ | Id of the IoT Catalyst Hypervisor | yes |
Hypervisor.getPreviewById
Return data of the IoT Catalyst Hypervisor with the given id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHypervisor | ^[1-9]\d*$ | Id of the IoT Catalyst Hypervisor | yes |
| type | (^simple$|^datatable$|$) | Choose how data will be rendered datatable. If not specified standard rendering is applied (simple) | no |
Hypervisor.getAllIds
Retrieves all the ids of IoT Catalyst Hypervisors sorted by id (default) or by name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| sort_by | ^[^'^ ]{1,255}$ | id or name | no |
Hypervisor.getByName
Retrieves an IoT Catalyst Hypervisor with the given name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| hypervisor_name | ^(?=.*[a-zA-Z])[a-zA-Z0-9_-]*$ | Name to be assigned to the new Hypervisor | yes |
Hypervisor.getAll
Retrieves a list of all the IoT Catalyst Hypervisors
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| type | (^raw$|^datatable$|$) | Choose how data will be rendered raw | datatable. If not specified standard rendering is applied (simple) | no |
Hypervisor.getAllFilteredByAPIToken
Retrieves a list of all the IoT Catalyst Hypervisors that are visible to the connected user
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| type | (^raw$|^datatable$|$) | Choose how data will be rendered raw | datatable. If not specified standard rendering is applied (simple) | no |
| apitoken | ^[^']+$ | The IoT Catalyst Token associated to a IoT Catalyst user | yes |
Hypervisor.getAllByArchitecture
Retrieves a list of all the IoT Catalyst Hypervisors of the given architecture
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| architecture | ^[a-zA-Z0-9_-]+$ | The architecture to look for e.g. p37-win-amd64 | yes |
Hypervisor.getforHM
Retrieves an IoT Catalyst Hypervisor with the given id (version for HM system)
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHypervisor | ^[1-9]\d*$ | Id of the IoT Catalyst Hypervisor | yes |
Hypervisor.getByNameforHM
Retrieves an IoT Catalyst Hypervisor with the given name (version for HM system)
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| hypervisor_name | ^(?=.*[a-zA-Z])[a-zA-Z0-9_-]*$ | yes |
Hypervisor.getAllforHM
Retrieves a list of all the IoT Catalyst Hypervisors sorted by id (default) or by name (version for HM system)
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| sort_by | (^id$|^name$) | id or name value | no |
Hypervisor.getAllByLocationName
Retrieves a list of all the IoT Catalyst Hypervisors related to the selected location
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| locationName | ^[a-zA-Z 0-9]+$ | Name of the Location to lookup | yes |
Hypervisor.getAllByidHypervisorList
Retrieves a list of all the IoT Catalyst Hypervisors related to the list of IDs
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHypervisorList | ^[0-9,]+$ | List of Hypervisor IDs | yes |
Hypervisor.getAllDatatable
Retrieves an array containing a list of all the IoT Catalyst Hypervisors
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
Hypervisor.getAllPreviewDatatable
Retrieves an array containing a preview list of all the IoT Catalyst Hypervisors
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
Hypervisor.getFilteredPreview
Retrieves an array containing a preview list of all the IoT Catalyst Hypervisors filtered by param idHypervisor, onlyAvailable, architecture and location
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHypervisor | ^[0-9 ]+$ | Id of the IoT Catalyst Hypervisor [Set value to 0 to remove the ID filter] | no |
| onlyAvailable | (^0$|^1$) | Filter by Hypervisor status [0 not apply/1 apply] | no |
| architecture | ^[a-zA-Z0-9-_ ]*$ | Hypervisor architecture [es. p37-linux-x86_64] | no |
| location | ^[a-zA-Z0-9 ]*$ | Name of the location of the Hypervisor (a list of the available Locations is exposed by another API method) | no |
Hypervisor.getHandshakingHistoryPreview
Retrieves the list of all the handshakings performed by the IoT Catalyst Hypervisor of the given id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHypervisor | ^[1-9]\d*$ | Id of the IoT Catalyst Hypervisor | yes |
| type | (^raw$|^datatable$|$) | Choose how data will be rendered raw | datatable. If not specified standard rendering is applied | no |
Hypervisor.getHypervisorContainersPreview
Retrieves the list of all the IoT Catalyst Containers managed by the IoT Catalyst Hypervisor specified by its id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHypervisor | ^[1-9]\d*$ | Id of the IoT Catalyst Hypervisor | yes |
| type | (^simple$|^datatable$|$) | Choose how data will be rendered datatable. If not specified standard rendering is applied (simple) | no |
Hypervisor.getHypervisorContainersByHypervisorNamePrefix
Retrieves the list of all the IoT Catalyst Containers managed by the IoT Catalyst Hypervisor name prefix
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| HypervisorName | ^(?=.*[a-zA-Z])[a-zA-Z0-9_-]*$ | Name of the hypervisor contained in the container name | yes |
Hypervisor.getDetailsByPassport
Retrieves an IoT Catalyst Hypervisor by associated passport
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| passport | ^[^']+$ | Passport associated to the Hypervisor to look for | yes |
Hypervisor.generateHypervisorByHostType
Creates a new IoT Catalyst Hypervisor of the given architecture
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| hypervisor_name | ^(?=.*[a-zA-Z])[a-zA-Z0-9_-]*$ | Name to be assigned to the new Hypervisor | yes |
| hypervisor_description | ^[a-zA-Z 0-9_]+$ | Description to be assigned to the new Hypervisor | yes |
| idHypervisorHostType | ^[1-9]\d*$ | Id of the HostType of the new Hypervisor (a list of the available HostTypes is exposed by another API method) | yes |
| idHypervisorHostTypeArchitecture | ^[1-9]\d*$ | Id of the HypervisorHostTypeArchitecture table which allows you to understand the architecture and host type of the Hypervisor | yes |
| idLocation | ^[1-9]\d*$ | Id of the location of the new Hypervisor (a list of the available Locations is exposed by another API method) | no |
Hypervisor.generateHypervisorByNames
Creates a new IoT Catalyst Hypervisor of the given architecture
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^(?=.*[a-zA-Z])[a-zA-Z0-9_-]*$ | Name to be assigned to the new Hypervisor | yes |
| description | ^[a-zA-Z 0-9_]+$ | Description to be assigned to the new Hypervisor | yes |
| vendor | ^(?=.*[a-zA-Z])[a-zA-Z0-9_ -]*$ | Vendor of the IoT gateway (Try Generic or Generic Windows 64 Bit if not known) | yes |
| model | ^(?=.*[a-zA-Z])[a-zA-Z0-9_ -]*$ | Model of the IoT gateway (try Linux or Win AMD 64bit for Generic or Generic Windows 64 Bit) | yes |
| architecture | ^(?=.*[a-zA-Z])[a-zA-Z0-9_ -]*$ | SO architecture of the IoT gateway (e.g. p37-linux-x86_64, p37-linux-armv7, p36-win-amd64) | yes |
| Location | ^(?=.*[a-zA-Z])[a-zA-Z0-9_ -]*$ | Location name of the new Hypervisor (a list of the available Locations is exposed by another API method) | no |
Hypervisor.getUserHypervisorListFromContainersACL
Retrieves the list of all the IoT Catalyst Hypervisors associated to the Container ACL of the given idLogin
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idLogin | ^[1-9]\d*$ | idLogin of the IoT Catalyst User to retrieve Hypervisor list for | yes |
Hypervisor.getHypervisorsUsedByContainers
Retrieves the list of all the IoT Catalyst Hypervisors that are actually used by at least one Container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
Hypervisor.getLiveStatusByName
Tries to gather the actual live status of an IoT Catalyst Hypervisor identified by its name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| hypervisor_name | ^(?=.*[a-zA-Z])[a-zA-Z0-9_-]*$ | Name of the targeted Hypervisor | yes |
Hypervisor.getLiveStatusById
Tries to gather the actual live status of an IoT Catalyst Hypervisor identified by its Id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHypervisor | ^[0-9]*$ | Id of the targeted Hypervisor | yes |
Hypervisor.deepDeleteById
Performs a deep delete of an IoT Catalyst Hypervisor with the given id. Operation fails if there are containers associated to the Hypervisor. In this case a detach method call is required on each associated container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHypervisor | ^[1-9]\d*$ | Id of the IoT Catalyst Hypervisor | yes |
Hypervisor.deepDeleteByName
Performs a deep delete of an IoT Catalyst Hypervisor with the given name. Operation fails if there are containers associated to the Hypervisor. In this case a detach method call is required on each associated container
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| hypervisor_name | ^(?=.*[a-zA-Z])[a-zA-Z0-9_-]*$ | Name of the targeted Hypervisor | yes |
Hypervisor.detachAllContainersByIdHypervisor
Detach all containers from an IoT Catalyst Hypervisor. After this operation it is possible to delete the IoT Catalyst Hypervisor
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHypervisor | ^[1-9]\d*$ | Id of the IoT Catalyst Hypervisor | yes |
Hypervisor.forceDeleteById
Detach all containers from an IoT Catalyst Hypervisor and performs a deep delete.
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHypervisor | ^[1-9]\d*$ | Id of the IoT Catalyst Hypervisor | yes |
Hypervisor.getAllAvailablePreview
Get all available Hypervisors.
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
HypervisorHostType.getAllAvailable
Gets the list of all the IoT Catalyst Hypervisor Host Types managed by the system
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
Hypervisor.deleteHandshakingLogsByidHypervisor
This method deletes all the handshaking log entries for the selected Hypervisor. It is not reversible
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHypervisor | ^[1-9]\d*$ | Id of the Hypervisor | yes |
Hypervisor.getProvisionCommandsHistoryPreview
Retrieves a list of all the IoT Catalyst Hypervisors
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idHypervisor | ^[1-9]\d*$ | Id of the Hypervisor | yes |
| type | (^raw$|^datatable$|$) | Choose how data will be rendered raw | datatable. If not specified standard rendering is applied | yes |
Location.create
Add a new Location in IoT Catalyst
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| location_name | ^(?=.*[a-zA-Z0-9])[a-zA-Z0-9_\- ]{1,50}$ | Name of the Location | yes |
| location_lon | ^(-?\d+(\.\d+)?)\.\s*(-?\d+(\.\d+)?)$ | Longitude coordinate in Google Maps format | yes |
| location_lat | ^(-?\d+(\.\d+)?)\.\s*(-?\d+(\.\d+)?)$ | Latitude coordinate in Google Maps format | yes |
Location.getAll
Gets all the stored Location
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| type | (^raw$|^datatable$|$) | Choose how data will be rendered raw | datatable. If not specified standard rendering is applied (simple) | no |
Location.get
Gets the Location with the given Id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idLocation | ^[1-9]\d*$ | Id of the IoT Catalyst Location to retrieve | yes |
Location.getByName
Gets the Location with the given Id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[^'^ ]{1,255}$ | Name of the IoT Catalyst Location to retrieve | yes |
Location.deleteByName
Delete a Location
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| location_name | ^[^'^ ]{1,255}$ | Name of the Location to delete. All the resources associated to this Location will be reassigned | yes |
Location.deleteById
Delete a Location
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idLocation | ^[1-9]\d*$ | Id of the Location to delete. All the resources associated to this Location will be reassigned | yes |
LogManager.getLoggingSettings
Retrieve the logging settings stored in logging.ini file on the IoT Catalyst Server
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
LogManager.saveLoggingSettings
Store the logging settings in logging.ini file on the IoT Catalyst Server
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| settings | ^[^']+$* | Is a JSON formatted string containing an array of name/value pairs | yes |
MQTT.createMQTTCertificates
Creates certificates for secure connection to the MQTT broker
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| None |
|---|
MQTT.sendMessage
Sends a MQTT message with QoS=0 and retained flag set to false
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| topic | ^[^']+$ | target topic of the message in the form of /topic/subtopic | yes |
| message | ^[^']+$ | should be a valid JSON message | no |
NotificationServer.getFATAL
Get the FATAL notifications stored during the current session
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
NotificationServer.getINFO
Get the INFO notifications stored during the current session
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
RemoteCacheManager.init
Initialize the RemoteCacheManager
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
RemoteCacheManager.logUpdate
Log the date of the last update occured to an entity table
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| entity | (^hypervisors$|^containers$|^digitalthings$|^locations$) | The entity to log the update for | yes |
RemoteCacheManager.getLastUpdateByEntity
Get the date of the last update occured to an entity table
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| entity | (^hypervisors$|^containers$|^digitalthings$|^locations$) | The entity to log the update for | yes |
RemoteCacheManager.getLastUpdatesOfAllEntities
Get the dates of all the last updates occured to all the manged entititie tables
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
ReservedKeywords.createHypervisor
Insert hypervisor name to validate
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| word | ^[a-zA-Z0-9_ ]*$ | Hypervisor name | yes |
ReservedKeywords.createContainer
Insert container name to validate
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| word | ^[a-zA-Z0-9_]*$ | Container name | yes |
ReservedKeywords.createDigitalThingSetting
Insert setting name for digitalthing to validate
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| word | ^[a-zA-Z][a-zA-Z0-9_]*$ | Setting name | yes |
ReservedKeywords.createDigitalThingFeature
Insert function name for digitalthing to validate
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| word | ^[a-zA-Z][a-zA-Z0-9_]*$ | Feature name | yes |
Snippet.checkIfExists
Check if the Snippet exists
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| category_name | ^[a-zA-Z0-9,_\- ]*$ | Name of the SnippetCategory the snippet is associated to | yes |
| snippet_name | ^[a-zA-Z0-9,_\- ]*$ | Name of the Snippets to check existence | yes |
| userId | ^[a-zA-Z0-9- ] | UserId of the User that is the owner of the snippet | yes |
Snippet.createByNames
Creates a new Snippet. The Snippet Category should exists
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| category_name | ^[a-zA-Z0-9,_\- ]*$ | Category Name to assign to the newly created Snippet | yes |
| snippet_name | ^[a-zA-Z0-9,_\- ]*$ | Name of the Snippet | yes |
| description | ^[a-zA-Z0-9,_\- ]*$ | A brief description for the snippet | yes |
| snippet | . | The actual code content of the snippet | yes |
| userId | ^[a-zA-Z0-9- ] | UserId of the User that is the owner of the new snippet | yes |
| category_code_mirror_mode | ^[a-zA-Z0-9,\/_\- ]*$ | Type of CodeMirror (e.g. python, shell, text/x-sql, toit) | no |
Snippet.update
Update a Snippets
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idSnippet | ^[1-9]\d*$ | Id of the IoT Catalyst Snippet | yes |
| idSnippetCategory | ^[1-9]\d*$ | Id of the IoT Catalyst SnippetCategory | yes |
| snippet_name | ^[a-zA-Z0-9,_\- ]*$ | Name of the Snippet | yes |
| description | ^[a-zA-Z0-9,_\- ]*$ | A brief description for the snippet | yes |
| snippet | . | The actual code content of the snippet | yes |
Snippet.delete
Delete a Snippets
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idSnippet | ^[1-9]\d*$ | Id of the IoT Catalyst Snippet | yes |
Snippet.getAll
Gets all the Snippets
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| type | (^raw$|^datatable$|$) | Choose how data will be rendered raw | datatable. If not specified standard rendering is applied (simple) | no |
Snippet.getAllByUserID
Gets all the Snippets filtered by UserId
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| type | (^raw$|^datatable$|$) | Choose how data will be rendered raw | datatable. If not specified standard rendering is applied (simple) | no |
| userId | ^[a-zA-Z0-9- ] | UserId of the User that is the owner of the new snippet | yes |
Snippet.getAllByCategoryName
Gets the Snippet filtered by Snippet Category Name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| category_name | ^[a-zA-Z0-9,_\- ]*$ | Category Name of the Snippets to retrieve | yes |
Snippet.getAllByCategoryNameAndUserID
Gets the Snippet filtered by Snippet Category Name and UserId
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| category_name | ^[a-zA-Z0-9,_\- ]*$ | Category Name of the Snippets to retrieve | yes |
| userId | ^[a-zA-Z0-9- ] | UserId of the User that is the owner of the new snippet | yes |
Snippet.getAllConsoleCommand
Gets the Snippet filtered by Snippet Category [ConsoleCommand] and UserId
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| category_name | ^[a-zA-Z0-9,_\- ]*$ | Category [ConsoleCommand] of the Snippets to retrieve | no |
| userId | ^[a-zA-Z0-9- ] | UserId of the User that is the owner of the new snippet | yes |
Snippet.getAllByCategoryNameInclusionList
Gets the Snippet filtered by Snippet Category Name
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| include | ^[a-zA-Z0-9,_\-, ]*$ | Category Names of the Snippets to include in the query (comma separeted list) | no |
| exclude | ^[a-zA-Z0-9,_\-, ]*$ | Category Names of the Snippets to exclude from the query (comma separeted list) | no |
| renderAsJSON | (^0$|^1$) | If set to yes, returns all the collected snippets as a single JSON object [0 No , 1 Yes] | no |
SnippetCategory.create
Creates a new Snippet Category.
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[a-zA-Z0-9,_\- ]*$ | Category Name | yes |
| code_mirror_mode | ^[a-zA-Z0-9,\/_\- ]*$ | Type of CodeMirror (e.g. python, shell, text/x-sql, toit) | yes |
| userId | ^[a-zA-Z0-9- ] | UserId of the User that is the owner of the new snippet | yes |
SnippetCategory.update
Update a Snippet Category.
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idSnippetCategory | ^[1-9]\d*$ | Id of the IoT Catalyst SnippetCategory | yes |
| name | ^[a-zA-Z0-9,_\- ]*$ | Category Name | yes |
| code_mirror_mode | ^[a-zA-Z0-9,\/_\- ]*$ | Type of CodeMirror (e.g. python, shell, text/x-sql, toit) | yes |
SnippetCategory.delete
Delete a SnippetCategory
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idSnippetCategory | ^[1-9]\d*$ | Id of the IoT Catalyst Snippet Category | yes |
SnippetCategory.checkIfExists
Check if the SnippetCategories exists
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[a-zA-Z0-9,_\- ]*$ | Name of the Snippet category to check existence | no |
| userId | ^[a-zA-Z0-9- ] | UserId of the User that is the owner of the new snippet | yes |
SnippetCategory.getAll
Gets all the Snippets categories
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| type | (^raw$|^datatable$|$) | Choose how data will be rendered raw | datatable. If not specified standard rendering is applied (simple) | no |
SnippetCategory.getAllByUserID
Gets all the Snippets categories filtered by UserId
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| type | (^raw$|^datatable$|$) | Choose how data will be rendered raw | datatable. If not specified standard rendering is applied (simple) | no |
| userId | ^[a-zA-Z0-9- ] | UserId of the User that is the owner of the new snippet category | yes |
SnippetCategory.getByName
Gets all the Snippets categories
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| name | ^[a-zA-Z0-9,_\- ]*$ | Name of the Snippet category to check existence | yes |
Tags.getAllByIdComponentTagsCloud
Find all component by tags cloud
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idComponentType | ^[0-9]*$ | Specifies the type of IoT Catalyst Component | yes |
| tagsCloud | ^[a-zA-Z0-9,_\- ]*$ | Tags cloud | yes |
| tagsBooleanLogic | ^[A-Z]*$ | Set boolean logic search (AND or OR) [default OR] | no |
Tags.getAllTagsByComponentTypeAndIdEntity
Find all tags by idComponentType and idEntity
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idComponentType | ^[0-9]*$ | Specifies the type of IoT Catalyst Component | yes |
| idEntity | ^[0-9]*$ | Specifies the id of the entity of the given idComponentType | yes |
Tags.getAllTagsByComponentType
Find all tags by component type
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idComponentType | ^[0-9]*$ | Specifies the type of IoT Catalyst Component | yes |
Tags.getAllByIdComponentTagsCloudforHM
Find all component by tags cloud (version for HM system)
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idComponentType | ^[0-9]*$ | Specifies the type of IoT Catalyst Component | yes |
| tagsCloud | ^[a-zA-Z0-9,_\- ]*$ | Tags cloud | yes |
| tagsBooleanLogic | ^[A-Z]*$ | Set boolean logic search (AND or OR) [default OR] | no |
Tags.updateTags
Updates or inserts the tags collection associated to an IoT Catalyst entity
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idComponentType | ^[0-9]*$ | Specifies the type of IoT Catalyst Component | yes |
| idEntity | ^[0-9]*$ | Specifies the id of the entity of the given idComponentType | yes |
| tags | ^[a-zA-Z0-9,_\- ]*$ | Tags cloud | yes |
Tags.deleteTagsByComponentTypeAndIdEntity
Delete the tags collection associated to an IoT Catalyst entity
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
https://{IoTCatalystStudioEndpoint}/api/v2
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idComponentType | ^[0-9]*$ | Specifies the type of IoT Catalyst Component | yes |
| idEntity | ^[0-9]*$ | Specifies the id of the entity of the given idComponentType | yes |
Passport.getPassportFile
Get the content of passport file
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| passport | ^[^']+$ | Passport associated to the IoTCatalyst Studio Compent | yes |
Passport.grant
Grant passport to Studio Component
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idComponent | ^[1-9]\d*$ | Specifies the id of the IoT Catalyst entity the requester depends on | yes |
| idComponentType | ^[1-9]\d*$ | Specifies the type of IoT Catalyst Component | yes |
| idAssociatedContainer | ^[1-9]\d*$ | Specifies the id of the IoT Catalyst associated Container | no |
LongRunningExecutor.poll
Fetch the updated status of a task executed using the LongRunningExecutor
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| task_id | ^[a-zA-Z][a-zA-Z0-9_]*$ | The task id to track | yes |
SettingType.get
Retrieves an Container Setting Type by Id
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| Name | Regex | Description | Mandatory |
|---|---|---|---|
| idSettingType | ^[0-9]*$ | The Setting Type id | yes |
SettingType.getAll
Retrieves all Container Setting Type
Available on:
https://{IoTCatalystStudioEndpoint}/api/v1
PARAMETERS
| None |
|---|
P.IVA/VAT: IT14426491008 © Copyright IoT Catalyst srl - IoT Catalyst 2023 ©