GET Requests/GetWorkflowHistory?requestID={requestID}

Gets the workflow history for the specified request.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
requestID

The ID of the request.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Collection of WorkflowHistoryItemDTO
NameDescriptionTypeAdditional information
TaskID

ID of Task

globally unique identifier

None.

TaskName

Task Name

string

None.

UserID

ID of the user

globally unique identifier

None.

UserName

Name of the user

string

None.

UserFullName

Full name of the user

string

None.

Message

Message

string

None.

Date

Date

date

None.

RoutingID

ID of the routing

globally unique identifier

None.

DataMart

DataMart

string

None.

WorkflowActivityID

ID of the Workflow Activity

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "results": [
    {
      "TaskID": "fc92f98f-ec94-47e7-b28a-c59880c069d5",
      "TaskName": "sample string 2",
      "UserID": "2123befc-e547-43d3-9517-a0d0717e59de",
      "UserName": "sample string 4",
      "UserFullName": "sample string 5",
      "Message": "sample string 6",
      "Date": "2024-05-14T01:44:52Z",
      "RoutingID": "3b88b378-25e6-4a16-b49b-ecfad54d494c",
      "DataMart": "sample string 8",
      "WorkflowActivityID": "5ba32e18-e443-4ef8-bc5a-13b6e052f66f"
    },
    {
      "TaskID": "fc92f98f-ec94-47e7-b28a-c59880c069d5",
      "TaskName": "sample string 2",
      "UserID": "2123befc-e547-43d3-9517-a0d0717e59de",
      "UserName": "sample string 4",
      "UserFullName": "sample string 5",
      "Message": "sample string 6",
      "Date": "2024-05-14T01:44:52Z",
      "RoutingID": "3b88b378-25e6-4a16-b49b-ecfad54d494c",
      "DataMart": "sample string 8",
      "WorkflowActivityID": "5ba32e18-e443-4ef8-bc5a-13b6e052f66f"
    }
  ]
}

text/javascript

Sample:
{"results":[{"TaskID":"fc92f98f-ec94-47e7-b28a-c59880c069d5","TaskName":"sample string 2","UserID":"2123befc-e547-43d3-9517-a0d0717e59de","UserName":"sample string 4","UserFullName":"sample string 5","Message":"sample string 6","Date":"2024-05-14T01:44:52Z","RoutingID":"3b88b378-25e6-4a16-b49b-ecfad54d494c","DataMart":"sample string 8","WorkflowActivityID":"5ba32e18-e443-4ef8-bc5a-13b6e052f66f"},{"TaskID":"fc92f98f-ec94-47e7-b28a-c59880c069d5","TaskName":"sample string 2","UserID":"2123befc-e547-43d3-9517-a0d0717e59de","UserName":"sample string 4","UserFullName":"sample string 5","Message":"sample string 6","Date":"2024-05-14T01:44:52Z","RoutingID":"3b88b378-25e6-4a16-b49b-ecfad54d494c","DataMart":"sample string 8","WorkflowActivityID":"5ba32e18-e443-4ef8-bc5a-13b6e052f66f"}]}

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

application/xml, text/xml

Sample:
<ArrayOfWorkflowHistoryItemDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO">
  <WorkflowHistoryItemDTO>
    <DataMart>sample string 8</DataMart>
    <Date xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T05:44:52.7467893Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </Date>
    <Message>sample string 6</Message>
    <RoutingID>3b88b378-25e6-4a16-b49b-ecfad54d494c</RoutingID>
    <TaskID>fc92f98f-ec94-47e7-b28a-c59880c069d5</TaskID>
    <TaskName>sample string 2</TaskName>
    <UserFullName>sample string 5</UserFullName>
    <UserID>2123befc-e547-43d3-9517-a0d0717e59de</UserID>
    <UserName>sample string 4</UserName>
    <WorkflowActivityID>5ba32e18-e443-4ef8-bc5a-13b6e052f66f</WorkflowActivityID>
  </WorkflowHistoryItemDTO>
  <WorkflowHistoryItemDTO>
    <DataMart>sample string 8</DataMart>
    <Date xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T05:44:52.7467893Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </Date>
    <Message>sample string 6</Message>
    <RoutingID>3b88b378-25e6-4a16-b49b-ecfad54d494c</RoutingID>
    <TaskID>fc92f98f-ec94-47e7-b28a-c59880c069d5</TaskID>
    <TaskName>sample string 2</TaskName>
    <UserFullName>sample string 5</UserFullName>
    <UserID>2123befc-e547-43d3-9517-a0d0717e59de</UserID>
    <UserName>sample string 4</UserName>
    <WorkflowActivityID>5ba32e18-e443-4ef8-bc5a-13b6e052f66f</WorkflowActivityID>
  </WorkflowHistoryItemDTO>
</ArrayOfWorkflowHistoryItemDTO>