POST Worklist/Retrieve?identifier={identifier}&global={global}

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
global	if set to true [global].	boolean	Default value is False

Body Parameters

The request.

WorklistRetrieveRequest

Name	Description	Type	Additional information
SessionID	Gets or sets the session identifier.	string	None.
Sorts	Gets or sets the query sorts.	Collection of ListSort	None.
Offset	Gets or sets the start position of the list.	integer	None.
Length	Gets or sets the count of records to be retrieved.	integer	None.
GroupBy	Gets or sets the group by type.	ListGroup	None.
OffsetKey	Gets or sets key of the worklist item which should be included in the result, possibly as the first one.	string	None.
AutoCompare	Gets or sets the viewer settings.	AutoCompareSettings	None.
Filters	Gets or sets the query filters.	Collection of ListFilter	None.
StudyUid		integer	None.
UserLogin	Gets or sets the user login.	string	None.
WorklistType	Gets or sets the worklist type indicating whether this request is for a QBE ,Legacy.	WorklistType	None.
Culture	Gets or sets the client culture.	string	None.
GetNonDicomContent		boolean	None.
VnaSetting		VnaSettings	None.

Request Formats

application/json, text/json

Sample:

{
  "SessionID": "sample string 1",
  "Sorts": [
    {
      "Column": "sample string 1",
      "Direction": 1
    },
    {
      "Column": "sample string 1",
      "Direction": 1
    }
  ],
  "Offset": 2,
  "Length": 3,
  "GroupBy": {
    "ItemKey": "sample string 1",
    "Columns": [
      {
        "ColumnName": "sample string 1",
        "GroupType": 0
      },
      {
        "ColumnName": "sample string 1",
        "GroupType": 0
      }
    ]
  },
  "OffsetKey": "sample string 4",
  "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": "2026-04-03T20:22:20",
        "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": "2026-04-03T20:22:20",
        "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": 5,
  "UserLogin": "sample string 6",
  "WorklistType": 0,
  "Culture": "sample string 7",
  "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

WorklistRetrieveResult

Name	Description	Type	Additional information
Records	Gets or sets the records.	Collection of IStudy	None.
NumResults	Gets or sets the number of of records based on the filters.	integer	None.
ColumnTypes	Gets or sets the column types.	Dictionary of string [key] and string [value]	None.
LastRefreshed	Gets or sets the last refreshed time.	date	None.
IsCacheExpired	Gets or sets a value indicating whether the cache for this worklist is expired or not.	boolean	None.
Offset	Gets or sets the offset of the first record in the result based on the whole query result.	integer	None.
IsWebQuerySupported		boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Records": null,
  "NumResults": 1,
  "ColumnTypes": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "LastRefreshed": "2026-04-03T20:22:20",
  "IsCacheExpired": true,
  "Offset": 4,
  "IsWebQuerySupported": true
}

application/xml, text/xml

Sample:

<WorklistRetrieveResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.Worklists">
  <IsWebQuerySupported>true</IsWebQuerySupported>
  <ColumnTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ColumnTypes>
  <IsCacheExpired>true</IsCacheExpired>
  <LastRefreshed>2026-04-03T20:22:20.8355182-05:00</LastRefreshed>
  <NumResults>1</NumResults>
  <Offset>4</Offset>
  <Records xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.DAL.Model.Worklist.KnownType" i:nil="true" />
</WorklistRetrieveResult>