API DocsRESTRun service

CreateRun

Create a run.

POST
/api/v2/runs

Request Body

application/jsonRequired

The request of a call to RunService_CreateRuns to create a new run.

name
Required
string

The name that will be assigned to the new run.

description
Required
string

A description about the new run.

tagsarray<string>

Tags to associate with the new run.

startTimestring

The time at which data ingestion begins for this new run. It must be before the stop_time, and it must be provided if a stop_time is provided. Important note: start_time will be automatically computed during data ingestion and will be set based on the timestamp of the data for this run.

Format: "date-time"

stopTimestring

The time at which data ingestion for this new run concludes. Important note: stop_time will be automatically computed during data ingestion and will be set based on the timestamp of the data for this run.

Format: "date-time"

organizationIdstring

An organization ID is only required if the user belongs to multiple organizations.

clientKeystring

An arbitrary user-chosen key that uniquely identifies this run. Optional, though it is recommended to provide.

curl -X POST "<API_URL>/api/v2/runs" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "tags": [
      "string"
    ],
    "startTime": "2019-08-24T14:15:22Z",
    "stopTime": "2019-08-24T14:15:22Z",
    "organizationId": "string",
    "clientKey": "string"
  }'

A successful response.

{
  "run": {
    "runId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "createdByUserId": "string",
    "modifiedByUserId": "string",
    "organizationId": "string",
    "startTime": "2019-08-24T14:15:22Z",
    "stopTime": "2019-08-24T14:15:22Z",
    "isPinned": true,
    "name": "string",
    "description": "string",
    "tags": [
      "string"
    ],
    "defaultReportId": "string",
    "clientKey": "string"
  }
}

Previous

CreateAutomaticRunAssociationForAssets POST

Next

DeleteRun DELETE