This is aDeveloper Previewof our new Salesforce API Explorer. We're collecting feedback to make learning Salesforce APIs even easier.  Send us Feedback!

Salesforce IoT API

Activity

An activity log to monitor context and orchestration events, such as errors and warnings.

Endpoints

This endpoint will return a list of all the activities matching the filter parameters. Optional source record ids can be an array.

URL

get/services/data/v43.0/iot/activities

Query Parameters

Optional

  • sourceIds
    array of strings
    IDs of the source objects to be retrieved.
  • search
    string
    Single-word term search.
  • level
    string
    Activity log level.
  • activityType
    string
    Type of activity.
  • instanceKey
    string
    Orchestration instance key.
  • startTime
    string
    Activity log start-time filter.
  • endTime
    string
    Activity log end-time filter.
  • 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.

Response Body

Retrieved an array of activities satisfying the queried filter parameters.
  • id
    string
    Unique identifier associated with log entry.
  • url
    string
    URL to the /activities/{...} for the specific log entry.
  • type
    string
    Category of activity.
  • level
    string
    Log level of activity.
  • source
    object
    • source.
      id
      string
      18 character identifier or US document ID associated with activity object.
    • source.
      url
      string
      URL link to the definition associated with the requested object.
    • source.
      name
      string
      Name associated with the activity object.
    • source.
      label
      string
      The label.
    • source.
      runtime
      string
      Runtime type associated with the activity.
    • source.
      category
      string
      Nominal category associated with the requested object ID.
  • summary
    string
    Short summary describing the activity.
  • createdBy
    object
    A reference to a user.
    • createdBy.
      id
      string
      The user ID.
    • createdBy.
      name
      string
      The user name.
  • createdDate
    string
    Time the activity was recorded.

Response Format

Retrieved an array of activities satisfying the queried filter parameters.
{
  "id": "string",
  "url": "string",
  "type": "string",
  "level": "string",
  "source": {
    "id": "string",
    "url": "string",
    "name": "string",
    "label": "string",
    "runtime": "string",
    "category": "string"
  },
  "summary": "string",
  "createdBy": {
    "id": "string",
    "name": "string"
  },
  "createdDate": "string"
}