Jump to

• Request
• Response

v1.0

get

/ec-auth-svc/rest/v1.0/allStudyRights

Retrieves rights assigned to a user for all studies.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

List of all study-mode rights for the user

Body ()

Root Schema : StudyModeRightsDto

Type: object

Represents rights available for a user per study and per mode. Contains the study ID and a list of rights for each available mode for the study.

Show Source

• modeRights: object modeRights
  Represents a set of rights for a user in a specific study mode.
• studyid: string
  Unique study identifier

  Example: A1B2C3D4E5F67890123456789ABCDEF0

{
    "type":"object",
    "properties":{
        "studyid":{
            "type":"string",
            "description":"Unique study identifier",
            "example":"A1B2C3D4E5F67890123456789ABCDEF0"
        },
        "modeRights":{
            "type":"object",
            "properties":{
                "mode":{
                    "type":"string",
                    "description":"Name of the mode.",
                    "example":"Test"
                },
                "rights":{
                    "uniqueItems":true,
                    "type":"array",
                    "description":"Set of authorization rights for the user in this mode.",
                    "example":[
                        "CodeListGet",
                        "StudyDesignReportPost"
                    ],
                    "items":{
                        "type":"string",
                        "description":"Set of authorization rights for the user in this mode.",
                        "example":"[\"CodeListGet\",\"StudyDesignReportPost\"]"
                    }
                }
            },
            "description":"Represents a set of rights for a user in a specific study mode.",
            "example":{
                "mode":"test",
                "rights":[
                    "UpdateRecipe",
                    "CodeListGet"
                ]
            }
        }
    },
    "description":"Represents rights available for a user per study and per mode. Contains the study ID and a list of rights for each available mode for the study."
}

Nested Schema : modeRights

Type: object

Represents a set of rights for a user in a specific study mode.

Show Source

• mode: string
  Name of the mode.

  Example: Test
• rights: array rights
  Unique Items Required: true

  Set of authorization rights for the user in this mode.

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string",
            "description":"Name of the mode.",
            "example":"Test"
        },
        "rights":{
            "uniqueItems":true,
            "type":"array",
            "description":"Set of authorization rights for the user in this mode.",
            "example":[
                "CodeListGet",
                "StudyDesignReportPost"
            ],
            "items":{
                "type":"string",
                "description":"Set of authorization rights for the user in this mode.",
                "example":"[\"CodeListGet\",\"StudyDesignReportPost\"]"
            }
        }
    },
    "description":"Represents a set of rights for a user in a specific study mode.",
    "example":{
        "mode":"test",
        "rights":[
            "UpdateRecipe",
            "CodeListGet"
        ]
    }
}

Example:

{
    "mode":"test",
    "rights":[
        "UpdateRecipe",
        "CodeListGet"
    ]
}

Nested Schema : rights

Type: array

Unique Items Required: true

Set of authorization rights for the user in this mode.

Show Source

• Array of: string
  Set of authorization rights for the user in this mode.

  Example: ["CodeListGet","StudyDesignReportPost"]

{
    "uniqueItems":true,
    "type":"array",
    "description":"Set of authorization rights for the user in this mode.",
    "example":[
        "CodeListGet",
        "StudyDesignReportPost"
    ],
    "items":{
        "type":"string",
        "description":"Set of authorization rights for the user in this mode.",
        "example":"[\"CodeListGet\",\"StudyDesignReportPost\"]"
    }
}

Example:

[
    "CodeListGet",
    "StudyDesignReportPost"
]

Examples

Select an example List of all study-mode rights for the user

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