IRPCObjectOperations.GetWorkflowStateHistory
Vault API / core read session or assertion idempotent
Gets the workflow state history of an object.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/GetWorkflowStateHistory |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-workflow-state-history |
| Request | GetWorkflowStateHistoryRequest |
| Response | GetWorkflowStateHistoryResponse |
| Book and level | Vault API, core |
| Kind | read |
| Session | Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata). |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
Returns the versions of the object in which the workflow state changed, oldest first, each with
its property values. obj_ver can be the LATEST marker. max_history_states_to_return
0 returns all; more_history_states_available tells whether the list was cut.
Request: GetWorkflowStateHistoryRequest
Request for getting workflow state history of an object.
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
obj_ver | ObjVer | The object version. |
obj_ver.obj_id | ObjID | The object. |
obj_ver.obj_id.type | int32 | The object type ID, for example 0 for documents. In a lookup value, the value list ID (for a lookup to objects, the object type ID). |
obj_ver.obj_id.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
obj_ver.version | ObjVerVersion | The version. Usually OBJ_VER_VERSION_TYPE_SPECIFIC with internal_version. |
obj_ver.version.type | ObjVerVersionType | What internal_version means. OBJ_VER_VERSION_TYPE_SPECIFIC for a version number.Values: OBJ_VER_VERSION_TYPE_UNINITIALIZED (0), OBJ_VER_VERSION_TYPE_LATEST (1), OBJ_VER_VERSION_TYPE_ANY (2), OBJ_VER_VERSION_TYPE_ALL (3), OBJ_VER_VERSION_TYPE_SPECIFIC (4), OBJ_VER_VERSION_TYPE_VALUE_LIST_ITEM (6), OBJ_VER_VERSION_TYPE_OBJECT_LEVEL_REFERENCE (7). |
obj_ver.version.internal_version | int32 | The version number, starting from 1, when type is OBJ_VER_VERSION_TYPE_SPECIFIC. The server returns -1 with OBJ_VER_VERSION_TYPE_LATEST. |
obj_ver.version.external_repository_version | string | Used only for objects in external repositories. Leave empty. |
obj_ver.version.external_repository_sort_key | int64 | Used only for objects in external repositories. Leave 0. |
max_history_states_to_return | uint32 | The maximum number of states to return. Zero indicates no limit. |
Response: GetWorkflowStateHistoryResponse
Response for getting workflow state history of an object.
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
history_states[] | repeated ObjVerWithProperties | Object version and its property values. |
history_states[].obj_ver | ObjVer | Object version. |
history_states[].obj_ver.obj_id | ObjID | The object. |
history_states[].obj_ver.version | ObjVerVersion | The version. Usually OBJ_VER_VERSION_TYPE_SPECIFIC with internal_version. |
history_states[].property_values[] | repeated PropertyValue | Properties. |
history_states[].property_values[].property_def | int32 | The property definition ID, for example 0 for "Name or title" or 100 for "Class". |
history_states[].property_values[].value | TypedValue | The value. Its type must match the data type of the property definition. |
more_history_states_available | bool | True if there are more history states available. |