Salesforce - API Salesforce Connect API

Salesforce / Salesforce Connect API / Releases / v42.0

Salesforce Connect API

RELEASED
v42.0 - Released at 2018-10-30 00:00

Use the Salesforce IoT REST API to create and manage your orchestrations and contexts and retrieve usage data. An orchestration is the business logic that processes incoming events by using states. A context specifies the data that the orchestration can access: one or more platform events, and optionally, data from an associated Salesforce object. With the Salesforce IoT REST API, you can create, retrieve, update, and delete your orchestrations and contexts. You can retrieve an orchestration instance, delete an instance, and retrieve traffic data. Other tasks that you can perform with an orchestration include activation and deactivation. Monitor your event and instance usage by retrieving usage data.

See Salesforce IoT REST API Getting Started Guide

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

DELETE

/iot/contexts/{contextId}

GET

/iot/contexts/{contextId}

PUT

/iot/contexts/{contextId}

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

`description`	string	The description of this context.
`events`	array [object]	The events used by this context.
`label`	string	Context label.
`name`	string	Context name.
`referenceData`	array [object]	The datasets that are referenced by this context.
`runtime`	string Allowed values: - `HighVolume` - `Standard`	The runtime for this context.

Responses

200Success

Body

Name	Data Type	Description
`ContextDetailRepresentation`

GET

/iot/contexts

List all contexts that have been defined in your org.

Request

Query

Name	Data Type	Description
`page`	string	For internal use only.
`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.
`runtime`	string Allowed values: - `HighVolume` - `Standard`	The Salesforce IoT runtime used.
`sort`	string Allowed values: - `ContextLabel` - `Label` - `LastModified` - `Status`	Sorting direction, either ascending or descending.
`sortDirection`	string Allowed values: - `Ascending` - `Descending`	Field name to be sorted.

Responses

200Success

Body

Name	Data Type	Description
`ContextCollectionRepresentation`

POST

/iot/contexts

Creates a context.

Request

Body

Name	Data Type	Description
`ContextInputRepresentation`	object	An input representation of a context.

Properties

`description`	string	The description of this context.
`events`	array [object]	The events used by this context.
`label`	string	Context label.
`name`	string	Context name.
`referenceData`	array [object]	The datasets that are referenced by this context.
`runtime`	string Allowed values: - `HighVolume` - `Standard`	The runtime for this context.

Responses

200Success

Body

Name	Data Type	Description
`ContextDetailRepresentation`

GET

/iot/orchestrations/{orchestrationId}/activations/last

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

200Success

Body

Name	Data Type	Description
`OrchestrationActivationDetailRepresentation`

PATCH

/iot/orchestrations/{orchestrationId}/activations/last

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

`options`	object	The orchestration activation options.
`status`	string Allowed values: - `Activating` - `Active` - `Deactivating` - `Error` - `Inactive` - `Unknown`	The orchestration activation status.

Responses

200Success

Body

Name	Data Type	Description
`OrchestrationActivationDetailRepresentation`

GET

/iot/orchestrations/{orchestrationId}/activations/{activationId}

Get activation information for the specified orchestration and activation.

Request

Path

Name	Data Type	Description
`activationId`	string	ID of the activation for which to get details.
`orchestrationId`	string	ID of the orchestration for which to get activation information.

Responses

200Success

Body

Name	Data Type	Description
`OrchestrationActivationDetailRepresentation`

PATCH

/iot/orchestrations/{orchestrationId}/activations/{activationId}

Deactivate the specified orchestration activation. No other updates are supported.

Request

Path

Name	Data Type	Description
`activationId`	string	ID of the activation for which to get details.
`orchestrationId`	string	ID of the orchestration for which to get activation information.

Body

Name	Data Type	Description
`OrchestrationActivationInputRepresentation`	object	An orchestration activation request.

Properties

`options`	object	The orchestration activation options.
`status`	string Allowed values: - `Activating` - `Active` - `Deactivating` - `Error` - `Inactive` - `Unknown`	The orchestration activation status.

Responses

200Success

Body

Name	Data Type	Description
`OrchestrationActivationDetailRepresentation`

GET

/iot/orchestrations/{orchestrationId}/activations

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
`page`	string	For internal use only.
`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.

Responses

200Success

Body

Name	Data Type	Description
`OrchestrationActivationCollectionRepresentation`

POST

/iot/orchestrations/{orchestrationId}/activations

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

`options`	object	The orchestration activation options.
`status`	string Allowed values: - `Activating` - `Active` - `Deactivating` - `Error` - `Inactive` - `Unknown`	The orchestration activation status.

Responses

200Success

Body

Name	Data Type	Description
`OrchestrationActivationDetailRepresentation`

DELETE

/iot/orchestrations/{orchestrationId}/instances/{instanceKey}

Delete the orchestration instance corresponding to the specified orchestration and instance key.

Request

Path

Name	Data Type	Description
`instanceKey`	string	The orchestration instance key. The instanceKey is the value of the event key field.
`orchestrationId`	string	The orchestration instance ID.

Responses

200Success

GET

/iot/orchestrations/{orchestrationId}/instances/{instanceKey}

Get the orchestration instance corresponding to the specified orchestration and instance key.

Request

Path

Name	Data Type	Description
`instanceKey`	string	The orchestration instance key. The instanceKey is the value of the event key field.
`orchestrationId`	string	The orchestration instance ID.

Responses

200Success

Body

Name	Data Type	Description
`OrchestrationInstanceDetailRepresentation`

