REST API for Clinical One Cloud Service

v1.0

get

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

Returns aggregated counts for each query lifecycle state for the supplied study and mode. Compared to the previous version, this initial v1.0 release establishes the baseline behaviour because no earlier REST version existed.

Request

Path Parameters

mode(required): string

Study mode. Allowed values: test (testing sandbox), training (training environment), and active (production).
studyId(required): string(uuid)

Clinical One study identifier formatted as a 32 to 36 character GUID.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Returns aggregated counts for every query lifecycle state found in the requested study and mode.

Root Schema : StudyQueryCountRespDTO v1.0

Type: object

Title: StudyQueryCountRespDTO v1.0

Envelope that returns lifecycle totals for queries within a study.

Show Source

errorData: object Error details DTO

Standard structure used to describe errors returned by Query APIs.
result: object StudyQueryCountDTO v1.0

Title: StudyQueryCountDTO v1.0

Payload containing lifecycle totals for queries within a study.
status: string

Read Only: true

Allowed Values: [ "success", "failed" ]

Overall execution status. Value is success when result is populated and failed when errorData is returned.

Example: success
version: string

Read Only: true

Semantic version of the response envelope.

Example: 1

{
    "title":"StudyQueryCountRespDTO v1.0",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Overall execution status. Value is success when result is populated and failed when errorData is returned.",
            "readOnly":true,
            "example":"success",
            "enum":[
                "success",
                "failed"
            ]
        },
        "result":{
            "$ref":"#/components/schemas/StudyQueryCountDTO"
        },
        "errorData":{
            "$ref":"#/components/schemas/Error details DTO"
        },
        "version":{
            "type":"string",
            "description":"Semantic version of the response envelope.",
            "readOnly":true,
            "example":"1"
        }
    },
    "description":"Envelope that returns lifecycle totals for queries within a study."
}

Nested Schema : Error details DTO

Type: object

Standard structure used to describe errors returned by Query APIs.

Show Source

details: object QueryRestErrorDetail

Read Only: true

Context object returned when additional error metadata is available.
errorCode: string

Read Only: true

Machine-readable error code that identifies the failure.

Example: QRY-5000
errorMessage: string

Read Only: true

Human-readable explanation describing why the request failed.

Example: Unexpected server error.

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Machine-readable error code that identifies the failure.",
            "readOnly":true,
            "example":"QRY-5000"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable explanation describing why the request failed.",
            "readOnly":true,
            "example":"Unexpected server error."
        },
        "details":{
            "$ref":"#/components/schemas/QueryRestErrorDetail"
        }
    },
    "description":"Standard structure used to describe errors returned by Query APIs.",
    "example":{
        "errorCode":"QRY-5000",
        "errorMessage":"Unexpected server error.",
        "details":{
            "requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
            "supportCode":"QRY-5000",
            "hint":"Retry request after verifying the study mode."
        }
    }
}

Example:

{
    "errorCode":"QRY-5000",
    "errorMessage":"Unexpected server error.",
    "details":{
        "requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
        "supportCode":"QRY-5000",
        "hint":"Retry request after verifying the study mode."
    }
}

Nested Schema : StudyQueryCountDTO v1.0

Type: object

Title: StudyQueryCountDTO v1.0

Payload containing lifecycle totals for queries within a study.

Show Source

answered: integer (int32)

Number of queries currently in the Answered state. Negative values are not allowed.

Example: 0
candidate: integer (int32)

Number of queries currently in the Candidate state. Negative values are not allowed.

Example: 1
closed: integer (int32)

Number of queries currently in the Closed state. Negative values are not allowed.

Example: 1
deleted: integer (int32)

Number of queries currently in the Deleted state. Negative values are not allowed.

Example: 4
opened: integer (int32)

Number of queries currently in the Open state. Negative values are not allowed.

Example: 2

