async-run-report-by-id

dci async-run-report-by-id id [flags]

Submits an async execution job for a saved report identified by ID. Returns 202 immediately with a Location header pointing to the operation status endpoint. Requires the Idempotency-Key header. Use ?dryRun=true to validate without creating an operation.

Flags

--dry-run: (boolean)

--time-range: (string)

--start-date: (string format:date)

--end-date: (string format:date)

Output

OK — dry-run only; no operation was created. The X-Dry-Run response header is set to "true".

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

Field	Type	Description
operationId	string	Unique identifier for the operation. Absent on dry-run responses.
status	string	Current lifecycle status of the operation. One of: "pending", "running", "succeeded", "failed", "canceled", "dry_run".
createTime	string (date-time)	Time the operation was created (absent on dry-run).

Raw JSON schema

{
  "type": "object",
  "description": "Response envelope for an async report operation. Returned on 202 (new operation) and 200 (dry-run). On dry-run, operationId is absent and status is \"dry_run\".",
  "properties": {
    "operationId": {
      "type": "string",
      "description": "Unique identifier for the operation. Absent on dry-run responses."
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "running",
        "succeeded",
        "failed",
        "canceled",
        "dry_run"
      ],
      "description": "Current lifecycle status of the operation."
    },
    "createTime": {
      "type": "string",
      "format": "date-time",
      "description": "Time the operation was created (absent on dry-run)."
    }
  }
}

Errors

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status	Exit code	Error code	Meaning
400	30	VALIDATION_ERROR	The arguments or request body were rejected. Review the command's flags and payload.
401	10	AUTHENTICATION_FAILED	Not signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
403	11	PERMISSION_DENIED	The DoiT user or the active customer context does not have access.
404	20	RESOURCE_NOT_FOUND	The requested resource does not exist. Check the identifier argument.
500	40	API_SERVER_ERROR	The API failed to process the request. Retryable; contact DoiT support if it persists.

Aliases: asyncrunreportbyid