Jump to

• Request
• Response

V9.0

post

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

Returns paginated study design data for the requested mode and pagination scope.

Request

Path Parameters

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

  Example:

  F054C951EB74443C93716CA714AB686E

Query Parameters

• dynamicData: boolean
  Return details when call made by service to service Optional.

  Default Value: true

  Example:

  true

• forms: boolean
  Set to true to paginate forms within each study version node. Optional.

  Default Value: false

  Example:

  false

• mode: string
  Study mode filter. Allowed values: design (draft design data), test (testing data), training (training data), active (approved production data), all (all modes). Optional.

  Default Value: test

  Allowed Values: [ "test", "active" ]

  Example:

  test

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• limit: integer (int32)
  Maximum number of records to display per page.

  Example: 50
• offset: integer (int32)
  An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.

  Example: 5
• version: string
  version

  Example: 1.3.0.6
• visitId: string (uuid)
  Visit GUID

{
    "type":"object",
    "properties":{
        "limit":{
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int32",
            "example":50
        },
        "offset":{
            "type":"integer",
            "description":"An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.",
            "format":"int32",
            "example":5
        },
        "version":{
            "type":"string",
            "description":"version",
            "example":"1.3.0.6"
        },
        "visitId":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        }
    }
}

Examples

Select an example requestExample

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : DesignerPaginatedResponse

Type: object

Title: DesignerPaginatedResponse

Study design 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
• studyDetails(required): array studyDetails
• totalResults(required): integer (int32)
  How many pages for a paginated object exist.

  Example: 6

{
    "title":"DesignerPaginatedResponse",
    "required":[
        "count",
        "hasMore",
        "limit",
        "offset",
        "studyDetails",
        "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
        },
        "studyDetails":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "description":"Study design paginated response."
}

Nested Schema : studyDetails

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Examples

Select an example successResponse

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