GetWorkflowStates

Gets the states of the given workflow in the appropriate order.

Syntax

// Assumes shellUI has been initialized with IShellUI instance
const results = await shellUI.Vault.ObjectOperations.GetWorkflowStates({
  workflow_id: 0,
  current_state: {
    is_null_value: false,
    type: 15 /* Enum: Datatype */,
    data: {
      acl: {
        checked_out_to_user: 0,
        is_fully_authoritative: false,
        custom_component: {
          named_acl_id: 0,
          has_named_acl: false,
          current_user_id: 0,
          has_current_user: false,
          permissions: [] /* Array of AccessControlEntry */,
          overridability_permissions: [] /* Array of AccessControlEntry */,
          status: {
            all: false,
            deleted: false,
            source_item_linked_via_pseudo_users: false,
          },
        },
        restrictive_components:
          [] /* Array of AccessControlListComponentMapEntry */,
        secondary_access_control_list: {} /* AccessControlList */,
        additive_components:
          [] /* Array of AccessControlListComponentMapEntry */,
      },
    },
  },
  obj_ver: {
    obj_id: {
      type: 0,
      item_id: {
        internal_id: 0,
        external_repository_id: {
          connection: "<connection>",
          item: "<item>",
        },
      },
    },
    version: {
      type: 7 /* Enum: ObjVerVersionType */,
      internal_version: 0,
      external_repository_version: "<external repository version>",
      external_repository_sort_key: 0,
    },
  },
});

Message

Name	Description	Type
workflow_id	The ID of the workflow.	number
current_state	If the pointer is not NULL, it points to a struct that specifies the current state of the object(s) as JSON (represented by MF_TypedValue struct). If the pointer is NULL, the bSelectable flags of all returned states will be true because transition rights cannot be checked in that case.	TypedValue
obj_ver	If the pointer is not NULL, it specifies the object version as JSON for which the state transitions are inquired. If the pointer is NULL, the bSelectable flags of all state transitions that involve pseudo users will be true because transition rights cannot be checked in that case.	ObjVer

Return type

Name	Description	Type
results	States.	StateBasic[]

Example

{
  "results": [] /* Array of StateBasic */
}