UpdateRun

Updates an existing run using using the list of fields specified in `update_mask`.

PATCH

/api/v2/runs

Request Body

application/jsonRequired

The request for a call to RunService_UpdateRun to update an existing run.

`run`
Required
object

`updateMask`
Required
string

The list of fields to be updated. The fields available to be updated are name, description, start_time, stop_time, is_pinned, client_key and tags. Important Note: When updating the start_time, please be aware that if a subsequent data ingestion commences for this run, the start_time will be automatically overwritten and set to the timestamp corresponding to the beginning of the latest run. Additionally, client_key can only be set once either in run creation or in update. Any subsequent attempt to update client_key will result in an error.

curl -X PATCH "<API_URL>/api/v2/runs" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "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"
    },
    "updateMask": "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"
  }
}

Request Body

runRequiredobject

Attributes

updateMaskRequiredstring

Response

`run`
Required
object

`updateMask`
Required
string