Jump to

• Request
• Response

Get data classifications for study role by study ID

get

/ec-auth-svc/rest/v1.0/dataclassification/{studyId}/studyrole/{studyRoleId}

Retrieves the data classifications with levels for the study role by study ID.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID

  Example:

  B1A77C0B1F6A4D6FBA5D9FDBE532A813

• studyRoleId(required): string(uuid)
  Study role ID

  Example:

  B1A77C0B1F6A4D6FBA5D9FDBE532A813

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DataClassificationDto

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

Nested Schema : DataClassificationDto

Type: object

Show Source

• dataClassificationDesc: string (String)
  DataClassification description

  Example: Data findings collected by an adjudicator from adjudication events or safety and efficacy clinical endpoints
• dataClassificationDescLabel: string (String)
  DataClassification translated description

  Example: Data findings collected by an adjudicator from adjudication events or safety and efficacy clinical endpoints
• dataClassificationId(required): string (uuid)
  DataClassification ID
• dataClassificationLevel: string
  Title: dataClassificationLevel

  DataClassification levels
• dataClassificationName(required): string (String)
  DataClassification name

  Example: Adjudication Data
• dataClassificationNameLabel: string (String)
  DataClassification translated name

  Example: Adjudication Data

{
    "required":[
        "dataClassificationId",
        "dataClassificationName"
    ],
    "type":"object",
    "properties":{
        "dataClassificationId":{
            "type":"string",
            "description":"DataClassification ID",
            "format":"uuid"
        },
        "dataClassificationName":{
            "type":"string",
            "description":"DataClassification name",
            "format":"String",
            "example":"Adjudication Data"
        },
        "dataClassificationNameLabel":{
            "type":"string",
            "description":"DataClassification translated name",
            "format":"String",
            "example":"Adjudication Data"
        },
        "dataClassificationDesc":{
            "type":"string",
            "description":"DataClassification description",
            "format":"String",
            "example":"Data findings collected by an adjudicator from adjudication events or safety and efficacy clinical endpoints"
        },
        "dataClassificationDescLabel":{
            "type":"string",
            "description":"DataClassification translated description",
            "format":"String",
            "example":"Data findings collected by an adjudicator from adjudication events or safety and efficacy clinical endpoints"
        },
        "dataClassificationLevel":{
            "title":"dataClassificationLevel",
            "type":"string",
            "description":"DataClassification levels"
        }
    }
}

Examples

Select an example Response for classifications by study role

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
  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: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• 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":"object",
            "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@76f8fc0a

Nested Schema : details

Type: object

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

Back to Top