Instance Custom Node Actions

https://api.losant.com/instances/INSTANCE_ID/nodes/INSTANCE_CUSTOM_NODE_ID

Below are the various requests that can be performed against the Instance Custom Node resource, as well as the expected parameters and the potential responses.

Delete

Deletes a Custom Node

Method And Url

DELETE https://api.losant.com/instances/INSTANCE_ID/nodes/INSTANCE_CUSTOM_NODE_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.Instance.bounded, all.User, all.User.bounded, instanceCustomNode.*, or instanceCustomNode.delete.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec7417ae143cd83dc4a96
INSTANCE_CUSTOM_NODE_ID	ID associated with the Custom Node	575ec7417ae143cd83dc4a95

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X DELETE \
    https://api.losant.com/instances/INSTANCE_ID/nodes/INSTANCE_CUSTOM_NODE_ID

Successful Responses

Code	Type	Description
200	Success	If Custom Node was successfully deleted

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if Custom Node was not found

Errors

Get information about errors that occurred during runs of this Custom Node

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/nodes/INSTANCE_CUSTOM_NODE_ID/errors

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceCustomNode.*, or instanceCustomNode.errors.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec7417ae143cd83dc4a96
INSTANCE_CUSTOM_NODE_ID	ID associated with the Custom Node	575ec7417ae143cd83dc4a95

Request Query Parameters

Name	Required	Description	Default	Example
duration	N	Duration of time range in milliseconds	86400000	duration=86400000
end	N	End of time range in milliseconds since epoch	0	end=0
limit	N	Maximum number of errors to return	25	limit=25
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	desc	sortDirection=desc

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/instances/INSTANCE_ID/nodes/INSTANCE_CUSTOM_NODE_ID/errors

Successful Responses

Code	Type	Description
200	Workflow Errors	Custom Node error information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if Custom Node was not found

Get

Retrieves information on a Custom Node

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/nodes/INSTANCE_CUSTOM_NODE_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceCustomNode.*, or instanceCustomNode.get.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec7417ae143cd83dc4a96
INSTANCE_CUSTOM_NODE_ID	ID associated with the Custom Node	575ec7417ae143cd83dc4a95

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/instances/INSTANCE_ID/nodes/INSTANCE_CUSTOM_NODE_ID

Successful Responses

Code	Type	Description
200	Instance Custom Node	Custom Node information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if Custom Node was not found

Patch

Updates information about a Custom Node

Method And Url

PATCH https://api.losant.com/instances/INSTANCE_ID/nodes/INSTANCE_CUSTOM_NODE_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.Instance.bounded, all.User, all.User.bounded, instanceCustomNode.*, or instanceCustomNode.patch.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec7417ae143cd83dc4a96
INSTANCE_CUSTOM_NODE_ID	ID associated with the Custom Node	575ec7417ae143cd83dc4a95

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Instance Custom Node Patch schema. For example, the following would be a valid body for this request:

{
  "name": "My Updated Instance Custom Node",
  "category": "logic"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"name":"My Updated Instance Custom Node","category":"logic"}' \
    https://api.losant.com/instances/INSTANCE_ID/nodes/INSTANCE_CUSTOM_NODE_ID

Successful Responses

Code	Type	Description
200	Instance Custom Node	Updated Custom Node information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if Custom Node was not found

Stats

Get statistics about runs for this Custom Node

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/nodes/INSTANCE_CUSTOM_NODE_ID/stats

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceCustomNode.*, or instanceCustomNode.stats.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec7417ae143cd83dc4a96
INSTANCE_CUSTOM_NODE_ID	ID associated with the Custom Node	575ec7417ae143cd83dc4a95

Request Query Parameters

Name	Required	Description	Default	Example
duration	N	Duration of time range in milliseconds	86400000	duration=86400000
end	N	End of time range in milliseconds since epoch	0	end=0
resolution	N	Resolution in milliseconds	3600000	resolution=3600000

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/instances/INSTANCE_ID/nodes/INSTANCE_CUSTOM_NODE_ID/stats

