1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Query
  4. Query Management
  5. Assign study roles to queries

v10.0

put

/ec-query-svc/rest/v10.0/studies/{studyId}/{mode}/queries/{queryId}/assignupdate

Compared to v9.0, this v10 endpoint enables multiple study role assignments in one call, captures an optional audit comment, and enforces enhanced validation under the enableAssignedQueryEnhancements flag. This improves user integration reliability.

Request

Path Parameters
Query Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Request payload for query assign update v10 API.
Show Source
Nested Schema : studyRoles
Type: array
List of study role identifiers to assign.
Show Source
Example:
[
    "6AF54DB79B764662B685D68C52AB0B84"
]
Examples

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : QueryDTO Version 9
Type: object
Title: QueryDTO Version 9
Information returned from updating/inserting query
Show Source
Example:
{\n  \"id\": \"AE33A9096BF548BBB29A96E399E9FBBB\",\n  \"queryComment\": \"Visit date clarification required.\",\n  \"state\": \"Opened\",\n  \"subjectId\": \"762744769B0E4E40B6A74691179BC578\",\n  \"dataElementId\": \"583A45DD0A1C46F88D7842D76CAF9A59\",\n  \"dataElementVersionStart\": \"2026-01-15T10:05:30Z\",\n  \"formId\": \"680E0FB01F1B4CCB990C333563FAEE80\",\n  \"siteId\": \"CB9BBB0767114F599FE75616223D6665\",\n  \"eventId\": \"3B95322B15144E4397B30305EB33E871\",\n  \"eventInstanceNumber\": 0,\n  \"formInstanceNumber\": 0,\n  \"objectVersionNumber\": 6,\n  \"itemId\": \"42738D18833E45C29D9CDEABBB2247FE\",\n  \"discrepancyId\": 123456789,\n  \"repeatFormNumber\": 1,\n  \"propertyName\": \"visit\",\n  \"propertyType\": \"visitStartDate\",\n  \"ruleId\": \"0E1F4EDBB97943F0B2DE8C6C5AA31234\",\n  \"isQueryCreator\": true,\n  \"studyRoles\": [{\"studyRoleId\": \"6AF54DB79B764662B685D68C52AB0B84\", \"studyRoleName\": \"CRA\"}]\n}
Nested Schema : studyRoles
Type: array
Study role assignments returned after update.
Show Source
Nested Schema : QueryStudyRoleDTOv6
Type: object
Show Source
Examples

400 Response

Request validation failed due to missing, invalid, or inconsistent request data.
Body ()
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
Example:
{\n  \"status\": \"success\",\n  \"result\": {\n    \"id\": \"AE33A9096BF548BBB29A96E399E9FBBB\",\n    \"state\": \"Answered\"\n  },\n  \"errorData\": null,\n  \"version\": \"1\"\n}
Nested Schema : Error details DTO
Type: object
Standard structure used to describe errors returned by Query APIs.
Show Source
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
  • Client-facing guidance that clarifies how to resolve or retry the request.
    Example: Retry request after verifying the study mode.
  • Unique identifier that can be supplied to Oracle Support when troubleshooting.
    Example: 3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a
  • Support or incident code associated with the error source.
    Example: QRY-5000
Example:
{
    "requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
    "supportCode":"QRY-5000",
    "hint":"Retry request"
}
Examples

404 Response

The query could not be found.
Body ()
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
Example:
{\n  \"status\": \"success\",\n  \"result\": {\n    \"id\": \"AE33A9096BF548BBB29A96E399E9FBBB\",\n    \"state\": \"Answered\"\n  },\n  \"errorData\": null,\n  \"version\": \"1\"\n}
Nested Schema : Error details DTO
Type: object
Standard structure used to describe errors returned by Query APIs.
Show Source
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
  • Client-facing guidance that clarifies how to resolve or retry the request.
    Example: Retry request after verifying the study mode.
  • Unique identifier that can be supplied to Oracle Support when troubleshooting.
    Example: 3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a
  • Support or incident code associated with the error source.
    Example: QRY-5000
Example:
{
    "requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
    "supportCode":"QRY-5000",
    "hint":"Retry request"
}
Examples

Back to Top