REST API for Clinical One Cloud Service

~~[Deprecated]: v3.0~~

post

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

Deprecated: Use latest version instead. Compared to v2.0, this v3.0 endpoint accepts an optional formInstanceNumber and returns property metadata (propertyType/propertyName and userName) within the response so downstream dashboards align with the expanded audit view.

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-character UUID without dashes.

Supported Media Types

application/json

Root Schema : QueryDTO Version 3

Type: object

Title: QueryDTO Version 3

Information for creating/editing query

Show Source

dataElementId(required): string (uuid)

Data element Unique GUID
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
queryComment(required): string

Minimum Length: 1

Maximum Length: 2048

Query comments

Example: Comment
siteId: string (uuid)

Site Unique GUID
state: string

Query state

Example: Opened
studyVersionStart: string (date-time)

Data element Version Start
subjectId(required): string (uuid)

Subject Unique GUID

{
    "title":"QueryDTO Version 3",
    "required":[
        "dataElementId",
        "queryComment",
        "subjectId"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Query 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"
        },
        "eventInstanceNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of repeating event",
            "example":0
        },
        "formInstanceNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of repeating form",
            "example":0
        }
    },
    "description":"Information for creating/editing query"
}

Examples

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : Response DTO

Type: object

Base envelope returned by Query APIs. Use the status field to determine whether result or errorData is populated.

Show Source

errorData: object Error details DTO

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

Result payload returned when status equals success.
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

{
    "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":{
            "type":"object",
            "description":"Result payload returned when status equals success.",
            "example":{
                "opened":3,
                "answered":1,
                "closed":2
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/Error details DTO"
        },
        "version":{
            "type":"string",
            "description":"Semantic version of the response envelope.",
            "readOnly":true,
            "example":"1"
        }
    },
    "description":"Base envelope returned by Query APIs. Use the status field to determine whether result or errorData is populated."
}

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 : result

Type: object

Result payload returned when status equals success.

Example:

{
    "opened":3,
    "answered":1,
    "closed":2
}

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

400 Response

Request validation failed due to missing, invalid, or inconsistent request data.

Root Schema : Response DTO

Type: object

Base envelope returned by Query APIs. Use the status field to determine whether result or errorData is populated.

Show Source

errorData: object Error details DTO

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

Result payload returned when status equals success.
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

{
    "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":{
            "type":"object",
            "description":"Result payload returned when status equals success.",
            "example":{
                "opened":3,
                "answered":1,
                "closed":2
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/Error details DTO"
        },
        "version":{
            "type":"string",
            "description":"Semantic version of the response envelope.",
            "readOnly":true,
            "example":"1"
        }
    },
    "description":"Base envelope returned by Query APIs. Use the status field to determine whether result or errorData is populated."
}

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 : result

Type: object

Result payload returned when status equals success.

Example:

{
    "opened":3,
    "answered":1,
    "closed":2
}

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