REST API for Clinical One Platform

~~[Deprecated]: Get details of an opened query~~

get

/ec-query-svc/rest/v3.0/studies/{studyId}/{mode}/openQueryDetails

Deprecated: Use latest version instead. Retrieves data related to opened non-candidate queries, based on any combination of the following parameters:

study ID
study mode (Testing, Training, or Production)
subject ID
site ID
visit ID
event ID
form ID
question ID
query state

Additional Filter options can be found in request payload.

Request

Path Parameters

dataElementId(required): string

Get query data for a specific data element.
eventId(required): string

Get query data for a specific visit event.
eventInstanceNumber(required): string

Get query data for a specific event instance number.
formId(required): string

Get query data for a specific form.
formInstanceNumber(required): string

Get query data for a specific form instance number.
limit(required):

Specify the maximum number of queries to return.
mode(required): string

Study mode.
offset(required):

Specify the offset in the query results from which to start returning data
oldest(required):

Order query data in ascending time order if oldest=true. Descending order otherwise.
siteId(required): string

Get query data for a specific site.
state(required): array

Get query data in a specific state.
studyId(required): string

Study ID.
subjectId(required): string

Get query data for a specific subject.
visitId(required): string

Get query data for a specific visit.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object QueryDetailsDTOV3

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/QueryDetailsDTOV3"
    }
}

Nested Schema : QueryDetailsDTOV3

Type: object

Show Source

comments: array comments
eventInstanceNumber: integer (int32)
formId: string (uuid)
formInstanceNumber: integer (int32)
formName: string
id: string (uuid)
itemId: string (uuid)
itemName: string
studyVersion: string
subjectId: string (uuid)
subjectName: string
visitId: string (uuid)
visitName: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "subjectName":{
            "type":"string"
        },
        "visitName":{
            "type":"string"
        },
        "formName":{
            "type":"string"
        },
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "subjectId":{
            "type":"string",
            "format":"uuid"
        },
        "visitId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "itemId":{
            "type":"string",
            "format":"uuid"
        },
        "itemName":{
            "type":"string"
        },
        "comments":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CommentDetailsDTO"
            }
        },
        "eventInstanceNumber":{
            "type":"integer",
            "format":"int32"
        },
        "formInstanceNumber":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : comments

Type: array

Show Source

Array of: object CommentDetailsDTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CommentDetailsDTO"
    }
}

Nested Schema : CommentDetailsDTO

Type: object

Show Source

queryComment: string
state: string

Allowed Values: [ "Candidate", "Opened", "Answered", "Deleted", "Closed" ]
userInfo: object DisplayUserDto
value: string
versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "state":{
            "type":"string",
            "enum":[
                "Candidate",
                "Opened",
                "Answered",
                "Deleted",
                "Closed"
            ]
        },
        "queryComment":{
            "type":"string"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "value":{
            "type":"string"
        },
        "userInfo":{
            "$ref":"#/components/schemas/DisplayUserDto"
        }
    }
}

Nested Schema : DisplayUserDto

Type: object

Show Source

emailAddress: string
firstName: string
id: string (uuid)
lastName: string
userName: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "firstName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "userName":{
            "type":"string"
        },
        "emailAddress":{
            "type":"string"
        }
    }
}

400 Response

Data is invalid.

Root Schema : Response DTO

Type: object

Response from Query APIs

Show Source

errorData: object Error details DTO

Read Only: true

Error details from Query APIs
result: object result

Read Only: true

Result Object
status: string

Read Only: true

Allowed Values: [ "success, failed" ]

Status
version: string

Read Only: true

Response version

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result Object",
            "readOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/Error details DTO"
        },
        "version":{
            "type":"string",
            "description":"Response version",
            "readOnly":true
        }
    },
    "description":"Response from Query APIs"
}

Nested Schema : Error details DTO

Type: object

Read Only: true

Error details from Query APIs

Show Source

details: object details

Read Only: true

Error Details
errorCode: string

Read Only: true

Error Code
errorMessage: string

Read Only: true

Error Message

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Query APIs",
    "readOnly":true
}

Nested Schema : result

Type: object

Read Only: true

Result Object

Nested Schema : details

Type: object

Read Only: true

Error Details

404 Response

The query could not be found.

Root Schema : Response DTO

Type: object

Response from Query APIs

Show Source

errorData: object Error details DTO

Read Only: true

Error details from Query APIs
result: object result

Read Only: true

Result Object
status: string

Read Only: true

Allowed Values: [ "success, failed" ]

Status
version: string

Read Only: true

Response version

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result Object",
            "readOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/Error details DTO"
        },
        "version":{
            "type":"string",
            "description":"Response version",
            "readOnly":true
        }
    },
    "description":"Response from Query APIs"
}

Nested Schema : Error details DTO

Type: object

Read Only: true

Error details from Query APIs

Show Source

details: object details

Read Only: true

Error Details
errorCode: string

Read Only: true

Error Code
errorMessage: string

Read Only: true

Error Message

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Query APIs",
    "readOnly":true
}

Nested Schema : result

Type: object

Read Only: true

Result Object

Nested Schema : details

Type: object

Read Only: true

Error Details