{
    "title":"StudyQueryCountDTO v1.0",
    "type":"object",
    "properties":{
        "candidate":{
            "type":"integer",
            "description":"Number of queries currently in the Candidate state. Negative values are not allowed.",
            "format":"int32",
            "example":1
        },
        "opened":{
            "type":"integer",
            "description":"Number of queries currently in the Open state. Negative values are not allowed.",
            "format":"int32",
            "example":2
        },
        "answered":{
            "type":"integer",
            "description":"Number of queries currently in the Answered state. Negative values are not allowed.",
            "format":"int32",
            "example":0
        },
        "deleted":{
            "type":"integer",
            "description":"Number of queries currently in the Deleted state. Negative values are not allowed.",
            "format":"int32",
            "example":4
        },
        "closed":{
            "type":"integer",
            "description":"Number of queries currently in the Closed state. Negative values are not allowed.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Payload containing lifecycle totals for queries within a study.",
    "example":{
        "candidate":1,
        "opened":3,
        "answered":2,
        "deleted":0,
        "closed":4
    }
}

Example:

{
    "candidate":1,
    "opened":3,
    "answered":2,
    "deleted":0,
    "closed":4
}

Nested Schema : QueryRestErrorDetail

Type: object

Read Only: true

Context object returned when additional error metadata is available.

Show Source

hint: string

Client-facing guidance that clarifies how to resolve or retry the request.

Example: Retry request after verifying the study mode.
requestId: string

Unique identifier that can be supplied to Oracle Support when troubleshooting.

Example: 3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a
supportCode: string

Support or incident code associated with the error source.

Example: QRY-5000

{
    "type":"object",
    "properties":{
        "requestId":{
            "type":"string",
            "description":"Unique identifier that can be supplied to Oracle Support when troubleshooting.",
            "example":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a"
        },
        "supportCode":{
            "type":"string",
            "description":"Support or incident code associated with the error source.",
            "example":"QRY-5000"
        },
        "hint":{
            "type":"string",
            "description":"Client-facing guidance that clarifies how to resolve or retry the request.",
            "example":"Retry request after verifying the study mode."
        }
    },
    "description":"Context object returned when additional error metadata is available.",
    "readOnly":true,
    "example":{
        "requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
        "supportCode":"QRY-5000",
        "hint":"Retry request"
    }
}

Example:

{
    "requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
    "supportCode":"QRY-5000",
    "hint":"Retry request"
}

Examples

500 Response

Unexpected server error prevented the query count from being returned.

Root Schema : StudyQueryCountRespDTO v1.0

Type: object

Title: StudyQueryCountRespDTO v1.0

Envelope that returns lifecycle totals for queries within a study.

Show Source

errorData: object Error details DTO

Standard structure used to describe errors returned by Query APIs.
result: object StudyQueryCountDTO v1.0

Title: StudyQueryCountDTO v1.0

Payload containing lifecycle totals for queries within a study.
status: string

Read Only: true

Allowed Values: [ "success", "failed" ]

Overall execution status. Value is success when result is populated and failed when errorData is returned.

Example: success
version: string

Read Only: true

Semantic version of the response envelope.

Example: 1

{
    "title":"StudyQueryCountRespDTO v1.0",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Overall execution status. Value is success when result is populated and failed when errorData is returned.",
            "readOnly":true,
            "example":"success",
            "enum":[
                "success",
                "failed"
            ]
        },
        "result":{
            "$ref":"#/components/schemas/StudyQueryCountDTO"
        },
        "errorData":{
            "$ref":"#/components/schemas/Error details DTO"
        },
        "version":{
            "type":"string",
            "description":"Semantic version of the response envelope.",
            "readOnly":true,
            "example":"1"
        }
    },
    "description":"Envelope that returns lifecycle totals for queries within a study."
}

Nested Schema : Error details DTO

Type: object

Standard structure used to describe errors returned by Query APIs.

Show Source

details: object QueryRestErrorDetail

Read Only: true

Context object returned when additional error metadata is available.
errorCode: string

Read Only: true

Machine-readable error code that identifies the failure.

Example: QRY-5000
errorMessage: string

Read Only: true

Human-readable explanation describing why the request failed.

