Salesforce Connect API


RELEASED
v45.0 - Released at 2018-12-14 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

GET
/iot/activities/{id}
GET
/iot/activities
GET
/iot/contexts/{contextId}/activations/active
GET
/iot/contexts/{contextId}/activations/last
GET
/iot/contexts/{contextId}/activations/{activationId}
GET
/iot/contexts/{contextId}/activations
POST
/iot/contexts/{contextId}/activations
GET
/iot/contexts/{contextId}/events
DELETE
/iot/contexts/{contextId}
GET
/iot/contexts/{contextId}
PUT
/iot/contexts/{contextId}
GET
/iot/contexts
POST
/iot/contexts
POST
/iot/events/{eventApiName}/{runtime}
GET
/iot/insights/sobjects/{sObjectName}/{recordId}/contexts/{contextIdOrName}/events/{eventName}/fields/{fieldName}
GET
/iot/insights/sobjects/{sObjectName}/{recordId}/contexts/{contextIdOrName}
GET
/iot/orchestrations/{orchestrationId}/activations/last
PATCH
/iot/orchestrations/{orchestrationId}/activations/last
GET
/iot/orchestrations/{orchestrationId}/activations/{activationId}
PATCH
/iot/orchestrations/{orchestrationId}/activations/{activationId}
GET
/iot/orchestrations/{orchestrationId}/activations
POST
/iot/orchestrations/{orchestrationId}/activations
GET
/iot/orchestrations/{orchestrationId}/instances/{instanceKey}/log
DELETE
/iot/orchestrations/{orchestrationId}/instances/{instanceKey}
GET
/iot/orchestrations/{orchestrationId}/instances/{instanceKey}
GET
/iot/orchestrations/{orchestrationId}/instances
GET
/iot/orchestrations/{orchestrationId}/metrics/transitions
GET
/iot/orchestrations/{orchestrationId}/states
DELETE
/iot/orchestrations/{orchestrationId}/trackers/{trackerId}
GET
/iot/orchestrations/{orchestrationId}/trackers/{trackerId}
PATCH
/iot/orchestrations/{orchestrationId}/trackers/{trackerId}
GET
/iot/orchestrations/{orchestrationId}/trackers
POST
/iot/orchestrations/{orchestrationId}/trackers
DELETE
/iot/orchestrations/{orchestrationId}
GET
/iot/orchestrations/{orchestrationId}
PUT
/iot/orchestrations/{orchestrationId}
GET
/iot/orchestrations
POST
/iot/orchestrations
GET
/iot/reference-data/sobjects/{name}
GET
/iot/reference-data/sobjects
GET
/iot/reference-data/wave/{name}
GET
/iot/reference-data/wave
GET
/iot/reference-data
GET
/iot/sobjects/{sObjectName}/{id}/instances
GET
/iot/sobjects/{sObjectName}/{id}/orchestrations/{orchestrationIdOrName}/instance
GET
/iot/usage/orchestration-usage
GET
/iot/usage
GET
/iot

Models

ActivityInfoRepresentation
ActivityLogCollectionRepresentation
ActivityLogRepresentation
AllocationsRepresentation
ContextActivationCollectionRepresentation
ContextActivationDetailRepresentation
ContextActivationInputRepresentation
ContextCollectionRepresentation
ContextDetailRepresentation
ContextInputRepresentation
EventUsageRepresentation
InsightsContextRepresentation
InsightsMetricDetailRepresentation
InsightsMetricSummaryRepresentation
IoTReferenceRepresentation
OrchestrationActivationCollectionRepresentation
OrchestrationActivationDetailRepresentation
OrchestrationActivationInputRepresentation
OrchestrationCollectionRepresentation
OrchestrationContextRuntimeEventCollectionRepresentation
OrchestrationDetailRepresentation
OrchestrationInputRepresentation
OrchestrationInstanceCollectionRepresentation
OrchestrationInstanceDetailCollectionRepresentation
OrchestrationInstanceDetailRepresentation
OrchestrationLogEventCollectionRepresentation
OrchestrationLogEventRepresentation
OrchestrationReferenceDataCollectionRepresentation
OrchestrationSobjectReferenceCollectionRepresentation
OrchestrationSobjectReferenceRepresentation
OrchestrationStateCollectionRepresentation
OrchestrationTrackerCollectionRepresentation
OrchestrationTrackerPatchInputRepresentation
OrchestrationTrackerPostInputRepresentation
OrchestrationTrackerRepresentation
OrchestrationTransitionCountCollectionRepresentation
OrchestrationTransitionCountRepresentation
OrchestrationUsageCollectionRepresentation
OrchestrationWaveDatasetCollectionRepresentation
OrchestrationWaveDatasetDetailRepresentation
PlatformEventCollectionRepresentation
PlatformEventResponseRepresentation
UsageDetailRepresentation

Authentication

No authentication schemes defined.

Metadata (Technical Details)

API Version 45.0-2018.12.14.11.25

Comments

Loading comments ...