Jump to

• Request
• Response

v1.0

get

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

Retrieves the studies and the modes which are assigned to a given user.

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

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object StudyAndModesDto v1.0
  Title: StudyAndModesDto v1.0

  Details of a study including the unique UUID and the assignment modes for the user.

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

Nested Schema : StudyAndModesDto v1.0

Type: object

Title: StudyAndModesDto v1.0

Details of a study including the unique UUID and the assignment modes for the user.

Show Source

• modes: array modes
  List of user assignment modes in the study
• studyid: string (uuid)
  Unique identifier for the study

{
    "title":"StudyAndModesDto v1.0",
    "type":"object",
    "properties":{
        "studyid":{
            "type":"string",
            "description":"Unique identifier for the study",
            "format":"uuid"
        },
        "modes":{
            "type":"array",
            "description":"List of user assignment modes in the study",
            "example":[
                "active",
                "test"
            ],
            "items":{
                "type":"string",
                "description":"List of user assignment modes in the study",
                "example":"[\"active\",\"test\"]"
            }
        }
    },
    "description":"Details of a study including the unique UUID and the assignment modes for the user."
}

Nested Schema : modes

Type: array

List of user assignment modes in the study

Show Source

• Array of: string
  List of user assignment modes in the study

  Example: ["active","test"]

{
    "type":"array",
    "description":"List of user assignment modes in the study",
    "example":[
        "active",
        "test"
    ],
    "items":{
        "type":"string",
        "description":"List of user assignment modes in the study",
        "example":"[\"active\",\"test\"]"
    }
}

Example:

[
    "active",
    "test"
]

Examples

Select an example Studies, modes, and user assignment details

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