Jump to

• Request
• Response

v1.0

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

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

Select an example Payload with classification IDs

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

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

Select an example Successful response mapping roles to their assigned data classification levels.

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
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

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

Example:

oracle.doceng.json.BetterJsonNull@65719c12

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top