The Salesforce IoT REST API enables you to get a list of all activities that correlates to matching filter parameters, return a list of all the activities matching the filter designations, create, retrieve, update, and delete orchestrations, contexts and more. Salesforce is a customer relationship management services company that provides a platform for developers to create and scale trusted applications.
Resources
Single activity record matching ID. This endpoint will return ancillary activity information associated with the activity for the parameterized ID.
Request
Path
| Name | Data Type | Description |
|---|---|---|
id
|
string |
Unique identifier for log entry. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ActivityInfoRepresentation
|
object |
Activity info marker |
Properties
activity
|
ActivityLogRepresentation |
Activity log details |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get a list of all activities correlating to matching filter parameters. This endpoint will return a list of all the activities matching the filter designations. Optional source record IDs can be an array.
Request
Query
| Name | Data Type | Description |
|---|---|---|
startTime
|
string |
Activity log start time filter. |
sourceIds
|
array |
IDs of source objects to be retrieved. |
search
|
string |
Simplistic single-word term search. |
pageSize
|
integer |
Number of items returned in the response. |
page
|
string |
For internal use only. |
level
|
string Allowed values: - Error- Info |
Activity log level. |
instanceKey
|
string |
Event instance key. |
endTime
|
string |
Activity log end time filter. |
activityType
|
string Allowed values: - ContextActivate- ContextDelete- ContextSave- DatasetError- DatasetLoad- DatasetRefresh- EventAllocationsExceeded- EventLimitNotification- InstanceAllocationsExceeded- LoggingStopped- LostEventNotification- OrchestrationActivate- OrchestrationDeactivate- OrchestrationDelete- OrchestrationInstanceLimitNotification- OrchestrationSave- OutputError- TransitionToErrorState- UnexpectedError |
Type of Activity. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ActivityLogCollectionRepresentation
|
object |
A list of activity logs. |
Properties
url
|
string |
URL for the list. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
totalSize
|
integer |
The total number of items in the list., irrespective of the page. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextPageUrl
|
string |
URL to get the next page of contents in the list. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activities
|
array [ActivityLogRepresentation] |
A list of activity logs. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Extends
Information about the items in the list.
Properties
| Name | Data Type | Description |
|---|---|---|
url
|
string |
URL for the list. |
totalSize
|
integer |
The total number of items in the list., irrespective of the page. |
nextPageUrl
|
string |
URL to get the next page of contents in the list. |
Get the active context activation for the context ID.
Request
Path
| Name | Data Type | Description |
|---|---|---|
contextId
|
string |
Context ID. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ContextActivationDetailRepresentation
|
object |
Context activation information. |
Properties
status
|
string Allowed values: - Activating- Active- Error- Inactive- Invalid- Validating |
The status of the context activation resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
runtime
|
string Allowed values: - HighVolume- Standard |
The parent context runtime. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
result
|
ContextActivationResultRepresentation |
A set of results for the activation of a context. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imageScale
|
integer |
The branding asset file size for the deployed image for this context. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imageFile
|
FileAssetRepresentation |
The file information for the deployed branding image for this context. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
definition
|
ContextDefinitionRepresentation |
The parent context definition. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contextUrl
|
string |
The URL of the parent context resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Extends
| Name | Data Type | Description |
|---|---|---|
AbstractContextActivationRepresentation
|
object |
A list of context activation resources. |
Extends
Get the context activation most recently created for the context ID.
Request
Path
| Name | Data Type | Description |
|---|---|---|
contextId
|
string |
Context ID. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ContextActivationDetailRepresentation
|
object |
Context activation information. |
Properties
status
|
string Allowed values: - Activating- Active- Error- Inactive- Invalid- Validating |
The status of the context activation resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
runtime
|
string Allowed values: - HighVolume- Standard |
The parent context runtime. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
result
|
ContextActivationResultRepresentation |
A set of results for the activation of a context. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imageScale
|
integer |
The branding asset file size for the deployed image for this context. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imageFile
|
FileAssetRepresentation |
The file information for the deployed branding image for this context. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
definition
|
ContextDefinitionRepresentation |
The parent context definition. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contextUrl
|
string |
The URL of the parent context resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Extends
| Name | Data Type | Description |
|---|---|---|
AbstractContextActivationRepresentation
|
object |
A list of context activation resources. |
Extends
Get the context activation for the specified IDs.
Request
Path
| Name | Data Type | Description |
|---|---|---|
contextId
|
string |
Context ID. |
activationId
|
string |
Activation ID. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ContextActivationDetailRepresentation
|
object |
Context activation information. |
Properties
status
|
string Allowed values: - Activating- Active- Error- Inactive- Invalid- Validating |
The status of the context activation resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
runtime
|
string Allowed values: - HighVolume- Standard |
The parent context runtime. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
result
|
ContextActivationResultRepresentation |
A set of results for the activation of a context. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imageScale
|
integer |
The branding asset file size for the deployed image for this context. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imageFile
|
FileAssetRepresentation |
The file information for the deployed branding image for this context. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
definition
|
ContextDefinitionRepresentation |
The parent context definition. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contextUrl
|
string |
The URL of the parent context resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Extends
| Name | Data Type | Description |
|---|---|---|
AbstractContextActivationRepresentation
|
object |
A list of context activation resources. |
Extends
List the history of context activations.
Request
Path
| Name | Data Type | Description |
|---|---|---|
contextId
|
string |
Context ID |
Query
| Name | Data Type | Description |
|---|---|---|
pageSize
|
integer |
Size of response list |
page
|
string |
Page token |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ContextActivationCollectionRepresentation
|
object |
A list of Salesforce IoT context activations. |
Properties
url
|
string |
URL for the list. |
|||||||||||||
totalSize
|
integer |
The total number of items in the list., irrespective of the page. |
|||||||||||||
nextPageUrl
|
string |
URL to get the next page of contents in the list. |
|||||||||||||
activations
|
array [ContextActivationSummaryRepresentation] |
Context activation information. |
|||||||||||||
Properties
Extends
AbstractContextActivationRepresentation
Extends |
|||||||||||||||
Extends
Information about the items in the list.
Properties
| Name | Data Type | Description |
|---|---|---|
url
|
string |
URL for the list. |
totalSize
|
integer |
The total number of items in the list., irrespective of the page. |
nextPageUrl
|
string |
URL to get the next page of contents in the list. |
Activates the context definition for the current context, optionally using activation options.
Request
Path
| Name | Data Type | Description |
|---|---|---|
contextId
|
string |
Context ID |
Body
| Name | Data Type | Description |
|---|---|---|
ContextActivationInputRepresentation
|
object |
An input representation of a context activation. |
Properties
options
|
object |
The options for this context activation. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ContextActivationDetailRepresentation
|
object |
Context activation information. |
Properties
status
|
string Allowed values: - Activating- Active- Error- Inactive- Invalid- Validating |
The status of the context activation resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
runtime
|
string Allowed values: - HighVolume- Standard |
The parent context runtime. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
result
|
ContextActivationResultRepresentation |
A set of results for the activation of a context. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imageScale
|
integer |
The branding asset file size for the deployed image for this context. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imageFile
|
FileAssetRepresentation |
The file information for the deployed branding image for this context. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
definition
|
ContextDefinitionRepresentation |
The parent context definition. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contextUrl
|
string |
The URL of the parent context resource. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Extends
| Name | Data Type | Description |
|---|---|---|
AbstractContextActivationRepresentation
|
object |
A list of context activation resources. |
Extends
Get a list of orchestration context events.
Request
Path
| Name | Data Type | Description |
|---|---|---|
contextId
|
string |
Context ID. |
Query
| Name | Data Type | Description |
|---|---|---|
pageSize
|
integer |
Page size. |
page
|
string |
For internal use only. |
instanceKey
|
string |
Instance key. |
eventType
|
string |
Event type. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationContextRuntimeEventCollectionRepresentation
|
object |
A list of Salesforce IoT orchestration context runtime events. |
Properties
url
|
string |
URL for the list. |
|||||||||||||||||||
totalSize
|
integer |
The total number of items in the list., irrespective of the page. |
|||||||||||||||||||
nextPageUrl
|
string |
URL to get the next page of contents in the list. |
|||||||||||||||||||
orchestrationContextEvents
|
array [OrchestrationContextRuntimeEventRepresentation] |
A list of orchestration context runtime events. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
isThrottled
|
boolean |
Identifies if event consumption is throttled by rate limits. |
|||||||||||||||||||
Extends
Information about the items in the list.
Properties
| Name | Data Type | Description |
|---|---|---|
url
|
string |
URL for the list. |
totalSize
|
integer |
The total number of items in the list., irrespective of the page. |
nextPageUrl
|
string |
URL to get the next page of contents in the list. |
Delete the specified context.
Request
Path
| Name | Data Type | Description |
|---|---|---|
contextId
|
string |
ID of the context to update. |
Responses
Get the specified context.
Request
Path
| Name | Data Type | Description |
|---|---|---|
contextId
|
string |
ID of the context to update. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ContextDetailRepresentation
|
object |
Information about the orchestration context. |
Properties
url
|
string |
The URL of this context. |
||||||||||||||||||||||||||||||||||||||
runtime
|
string Allowed values: - HighVolume- Standard |
The runtime type of this context. |
||||||||||||||||||||||||||||||||||||||
namespace
|
string |
The namespace that this context belongs to. |
||||||||||||||||||||||||||||||||||||||
name
|
string |
The context name. |
||||||||||||||||||||||||||||||||||||||
manageableState
|
string Allowed values: - ManagedBeta- ManagedDeletable- ManagedDeleted- ManagedDeprecated- ManagedInstalled- ManagedReleased- Unmanaged |
The manageableState of this context: released, deleted, deprecated, installed, beta, unmanaged. |
||||||||||||||||||||||||||||||||||||||
lastModifiedDate
|
string |
The date on which this context was last edited. |
||||||||||||||||||||||||||||||||||||||
lastModifiedBy
|
IoTReferenceRepresentation |
The user who last edited this context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
label
|
string |
Context label. |
||||||||||||||||||||||||||||||||||||||
imageScale
|
integer |
The scale percentage of the context branding image. |
||||||||||||||||||||||||||||||||||||||
imageFile
|
FileAssetRepresentation |
The branding asset information for this context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
id
|
string |
The 18-character ID of this context. |
||||||||||||||||||||||||||||||||||||||
description
|
string |
The context description. |
||||||||||||||||||||||||||||||||||||||
createdDate
|
string |
The date on which the context was created. |
||||||||||||||||||||||||||||||||||||||
createdBy
|
IoTReferenceRepresentation |
The user who created this context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
activationStatus
|
string Allowed values: - Activating- Active- Error- Inactive- Invalid- Validating |
The activation status of the context. |
||||||||||||||||||||||||||||||||||||||
validationMessages
|
ContextValidationMessagesRepresentation |
A list of messages generated during context validation. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
referenceData
|
array [OrchestrationContextDatasetRepresentation] |
The reference data for this orchestration context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
orchestrationsUrl
|
string |
The URL of orchestrations using this context. |
||||||||||||||||||||||||||||||||||||||
events
|
array [OrchestrationEventTypeRepresentation] |
The events for this orchestration context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
eventHistory
|
ContextInsightsRepresentation |
Event history setup information for this context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
activationsUrl
|
string |
The URL of activations of this context. |
||||||||||||||||||||||||||||||||||||||
Extends
A list of the properties for this context.
Properties
| Name | Data Type | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
url
|
string |
The URL of this context. |
||||||||||||||||||||||||||||
runtime
|
string Allowed values: - HighVolume- Standard |
The runtime type of this context. |
||||||||||||||||||||||||||||
namespace
|
string |
The namespace that this context belongs to. |
||||||||||||||||||||||||||||
name
|
string |
The context name. |
||||||||||||||||||||||||||||
manageableState
|
string Allowed values: - ManagedBeta- ManagedDeletable- ManagedDeleted- ManagedDeprecated- ManagedInstalled- ManagedReleased- Unmanaged |
The manageableState of this context: released, deleted, deprecated, installed, beta, unmanaged. |
||||||||||||||||||||||||||||
lastModifiedDate
|
string |
The date on which this context was last edited. |
||||||||||||||||||||||||||||
lastModifiedBy
|
IoTReferenceRepresentation |
The user who last edited this context. |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
label
|
string |
Context label. |
||||||||||||||||||||||||||||
imageScale
|
integer |
The scale percentage of the context branding image. |
||||||||||||||||||||||||||||
imageFile
|
FileAssetRepresentation |
The branding asset information for this context. |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
id
|
string |
The 18-character ID of this context. |
||||||||||||||||||||||||||||
description
|
string |
The context description. |
||||||||||||||||||||||||||||
createdDate
|
string |
The date on which the context was created. |
||||||||||||||||||||||||||||
createdBy
|
IoTReferenceRepresentation |
The user who created this context. |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
activationStatus
|
string Allowed values: - Activating- Active- Error- Inactive- Invalid- Validating |
The activation status of the context. |
||||||||||||||||||||||||||||
Update the designated context using the full context definition specified.
Request
Path
| Name | Data Type | Description |
|---|---|---|
contextId
|
string |
ID of the context to update. |
Body
| Name | Data Type | Description |
|---|---|---|
ContextInputRepresentation
|
object |
An input representation of a context. |
Properties
runtime
|
string Allowed values: - HighVolume- Standard |
The runtime for this context. |
referenceData
|
array [object] |
The datasets that are referenced by this context. |
name
|
string |
Context name. |
label
|
string |
Context label. |
imageScale
|
integer |
The fileforce image scale for this context. |
imageName
|
string |
The fileforce image ID for this context. |
events
|
array [object] |
The events used by this context. |
eventHistory
|
object |
The event history metadata to store fields metadata for this context. |
description
|
string |
The description of this context. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ContextDetailRepresentation
|
object |
Information about the orchestration context. |
Properties
url
|
string |
The URL of this context. |
||||||||||||||||||||||||||||||||||||||
runtime
|
string Allowed values: - HighVolume- Standard |
The runtime type of this context. |
||||||||||||||||||||||||||||||||||||||
namespace
|
string |
The namespace that this context belongs to. |
||||||||||||||||||||||||||||||||||||||
name
|
string |
The context name. |
||||||||||||||||||||||||||||||||||||||
manageableState
|
string Allowed values: - ManagedBeta- ManagedDeletable- ManagedDeleted- ManagedDeprecated- ManagedInstalled- ManagedReleased- Unmanaged |
The manageableState of this context: released, deleted, deprecated, installed, beta, unmanaged. |
||||||||||||||||||||||||||||||||||||||
lastModifiedDate
|
string |
The date on which this context was last edited. |
||||||||||||||||||||||||||||||||||||||
lastModifiedBy
|
IoTReferenceRepresentation |
The user who last edited this context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
label
|
string |
Context label. |
||||||||||||||||||||||||||||||||||||||
imageScale
|
integer |
The scale percentage of the context branding image. |
||||||||||||||||||||||||||||||||||||||
imageFile
|
FileAssetRepresentation |
The branding asset information for this context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
id
|
string |
The 18-character ID of this context. |
||||||||||||||||||||||||||||||||||||||
description
|
string |
The context description. |
||||||||||||||||||||||||||||||||||||||
createdDate
|
string |
The date on which the context was created. |
||||||||||||||||||||||||||||||||||||||
createdBy
|
IoTReferenceRepresentation |
The user who created this context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
activationStatus
|
string Allowed values: - Activating- Active- Error- Inactive- Invalid- Validating |
The activation status of the context. |
||||||||||||||||||||||||||||||||||||||
validationMessages
|
ContextValidationMessagesRepresentation |
A list of messages generated during context validation. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
referenceData
|
array [OrchestrationContextDatasetRepresentation] |
The reference data for this orchestration context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
orchestrationsUrl
|
string |
The URL of orchestrations using this context. |
||||||||||||||||||||||||||||||||||||||
events
|
array [OrchestrationEventTypeRepresentation] |
The events for this orchestration context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
eventHistory
|
ContextInsightsRepresentation |
Event history setup information for this context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
activationsUrl
|
string |
The URL of activations of this context. |
||||||||||||||||||||||||||||||||||||||
Extends
A list of the properties for this context.
Properties
| Name | Data Type | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
url
|
string |
The URL of this context. |
||||||||||||||||||||||||||||
runtime
|
string Allowed values: - HighVolume- Standard |
The runtime type of this context. |
||||||||||||||||||||||||||||
namespace
|
string |
The namespace that this context belongs to. |
||||||||||||||||||||||||||||
name
|
string |
The context name. |
||||||||||||||||||||||||||||
manageableState
|
string Allowed values: - ManagedBeta- ManagedDeletable- ManagedDeleted- ManagedDeprecated- ManagedInstalled- ManagedReleased- Unmanaged |
The manageableState of this context: released, deleted, deprecated, installed, beta, unmanaged. |
||||||||||||||||||||||||||||
lastModifiedDate
|
string |
The date on which this context was last edited. |
||||||||||||||||||||||||||||
lastModifiedBy
|
IoTReferenceRepresentation |
The user who last edited this context. |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
label
|
string |
Context label. |
||||||||||||||||||||||||||||
imageScale
|
integer |
The scale percentage of the context branding image. |
||||||||||||||||||||||||||||
imageFile
|
FileAssetRepresentation |
The branding asset information for this context. |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
id
|
string |
The 18-character ID of this context. |
||||||||||||||||||||||||||||
description
|
string |
The context description. |
||||||||||||||||||||||||||||
createdDate
|
string |
The date on which the context was created. |
||||||||||||||||||||||||||||
createdBy
|
IoTReferenceRepresentation |
The user who created this context. |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
activationStatus
|
string Allowed values: - Activating- Active- Error- Inactive- Invalid- Validating |
The activation status of the context. |
||||||||||||||||||||||||||||
List all contexts that have been defined in your org.
Request
Query
| Name | Data Type | Description |
|---|---|---|
sortDirection
|
string Allowed values: - Ascending- Descending |
Field name to be sorted. |
sort
|
string Allowed values: - ContextLabel- Label- LastModified- Status |
Sorting direction, either ascending or descending. |
runtime
|
string Allowed values: - HighVolume- Standard |
The Salesforce IoT runtime used. |
pageSize
|
integer |
The number of contexts returned per page. When one page is returned, it contains the URL in the nextPageUrl property that you use to get the next page of results. |
page
|
string |
For internal use only. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ContextCollectionRepresentation
|
object |
A list of Salesforce IoT contexts. |
Properties
url
|
string |
URL for the list. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
totalSize
|
integer |
The total number of items in the list., irrespective of the page. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextPageUrl
|
string |
URL to get the next page of contents in the list. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contexts
|
array [ContextSummaryRepresentation] |
A list of Salesforce IoT contexts. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
AbstractContextRepresentation
A list of the properties for this context. Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Extends
Information about the items in the list.
Properties
| Name | Data Type | Description |
|---|---|---|
url
|
string |
URL for the list. |
totalSize
|
integer |
The total number of items in the list., irrespective of the page. |
nextPageUrl
|
string |
URL to get the next page of contents in the list. |
Creates a context.
Request
Body
| Name | Data Type | Description |
|---|---|---|
ContextInputRepresentation
|
object |
An input representation of a context. |
Properties
runtime
|
string Allowed values: - HighVolume- Standard |
The runtime for this context. |
referenceData
|
array [object] |
The datasets that are referenced by this context. |
name
|
string |
Context name. |
label
|
string |
Context label. |
imageScale
|
integer |
The fileforce image scale for this context. |
imageName
|
string |
The fileforce image ID for this context. |
events
|
array [object] |
The events used by this context. |
eventHistory
|
object |
The event history metadata to store fields metadata for this context. |
description
|
string |
The description of this context. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ContextDetailRepresentation
|
object |
Information about the orchestration context. |
Properties
url
|
string |
The URL of this context. |
||||||||||||||||||||||||||||||||||||||
runtime
|
string Allowed values: - HighVolume- Standard |
The runtime type of this context. |
||||||||||||||||||||||||||||||||||||||
namespace
|
string |
The namespace that this context belongs to. |
||||||||||||||||||||||||||||||||||||||
name
|
string |
The context name. |
||||||||||||||||||||||||||||||||||||||
manageableState
|
string Allowed values: - ManagedBeta- ManagedDeletable- ManagedDeleted- ManagedDeprecated- ManagedInstalled- ManagedReleased- Unmanaged |
The manageableState of this context: released, deleted, deprecated, installed, beta, unmanaged. |
||||||||||||||||||||||||||||||||||||||
lastModifiedDate
|
string |
The date on which this context was last edited. |
||||||||||||||||||||||||||||||||||||||
lastModifiedBy
|
IoTReferenceRepresentation |
The user who last edited this context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
label
|
string |
Context label. |
||||||||||||||||||||||||||||||||||||||
imageScale
|
integer |
The scale percentage of the context branding image. |
||||||||||||||||||||||||||||||||||||||
imageFile
|
FileAssetRepresentation |
The branding asset information for this context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
id
|
string |
The 18-character ID of this context. |
||||||||||||||||||||||||||||||||||||||
description
|
string |
The context description. |
||||||||||||||||||||||||||||||||||||||
createdDate
|
string |
The date on which the context was created. |
||||||||||||||||||||||||||||||||||||||
createdBy
|
IoTReferenceRepresentation |
The user who created this context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
activationStatus
|
string Allowed values: - Activating- Active- Error- Inactive- Invalid- Validating |
The activation status of the context. |
||||||||||||||||||||||||||||||||||||||
validationMessages
|
ContextValidationMessagesRepresentation |
A list of messages generated during context validation. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
referenceData
|
array [OrchestrationContextDatasetRepresentation] |
The reference data for this orchestration context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
orchestrationsUrl
|
string |
The URL of orchestrations using this context. |
||||||||||||||||||||||||||||||||||||||
events
|
array [OrchestrationEventTypeRepresentation] |
The events for this orchestration context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
eventHistory
|
ContextInsightsRepresentation |
Event history setup information for this context. |
||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||
activationsUrl
|
string |
The URL of activations of this context. |
||||||||||||||||||||||||||||||||||||||
Extends
A list of the properties for this context.
Properties
| Name | Data Type | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
url
|
string |
The URL of this context. |
||||||||||||||||||||||||||||
runtime
|
string Allowed values: - HighVolume- Standard |
The runtime type of this context. |
||||||||||||||||||||||||||||
namespace
|
string |
The namespace that this context belongs to. |
||||||||||||||||||||||||||||
name
|
string |
The context name. |
||||||||||||||||||||||||||||
manageableState
|
string Allowed values: - ManagedBeta- ManagedDeletable- ManagedDeleted- ManagedDeprecated- ManagedInstalled- ManagedReleased- Unmanaged |
The manageableState of this context: released, deleted, deprecated, installed, beta, unmanaged. |
||||||||||||||||||||||||||||
lastModifiedDate
|
string |
The date on which this context was last edited. |
||||||||||||||||||||||||||||
lastModifiedBy
|
IoTReferenceRepresentation |
The user who last edited this context. |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
label
|
string |
Context label. |
||||||||||||||||||||||||||||
imageScale
|
integer |
The scale percentage of the context branding image. |
||||||||||||||||||||||||||||
imageFile
|
FileAssetRepresentation |
The branding asset information for this context. |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
id
|
string |
The 18-character ID of this context. |
||||||||||||||||||||||||||||
description
|
string |
The context description. |
||||||||||||||||||||||||||||
createdDate
|
string |
The date on which the context was created. |
||||||||||||||||||||||||||||
createdBy
|
IoTReferenceRepresentation |
The user who created this context. |
||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||
activationStatus
|
string Allowed values: - Activating- Active- Error- Inactive- Invalid- Validating |
The activation status of the context. |
||||||||||||||||||||||||||||
Publish a platform event message to the provided runtime.
Request
Path
| Name | Data Type | Description |
|---|---|---|
runtime
|
string Allowed values: - HighVolume- Standard |
Runtime to which the event will be sent. |
eventApiName
|
string |
Platform event API name. |
Body
| Name | Data Type | Description |
|---|---|---|
PlatformEventCollectionRepresentation
|
object |
The platform event payload specification. |
Properties
events
|
array [object] |
The batch of events for sender. |
connectedAppName
|
string |
For internal use only. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
PlatformEventResponseRepresentation
|
object |
Response on sending platform event. |
Properties
isSuccess
|
boolean |
Flag indicating event sending success. |
Historical data for this metric, including the context ID, API name, platform event API name, and other SObject data.
Request
Path
| Name | Data Type | Description |
|---|---|---|
sObjectName
|
string |
SObject name |
recordId
|
string |
SObject ID |
fieldName
|
string |
Platform event field API name |
eventName
|
string |
Platform event API name |
contextIdOrName
|
string |
Context ID or API name |
Query
| Name | Data Type | Description |
|---|---|---|
toDate
|
string |
Collect data with timestamp earlier than toDate |
limit
|
integer |
Number of records to retrieve |
fromDate
|
string |
Collect data with timestamp later than fromDate |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
InsightsMetricDetailRepresentation
|
object |
A representation of current and historical data for this object. |
Properties
url
|
string |
URL of the detailed resource including historical values for this metric. |
||||||||||
unit
|
string |
Units for this metric. |
||||||||||
lastModifiedDate
|
string |
Most recent timestamp of this metric. |
||||||||||
label
|
string |
Display label of this metric. |
||||||||||
fieldName
|
string |
The field of the platform event supplying this metric. |
||||||||||
eventName
|
string |
The platform event supplying this metric. |
||||||||||
dataType
|
string Allowed values: - Boolean- DateTime- Number- Object- String |
Data type for this metric. |
||||||||||
currentValue
|
object |
Current values for this metric. |
||||||||||
key
|
string |
Primary key of the data. |
||||||||||
historicalValues
|
InsightsMetricHistoricalValuesRepresentation |
List of current values for this device. |
||||||||||
Properties
|
||||||||||||
contextUrl
|
string |
URL of the detailed resource for this context. |
||||||||||
contextLabel
|
string |
Context label. |
||||||||||
contextId
|
string |
The 18-character context ID. |
||||||||||
Extends
A representation for an Insights metric
Properties
| Name | Data Type | Description |
|---|---|---|
url
|
string |
URL of the detailed resource including historical values for this metric. |
unit
|
string |
Units for this metric. |
lastModifiedDate
|
string |
Most recent timestamp of this metric. |
label
|
string |
Display label of this metric. |
fieldName
|
string |
The field of the platform event supplying this metric. |
eventName
|
string |
The platform event supplying this metric. |
dataType
|
string Allowed values: - Boolean- DateTime- Number- Object- String |
Data type for this metric. |
currentValue
|
object |
Current values for this metric. |
Get current data for this object, including the context ID or API name, SObject ID and SObject name..
Request
Path
| Name | Data Type | Description |
|---|---|---|
sObjectName
|
string |
SObject name |
recordId
|
string |
SObject ID |
contextIdOrName
|
string |
Context ID or API name |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
InsightsContextRepresentation
|
object |
A representation of current data for this object. |
Properties
metrics
|
array [InsightsMetricSummaryRepresentation] |
List of current values for this object. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
AbstractInsightsMetricRepresentation
A representation for an Insights metric Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
key
|
string |
Primary key of the data. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
contextUrl
|
string |
URL of the detailed resource for this context. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
contextLabel
|
string |
Context label. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
contextId
|
string |
The 18-character context ID. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get the orchestration activation that was most recently created for this orchestration ID.
Request
Path
| Name | Data Type | Description |
|---|---|---|
orchestrationId
|
string |
ID of the orchestration to deactivate. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationActivationDetailRepresentation
|
object |
Orchestration activation information, including activation status and URLs of related orchestration resources. |
Properties
status
|
string Allowed values: - Activating- Active- Deactivating- Error- Inactive- Unknown |
The status of the orchestration activation resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orchestrationUrl
|
string |
The URL of the related orchestration resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options
|
OrchestrationActivationOptionsRepresentation |
The orchestration activation options. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
definition
|
OrchestrationDefinitionRepresentation |
The orchestration activation definition. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Extends
| Name | Data Type | Description |
|---|---|---|
AbstractOrchestrationActivationRepresentation
|
object |
A list of orchestration activation resources. |
Extends
Deactivate the specified orchestration. Use only to deactivate an active orchestration.
Request
Path
| Name | Data Type | Description |
|---|---|---|
orchestrationId
|
string |
ID of the orchestration to deactivate. |
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationActivationInputRepresentation
|
object |
An orchestration activation request. |
Properties
status
|
string Allowed values: - Activating- Active- Deactivating- Error- Inactive- Unknown |
The orchestration activation status. |
options
|
object |
The orchestration activation options. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationActivationDetailRepresentation
|
object |
Orchestration activation information, including activation status and URLs of related orchestration resources. |
Properties
status
|
string Allowed values: - Activating- Active- Deactivating- Error- Inactive- Unknown |
The status of the orchestration activation resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orchestrationUrl
|
string |
The URL of the related orchestration resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options
|
OrchestrationActivationOptionsRepresentation |
The orchestration activation options. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
definition
|
OrchestrationDefinitionRepresentation |
The orchestration activation definition. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Extends
| Name | Data Type | Description |
|---|---|---|
AbstractOrchestrationActivationRepresentation
|
object |
A list of orchestration activation resources. |
Extends
Get activation information for the specified orchestration and activation.
Request
Path
| Name | Data Type | Description |
|---|---|---|
orchestrationId
|
string |
ID of the orchestration for which to get activation information. |
activationId
|
string |
ID of the activation for which to get details. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationActivationDetailRepresentation
|
object |
Orchestration activation information, including activation status and URLs of related orchestration resources. |
Properties
status
|
string Allowed values: - Activating- Active- Deactivating- Error- Inactive- Unknown |
The status of the orchestration activation resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orchestrationUrl
|
string |
The URL of the related orchestration resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options
|
OrchestrationActivationOptionsRepresentation |
The orchestration activation options. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
definition
|
OrchestrationDefinitionRepresentation |
The orchestration activation definition. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Extends
| Name | Data Type | Description |
|---|---|---|
AbstractOrchestrationActivationRepresentation
|
object |
A list of orchestration activation resources. |
Extends
Deactivate the specified orchestration activation. No other updates are supported.
Request
Path
| Name | Data Type | Description |
|---|---|---|
orchestrationId
|
string |
ID of the orchestration for which to get activation information. |
activationId
|
string |
ID of the activation for which to get details. |
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationActivationInputRepresentation
|
object |
An orchestration activation request. |
Properties
status
|
string Allowed values: - Activating- Active- Deactivating- Error- Inactive- Unknown |
The orchestration activation status. |
options
|
object |
The orchestration activation options. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationActivationDetailRepresentation
|
object |
Orchestration activation information, including activation status and URLs of related orchestration resources. |
Properties
status
|
string Allowed values: - Activating- Active- Deactivating- Error- Inactive- Unknown |
The status of the orchestration activation resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orchestrationUrl
|
string |
The URL of the related orchestration resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options
|
OrchestrationActivationOptionsRepresentation |
The orchestration activation options. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
definition
|
OrchestrationDefinitionRepresentation |
The orchestration activation definition. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Extends
| Name | Data Type | Description |
|---|---|---|
AbstractOrchestrationActivationRepresentation
|
object |
A list of orchestration activation resources. |
Extends
Get the activation history for the specified orchestration. The activations are sorted by creation date in descending order.
Request
Path
| Name | Data Type | Description |
|---|---|---|
orchestrationId
|
string |
ID of the orchestration for which to get the activation history. |
Query
| Name | Data Type | Description |
|---|---|---|
pageSize
|
integer |
The number of activations returned per page. When a page of the response is returned, it contains the nextPageUrl property which is the URL that you use to get the next page of results. |
page
|
string |
For internal use only. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationActivationCollectionRepresentation
|
object |
A list of Salesforce IoT orchestration activations. |
Properties
url
|
string |
URL for the list. |
|||||||||||||
totalSize
|
integer |
The total number of items in the list., irrespective of the page. |
|||||||||||||
nextPageUrl
|
string |
URL to get the next page of contents in the list. |
|||||||||||||
activations
|
array [OrchestrationActivationSummaryRepresentation] |
A list of Salesforce IoT orchestration activations. |
|||||||||||||
Properties
Extends
AbstractOrchestrationActivationRepresentation
Extends |
|||||||||||||||
Extends
Information about the items in the list.
Properties
| Name | Data Type | Description |
|---|---|---|
url
|
string |
URL for the list. |
totalSize
|
integer |
The total number of items in the list., irrespective of the page. |
nextPageUrl
|
string |
URL to get the next page of contents in the list. |
Activate the specified orchestration, optionally using activation options.
Request
Path
| Name | Data Type | Description |
|---|---|---|
orchestrationId
|
string |
ID of the orchestration for which to get the activation history. |
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationActivationInputRepresentation
|
object |
An orchestration activation request. |
Properties
status
|
string Allowed values: - Activating- Active- Deactivating- Error- Inactive- Unknown |
The orchestration activation status. |
options
|
object |
The orchestration activation options. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationActivationDetailRepresentation
|
object |
Orchestration activation information, including activation status and URLs of related orchestration resources. |
Properties
status
|
string Allowed values: - Activating- Active- Deactivating- Error- Inactive- Unknown |
The status of the orchestration activation resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orchestrationUrl
|
string |
The URL of the related orchestration resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options
|
OrchestrationActivationOptionsRepresentation |
The orchestration activation options. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
definition
|
OrchestrationDefinitionRepresentation |
The orchestration activation definition. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Extends
| Name | Data Type | Description |
|---|---|---|
AbstractOrchestrationActivationRepresentation
|
object |
A list of orchestration activation resources. |
Extends
Get a list of orchestration log events.
Request
Path
| Name | Data Type | Description |
|---|---|---|
orchestrationId
|
string |
Orchestration ID. |
instanceKey
|
string |
Orchestration instance key. |
Query
| Name | Data Type | Description |
|---|---|---|
toDate
|
string |
Collect log events, which timestamp is lower than toDate. |
sortDirection
|
string Allowed values: - Ascending- Descending |
Field name to be sorted. |
pageSize
|
integer |
The number of contexts returned per page. When one page is returned, it contains the URL in the nextPageUrl property that you use to get the next page of results. |
page
|
string |
Page token. |
fromDate
|
string |
Collect log events, which timestamp is higher than fromDate. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationLogEventCollectionRepresentation
|
object |
A list of orchestration log events. |
Properties
url
|
string |
URL for the list of events. |
||||||||||||||||||||||
prevPageUrl
|
string |
URL for the previous page of contents in the list. |
||||||||||||||||||||||
nextPageUrl
|
string |
URL for the next page of orchestration log events. |
||||||||||||||||||||||
log
|
array [OrchestrationLogEventRepresentation] |
Orchestration log events. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
Delete the orchestration instance corresponding to the specified orchestration and instance key.
Request
Path
| Name | Data Type | Description |
|---|---|---|
orchestrationId
|
string |
The orchestration instance ID. |
instanceKey
|
string |
The orchestration instance key. The instanceKey is the value of the event key field. |
Responses
Get the orchestration instance corresponding to the specified orchestration and instance key.
Request
Path
| Name | Data Type | Description |
|---|---|---|
orchestrationId
|
string |
The orchestration instance ID. |
instanceKey
|
string |
The orchestration instance key. The instanceKey is the value of the event key field. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationInstanceDetailRepresentation
|
object |
Orchestration instance information. |
Properties
variables
|
array [VariableRepresentation] |
List of variables that are part of the orchestration instance resource. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
orchestrationState
|
OrchestrationInstanceStateRepresentation |
Orchestration state the orchestration instance is currently in. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
orchestrationLabel
|
string |
Orchestration label. |
||||||||||||||||||||||
orchestrationId
|
string |
ID of the orchestration instance resource. |
||||||||||||||||||||||
instanceKey
|
string |
Instance key of the orchestration instance resource. |
||||||||||||||||||||||
Extends
Properties
| Name | Data Type | Description |
|---|---|---|
url
|
string |
The URL of this resource. |
namespace
|
string |
The namespace that this resource belongs to. |
name
|
string |
The resource name. |
lastModifiedDate
|
string |
The date on which this resource was last edited. |
label
|
string |
The resource label. |
id
|
string |
The 18-character ID of the resource. |
description
|
string |
The resource description. |
createdDate
|
string |
The date on which the resource was created. |
Extends
Get the orchestration instances, which can be filtered by state.
Request
Path
| Name | Data Type | Description |
|---|---|---|
orchestrationId
|
string |
Orchestration ID. |
Query
| Name | Data Type | Description |
|---|---|---|
stateId
|
integer |
State ID. |
pageSize
|
integer |
The number of contexts returned per page. When one page is returned, it contains the URL in the nextPageUrl property that you use to get the next page of results. |
page
|
string |
Page token. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationInstanceCollectionRepresentation
|
object |
A list of Salesforce IoT orchestration instances. |
Properties
url
|
string |
URL for the list. |
||||||||||||||||||||||||||||||||||
totalSize
|
integer |
The total number of items in the list., irrespective of the page. |
||||||||||||||||||||||||||||||||||
nextPageUrl
|
string |
URL to get the next page of contents in the list. |
||||||||||||||||||||||||||||||||||
instances
|
array [OrchestrationInstanceSummaryRepresentation] |
A list of Salesforce IoT orchestration instances. |
||||||||||||||||||||||||||||||||||
Properties
Extends
AbstractOrchestrationInstanceRepresentation
Properties
Extends |
||||||||||||||||||||||||||||||||||||
Extends
Information about the items in the list.
Properties
| Name | Data Type | Description |
|---|---|---|
url
|
string |
URL for the list. |
totalSize
|
integer |
The total number of items in the list., irrespective of the page. |
nextPageUrl
|
string |
URL to get the next page of contents in the list. |
Get state transition counts for the specified orchestration.
Request
Path
| Name | Data Type | Description |
|---|---|---|
orchestrationId
|
string |
ID of the orchestration to get transition counts for. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationTransitionCountCollectionRepresentation
|
object |
A list of orchestration transition counts. |
Properties
metrics
|
array [OrchestrationTransitionCountRepresentation] |
A list of orchestration transition counts. |
||||||||||||||||
Properties
|
||||||||||||||||||
Get the orchestration states for the specified orchestration ID.
Request
Path
| Name | Data Type | Description |
|---|---|---|
orchestrationId
|
string |
Orchestration ID. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationStateCollectionRepresentation
|
object |
A list of Salesforce IoT orchestration states. |
Properties
url
|
string |
URL for the list. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
totalSize
|
integer |
The total number of items in the list., irrespective of the page. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextPageUrl
|
string |
URL to get the next page of contents in the list. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
states
|
array [OrchestrationStateSummaryRepresentation] |
The orchestration states in this list. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
AbstractResourceRepresentation
Properties
Extends |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Extends
Information about the items in the list.
Properties
| Name | Data Type | Description |
|---|---|---|
url
|
string |
URL for the list. |
totalSize
|
integer |
The total number of items in the list., irrespective of the page. |
nextPageUrl
|
string |
URL to get the next page of contents in the list. |
Delete the orchestration tracker.
Request
Path
| Name | Data Type | Description |
|---|---|---|
trackerId
|
string |
Tracker ID. |
orchestrationId
|
string |
ID of the tracker's orchestration. |
Responses
Get a list of trackers set up for this orchestration.
Request
Path
| Name | Data Type | Description |
|---|---|---|
trackerId
|
string |
Tracker ID. |
orchestrationId
|
string |
ID of the tracker's orchestration. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationTrackerRepresentation
|
object |
Orchestration tracker information. |
Properties
url
|
string |
The URL of this resource. |
|||||||||||||||||||
terminationReason
|
string Allowed values: - Expired- NotApplicable- Throttled |
Termination code. |
|||||||||||||||||||
terminatedDate
|
string |
Terminated date. |
|||||||||||||||||||
terminated
|
boolean |
Tracker termination status. |
|||||||||||||||||||
startDate
|
string |
Tracker start date. |
|||||||||||||||||||
orchestrationUrl
|
string |
Orchestration URL. |
|||||||||||||||||||
lastModifiedDate
|
string |
The date on which the tracker was modified. |
|||||||||||||||||||
lastModifiedBy
|
IoTReferenceRepresentation |
The user who modified this tracker. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
instanceKey
|
string |
Instance key. |
|||||||||||||||||||
id
|
string |
The 18-character ID of this tracker. |
|||||||||||||||||||
expirationDate
|
string |
Expiration date. |
|||||||||||||||||||
createdDate
|
string |
The date on which the resource was created. |
|||||||||||||||||||
createdBy
|
IoTReferenceRepresentation |
The user who created this resource. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
Update the orchestration tracker.
Request
Path
| Name | Data Type | Description |
|---|---|---|
trackerId
|
string |
Tracker ID. |
orchestrationId
|
string |
ID of the tracker's orchestration. |
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationTrackerPatchInputRepresentation
|
object |
Input representation of the tracker for PATCH requests. |
Properties
startDate
|
string |
Start date. |
expirationDate
|
string |
Expiration date. |
terminated
|
boolean |
Terminated flag. |
Extends
Representation of the tracker that you want to create.
Properties
| Name | Data Type | Description |
|---|---|---|
startDate
|
string |
Start date. |
expirationDate
|
string |
Expiration date. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationTrackerRepresentation
|
object |
Orchestration tracker information. |
Properties
url
|
string |
The URL of this resource. |
|||||||||||||||||||
terminationReason
|
string Allowed values: - Expired- NotApplicable- Throttled |
Termination code. |
|||||||||||||||||||
terminatedDate
|
string |
Terminated date. |
|||||||||||||||||||
terminated
|
boolean |
Tracker termination status. |
|||||||||||||||||||
startDate
|
string |
Tracker start date. |
|||||||||||||||||||
orchestrationUrl
|
string |
Orchestration URL. |
|||||||||||||||||||
lastModifiedDate
|
string |
The date on which the tracker was modified. |
|||||||||||||||||||
lastModifiedBy
|
IoTReferenceRepresentation |
The user who modified this tracker. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
instanceKey
|
string |
Instance key. |
|||||||||||||||||||
id
|
string |
The 18-character ID of this tracker. |
|||||||||||||||||||
expirationDate
|
string |
Expiration date. |
|||||||||||||||||||
createdDate
|
string |
The date on which the resource was created. |
|||||||||||||||||||
createdBy
|
IoTReferenceRepresentation |
The user who created this resource. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
Get a list of trackers that have been set up for this orchestration.
Request
Path
| Name | Data Type | Description |
|---|---|---|
orchestrationId
|
string |
Orchestration ID. |
Query
| Name | Data Type | Description |
|---|---|---|
pageSize
|
integer |
The number of contexts returned per page. When one page is returned, it contains the URL in the nextPageUrl property that you use to get the next page of results. |
page
|
string |
Page Token |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationTrackerCollectionRepresentation
|
object |
A list of orchestration trackers. |
Properties
url
|
string |
URL for the list. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
totalSize
|
integer |
The total number of items in the list., irrespective of the page. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextPageUrl
|
string |
URL to get the next page of contents in the list. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
trackers
|
array [OrchestrationTrackerRepresentation] |
Orchestration trackers. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Extends
Information about the items in the list.
Properties
| Name | Data Type | Description |
|---|---|---|
url
|
string |
URL for the list. |
totalSize
|
integer |
The total number of items in the list., irrespective of the page. |
nextPageUrl
|
string |
URL to get the next page of contents in the list. |
Create a new orchestration tracker.
Request
Path
| Name | Data Type | Description |
|---|---|---|
orchestrationId
|
string |
Orchestration ID. |
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationTrackerPostInputRepresentation
|
object |
Input representation of the tracker for POST requests |
Properties
startDate
|
string |
Start date. |
expirationDate
|
string |
Expiration date. |
instanceKey
|
string |
Instance key. |
Extends
Representation of the tracker that you want to create.
Properties
| Name | Data Type | Description |
|---|---|---|
startDate
|
string |
Start date. |
expirationDate
|
string |
Expiration date. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationTrackerRepresentation
|
object |
Orchestration tracker information. |
Properties
url
|
string |
The URL of this resource. |
|||||||||||||||||||
terminationReason
|
string Allowed values: - Expired- NotApplicable- Throttled |
Termination code. |
|||||||||||||||||||
terminatedDate
|
string |
Terminated date. |
|||||||||||||||||||
terminated
|
boolean |
Tracker termination status. |
|||||||||||||||||||
startDate
|
string |
Tracker start date. |
|||||||||||||||||||
orchestrationUrl
|
string |
Orchestration URL. |
|||||||||||||||||||
lastModifiedDate
|
string |
The date on which the tracker was modified. |
|||||||||||||||||||
lastModifiedBy
|
IoTReferenceRepresentation |
The user who modified this tracker. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
instanceKey
|
string |
Instance key. |
|||||||||||||||||||
id
|
string |
The 18-character ID of this tracker. |
|||||||||||||||||||
expirationDate
|
string |
Expiration date. |
|||||||||||||||||||
createdDate
|
string |
The date on which the resource was created. |
|||||||||||||||||||
createdBy
|
IoTReferenceRepresentation |
The user who created this resource. |
|||||||||||||||||||
Properties
|
|||||||||||||||||||||
Delete the orchestration with the specified ID.
Request
Path
| Name | Data Type | Description |
|---|---|---|
orchestrationId
|
string |
ID of the orchestration to retrieve. |
Responses
Get the orchestration for the designated ID.
Request
Path
| Name | Data Type | Description |
|---|---|---|
orchestrationId
|
string |
ID of the orchestration to retrieve. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationDetailRepresentation
|
object |
Detailed information about an orchestration. |
Properties
url
|
string |
The URL of this resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
|
string Allowed values: - Activating- Active- Deactivating- Error- Inactive- Unknown |
The activation status of this orchestration. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orchestrationContext
|
ContextReferenceRepresentation |
The context of this resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
namespace
|
string |
The namespace that this resource belongs to. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string |
The name of this resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
manageableState
|
string Allowed values: - ManagedBeta- ManagedDeletable- ManagedDeleted- ManagedDeprecated- ManagedInstalled- ManagedReleased- Unmanaged |
The manageableState of this orchestration: released, deleted, deprecated, installed, beta, unmanaged |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lastModifiedDate
|
string |
The date on which this resource was last edited. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lastModifiedBy
|
IoTReferenceRepresentation |
The user who last edited this resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
label
|
string |
The label for this resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
The 18-character ID of this resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdDate
|
string |
The date on which the resource was created. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdBy
|
IoTReferenceRepresentation |
The user who created this resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
validationMessages
|
OrchestrationValidationMessagesRepresentation |
A list of messages generated while validating the orchestration definition. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transitionMetricsUrl
|
string |
The URL of transitions metrics for this context. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
trackersUrl
|
string |
The URL of trackers for this orchestration. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
extendedMetadata
|
OrchestrationExtendedMetadataRepresentation |
A list of response events with objects that have been defined in the orchestration. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deletedStates
|
array [OrchestrationStateReferenceRepresentation] |
A list of deleted states that are still referenced by active orchestration instances. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
AbstractOrchestrationStateRepresentation
A reference to an orchestration state. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
definition
|
OrchestrationDefinitionRepresentation |
The orchestration definition. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activationsUrl
|
string |
The URL of activations of this orchestration. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Extends
A list of orchestration resources.
Properties
| Name | Data Type | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
url
|
string |
The URL of this resource. |
||||||||||||||||||||||
status
|
string Allowed values: - Activating- Active- Deactivating- Error- Inactive- Unknown |
The activation status of this orchestration. |
||||||||||||||||||||||
orchestrationContext
|
ContextReferenceRepresentation |
The context of this resource. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
namespace
|
string |
The namespace that this resource belongs to. |
||||||||||||||||||||||
name
|
string |
The name of this resource. |
||||||||||||||||||||||
manageableState
|
string Allowed values: - ManagedBeta- ManagedDeletable- ManagedDeleted- ManagedDeprecated- ManagedInstalled- ManagedReleased- Unmanaged |
The manageableState of this orchestration: released, deleted, deprecated, installed, beta, unmanaged |
||||||||||||||||||||||
lastModifiedDate
|
string |
The date on which this resource was last edited. |
||||||||||||||||||||||
lastModifiedBy
|
IoTReferenceRepresentation |
The user who last edited this resource. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
label
|
string |
The label for this resource. |
||||||||||||||||||||||
id
|
string |
The 18-character ID of this resource. |
||||||||||||||||||||||
createdDate
|
string |
The date on which the resource was created. |
||||||||||||||||||||||
createdBy
|
IoTReferenceRepresentation |
The user who created this resource. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
Update the specified orchestration using the full orchestration definition.
Request
Path
| Name | Data Type | Description |
|---|---|---|
orchestrationId
|
string |
ID of the orchestration to retrieve. |
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationInputRepresentation
|
object |
Input representation of an orchestration. |
Properties
orchestrationContext
|
object |
The context that is referenced by this orchestration. |
name
|
string |
The orchestration name. |
label
|
string |
The orchestration label. |
description
|
string |
The orchestration description. |
definition
|
object |
The orchestration definition. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
OrchestrationDetailRepresentation
|
object |
Detailed information about an orchestration. |
Properties
url
|
string |
The URL of this resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status
|
string Allowed values: - Activating- Active- Deactivating- Error- Inactive- Unknown |
The activation status of this orchestration. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orchestrationContext
|
ContextReferenceRepresentation |
The context of this resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
namespace
|
string |
The namespace that this resource belongs to. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name
|
string |
The name of this resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
manageableState
|
string Allowed values: - ManagedBeta- ManagedDeletable- ManagedDeleted- ManagedDeprecated- ManagedInstalled- ManagedReleased- Unmanaged |
The manageableState of this orchestration: released, deleted, deprecated, installed, beta, unmanaged |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lastModifiedDate
|
string |
The date on which this resource was last edited. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lastModifiedBy
|
IoTReferenceRepresentation |
The user who last edited this resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
label
|
string |
The label for this resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id
|
string |
The 18-character ID of this resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdDate
|
string |
The date on which the resource was created. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdBy
|
IoTReferenceRepresentation |
The user who created this resource. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
validationMessages
|
OrchestrationValidationMessagesRepresentation |
A list of messages generated while validating the orchestration definition. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transitionMetricsUrl
|
string |
The URL of transitions metrics for this context. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
trackersUrl
|
string |
The URL of trackers for this orchestration. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
extendedMetadata
|
OrchestrationExtendedMetadataRepresentation |
A list of response events with objects that have been defined in the orchestration. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deletedStates
|
array [OrchestrationStateReferenceRepresentation] |
A list of deleted states that are still referenced by active orchestration instances. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
AbstractOrchestrationStateRepresentation
A reference to an orchestration state. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
definition
|
OrchestrationDefinitionRepresentation |
The orchestration definition. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
activationsUrl
|
string |
The URL of activations of this orchestration. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Extends
A list of orchestration resources.
Properties
| Name | Data Type | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
url
|
string |
The URL of this resource. |
||||||||||||||||||||||
status
|
string Allowed values: - Activating- Active- Deactivating- Error- Inactive- Unknown |
The activation status of this orchestration. |
||||||||||||||||||||||
orchestrationContext
|
ContextReferenceRepresentation |
The context of this resource. |
||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||
namespace
|
string |
The namespace that this resource belongs to. |
||||||||||||||||||||||
name
|
string |
The name of this resource. |
||||||||||||||||||||||
manageableState
|
string Allowed values: - ManagedBeta- ManagedDeletable- ManagedDeleted- ManagedDeprecated- ManagedInstalled- ManagedReleased- Unmanaged |
The manageableState of this orchestration: released, deleted, deprecated, installed, beta, unmanaged |
||||||||||||||||||||||
lastModifiedDate
|
string |
The date on which this resource was last edited. |
||||||||||||||||||||||
lastModifiedBy
|
IoTReferenceRepresentation |
The user who last edited this resource. |
||||||||||||||||||||||
Properties
| ||||||||||||||||||||||||