API DocsRESTReport service

UpdateReport

Update a report.

PUT
/api/v1/reports

Request Body

application/jsonRequired

report
Required
object

updateMask
Required
string

The list of fields to be updated. The fields available to be updated are archived_date.

curl -X PUT "<API_URL>/api/v1/reports" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "report": {
      "reportId": "string",
      "reportTemplateId": "string",
      "runId": "string",
      "organizationId": "string",
      "name": "string",
      "description": "string",
      "createdByUserId": "string",
      "modifiedByUserId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "summaries": [
        {
          "ruleId": "string",
          "ruleClientKey": "string",
          "ruleVersionId": "string",
          "ruleVersionNumber": 0,
          "reportRuleVersionId": "string",
          "numOpen": 0,
          "numFailed": 0,
          "numPassed": 0,
          "status": "REPORT_RULE_STATUS_UNSPECIFIED",
          "statusDetails": {
            "created": {},
            "live": {},
            "finished": {
              "stdout": "string",
              "stderr": "string"
            },
            "failed": {
              "errorMessage": "string",
              "exitCode": 0,
              "stdout": "string",
              "stderr": "string"
            },
            "canceled": {},
            "error": {
              "errorMessage": "string",
              "exitCode": 0,
              "stdout": "string",
              "stderr": "string"
            }
          },
          "createdDate": "2019-08-24T14:15:22Z",
          "modifiedDate": "2019-08-24T14:15:22Z",
          "assetId": "string",
          "deletedDate": "2019-08-24T14:15:22Z"
        }
      ],
      "tags": [
        {
          "tagName": "string"
        }
      ],
      "rerunFromReportId": "string",
      "jobId": "string",
      "archivedDate": "2019-08-24T14:15:22Z"
    },
    "updateMask": "string"
  }'

A successful response.

{}