dc-management-sdk-js
    Preparing search index...

    Class WorkflowState

    Class representing the WorkflowState resource.

    It is possible to define a list of workflow states on a hub which will allow users to implement one or more rudimentary workflows. Each content item within the hub can have its status set to one of the workflow states defined within the hub.

    In the interest of flexibility, the transitions between states are not validated. In other words, it is possible to transition a content item from any state into any other state.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _links?: Map<string, HalLink>
    color: string

    Assigned colour in the format of rgb(R,G,B)

    createdBy?: string

    Id of the user responsible for originally creating the Workflow State

    createdDate?: string

    Timestamp representing when the Workflow State was originally created in ISO 8601 format

    id?: string

    Unique id generated on creation

    label?: string

    Friendly display label for the WorkflowState

    lastModifiedBy?: string

    Id of the user responsible for the last update to the Workflow State

    lastModifiedDate?: string

    Timestamp representing when the Workflow State was last updated in ISO 8601 format

    related: {
        hub: () => Promise<Hub>;
        update: (mutation: WorkflowState) => Promise<WorkflowState>;
    } = ...

    Resources and actions related to a WorkflowState

    Type declaration

    • hub: () => Promise<Hub>

      Retrieves the Hub this webhook is stored in

    • update: (mutation: WorkflowState) => Promise<WorkflowState>

      Updates this Workflow State with the changes in the mutation parameter.

    Methods

    • POST to an action endpoint with no resource response returned.

      Parameters

      • name: string
      • params: any
      • data: any
      • method: POST | PUT | PATCH = HttpMethod.POST

      Returns Promise<void>