REST API for Clinical One Platform

Assign data classifications to study role for study ID

put

/ec-auth-svc/rest/v1.0/dataclassification/{StudyID}/studyrole/{StudyRoleID}

Assign or update data classification levels for a specific study role in a study. Path parameters: StudyID (UUID) identifies the study, StudyRoleID (UUID) identifies the study role. Request body: List of DataClassificationIdLevelDto, where each element specifies a data classification ID (UUID) and the corresponding list of classification levels to set.

Request

Path Parameters

StudyID(required): string(uuid)
Unique identifier (UUID) for the study.
Example:
```
1442AC5976354C8BB403420E680283AD
```
StudyRoleID(required): string(uuid)
Unique identifier (UUID) for the study role.
Example:
```
C54AA9745A524BE1B4C3A270D00F8346
```

Supported Media Types

application/json

Root Schema : schema

Type: object

DTO for Data Classification with specific levels per classification.

Show Source

dataClassificationId(required): string

Unique identifier for the Data Classification.

Example: 899E66BCE1D8471F96F58A396C416E0D
dataClassificationLevel(required): string

List of classification levels assigned to the data classification.

Example: ["SITE","DEPOT"]

{
    "required":[
        "dataClassificationId",
        "dataClassificationLevel"
    ],
    "type":"object",
    "properties":{
        "dataClassificationId":{
            "type":"string",
            "description":"Unique identifier for the Data Classification.",
            "example":"899E66BCE1D8471F96F58A396C416E0D"
        },
        "dataClassificationLevel":{
            "type":"string",
            "description":"List of classification levels assigned to the data classification.",
            "example":"[\"SITE\",\"DEPOT\"]"
        }
    },
    "description":"DTO for Data Classification with specific levels per classification."
}

Examples

Response

Supported Media Types

application/json

200 Response

Success. Returns a response object if save is successful.

Root Schema : schema

Type: string

Examples

400 Response

Bad request

Root Schema : AuthResponse

Type: object

Generic API response wrapper containing result, error data, response version and status.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result

Result data of the API response; actual type depends on the API
status: string (none)

Indicates request success ("success") or failure ("failure").

Example: success
version: integer (int32)

Version of the response schema.

Example: 1

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Indicates request success (\"success\") or failure (\"failure\").",
            "format":"none",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Result data of the API response; actual type depends on the API",
            "example":null
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "description":"Version of the response schema.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Generic API response wrapper containing result, error data, response version and status."
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result data of the API response; actual type depends on the API

Example:

oracle.doceng.json.BetterJsonNull@3565a0f5