Example: Unexpected server error.

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Machine-readable error code that identifies the failure.",
            "readOnly":true,
            "example":"QRY-5000"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable explanation describing why the request failed.",
            "readOnly":true,
            "example":"Unexpected server error."
        },
        "details":{
            "$ref":"#/components/schemas/QueryRestErrorDetail"
        }
    },
    "description":"Standard structure used to describe errors returned by Query APIs.",
    "example":{
        "errorCode":"QRY-5000",
        "errorMessage":"Unexpected server error.",
        "details":{
            "requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
            "supportCode":"QRY-5000",
            "hint":"Retry request after verifying the study mode."
        }
    }
}

Example:

{
    "errorCode":"QRY-5000",
    "errorMessage":"Unexpected server error.",
    "details":{
        "requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
        "supportCode":"QRY-5000",
        "hint":"Retry request after verifying the study mode."
    }
}

Nested Schema : StudyQueryCountDTO v1.0

Type: object

Title: StudyQueryCountDTO v1.0

Payload containing lifecycle totals for queries within a study.

Show Source

answered: integer (int32)

Number of queries currently in the Answered state. Negative values are not allowed.

Example: 0
candidate: integer (int32)

Number of queries currently in the Candidate state. Negative values are not allowed.

Example: 1
closed: integer (int32)

Number of queries currently in the Closed state. Negative values are not allowed.

Example: 1
deleted: integer (int32)

Number of queries currently in the Deleted state. Negative values are not allowed.

Example: 4
opened: integer (int32)

Number of queries currently in the Open state. Negative values are not allowed.

Example: 2

{
    "title":"StudyQueryCountDTO v1.0",
    "type":"object",
    "properties":{
        "candidate":{
            "type":"integer",
            "description":"Number of queries currently in the Candidate state. Negative values are not allowed.",
            "format":"int32",
            "example":1
        },
        "opened":{
            "type":"integer",
            "description":"Number of queries currently in the Open state. Negative values are not allowed.",
            "format":"int32",
            "example":2
        },
        "answered":{
            "type":"integer",
            "description":"Number of queries currently in the Answered state. Negative values are not allowed.",
            "format":"int32",
            "example":0
        },
        "deleted":{
            "type":"integer",
            "description":"Number of queries currently in the Deleted state. Negative values are not allowed.",
            "format":"int32",
            "example":4
        },
        "closed":{
            "type":"integer",
            "description":"Number of queries currently in the Closed state. Negative values are not allowed.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Payload containing lifecycle totals for queries within a study.",
    "example":{
        "candidate":1,
        "opened":3,
        "answered":2,
        "deleted":0,
        "closed":4
    }
}

Example:

{
    "candidate":1,
    "opened":3,
    "answered":2,
    "deleted":0,
    "closed":4
}

Nested Schema : QueryRestErrorDetail

Type: object

Read Only: true

Context object returned when additional error metadata is available.

Show Source

hint: string

Client-facing guidance that clarifies how to resolve or retry the request.

Example: Retry request after verifying the study mode.
requestId: string

Unique identifier that can be supplied to Oracle Support when troubleshooting.

Example: 3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a
supportCode: string

Support or incident code associated with the error source.

Example: QRY-5000

{
    "type":"object",
    "properties":{
        "requestId":{
            "type":"string",
            "description":"Unique identifier that can be supplied to Oracle Support when troubleshooting.",
            "example":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a"
        },
        "supportCode":{
            "type":"string",
            "description":"Support or incident code associated with the error source.",
            "example":"QRY-5000"
        },
        "hint":{
            "type":"string",
            "description":"Client-facing guidance that clarifies how to resolve or retry the request.",
            "example":"Retry request after verifying the study mode."
        }
    },
    "description":"Context object returned when additional error metadata is available.",
    "readOnly":true,
    "example":{
        "requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
        "supportCode":"QRY-5000",
        "hint":"Retry request"
    }
}

Example:

{
    "requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
    "supportCode":"QRY-5000",
    "hint":"Retry request"
}

Examples