Sift | Docs
APIReferenceREST (HTTP/JSON)Run service

CreateAdhocRun

Create an adhoc run.

POST
/api/v2/runs:adhoc

Request Body

application/jsonRequired

The request for a call to RunService_CreateAdhocRun to create an adhoc run.

name
Required
string

The name that will be assigned to the new run.

description
Required
string

A description about the new run.

startTime
Required
The time at which data ingestion began for this new run. It must be before the `stop_time`

Format: "date-time"

stopTime
Required
string

The time at which data ingestion concluded for this new run.

Format: "date-time"

assetIds
Required
array<string>

A list of asset IDs to associate with the new run.

tagsarray<string>

Tags to associate with the new run.

metadataarray<object>

The metadata values associated with this run.

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:adhoc" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "startTime": "2019-08-24T14:15:22Z",
    "stopTime": "2019-08-24T14:15:22Z",
    "assetIds": [
      "string"
    ],
    "tags": [
      "string"
    ],
    "metadata": [
      {
        "key": {
          "name": "string",
          "type": "METADATA_KEY_TYPE_UNSPECIFIED",
          "archivedDate": "2019-08-24T14:15:22Z"
        },
        "stringValue": "string",
        "numberValue": 0.1,
        "booleanValue": true,
        "archivedDate": "2019-08-24T14:15:22Z"
      }
    ],
    "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",
    "metadata": [
      {
        "key": {
          "name": "string",
          "type": "METADATA_KEY_TYPE_UNSPECIFIED",
          "archivedDate": "2019-08-24T14:15:22Z"
        },
        "stringValue": "string",
        "numberValue": 0.1,
        "booleanValue": true,
        "archivedDate": "2019-08-24T14:15:22Z"
      }
    ],
    "assetIds": [
      "string"
    ],
    "archivedDate": "2019-08-24T14:15:22Z",
    "isAdhoc": true
  }
}

Previous

ViewJsonRules GET

Next

CreateAutomaticRunAssociationForAssets POST