Jump to

• Request
• Response

Get a list of data classifications by study roles for a tenant

get

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

Retrieves a list of data classifications by study roles for a tenant

Request

Path Parameters

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

  Example:

  ABE31741A0E945F6B827048B279F2F19

Query Parameters

• fetchForActiveRoles: boolean
  fetchForActiveRoles

  Default Value: false

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 DataClassificationStudyLevelDto
  Extends DataClassificationDto to include information about the associated study role for data classification at the study level.

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

Nested Schema : DataClassificationStudyLevelDto

Type: object

Extends DataClassificationDto to include information about the associated study role for data classification at the study level.

Show Source

• dataClassificationDesc: string
  Description of the Data Classification.

  Example: Data findings collected by an adjudicator from adjudication events or safety and efficacy clinical endpoints
• dataClassificationDescLabel: string
  Localized label for the Data Classification's description.

  Example: Data findings collected by an adjudicator from adjudication events or safety and efficacy clinical endpoints
• dataClassificationId(required): string
  Unique identifier for the Data Classification.

  Example: C94C507E21544840A8C17B1031305D7E
• dataClassificationLevel: string
  List of classification levels (e.g. SITE, DEPOT, STUDY).

  Example: ["SITE","DEPOT"]
• dataClassificationName(required): string
  Name of the Data Classification.

  Example: Adjudication Data
• dataClassificationNameLabel: string
  Localized label for the Data Classification's name.

  Example: Adjudication Data
• studyRoleId(required): string
  Unique identifier for the associated study role.

  Example: 7F4E9071608843F4A9F67B297672B09E

{
    "required":[
        "dataClassificationId",
        "dataClassificationName",
        "studyRoleId"
    ],
    "type":"object",
    "properties":{
        "dataClassificationId":{
            "type":"string",
            "description":"Unique identifier for the Data Classification.",
            "example":"C94C507E21544840A8C17B1031305D7E"
        },
        "dataClassificationName":{
            "type":"string",
            "description":"Name of the Data Classification.",
            "example":"Adjudication Data"
        },
        "dataClassificationNameLabel":{
            "type":"string",
            "description":"Localized label for the Data Classification's name.",
            "example":"Adjudication Data"
        },
        "dataClassificationDesc":{
            "type":"string",
            "description":"Description of the Data Classification.",
            "example":"Data findings collected by an adjudicator from adjudication events or safety and efficacy clinical endpoints"
        },
        "dataClassificationLevel":{
            "type":"string",
            "description":"List of classification levels (e.g. SITE, DEPOT, STUDY).",
            "example":"[\"SITE\",\"DEPOT\"]"
        },
        "dataClassificationDescLabel":{
            "type":"string",
            "description":"Localized label for the Data Classification's description.",
            "example":"Data findings collected by an adjudicator from adjudication events or safety and efficacy clinical endpoints"
        },
        "studyRoleId":{
            "type":"string",
            "description":"Unique identifier for the associated study role.",
            "example":"7F4E9071608843F4A9F67B297672B09E"
        }
    },
    "description":"Extends DataClassificationDto to include information about the associated study role for data classification at the study level."
}

Examples

Select an example List of data classification assignments for all study roles

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