Embedded Deployment Actions

https://api.app.wnology.io/applications/APPLICATION_ID/embedded/deployments/EMBEDDED_DEPLOYMENT_ID

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

Get

Retrieves information on an embedded deployment

Method And Url

GET https://api.app.wnology.io/applications/APPLICATION_ID/embedded/deployments/EMBEDDED_DEPLOYMENT_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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, embeddedDeployment.*, or embeddedDeployment.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EMBEDDED_DEPLOYMENT_ID	ID associated with the embedded deployment	575ed78e7ae143cd83dc4aab

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.app.wnology.io/applications/APPLICATION_ID/embedded/deployments/EMBEDDED_DEPLOYMENT_ID

Successful Responses

Code	Type	Description
200	Embedded Deployment	Embedded deployment information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if embedded deployment was not found

Schemas

Embedded Deployment

Schema for a single deployment of embedded workflows to embedded devices

Embedded Deployment Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 13 keys
▶
id:{} 2 keys
▶
embeddedDeploymentId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
deviceId:{} 2 keys
▶
deviceName:{} 3 keys
▶
deviceConnectionInfo:{} 2 keys
▶
flows:{} 3 keys
▶
currentBundleVersion:{} 3 keys
▶
desiredBundleVersion:{} 3 keys
▶
unknownBundle:{} 1 key
▶
logs:{} 2 keys

Embedded Deployment Example

▶
(root){} 10 keys
id:"5a591be186b70d7b9f9b0954"
embeddedDeploymentId:"5a591be186b70d7b9f9b0954"
applicationId:"575ec8687ae143cd83dc4a97"
▶
flows:{} 1 key
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
currentBundleVersion:"nullVersion"
desiredBundleVersion:"1615500683"
unknownBundle:false
▶
logs:[] 1 item

Error

Schema for errors returned by the API

Error Schema

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

Error Example

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