Jump to

• Request
• Response

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

Request Body - 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

Select an example Payload assigning levels for two classifications

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success. Returns a response object if save is successful.

Body ()

Root Schema : schema

Type: string

Examples

Select an example Success response (empty result string)

400 Response

Bad request

Body ()

Root Schema : AuthResponse

Type: object

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

Show Source

• errorData: object ErrorResponseData
• 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

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

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

Example:

oracle.doceng.json.BetterJsonNull@1466a41f

Nested Schema : details

Type: object

Back to Top