Jump to

• Request
• Response

Get list of data classification with levels

get

/ec-auth-svc/rest/v2.0/dataclassification/{studyId}/{mode}/user/{userId}

Retrieves the list of data classification with levels.

Request

Path Parameters

• mode(required): string
  Mode
• studyId(required): string(uuid)
  Study ID
• userId(required): string(uuid)
  User ID of the user that needs to be retrieved.

Query Parameters

• userDcForCacheKey: boolean
  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 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"
        }
    }
}

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