POST api/WorkflowEngine/Worklist/Retrieve?identifier={identifier}

Retrieves the worklist having the given name and matching the criteria in the request.

Request Information

URI Parameters

Name	Description	Type	Additional information
identifier	The identifier.	string	Required

Body Parameters

The request.

TargetDsWorklistRetrieveRequest

Name	Type	Additional information
TargetDataSources	Collection of string	None.
IsVnaMode	boolean	None.
DataSource	string	None.
IsFetchNextStudy	boolean	None.
SessionID	string	None.
Sorts	Collection of ListSort	None.
Offset	integer	None.
Length	integer	None.
GroupBy	ListGroup	None.
OffsetKey	string	None.
AutoCompare	AutoCompareSettings	None.
Filters	Collection of ListFilter	None.
StudyUid	integer	None.
UserLogin	string	None.
WorklistType	WorklistType	None.
Culture	string	None.
GetNonDicomContent	boolean	None.
VnaSetting	VnaSettings	None.

Request Formats

application/json, text/json

Sample:

{
  "TargetDataSources": [
    "sample string 1",
    "sample string 2"
  ],
  "IsVnaMode": true,
  "DataSource": "sample string 2",
  "IsFetchNextStudy": true,
  "SessionID": "sample string 4",
  "Sorts": [
    {
      "Column": "sample string 1",
      "Direction": 1
    },
    {
      "Column": "sample string 1",
      "Direction": 1
    }
  ],
  "Offset": 5,
  "Length": 6,
  "GroupBy": {
    "ItemKey": "sample string 1",
    "Columns": [
      {
        "ColumnName": "sample string 1",
        "GroupType": 0
      },
      {
        "ColumnName": "sample string 1",
        "GroupType": 0
      }
    ]
  },
  "OffsetKey": "sample string 7",
  "AutoCompare": {
    "IsEnabled": true,
    "UserName": "sample string 2",
    "CurrentViewerSettings": {
      "IncludeStudiesNewerThanCurrentStudies": true,
      "MaxNumOfStudies": 2
    },
    "SelectionRules": {
      "SameModality": true,
      "SameProcedureCode": true,
      "RpcAndSameModality": true,
      "RpcAndAnyModality": true,
      "RpcAndSelectedModalities": true,
      "SelectedModalities": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "DateRange": {
      "MinAge": {
        "IsEnabled": true,
        "Interval": 2,
        "Unit": "sample string 3"
      },
      "MaxAge": {
        "IsEnabled": true,
        "Interval": 2,
        "Unit": "sample string 3"
      }
    },
    "SortItemsOption": 0,
    "Studies": [
      {
        "Iuid": "sample string 1",
        "Modality": "sample string 2",
        "StatusCode": "sample string 3",
        "DateTime": "2025-08-02T22:13:03.8641198-05:00",
        "Procedure": {
          "Code": "sample string 1",
          "Description": "sample string 2",
          "Modality": "sample string 3"
        },
        "ImageCount": 1,
        "Datasource": "sample string 4"
      },
      {
        "Iuid": "sample string 1",
        "Modality": "sample string 2",
        "StatusCode": "sample string 3",
        "DateTime": "2025-08-02T22:13:03.8641198-05:00",
        "Procedure": {
          "Code": "sample string 1",
          "Description": "sample string 2",
          "Modality": "sample string 3"
        },
        "ImageCount": 1,
        "Datasource": "sample string 4"
      }
    ],
    "CrDxEquivalence": true,
    "StudyUid": "sample string 4",
    "PatientId": 5,
    "IncludeSlow": true
  },
  "Filters": [
    {
      "Column": "sample string 1",
      "Operator": "sample string 2",
      "Value": "sample string 3",
      "ValueList": [
        "sample string 1",
        "sample string 2"
      ],
      "SecondValue": "sample string 4",
      "IsLocalizable": true,
      "Group": 6
    },
    {
      "Column": "sample string 1",
      "Operator": "sample string 2",
      "Value": "sample string 3",
      "ValueList": [
        "sample string 1",
        "sample string 2"
      ],
      "SecondValue": "sample string 4",
      "IsLocalizable": true,
      "Group": 6
    }
  ],
  "StudyUid": 8,
  "UserLogin": "sample string 9",
  "WorklistType": 0,
  "Culture": "sample string 10",
  "GetNonDicomContent": true,
  "VnaSetting": {
    "QidoApiBaseUrl": "sample string 1",
    "RestApiBaseUrl": "sample string 2",
    "VnaHostName": "sample string 3",
    "VnaAuthorizationUser": "sample string 4",
    "VnaAuthorizationPassword": "sample string 5",
    "TargetOrganizationName": "sample string 6",
    "RetrieveCacheExpirationMinutes": 7,
    "FinalizedStatusCode": 8,
    "DataSourceName": "sample string 9",
    "IsVnaECVConfigured": true,
    "IsVnaICVConfigured": true
  }
}

application/octet-stream

Sample:

{"TargetDataSources":["sample string 1","sample string 2"],"IsVnaMode":true,"DataSource":"sample string 2","IsFetchNextStudy":true,"SessionID":"sample string 4","Sorts":[{"Column":"sample string 1","Direction":1},{"Column":"sample string 1","Direction":1}],"Offset":5,"Length":6,"GroupBy":{"ItemKey":"sample string 1","Columns":[{"ColumnName":"sample string 1","GroupType":0},{"ColumnName":"sample string 1","GroupType":0}]},"OffsetKey":"sample string 7","AutoCompare":{"IsEnabled":true,"UserName":"sample string 2","CurrentViewerSettings":{"IncludeStudiesNewerThanCurrentStudies":true,"MaxNumOfStudies":2},"SelectionRules":{"SameModality":true,"SameProcedureCode":true,"RpcAndSameModality":true,"RpcAndAnyModality":true,"RpcAndSelectedModalities":true,"SelectedModalities":["sample string 1","sample string 2"]},"DateRange":{"MinAge":{"IsEnabled":true,"Interval":2,"Unit":"sample string 3"},"MaxAge":{"IsEnabled":true,"Interval":2,"Unit":"sample string 3"}},"SortItemsOption":0,"Studies":[{"Iuid":"sample string 1","Modality":"sample string 2","StatusCode":"sample string 3","DateTime":"2025-08-02T22:13:03.8641198-05:00","Procedure":{"Code":"sample string 1","Description":"sample string 2","Modality":"sample string 3"},"ImageCount":1,"Datasource":"sample string 4"},{"Iuid":"sample string 1","Modality":"sample string 2","StatusCode":"sample string 3","DateTime":"2025-08-02T22:13:03.8641198-05:00","Procedure":{"Code":"sample string 1","Description":"sample string 2","Modality":"sample string 3"},"ImageCount":1,"Datasource":"sample string 4"}],"CrDxEquivalence":true,"StudyUid":"sample string 4","PatientId":5,"IncludeSlow":true},"Filters":[{"Column":"sample string 1","Operator":"sample string 2","Value":"sample string 3","ValueList":["sample string 1","sample string 2"],"SecondValue":"sample string 4","IsLocalizable":true,"Group":6},{"Column":"sample string 1","Operator":"sample string 2","Value":"sample string 3","ValueList":["sample string 1","sample string 2"],"SecondValue":"sample string 4","IsLocalizable":true,"Group":6}],"StudyUid":8,"UserLogin":"sample string 9","WorklistType":0,"Culture":"sample string 10","GetNonDicomContent":true,"VnaSetting":{"QidoApiBaseUrl":"sample string 1","RestApiBaseUrl":"sample string 2","VnaHostName":"sample string 3","VnaAuthorizationUser":"sample string 4","VnaAuthorizationPassword":"sample string 5","TargetOrganizationName":"sample string 6","RetrieveCacheExpirationMinutes":7,"FinalizedStatusCode":8,"DataSourceName":"sample string 9","IsVnaECVConfigured":true,"IsVnaICVConfigured":true}}

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.