Successful Responses

Code	Type	Description
200	Workflow Statistics	Statistics for Custom Node runs

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if Custom Node was not found

Schemas

Error

Schema for errors returned by the API

Error Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
type:{} 1 key
▶
message:{} 1 key
▶
validationErrors:{} 2 keys

Error Example

▶
(root){} 2 keys
type:"NotFound"
message:"Application was not found"

Workflow Errors

Workflow run error information

Workflow Errors Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 8 keys
▶
flowVersion:{} 3 keys
▶
flowVersionId:{} 2 keys
▶
deviceId:{} 2 keys
▶
start:{} 2 keys
▶
end:{} 2 keys
▶
limit:{} 1 key
▶
sortDirection:{} 2 keys
▶
errors:{} 2 keys

Workflow Errors Example

▶
(root){} 5 keys
start:"2016-06-03T00:00:00.000Z"
end:"2016-06-04T00:00:00.000Z"
limit:25
sortDirection:"desc"
▶
errors:[] 1 item

Workflow Statistics

Statistics about the runs for a given workflow

Workflow Statistics Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 7 keys
▶
flowVersion:{} 3 keys
▶
flowVersionId:{} 2 keys
▶
deviceId:{} 2 keys
▶
start:{} 2 keys
▶
end:{} 2 keys
▶
resolution:{} 1 key
▶
metrics:{} 2 keys

Workflow Statistics Example

▶
(root){} 4 keys
start:"2016-06-03T00:00:00.000Z"
end:"2016-06-04T00:00:00.000Z"
resolution:86400000
▶
metrics:[] 1 item

Instance Custom Node

Schema for a single Instance Custom Node

Instance Custom Node Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 25 keys
▶
id:{} 2 keys
▶
instanceCustomNodeId:{} 2 keys
▶
instanceId:{} 2 keys
▶
creationDate:{} 2 keys
▶
createdById:{} 2 keys
▶
createdByType:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
lastUpdatedById:{} 2 keys
▶
lastUpdatedByType:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
shortDescription:{} 2 keys
▶
iconData:{} 3 keys
▶
docsUrl:{} 2 keys
▶
category:{} 2 keys
▶
minimumAgentVersion:{} 2 keys
▶
triggers:{} 3 keys
▶
nodes:{} 2 keys
▶
customNodeConfig:{} 4 keys
▶
customNodeSupports:{} 3 keys
▶
sourceApplicationId:{} 2 keys
▶
sourceFlowId:{} 2 keys
▶
sourceFlowVersion:{} 3 keys
▶
stats:{} 3 keys
▶
usage:{} 4 keys

Instance Custom Node Example

▶
(root){} 11 keys
id:"575ed18f7ae143cd83dc4aa6"
instanceCustomNodeId:"575ed18f7ae143cd83dc4aa6"
instanceId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
name:"My Instance Custom Node"
description:"Description of my instance custom node"
▶
triggers:[] 1 item
▶
nodes:[] 1 item
▶
usage:{} 1 key
▶
stats:{} 2 keys

Instance Custom Node Patch

Schema for the body of an Instance Custom Node modification request

Instance Custom Node Patch Schema

▶
(root){} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 11 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
shortDescription:{} 2 keys
▶
iconData:{} 1 key
▶
docsUrl:{} 2 keys
▶
category:{} 2 keys
▶
minimumAgentVersion:{} 2 keys
▶
triggers:{} 2 keys
▶
nodes:{} 2 keys
▶
customNodeConfig:{} 4 keys
▶
customNodeSupports:{} 3 keys
▶
additionalProperties:{} 1 key
maxProperties:25

Instance Custom Node Patch Example

▶
(root){} 2 keys
name:"My Updated Instance Custom Node"
category:"logic"

Success

Schema for reporting a successful operation

Success Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 1 key
▶
success:{} 2 keys

Success Example

▶
(root){} 1 key
success:true