Jump to

• Request
• Response

Get Study Inventory Settings report

post

/ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/inventorysettings

Retrieves the Study Inventory Settings report. Rights: StudyDesignReportPost.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.
• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Supported Media Types

• */*

Request Body - */* ()

Root Schema : SearchSpecs

Type: object

Title: SearchSpecs

Request body passing search specs like limit, offset and list of fields

Show Source

• fieldSpecsList: array fieldSpecsList
  Field Specification List
• 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.

  Example: 5

{
    "title":"SearchSpecs",
    "type":"object",
    "properties":{
        "limit":{
            "maximum":5000,
            "minimum":1,
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int32",
            "example":50
        },
        "offset":{
            "maximum":2147483647,
            "minimum":0,
            "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
        },
        "fieldSpecsList":{
            "type":"array",
            "description":"Field Specification List",
            "items":{
                "$ref":"#/components/schemas/Field"
            }
        }
    },
    "description":"Request body passing search specs like limit, offset and list of fields"
}

Nested Schema : fieldSpecsList

Type: array

Field Specification List

Show Source

• Array of: object Field
  Contains field details.

{
    "type":"array",
    "description":"Field Specification List",
    "items":{
        "$ref":"#/components/schemas/Field"
    }
}

Nested Schema : Field

Type: object

Contains field details.

Show Source

• fieldName(required): string
  Minimum Length: 0

  Maximum Length: 255

  Field name. The acceptable values are : TENANTID, STUDYID, COUNTRY, SITEID, INVID, INVNAM, USUBJID, SCRNID, SUBJID, VISITNUM, VISIT, UNSCHED, SVSTDTC, DOMAIN, LAB ID, LAB NAME, REPEATNUMBER, SREPEATID, SREPEATNUMBER, ENTERED BY, ENTERED DATE, LAST CHANGED BY, LAST CHANGED DATE etc.

  Example: siteIds or dateRange
• fieldSequence: integer (int32)
  Field sequence

  Example: 1
• fieldType(required): string
  Minimum Length: 0

  Maximum Length: 50

  Field type. The fields type can be : date-time, string, list, number etc.

  Example: list or date-time
• fieldValueList(required): array fieldValueList
  List of values for the Field

{
    "required":[
        "fieldName",
        "fieldType",
        "fieldValueList"
    ],
    "type":"object",
    "properties":{
        "fieldName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Field name. The acceptable values are : TENANTID, STUDYID, COUNTRY, SITEID, INVID, INVNAM, USUBJID, SCRNID, SUBJID, VISITNUM, VISIT, UNSCHED, SVSTDTC, DOMAIN, LAB ID, LAB NAME, REPEATNUMBER, SREPEATID, SREPEATNUMBER, ENTERED BY, ENTERED DATE, LAST CHANGED BY, LAST CHANGED DATE etc. ",
            "example":"siteIds or dateRange"
        },
        "fieldType":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Field type. The fields type can be : date-time, string, list, number etc.",
            "example":"list or date-time"
        },
        "fieldSequence":{
            "type":"integer",
            "description":"Field sequence",
            "format":"int32",
            "example":1
        },
        "fieldValueList":{
            "type":"array",
            "description":"List of values for the Field",
            "example":[
                "D5E16DD550CB4AD1B330E0D09B4B8F3F",
                "A5E16DD550CB4AD1B330E0D09B4B8F3F"
            ],
            "items":{
                "type":"string",
                "description":"List of values for the Field",
                "example":"[\"D5E16DD550CB4AD1B330E0D09B4B8F3F\",\"A5E16DD550CB4AD1B330E0D09B4B8F3F\"]"
            }
        }
    },
    "description":"Contains field details."
}

Nested Schema : fieldValueList

Type: array

List of values for the Field

Show Source

• Array of: string
  List of values for the Field

  Example: ["D5E16DD550CB4AD1B330E0D09B4B8F3F","A5E16DD550CB4AD1B330E0D09B4B8F3F"]

{
    "type":"array",
    "description":"List of values for the Field",
    "example":[
        "D5E16DD550CB4AD1B330E0D09B4B8F3F",
        "A5E16DD550CB4AD1B330E0D09B4B8F3F"
    ],
    "items":{
        "type":"string",
        "description":"List of values for the Field",
        "example":"[\"D5E16DD550CB4AD1B330E0D09B4B8F3F\",\"A5E16DD550CB4AD1B330E0D09B4B8F3F\"]"
    }
}

