1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Reporting
  4. v1.0

Kickstart the generation of report

post

/ec-reporting-svc/rest/v1.0/report/job/{jobId}

Invoked by Reporting retrial thread. This API starts the processing of report.
Right: ReportingPost.

Request

Path Parameters
Query Parameters
  • Mode of the study. Accepts test, active, or training.
    Example:
    test
  • ID of the study for which you want to generate report. Tenant reports, such as HSL report, can be generated by making study ID as null.
    Example:
    CFD8129A430A473C8A02F4BA5DAAD865
Supported Media Types
Request Body - application/json ()
Root Schema : Extended Field Specs
Type: object
Title: Extended Field Specs
Contains extended field specifications.
Show Source
Nested Schema : Extended Field Specs
Type: array
Title: Extended Field Specs
Minimum Number of Items: 0
List of extended field specifications.
Show Source
  • Field
    Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.
Nested Schema : Field Specs
Type: array
Title: Field Specs
Minimum Number of Items: 0
List of base field specifications.
Show Source
  • Field
    Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.
Nested Schema : Field
Type: object
Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.
Show Source
  • Minimum Length: 1
    Maximum Length: 255
    Field name to evaluate. Examples include STUDYID, SITEID, ruleState, and dateRange.
    Example: ruleState
  • Minimum Value: 0
    Maximum Value: 2147483647
    Sequence/order of the field. Provide a non-negative integer.
    Example: 1
  • Minimum Length: 4
    Maximum Length: 16
    Allowed Values: [ "list", "date", "date-time", "number", "string", "boolean" ]
    Field value classification. Use list for enumerations, date for calendar values, date-time for timestamps, number for numeric filters, string for textual filters, or boolean for true/false.
    Example: list
  • fieldValueList
    List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.
Example:
{
    "fieldName":"ruleState",
    "fieldType":"list",
    "fieldSequence":1,
    "fieldValueList":[
        "approved"
    ]
}
Nested Schema : fieldValueList
Type: array
List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Examples

Back to Top

Response

Supported Media Types

202 Response

Success.
Body ()
Root Schema : ExecutionLog
Type: object
Show Source
Examples

401 Response

Unauthorized user.
Body ()
Root Schema : BaseResponse
Type: object
Base response object for all reporting service endpoints, providing a standard structure for status, result, and errorData.
Show Source
Nested Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • 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
Nested Schema : result
Type: object
Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Examples

Back to Top