Skip to main content

Get Work Actions

Obtain actions triggered by scenarios for a given work.

info

Available in Contextal Platform 1.0 and later.

Request​

  • Path: /api/v1/actions/{work_id}
  • Verb: GET
  • URL parameters:
    • maxitems (positive number) = the maximum number of results to return (default 1)
note
  1. Set work_id to the value returned by Submit Work Request

Reply​

On success:

  • Status: 200 - Ok

  • Content-Type: application/json

  • Body: A JSON array of object in the form of:

    {
      "work_id": String (the requested work id)
      "t": Timestamp (the time when the scenarios were applied)
      "actions": [ (the triggered scenario actions)
          {
             "scenario": String (the name of the scenario)
             "ctime": Timestamp (the creation time of the scenario)
             "action": String (the triggered action)
          },
          ....
      ]
    }
note

The objects in the array are sorted from the latest to the earliest

On failure:

  • Status: 5xx