GetWorkflowStateHistory

Gets the workflow state history of an object.

Syntax

// Assumes shellUI has been initialized with IShellUI instance
const results = await shellUI.Vault.ObjectOperations.GetWorkflowStateHistory({
  obj_ver: {
    obj_id: {
      type: 0,
      item_id: {
        internal_id: 0,
        external_repository_id: {
          connection: "<!< The external repository connection identifier.>",
          item: "<item>",
        },
      },
    },
    version: {
      type: 7 /* Enum: ObjVerVersionType */,
      internal_version: 0,
      external_repository_version: "<external_repository_version>",
      external_repository_sort_key: 0,
    },
  },
  max_history_states_to_return: 0,
});

Message

Name	Description	Type
obj_ver	The object version.	ObjVer
max_history_states_to_return	The maximum number of states to return. Zero indicates no limit.	number

Return type

Name	Description	Type
history_states	Object version and its property values.	ObjVerWithProperties[]
more_history_states_available	True if there are more history states available.	boolean

Example

{
  "history_states": [] /* Array of ObjVerWithProperties */,
  "more_history_states_available": false
}