COconductorone
Report

Update

Changed on

Update modifies a report's display name, prompt, or parameter values. Any caller holding this permission may update any report in the tenant; the read-only administrator's role does not carry it.

post/api/v1/reporting/reports/{id}

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/reporting/reports/{id}
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Path parameters

idstring required

The id field.

Request body

descriptionstring

The description field.

displayNamestring

The displayName field.

expectedProgramIdstring

Required with parameter_values. Prevents values prepared for one source version from being installed after an assistant edit advances the report.

parameterValuesobject nullable
promptstring

Editing this does not re-plan, so it may drift from program.planned_from_prompt — that drift is how a stale report is detected.

Response

Successful response

Changes

  • fe943bedf41bRevision changes
    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

  • 918a4e749f56Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      response property report/oneOf[subschema #1: Report]/program/oneOf[subschema #1: Program Ref]/commitId deprecated

    • info

      response property report/oneOf[subschema #1: Report]/program/oneOf[subschema #1: Program Ref]/functionId deprecated