GET

/iot/orchestrations/{orchestrationId}/metrics/transitions

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

200Success

Body

Name	Data Type	Description
`OrchestrationTransitionCountCollectionRepresentation`	object	A list of orchestration transition counts.

Properties


                        metrics

array [OrchestrationTransitionCountRepresentation]

A list of orchestration transition counts.


                        OrchestrationTransitionCountRepresentation

object

Orchestration transition count.

Properties

`action`	string	Transition action.
`count`	long	Count.
`fromStateId`	integer	From state ID.
`toStateId`	integer	To state ID.

DELETE

/iot/orchestrations/{orchestrationId}

GET

/iot/orchestrations/{orchestrationId}

PUT

/iot/orchestrations/{orchestrationId}

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

`definition`	object	The orchestration definition.
`description`	string	The orchestration description.
`label`	string	The orchestration label.
`name`	string	The orchestration name.
`orchestrationContext`	object	The context that is referenced by this orchestration.

Responses

200Success

Body

Name	Data Type	Description
`OrchestrationDetailRepresentation`

GET

/iot/orchestrations

Get a list of Salesforce IoT orchestrations.

Request

Query

Name	Data Type	Description
`contextId`	string	ID of the context to retrieve.
`page`	string	For internal use only.
`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 contexts.
`runtime`	string Allowed values: - `HighVolume` - `Standard`	The Salesforce IoT runtime used.
`sort`	string Allowed values: - `ContextLabel` - `Label` - `LastModified` - `Status`	Sorting direction, either ascending or descending.
`sortDirection`	string Allowed values: - `Ascending` - `Descending`	Field name to be sorted.

Responses

200Success

Body

Name	Data Type	Description
`OrchestrationCollectionRepresentation`

POST

/iot/orchestrations

Create an IoT orchestration.

Request

Body

Name	Data Type	Description
`OrchestrationInputRepresentation`	object	Input representation of an orchestration.

Properties

`definition`	object	The orchestration definition.
`description`	string	The orchestration description.
`label`	string	The orchestration label.
`name`	string	The orchestration name.
`orchestrationContext`	object	The context that is referenced by this orchestration.

Responses

200Success

Body

Name	Data Type	Description
`OrchestrationDetailRepresentation`

GET

/iot/usage/orchestration-usage

Get usage data for each orchestration in the org, including the number of instances, and the number of processed events per orchestration.

Request

Query

Name	Data Type	Description
`page`	string	For internal use only.
`pageSize`	integer	The number of items 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.

Responses

200Success

Body

Name	Data Type	Description
`OrchestrationUsageCollectionRepresentation`

GET

/iot/usage

Get the current org-level usage and allocations.

Responses

200Success

Body

Name	Data Type	Description
`UsageDetailRepresentation`	object	Current org-level usage information.

Properties


                        allocations

AllocationsRepresentation

Current org-level allocations.


                        AllocationsRepresentation

object

Org-level allocations for the number of events that can be processed.

Properties

`eventAllocation`	AllocationCountRepresentation	Allocation for maximum number of events that can be processed by orchestrations in an org.
`instanceAllocation`	AllocationCountRepresentation	Allocation for maximum number of instances per orchestration.


                        eventUsage

EventUsageRepresentation

Current org-level event usage.


                        EventUsageRepresentation

object

Current org-level event usage.

Properties

`processedEventCount`	long	Number of events processed in the last 24 hours.
`rejectedEventCount`	long	Number of events rejected in the last 24 hours.


                        orchestrationUsageUrl

string

URL for current orchestration usage.

Models

AllocationsRepresentation

ContextCollectionRepresentation

ContextDetailRepresentation

ContextInputRepresentation

EventUsageRepresentation

OrchestrationActivationCollectionRepresentation

OrchestrationActivationDetailRepresentation

OrchestrationActivationInputRepresentation

OrchestrationCollectionRepresentation

OrchestrationDetailRepresentation

OrchestrationInputRepresentation

OrchestrationInstanceDetailRepresentation

OrchestrationTransitionCountCollectionRepresentation

A list of orchestration transition counts.

Properties

Name Data Type Description


                        metrics

array [OrchestrationTransitionCountRepresentation]

A list of orchestration transition counts.


                        OrchestrationTransitionCountRepresentation

object

Orchestration transition count.

Properties

`action`	string	Transition action.
`count`	long	Count.
`fromStateId`	integer	From state ID.
`toStateId`	integer	To state ID.

OrchestrationTransitionCountRepresentation

OrchestrationUsageCollectionRepresentation

UsageDetailRepresentation

Current org-level usage information.

Properties

Name Data Type Description


                        allocations

AllocationsRepresentation

Current org-level allocations.


                        AllocationsRepresentation

object

Org-level allocations for the number of events that can be processed.

Properties

`eventAllocation`	AllocationCountRepresentation	Allocation for maximum number of events that can be processed by orchestrations in an org.
`instanceAllocation`	AllocationCountRepresentation	Allocation for maximum number of instances per orchestration.


                        eventUsage

EventUsageRepresentation

Current org-level event usage.


                        EventUsageRepresentation

object

Current org-level event usage.

Properties

`processedEventCount`	long	Number of events processed in the last 24 hours.
`rejectedEventCount`	long	Number of events rejected in the last 24 hours.


                        orchestrationUsageUrl

string

URL for current orchestration usage.

Authentication

No authentication schemes defined.

Metadata (Technical Details)

API Version 42.0-2018.10.30.10.45

Comments

Loading comments ...