Skip to content

embeddedDeployments.md

Latest commit

 

History

History
215 lines (152 loc) · 8.15 KB

embeddedDeployments.md

File metadata and controls

215 lines (152 loc) · 8.15 KB

Embedded Deployments Actions

Details on the various actions that can be performed on the Embedded Deployments resource, including the expected parameters and the potential responses.

Contents

Export

Request an export of the compiled WASM files for a current deployment

result = client.embedded_deployments.export(applicationId=my_application_id)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. 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, embeddedDeployments.*, or embeddedDeployments.export.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
options Embedded Deployment Export N Export options for embedded deployment Embedded Deployment Export Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
202 Job Enqueued API Result If generation of export was successfully started

Error Responses

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

Get

Returns the embedded deployments for an application

result = client.embedded_deployments.get(applicationId=my_application_id)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. 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, embeddedDeployments.*, or embeddedDeployments.get.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
sortField string N Field to sort the results by. Accepted values are: id, creationDate, lastUpdated lastUpdated creationDate
sortDirection string N Direction to sort the results by. Accepted values are: asc, desc desc asc
page string N Which page of results to return 0 0
perPage string N How many items to return per page 1000 10
deviceId string N Filter deployments to the given Device ID 575ecf887ae143cd83dc4aa2
version string N Filter deployments to the given Workflow Version (matches against both current and desired) myFlowVersion
flowId string N Filter deployments to the given Workflow ID 575ed18f7ae143cd83dc4aa6
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Embedded Deployments Collection of embedded deployments

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if application or device was not found

Release

Deploy an embedded workflow version to one or more embedded devices. Version can be blank, if removal is desired.

result = client.embedded_deployments.release(
    applicationId=my_application_id,
    deployment=my_deployment)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, embeddedDeployments.*, or embeddedDeployments.release.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
deployment Embedded Deployment Release Y Deployment release information Embedded Deployment Release Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
201 Success If deployment release has been initiated successfully

Error Responses

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

Remove

Remove all embedded deployments from a device, remove all embedded deployments of a workflow, or remove a specific workflow from a specific device

result = client.embedded_deployments.remove(
    applicationId=my_application_id,
    deployment=my_deployment)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, embeddedDeployments.*, or embeddedDeployments.remove.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
deployment Embedded Deployment Remove Y Deployment removal information Embedded Deployment Remove Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
201 Success If deployment removal has been initiated successfully

Error Responses

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

Replace

Replace deployments of an embedded workflow version with a new version. New version can be blank, if removal is desired.

result = client.embedded_deployments.replace(
    applicationId=my_application_id,
    deployment=my_deployment)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, embeddedDeployments.*, or embeddedDeployments.replace.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
deployment Embedded Deployment Replace Y Deployment replacement information Embedded Deployment Replace Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
201 Success If deployment replacement has been initiated successfully

Error Responses

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