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

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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
identifier

The worklist identifier.

string

Required

Body Parameters

The worklist request.

WorklistQueryRequest
NameDescriptionTypeAdditional information
TargetDataSources

Collection of string

None.

ForceRefresh

boolean

None.

Sorts

Collection of ListSort

None.

DataSource

string

None.

IsWorkflowRequest

boolean

None.

StudyInstanceEuid

string

None.

QueryId

string

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"
  ],
  "ForceRefresh": true,
  "Sorts": [
    {
      "Column": "sample string 1",
      "Direction": 1
    },
    {
      "Column": "sample string 1",
      "Direction": 1
    }
  ],
  "DataSource": "sample string 2",
  "IsWorkflowRequest": true,
  "StudyInstanceEuid": "sample string 4",
  "QueryId": "sample string 5",
  "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": 6,
  "UserLogin": "sample string 7",
  "WorklistType": 0,
  "Culture": "sample string 8",
  "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"],"ForceRefresh":true,"Sorts":[{"Column":"sample string 1","Direction":1},{"Column":"sample string 1","Direction":1}],"DataSource":"sample string 2","IsWorkflowRequest":true,"StudyInstanceEuid":"sample string 4","QueryId":"sample string 5","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":6,"UserLogin":"sample string 7","WorklistType":0,"Culture":"sample string 8","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
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.