Jump to

• Request
• Response

V9.0

get

/ec-designer-svc/rest/v9.0/studies/{studyId}/studyversionobjects/paginated

Returns paginated study version objects for the requested study. Compared with v8.0, this version returns the v11 study-version-object response shape while retaining formCategory filtering and pagination metadata.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  2F9A6C7E1B8F4D56A23C9F3A0C7D4E11

Query Parameters

• formCategory: string
  Return forms with this Form Category. Optional.

  Default Value: DCS

  Allowed Values: [ "DCS", "CRF", "UNBLINDED", "ADJUDICATION", "DIARY", "DEFAULT" ]

  Example:

  DCS

• limit: string
  Maximum number of study versions to return. Optional.

  Default Value: 1000

  Example:

  1000

• offset: string
  Zero-based offset within the study version result set. Optional.

  Default Value: 0

  Example:

  0

• order: string
  Sort direction for study versions. Optional. Allowed values: asc, desc.

  Default Value: asc

  Allowed Values: [ "asc", "desc" ]

  Example:

  asc

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : DesignerPaginatedResponse

Type: object

Title: DesignerPaginatedResponse

Designer paginated response.

Show Source

• count(required): integer (int32)
  How many pages in the paginated subList.

  Example: 2
• hasMore(required): boolean
  Yes - if there is at least one next page exists.

  Example: false
• limit(required): integer (int32)
  Max requested number of pages in the paginated subList.

  Example: 3
• offset(required): integer (int32)
  Requested lower page (inclusive) of the paginated subList.

  Example: 2
• resultData(required): object resultData
• totalResults(required): integer (int32)
  How many pages for a paginated object exist.

  Example: 6

{
    "title":"DesignerPaginatedResponse",
    "required":[
        "count",
        "hasMore",
        "limit",
        "offset",
        "resultData",
        "totalResults"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"How many pages for a paginated object exist.",
            "format":"int32",
            "example":6
        },
        "offset":{
            "type":"integer",
            "description":"Requested lower page (inclusive) of the paginated subList.",
            "format":"int32",
            "example":2
        },
        "limit":{
            "type":"integer",
            "description":"Max requested number of pages in the paginated subList.",
            "format":"int32",
            "example":3
        },
        "count":{
            "type":"integer",
            "description":"How many pages in the paginated subList.",
            "format":"int32",
            "example":2
        },
        "hasMore":{
            "type":"boolean",
            "description":"Yes - if there is at least one next page exists.",
            "example":false
        },
        "resultData":{
            "type":"object"
        }
    },
    "description":"Designer paginated response."
}

Nested Schema : resultData

Type: object

Examples

Select an example successResponse

204 Response

Successful operation.

Body ()

Root Schema : DesignerPaginatedResponse

Type: object

Title: DesignerPaginatedResponse

Designer paginated response.

Show Source

• count(required): integer (int32)
  How many pages in the paginated subList.

  Example: 2
• hasMore(required): boolean
  Yes - if there is at least one next page exists.

  Example: false
• limit(required): integer (int32)
  Max requested number of pages in the paginated subList.

  Example: 3
• offset(required): integer (int32)
  Requested lower page (inclusive) of the paginated subList.

  Example: 2
• resultData(required): object resultData
• totalResults(required): integer (int32)
  How many pages for a paginated object exist.

  Example: 6

{
    "title":"DesignerPaginatedResponse",
    "required":[
        "count",
        "hasMore",
        "limit",
        "offset",
        "resultData",
        "totalResults"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"How many pages for a paginated object exist.",
            "format":"int32",
            "example":6
        },
        "offset":{
            "type":"integer",
            "description":"Requested lower page (inclusive) of the paginated subList.",
            "format":"int32",
            "example":2
        },
        "limit":{
            "type":"integer",
            "description":"Max requested number of pages in the paginated subList.",
            "format":"int32",
            "example":3
        },
        "count":{
            "type":"integer",
            "description":"How many pages in the paginated subList.",
            "format":"int32",
            "example":2
        },
        "hasMore":{
            "type":"boolean",
            "description":"Yes - if there is at least one next page exists.",
            "example":false
        },
        "resultData":{
            "type":"object"
        }
    },
    "description":"Designer paginated response."
}

Nested Schema : resultData

Type: object

Examples

Select an example noContentResponse

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

Body ()

Root 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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Back to Top