Codemode Runs

Retire a generated Artifact view

Changed on

Retires the Artifact view: its status becomes retired, it loses its active revision and useInWorkflow flag, and it is removed from every member's dashboard. Immutable revisions are kept, so activating one later restores the view. Requires manager access to the Workflow.

post/v1/artifact-views/{artifactViewId}/retire

Request

  • Base URL: https://api.openworklabs.com
  • URL: https://api.openworklabs.com/v1/artifact-views/{artifactViewId}/retire
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

artifactViewIdstring required

Response

Artifact view retired.

dataMode'live' | 'snapshot'
idstring required
configObjectIdstring required
titlestring required
descriptionstring nullable required
status'active' | 'retired' required
activeRevisionIdstring nullable required
useInWorkflowboolean
createdAtstring date-time required
updatedAtstring date-time required

Changes