Example:

[
    "D5E16DD550CB4AD1B330E0D09B4B8F3F",
    "A5E16DD550CB4AD1B330E0D09B4B8F3F"
]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ReportBaseResponse

Type: object

Title: ReportBaseResponse

Response Object for different report APIs.

Show Source

• errorData: string
  Detail of error
• result: object PaginatedResponseDto
  Title: PaginatedResponseDto

  Paginated Response Object for report APIs.
• status: string
  Status of request

  Example: Success

{
    "title":"ReportBaseResponse",
    "type":"object",
    "properties":{
        "result":{
            "$ref":"#/components/schemas/PaginatedResponseDto"
        },
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "errorData":{
            "type":"string",
            "description":"Detail of error"
        }
    },
    "description":"Response Object for different report APIs."
}

Nested Schema : PaginatedResponseDto

Type: object

Title: PaginatedResponseDto

Paginated Response Object for report APIs.

Show Source

• columns: array columns
  Names of report columns in the result set
• count: integer (int32)
  Total count of result

  Example: 5
• data: array data
  Tabular data where each item is a row (array of string values in report column order)
• hasMore: string
  Attribute describes if result set has more records

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

  Example: 5
• 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: 400
• totalResults: integer (int32)
  Total number of entities in response

  Example: 5

{
    "title":"PaginatedResponseDto",
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"string",
            "description":"Attribute describes if result set has more records",
            "example":"true"
        },
        "totalResults":{
            "type":"integer",
            "description":"Total number of entities in response",
            "format":"int32",
            "example":5
        },
        "count":{
            "type":"integer",
            "description":"Total count of result",
            "format":"int32",
            "example":5
        },
        "limit":{
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int32",
            "example":5
        },
        "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":400
        },
        "columns":{
            "type":"array",
            "description":"Names of report columns in the result set",
            "example":[
                "Footer Message"
            ],
            "items":{
                "type":"string",
                "description":"Names of report columns in the result set",
                "example":"[\"Footer Message\"]"
            }
        },
        "data":{
            "type":"array",
            "description":"Tabular data where each item is a row (array of string values in report column order)",
            "example":[
            ],
            "items":{
                "type":"array",
                "description":"Tabular data where each item is a row (array of string values in report column order)",
                "example":[
                ],
                "items":{
                    "type":"string",
                    "description":"Tabular data where each item is a row (array of string values in report column order)",
                    "example":"[]"
                }
            }
        }
    },
    "description":"Paginated Response Object for report APIs."
}

Nested Schema : columns

Type: array

Names of report columns in the result set

Show Source

• Array of: string
  Names of report columns in the result set

  Example: ["Footer Message"]

{
    "type":"array",
    "description":"Names of report columns in the result set",
    "example":[
        "Footer Message"
    ],
    "items":{
        "type":"string",
        "description":"Names of report columns in the result set",
        "example":"[\"Footer Message\"]"
    }
}

Example:

[
    "Footer Message"
]

Nested Schema : data

Type: array

Tabular data where each item is a row (array of string values in report column order)

Show Source

• Array of: array items
  Tabular data where each item is a row (array of string values in report column order)

{
    "type":"array",
    "description":"Tabular data where each item is a row (array of string values in report column order)",
    "example":[
    ],
    "items":{
        "type":"array",
        "description":"Tabular data where each item is a row (array of string values in report column order)",
        "example":[
        ],
        "items":{
            "type":"string",
            "description":"Tabular data where each item is a row (array of string values in report column order)",
            "example":"[]"
        }
    }
}

Nested Schema : items

Type: array

Tabular data where each item is a row (array of string values in report column order)

Show Source

• Array of: string
  Tabular data where each item is a row (array of string values in report column order)

  Example: []

{
    "type":"array",
    "description":"Tabular data where each item is a row (array of string values in report column order)",
    "example":[
    ],
    "items":{
        "type":"string",
        "description":"Tabular data where each item is a row (array of string values in report column order)",
        "example":"[]"
    }
}

400 Response

Invalid search criteria

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

404 Response

Study not found

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

Back to Top