POST api/WorkflowEngine/Worklist/FetchNextStudy?identifier={identifier}&clientID={clientID}

Retrieves the next study item having the given name and matching the criteria in the request.

Request Information

URI Parameters

Name	Description	Type	Additional information
identifier	Worklist Name	string	Required
clientID	Unique client identification number.	string	Required

Body Parameters

Parameters required to filter,sort and get next study item

WorklistFetchNextStudyRequest

Name	Type	Additional information
TargetDataSources	Collection of string	None.
OffsetCriteria	Collection of ListFilter	None.
Sorts	Collection of ListSort	None.
Skip	boolean	None.
PickFromTop	boolean	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"
  ],
  "OffsetCriteria": [
    {
      "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
    }
  ],
  "Sorts": [
    {
      "Column": "sample string 1",
      "Direction": 1
    },
    {
      "Column": "sample string 1",
      "Direction": 1
    }
  ],
  "Skip": true,
  "PickFromTop": 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": 3,
  "UserLogin": "sample string 4",
  "WorklistType": 0,
  "Culture": "sample string 5",
  "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"],"OffsetCriteria":[{"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}],"Sorts":[{"Column":"sample string 1","Direction":1},{"Column":"sample string 1","Direction":1}],"Skip":true,"PickFromTop":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":3,"UserLogin":"sample string 4","WorklistType":0,"Culture":"sample string 5","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

WorklistFetchNextStudyResult

Name	Type	Additional information
Succeeded	boolean	None.
EndOfList	boolean	None.
NextStudy	IStudy	None.

Response Formats

application/json, text/json

Sample:

{
  "Succeeded": true,
  "EndOfList": true,
  "NextStudy": null
}

application/octet-stream

Sample:

{"Succeeded":true,"EndOfList":true,"NextStudy":null}

application/xml, text/xml

Sample:

<WorklistFetchNextStudyResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.Worklists">
  <EndOfList>true</EndOfList>
  <NextStudy xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.DAL.Model.Worklist.KnownType" i:nil="true" />
  <Succeeded>true</Succeeded>
</WorklistFetchNextStudyResult>