Jump to

• Request
• Response

v1.0

get

/ec-auth-svc/rest/v1.0/authstudies/{studyId}/sdfs

Retrieves all the sites and depots that are present in a study.

Request

Path Parameters

• studyId(required): string(uuid)
  Unique identifier for the study.

  Example:

  5C1A37B940984ADB837CB5A6F9D9E99B

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

List of sites and depots for the specified study.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SDFShortInfo
  Short information for a Site/Depot/Facility???used for listing and selection responses. Includes unique id and logical name.

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

Nested Schema : SDFShortInfo

Type: object

Short information for a Site/Depot/Facility???used for listing and selection responses. Includes unique id and logical name.

Show Source

• id: string
  Unique identifier for the site, depot, or facility (UUID, 32-character uppercase hex as string).

  Example: 9FF4B6B23C864E1F9E9007A8816DBB27
• name: string
  Human-readable label for the site, depot, or facility entry.

  Example: Depot Alpha

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for the site, depot, or facility (UUID, 32-character uppercase hex as string).",
            "example":"9FF4B6B23C864E1F9E9007A8816DBB27"
        },
        "name":{
            "type":"string",
            "description":"Human-readable label for the site, depot, or facility entry.",
            "example":"Depot Alpha"
        }
    },
    "description":"Short information for a Site/Depot/Facility???used for listing and selection responses. Includes unique id and logical name."
}

Examples

Select an example Array of SDFShortInfo objects (site or depot short details), showing id and name fields.

400 Response

Bad request. Returned if studyId is missing.

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