Jump to

• Request
• Response

[Deprecated]: v1.0

put

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

Deprecated: Use latest version instead. Compared to the previous back-office process, this v1.0 endpoint lets clients assign multiple study roles to a query while validating rights and returning the updated query envelope. This improves user integration reliability.

Request

Path Parameters

• mode(required): string
  Study mode. Allowed values: test (testing sandbox), training (training environment), and active (production).
• queryId(required): string(uuid)
  Query ID.
• studyId(required): string(uuid)
  Clinical One study identifier formatted as a 32 to 36 character GUID.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request for assignupdate Query API

Show Source

• studyRoles(required): array studyRoles
  List of study role identifiers to assign. Provide between 1 and 50 values.

{
    "required":[
        "studyRoles"
    ],
    "type":"object",
    "properties":{
        "studyRoles":{
            "type":"array",
            "description":"List of study role identifiers to assign. Provide between 1 and 50 values.",
            "example":[
                "6AF54DB79B764662B685D68C52AB0B84",
                "9F8435D105BD49CC9A31DF94A2AF1F01"
            ],
            "items":{
                "type":"string",
                "description":"List of study role identifiers to assign. Provide between 1 and 50 values.",
                "format":"uuid"
            }
        }
    },
    "description":"Request for assignupdate Query API",
    "example":"{\\n  \\\"studyRoles\\\": [\\\"6AF54DB79B764662B685D68C52AB0B84\\\", \\\"9F8435D105BD49CC9A31DF94A2AF1F01\\\"]\\n}"
}

Example:

{\n  \"studyRoles\": [\"6AF54DB79B764662B685D68C52AB0B84\", \"9F8435D105BD49CC9A31DF94A2AF1F01\"]\n}

Nested Schema : studyRoles

Type: array

List of study role identifiers to assign. Provide between 1 and 50 values.

Show Source

• Array of: string(uuid)
  List of study role identifiers to assign. Provide between 1 and 50 values.

{
    "type":"array",
    "description":"List of study role identifiers to assign. Provide between 1 and 50 values.",
    "example":[
        "6AF54DB79B764662B685D68C52AB0B84",
        "9F8435D105BD49CC9A31DF94A2AF1F01"
    ],
    "items":{
        "type":"string",
        "description":"List of study role identifiers to assign. Provide between 1 and 50 values.",
        "format":"uuid"
    }
}

Example:

[
    "6AF54DB79B764662B685D68C52AB0B84",
    "9F8435D105BD49CC9A31DF94A2AF1F01"
]

Examples

Select an example AssignUpdateRequest

Back to Top

Response

Supported Media Types

• application/json

200 Response

Study roles assigned to the query successfully.

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

• 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.",
    "example":"{\\n  \\\"status\\\": \\\"success\\\",\\n  \\\"result\\\": {\\n    \\\"id\\\": \\\"AE33A9096BF548BBB29A96E399E9FBBB\\\",\\n    \\\"state\\\": \\\"Answered\\\"\\n  },\\n  \\\"errorData\\\": null,\\n  \\\"version\\\": \\\"1\\\"\\n}"
}

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

• 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

Select an example AssignUpdateSuccess

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

• 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.",
    "example":"{\\n  \\\"status\\\": \\\"success\\\",\\n  \\\"result\\\": {\\n    \\\"id\\\": \\\"AE33A9096BF548BBB29A96E399E9FBBB\\\",\\n    \\\"state\\\": \\\"Answered\\\"\\n  },\\n  \\\"errorData\\\": null,\\n  \\\"version\\\": \\\"1\\\"\\n}"
}

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

• 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

Select an example AssignUpdateBadRequest

404 Response

Returned when the target query cannot 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

• 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.",
    "example":"{\\n  \\\"status\\\": \\\"success\\\",\\n  \\\"result\\\": {\\n    \\\"id\\\": \\\"AE33A9096BF548BBB29A96E399E9FBBB\\\",\\n    \\\"state\\\": \\\"Answered\\\"\\n  },\\n  \\\"errorData\\\": null,\\n  \\\"version\\\": \\\"1\\\"\\n}"
}

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

• 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

Select an example AssignUpdateNotFound

500 Response

Returned when the service encounters an unexpected error while assigning study roles.

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

• 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.",
    "example":"{\\n  \\\"status\\\": \\\"success\\\",\\n  \\\"result\\\": {\\n    \\\"id\\\": \\\"AE33A9096BF548BBB29A96E399E9FBBB\\\",\\n    \\\"state\\\": \\\"Answered\\\"\\n  },\\n  \\\"errorData\\\": null,\\n  \\\"version\\\": \\\"1\\\"\\n}"
}

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

• 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

Select an example AssignUpdateServerError

Back to Top