Jump to

• Request
• Response

V2.0

get

/ec-designer-svc/rest/v2.0/studies/{studyId}/studyversionobjects/formitems

Retrieves items with ASVs within a given date range.

Request

Path Parameters

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

  Example:

  F054C951EB74443C93716CA714AB686E

Query Parameters

• formCategory: string
  Form category to filter form items by. Optional.

  Default Value: DCS

  Example:

  DCS

• fromDate: string
  Start date-time (yyyy-MM-dd'T'HH:mm:ss) for filtering study versions. Optional.

  Example:

  2024-01-01T00:00:00

• limit: integer(int32)
  Number of study versions to return. Optional.

  Default Value: 1000

  Example:

  1000

• offset: integer(int32)
  Study version index to start from. Optional.

  Default Value: 0

  Example:

  0

• toDate: string
  End date-time (yyyy-MM-dd'T'HH:mm:ss) for filtering study versions. Optional.

  Example:

  2024-12-31T23:59:59

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object StudyVersionFormItemDto

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

Nested Schema : StudyVersionFormItemDto

Type: object

Show Source

• count: integer (int32)
  Count

  Example: 10
• hasMore: boolean (true)
  has more

  Example: true
• limit: integer (int32)
  Limit

  Example: 10
• offset: integer (int32)
  Offset

  Example: 10
• resultData: array resultData
  The items
• totalResults: integer (int32)
  Total Results

  Example: 10

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"has more",
            "format":"true",
            "example":true
        },
        "totalResults":{
            "type":"integer",
            "description":"Total Results",
            "format":"int32",
            "example":10
        },
        "count":{
            "type":"integer",
            "description":"Count",
            "format":"int32",
            "example":10
        },
        "limit":{
            "type":"integer",
            "description":"Limit",
            "format":"int32",
            "example":10
        },
        "offset":{
            "type":"integer",
            "description":"Offset",
            "format":"int32",
            "example":10
        },
        "resultData":{
            "type":"array",
            "description":"The items",
            "format":"ItemDetailsDto",
            "items":{
                "$ref":"#/components/schemas/ItemDetailsDto"
            }
        }
    }
}

Nested Schema : resultData

Type: array

The items

Show Source

• Array of: object ItemDetailsDto
  The items

{
    "type":"array",
    "description":"The items",
    "format":"ItemDetailsDto",
    "items":{
        "$ref":"#/components/schemas/ItemDetailsDto"
    }
}

Nested Schema : ItemDetailsDto

Type: object

The items

Show Source

• itemId: string (uuid)
  Item Id
• mode: string (TEST)
  mode

  Example: TEST
• sourceStudyVersion: string (string)
  Source Study Verson

  Example: 1.0.0.1
• studyVersion: string (string)
  Study Verson

  Example: 1.0.0.1
• targetStudyVersion: string (string)
  Target Study Verson

  Example: 1.0.0.1
• versionStart: string (date-time)
  Item Id

{
    "type":"object",
    "properties":{
        "studyVersion":{
            "type":"string",
            "description":"Study Verson",
            "format":"string",
            "example":"1.0.0.1"
        },
        "targetStudyVersion":{
            "type":"string",
            "description":"Target Study Verson",
            "format":"string",
            "example":"1.0.0.1"
        },
        "sourceStudyVersion":{
            "type":"string",
            "description":"Source Study Verson",
            "format":"string",
            "example":"1.0.0.1"
        },
        "itemId":{
            "type":"string",
            "description":"Item Id",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Item Id",
            "format":"date-time"
        },
        "mode":{
            "type":"string",
            "description":"mode",
            "format":"TEST",
            "example":"TEST"
        }
    },
    "description":"The items",
    "format":"ItemDetailsDto"
}

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top