Get Study Design kit list report
post
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/kitlist
Retrieves Study Design kit list report. Rights: StudyDesignReportPost.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
studyId(required): string(uuid)
ID of the study
Supported Media Types
- */*
Root Schema : schema
Type:
object
Request body passing search specs like limit, offset and list of fields
Show Source
-
fieldSpecsList: array
fieldSpecsList
-
limit: integer
(int32)
Minimum Value:
1
Maximum Value:5000
Maximum number of records to display per page.Example:50
-
offset: integer
(int32)
Minimum Value:
0
Maximum Value:2147483647
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. Offset is affected by the value of the order parameterExample:5
Nested Schema : fieldSpecsList
Type:
Show Source
array
-
Array of:
object Field
Contains field details.
Nested Schema : Field
Type:
object
Contains field details.
Show Source
-
fieldName(required): string
Minimum Length:
0
Maximum Length:255
Field nameExample:siteIds
-
fieldSequence: integer
(int32)
Minimum Value:
0
Field sequenceExample:1
-
fieldType(required): string
Minimum Length:
0
Maximum Length:50
Field typeExample:list
-
fieldValueList(required): array
fieldValueList
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ReportBaseResponse
Type:
object
Title:
ReportBaseResponse
Response Object for different report APIs.
Show Source
-
errorData: string
Detail of error
-
result: object
PaginatedResponseDto
Paginated Response Object for report APIs.
-
status: string
Status of requestExample:
Success
Nested Schema : PaginatedResponseDto
Type:
object
Paginated Response Object for report APIs.
Show Source
-
columns: array
columns
-
count: integer
(int32)
Total count of result
-
data: array
data
-
hasMore: string
Attribute describes if result set has more recordsExample:
true
-
limit: integer
(int32)
Maximum number of records to display per page.
-
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. Offset is affected by the value of the order parameterExample:
400
-
totalResults: integer
(int32)
Total number of entities in response
400 Response
Invalid search criteria
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
404 Response
Study not found
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
500 Response
Internal server error
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object