1. REST API for Clinical One Platform
  2. Tasks
  3. Randomization and Supplies
  4. Report APIs
  5. v1.0

Get System Usage report

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/shipments

Retrieves the System Usage report. Rights: SystemUsageReportPost.

Request

Path Parameters
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
  • Minimum Value: 1
    Maximum Value: 5000
    Maximum number of records to display per page.
    Example: 50
  • 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 parameter
    Example: 5
Nested Schema : fieldSpecsList
Type: array
Show Source
Nested Schema : Field
Type: object
Contains field details.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : ReportBaseResponse
Type: object
Title: ReportBaseResponse
Response Object for different report APIs.
Show Source
Nested Schema : PaginatedResponseDto
Type: object
Title: PaginatedResponseDto
Paginated Response Object for report APIs.
Show Source
Nested Schema : columns
Type: array
Names of report columns in the result set.
Show Source
  • Names of report columns in the result set.
    Example: ["UserName","UserId","SiteName","Role"]
Example:
[
    "UserName",
    "UserId",
    "SiteName",
    "Role"
]
Nested Schema : data
Type: array
Tabular data where each item is a row (array of string values in report column order).
Show Source
  • items
    Tabular data where each item is a row (array of string values in report column order).
Example:
[
    [
        "fiona.cobb@example.com",
        "8571341A98694B82B8EB3EB901C88ACD",
        "US-East",
        "Rule Designer"
    ],
    [
        "lucas.james@example.com",
        "225B79C982104415886DE02BC73C1E1E",
        "US-West",
        "Site User"
    ]
]
Nested Schema : items
Type: array
Tabular data where each item is a row (array of string values in report column order).
Show Source
  • Tabular data where each item is a row (array of string values in report column order).
    Example: [["fiona.cobb@example.com","8571341A98694B82B8EB3EB901C88ACD","US-East","Rule Designer"],["lucas.james@example.com","225B79C982104415886DE02BC73C1E1E","US-West","Site User"]]
Example:
[
    [
        "fiona.cobb@example.com",
        "8571341A98694B82B8EB3EB901C88ACD",
        "US-East",
        "Rule Designer"
    ],
    [
        "lucas.james@example.com",
        "225B79C982104415886DE02BC73C1E1E",
        "US-West",
        "Site User"
    ]
]

400 Response

Invalid search criteria.
Body ()
Root Schema : ORSResponse
Type: object
Common response object.
Show Source
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
  • 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
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Result Object

404 Response

Study not found.
Body ()
Root Schema : ORSResponse
Type: object
Common response object.
Show Source
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
  • 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
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Result Object

500 Response

Internal server error
Body ()
Root Schema : ORSResponse
Type: object
Common response object.
Show Source
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
  • 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
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Result Object
Back to Top