REST API for Clinical One Platform

~~[Deprecated]: Get all historical records on DC_Query table~~

get

/ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/queries/queryTable

Deprecated: Use latest version instead. Retrieves all historical records on all database columns of the DC_Query table in paginated format for a requested studyid and study mode sorted by version_start.

Request

Path Parameters

mode(required): string

Study mode.
studyId(required): string

Study ID.

Query Parameters

limit: integer(int32)

Limit
offset: integer(int32)

Offset
queryId: string

Query ID.
sort: string

Sort Order: desc-descending order, any other value-ascending order.

Default Value: asc

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 QueryDTO Version 6

Title: QueryDTO Version 6

Information for creating/editing query

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

Nested Schema : QueryDTO Version 6

Type: object

Title: QueryDTO Version 6

Information for creating/editing query

Show Source

branchId: string

branch Unique GUID

Example: B2B8327AFAA6412287106192AB5984EF
brancreatorStudyRoleIdchId: string

creatorStudyRole Unique GUID

Example: B2B8327AFAA6412287106192AB5984EF
comment: string

comment

Example: site12
dataElementId: string (uuid)

Data element Unique GUID
discrepancyId: integer

Unique DiscrepancyId

Example: 1
eventId: string (uuid)

Event Unique GUID
eventInstanceNumber: number

Sequence number (0, 1, 2, ...) of repeating event

Example: 0
formId: string (uuid)

Form Unique GUID
formInstanceNumber: number

Sequence number (0, 1, 2, ...) of repeating form

Example: 0
id: string (uuid)

Query Unique GUID
itemId: string

Item Unique GUID

Example: B2B8327AFAA6412287106192AB5984EF
objectVersionNumber: number

Sequence number (0, 1, 2, ...) of object Version Number

Example: 0
operationType: string

operation type

Example: CREATED
queryComment: string

Minimum Length: 1

Maximum Length: 2048

Query comments

Example: Comment
reason: string

reason

Example: Study roles assignment change
ruleId: string (uuid)

rule Unique GUID
siteId: string (uuid)

Site Unique GUID
softwareVersionNumber: number

softwareVersionNumber

Example: 1
state: string

Query state

Example: Opened
studyRoleId: string

studyRole Unique GUID

Example: B2B8327AFAA6412287106192AB5984EF
studyVersionStart: string (date-time)

Data element Version Start
subjectId: string (uuid)

Subject Unique GUID
subjectNumber: string

subjectNumber

Example: site12
userId: string

user Unique GUID

Example: B2B8327AFAA6412287106192AB5984EF
versionEnd: string (date-time)

query Version end
versionStart: string (date-time)

query Version Start

{
    "title":"QueryDTO Version 6",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Query Unique GUID",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"query Version Start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"query Version end",
            "format":"date-time"
        },
        "ruleId":{
            "type":"string",
            "description":"rule Unique GUID",
            "format":"uuid"
        },
        "queryComment":{
            "maxLength":"2048",
            "minLength":"1",
            "type":"string",
            "description":"Query comments",
            "example":"Comment"
        },
        "state":{
            "type":"string",
            "description":"Query state",
            "example":"Opened"
        },
        "subjectId":{
            "type":"string",
            "description":"Subject Unique GUID",
            "format":"uuid"
        },
        "dataElementId":{
            "type":"string",
            "description":"Data element Unique GUID",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Data element Version Start",
            "format":"date-time"
        },
        "formId":{
            "type":"string",
            "description":"Form Unique GUID",
            "format":"uuid"
        },
        "siteId":{
            "type":"string",
            "description":"Site Unique GUID",
            "format":"uuid"
        },
        "eventId":{
            "type":"string",
            "description":"Event Unique GUID",
            "format":"uuid"
        },
        "formInstanceNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of repeating form",
            "example":"0"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of object Version Number",
            "example":"0"
        },
        "itemId":{
            "type":"string",
            "description":"Item Unique GUID",
            "example":"B2B8327AFAA6412287106192AB5984EF"
        },
        "operationType":{
            "type":"string",
            "description":"operation type",
            "example":"CREATED"
        },
        "reason":{
            "type":"string",
            "description":"reason",
            "example":"Study roles assignment change"
        },
        "eventInstanceNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of repeating event",
            "example":"0"
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"softwareVersionNumber",
            "example":"1"
        },
        "subjectNumber":{
            "type":"string",
            "description":"subjectNumber",
            "example":"site12"
        },
        "comment":{
            "type":"string",
            "description":"comment",
            "example":"site12"
        },
        "userId":{
            "type":"string",
            "description":"user Unique GUID",
            "example":"B2B8327AFAA6412287106192AB5984EF"
        },
        "branchId":{
            "type":"string",
            "description":"branch Unique GUID",
            "example":"B2B8327AFAA6412287106192AB5984EF"
        },
        "studyRoleId":{
            "type":"string",
            "description":"studyRole Unique GUID",
            "example":"B2B8327AFAA6412287106192AB5984EF"
        },
        "brancreatorStudyRoleIdchId":{
            "type":"string",
            "description":"creatorStudyRole Unique GUID",
            "example":"B2B8327AFAA6412287106192AB5984EF"
        },
        "discrepancyId":{
            "type":"integer",
            "description":"Unique DiscrepancyId",
            "example":"1"
        }
    },
    "description":"Information for creating/editing query"
}

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