REST API for Clinical One Platform

Get specific data classifications for all study roles of a study

put

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

Returns a list of DataClassificationStudyRolesDto for a given study based on provided classification IDs

Request

Path Parameters

StudyID(required): string(uuid)
Unique identifier (UUID) of the study.
Example:
```
F37A78CBB3B04F6AA5F388B66702ED24
```

Supported Media Types

application/json

Root Schema : schema

Type: object

List of DataClassification UUIDs as part of a request payload.

Show Source

dataClassifications(required): array dataClassifications

list of data classifications Unique GUIDs

{
    "required":[
        "dataClassifications"
    ],
    "type":"object",
    "properties":{
        "dataClassifications":{
            "type":"array",
            "description":"list of data classifications Unique GUIDs",
            "format":"uuid",
            "example":[
                "938D23FA6B7241CCA41BD627E5DB60DA",
                "699EF3745FC545589F186D2198F3C65E"
            ],
            "items":{
                "type":"string",
                "description":"list of data classifications Unique GUIDs",
                "format":"uuid"
            }
        }
    },
    "description":"List of DataClassification UUIDs as part of a request payload.",
    "example":{
        "dataClassifications":[
            "938D23FA6B7241CCA41BD627E5DB60DA",
            "699EF3745FC545589F186D2198F3C65E"
        ]
    }
}

Example:

{
    "dataClassifications":[
        "938D23FA6B7241CCA41BD627E5DB60DA",
        "699EF3745FC545589F186D2198F3C65E"
    ]
}

Nested Schema : dataClassifications

Type: array

list of data classifications Unique GUIDs

Show Source

Array of: string(uuid)

list of data classifications Unique GUIDs

{
    "type":"array",
    "description":"list of data classifications Unique GUIDs",
    "format":"uuid",
    "example":[
        "938D23FA6B7241CCA41BD627E5DB60DA",
        "699EF3745FC545589F186D2198F3C65E"
    ],
    "items":{
        "type":"string",
        "description":"list of data classifications Unique GUIDs",
        "format":"uuid"
    }
}

Example:

[
    "938D23FA6B7241CCA41BD627E5DB60DA",
    "699EF3745FC545589F186D2198F3C65E"
]

Examples

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object DataClassificationStudyRolesDto

Represents a mapping between a study role and its associated data classification including the assigned classification level(s).

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DataClassificationStudyRolesDto"
    }
}

Nested Schema : DataClassificationStudyRolesDto

Type: object

Represents a mapping between a study role and its associated data classification including the assigned classification level(s).

Show Source

dataClassificationId(required): string (uuid)

Unique identifier of the data classification object associated with this study role.
dataClassificationLevel(required): string

Classification levels applied for this role.

Example: ["SITE","DEPOT"]
StudyRoleID(required): string (uuid)

Unique identifier for the study role.
studyRoleName(required): string

Name of the study role.

Example: Rule Designer
studyRoleStatus(required): string

Status of the study role (e.g., ACTIVE, INACTIVE).

Example: ACTIVE

{
    "required":[
        "dataClassificationId",
        "dataClassificationLevel",
        "StudyRoleID",
        "studyRoleName",
        "studyRoleStatus"
    ],
    "type":"object",
    "properties":{
        "StudyRoleID":{
            "type":"string",
            "description":"Unique identifier for the study role.",
            "format":"uuid"
        },
        "studyRoleName":{
            "type":"string",
            "description":"Name of the study role.",
            "example":"Rule Designer"
        },
        "studyRoleStatus":{
            "type":"string",
            "description":"Status of the study role (e.g., ACTIVE, INACTIVE).",
            "example":"ACTIVE"
        },
        "dataClassificationId":{
            "type":"string",
            "description":"Unique identifier of the data classification object associated with this study role.",
            "format":"uuid"
        },
        "dataClassificationLevel":{
            "type":"string",
            "description":"Classification levels applied for this role.",
            "example":"[\"SITE\",\"DEPOT\"]"
        }
    },
    "description":"Represents a mapping between a study role and its associated data classification including the assigned classification level(s)."
}

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