REST API for Clinical One Platform

Get the number of queries in a study

get

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

Retrieves a list of all queries by study ID.

Request

Path Parameters

mode(required): string

Study mode.
studyId(required): string

Study ID.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : StudyQueryCountRespDTO v1.0

Type: object

Title: StudyQueryCountRespDTO v1.0

Study Query Count payload

Show Source

errorData: object Error details DTO

Read Only: true

Error details from Query APIs
result: object StudyQueryCountDTO v1.0

Title: StudyQueryCountDTO v1.0

Read Only: true

Study Query Count request payload
status: string

Read Only: true

Allowed Values: [ "success, failed" ]

Status
version: string

Read Only: true

Response version

{
    "title":"StudyQueryCountRespDTO v1.0",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "$ref":"#/components/schemas/StudyQueryCountDTO"
        },
        "errorData":{
            "$ref":"#/components/schemas/Error details DTO"
        },
        "version":{
            "type":"string",
            "description":"Response version",
            "readOnly":true
        }
    },
    "description":"Study Query Count payload"
}

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 : StudyQueryCountDTO v1.0

Type: object

Title: StudyQueryCountDTO v1.0

Read Only: true

Study Query Count request payload

Show Source

answered: integer (int32)

answered query count

Example: 0
candidate: integer (int32)

candidate query count

Example: 1
closed: integer (int32)

closed query count

Example: 1
deleted: integer (int32)

deleted query count

Example: 4
opened: integer (int32)

opened query count

Example: 2

{
    "title":"StudyQueryCountDTO v1.0",
    "type":"object",
    "properties":{
        "candidate":{
            "type":"integer",
            "description":"candidate query count",
            "format":"int32",
            "example":1
        },
        "opened":{
            "type":"integer",
            "description":"opened query count",
            "format":"int32",
            "example":2
        },
        "answered":{
            "type":"integer",
            "description":"answered query count",
            "format":"int32",
            "example":0
        },
        "deleted":{
            "type":"integer",
            "description":"deleted query count",
            "format":"int32",
            "example":4
        },
        "closed":{
            "type":"integer",
            "description":"closed query count",
            "format":"int32",
            "example":1
        }
    },
    "description":"Study Query Count request payload",
    "readOnly":true
}

Nested Schema : details

Type: object

Read Only: true

Error Details

500 Response

Internal server error.

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