REST API for Clinical One Platform

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

jobId(required): string
Report job ID
Example:
```
6A7C29DD011241DFBE1B64399283C860
```

Query Parameters

mode: string
Mode of the study. Accepts test, active, or training.
Example:
```
test
```
studyId: string(uuid)
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

application/json

Root Schema : schema

Type: object

Specifies fields for report generation

Show Source

extFieldSpecsList: object extFieldSpecsList

Contains field details.
fieldSpecsList: object fieldSpecsList

Contains field details.

{
    "type":"object",
    "properties":{
        "fieldSpecsList":{
            "required":[
                "fieldName",
                "fieldType",
                "fieldValueList"
            ],
            "type":"object",
            "properties":{
                "fieldName":{
                    "maxLength":255,
                    "minLength":0,
                    "type":"string",
                    "description":"Field name",
                    "example":"siteIds"
                },
                "fieldType":{
                    "maxLength":50,
                    "minLength":0,
                    "type":"string",
                    "description":"Field type",
                    "example":"list"
                },
                "fieldSequence":{
                    "minimum":0,
                    "type":"integer",
                    "description":"Field sequence",
                    "format":"int32",
                    "example":1
                },
                "fieldValueList":{
                    "type":"string",
                    "description":"List of values for the Field",
                    "example":"[\"D5E16DD550CB4AD1B330E0D09B4B8F3F\",\"A5E16DD550CB4AD1B330E0D09B4B8F3F\"]"
                }
            },
            "description":"Contains field details."
        },
        "extFieldSpecsList":{
            "required":[
                "fieldName",
                "fieldType",
                "fieldValueList"
            ],
            "type":"object",
            "properties":{
                "fieldName":{
                    "maxLength":255,
                    "minLength":0,
                    "type":"string",
                    "description":"Field name",
                    "example":"siteIds"
                },
                "fieldType":{
                    "maxLength":50,
                    "minLength":0,
                    "type":"string",
                    "description":"Field type",
                    "example":"list"
                },
                "fieldSequence":{
                    "minimum":0,
                    "type":"integer",
                    "description":"Field sequence",
                    "format":"int32",
                    "example":1
                },
                "fieldValueList":{
                    "type":"string",
                    "description":"List of values for the Field",
                    "example":"[\"D5E16DD550CB4AD1B330E0D09B4B8F3F\",\"A5E16DD550CB4AD1B330E0D09B4B8F3F\"]"
                }
            },
            "description":"Contains field details."
        }
    },
    "description":"Specifies fields for report generation"
}

Nested Schema : extFieldSpecsList

Type: object

Contains field details.

Show Source

fieldName(required): string

Minimum Length: 0

Maximum Length: 255

Field name

Example: siteIds
fieldSequence: integer (int32)

Minimum Value: 0

Field sequence

Example: 1
fieldType(required): string

Minimum Length: 0

Maximum Length: 50

Field type

Example: list
fieldValueList(required): string

List of values for the Field

Example: ["D5E16DD550CB4AD1B330E0D09B4B8F3F","A5E16DD550CB4AD1B330E0D09B4B8F3F"]

{
    "required":[
        "fieldName",
        "fieldType",
        "fieldValueList"
    ],
    "type":"object",
    "properties":{
        "fieldName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Field name",
            "example":"siteIds"
        },
        "fieldType":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Field type",
            "example":"list"
        },
        "fieldSequence":{
            "minimum":0,
            "type":"integer",
            "description":"Field sequence",
            "format":"int32",
            "example":1
        },
        "fieldValueList":{
            "type":"string",
            "description":"List of values for the Field",
            "example":"[\"D5E16DD550CB4AD1B330E0D09B4B8F3F\",\"A5E16DD550CB4AD1B330E0D09B4B8F3F\"]"
        }
    },
    "description":"Contains field details."
}

Nested Schema : fieldSpecsList

Type: object

Contains field details.

Show Source

fieldName(required): string

Minimum Length: 0

Maximum Length: 255

Field name

Example: siteIds
fieldSequence: integer (int32)

Minimum Value: 0

Field sequence

Example: 1
fieldType(required): string

Minimum Length: 0

Maximum Length: 50

Field type

Example: list
fieldValueList(required): string

List of values for the Field

Example: ["D5E16DD550CB4AD1B330E0D09B4B8F3F","A5E16DD550CB4AD1B330E0D09B4B8F3F"]

{
    "required":[
        "fieldName",
        "fieldType",
        "fieldValueList"
    ],
    "type":"object",
    "properties":{
        "fieldName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Field name",
            "example":"siteIds"
        },
        "fieldType":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Field type",
            "example":"list"
        },
        "fieldSequence":{
            "minimum":0,
            "type":"integer",
            "description":"Field sequence",
            "format":"int32",
            "example":1
        },
        "fieldValueList":{
            "type":"string",
            "description":"List of values for the Field",
            "example":"[\"D5E16DD550CB4AD1B330E0D09B4B8F3F\",\"A5E16DD550CB4AD1B330E0D09B4B8F3F\"]"
        }
    },
    "description":"Contains field details."
}

Examples

Response

Supported Media Types

application/json

202 Response

Success.

Root Schema : ExecutionLog

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 4000

User-provided free-form comment about this execution
currSearchSpec: string

Minimum Length: 0

Maximum Length: 32000

Search specification filter string for this run (may be large)
currSortSpec: string

Minimum Length: 0

Maximum Length: 512

Sort specification string for this report run
fileStorageId: string (uuid)

ID of the associated report file blob in storage (UUID)
id: string (uuid)

Primary key. Unique job execution identifier (UUID). Example: 'BBAACF7D12C245A2A59B1C23DEADBEEF'
objectVersionNumber: number

Object version field (for optimistic concurrency/locking)
operationType: string

Minimum Length: 0

Maximum Length: 1024

Database action or type of operation represented by this job record. (E.g. INSERT, UPDATE, DELETE)
reason: string

Minimum Length: 0

Maximum Length: 4000

Reason provided for status or operation (e.g. failed status explanation)
recCount: integer (int32)

Total number of records in this report run (if known)
rptFormat(required): string

Minimum Length: 0

Maximum Length: 255

Format of generated report. Enumerated (PDF, XLSX, etc.)

Example: PDF
rptId: string (uuid)

Report template identifier (UUID). Example: 'AABB1234DD884FA1A9DC1AFDECBA1A35'
rptKickoffDatetime(required): string (date-time)

Date/time the report run started (ISO-8601 date/time). Example: '2025-10-27T10:00:00.000Z'

Example: 2025-10-27T10:00:00Z
rptName(required): string

Minimum Length: 0

Maximum Length: 255

Report name. Example: 'Subject Listing'

Example: Subject Listing
rptStatCd: string

Minimum Length: 0

Maximum Length: 255

Report status code (business state of run, e.g. SUCCESS, FAILED, SUBMITTED, IN_PROGRESS)

Example: SUCCESS
runDuration: integer (int64)

Job execution run duration in milliseconds
softwareVersionNumber: number

Software/application version field (build or runtime version, if needed)
userId(required): string (uuid)

User identifier (UUID) who initiated or owns the job. Example: '123E4567E89B12D3A456426614174000'
versionEnd(required): string (date-time)

Job execution version end timestamp (ISO-8601 date/time). Example: '2025-10-27T10:30:00.789Z'

Example: 2025-10-27T10:30:00.789Z
versionStart(required): string (date-time)

Job execution version start timestamp (ISO-8601 date/time). Example: '2025-10-27T10:00:00.123Z'

Example: 2025-10-27T10:00:00.123Z

{
    "required":[
        "rptFormat",
        "rptKickoffDatetime",
        "rptName",
        "userId",
        "versionEnd",
        "versionStart"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Primary key. Unique job execution identifier (UUID). Example: 'BBAACF7D12C245A2A59B1C23DEADBEEF'",
            "format":"uuid"
        },
        "rptId":{
            "type":"string",
            "description":"Report template identifier (UUID). Example: 'AABB1234DD884FA1A9DC1AFDECBA1A35'",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Job execution version start timestamp (ISO-8601 date/time). Example: '2025-10-27T10:00:00.123Z'",
            "format":"date-time",
            "example":"2025-10-27T10:00:00.123Z"
        },
        "runDuration":{
            "type":"integer",
            "description":"Job execution run duration in milliseconds",
            "format":"int64"
        },
        "userId":{
            "type":"string",
            "description":"User identifier (UUID) who initiated or owns the job. Example: '123E4567E89B12D3A456426614174000'",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "description":"Job execution version end timestamp (ISO-8601 date/time). Example: '2025-10-27T10:30:00.789Z'",
            "format":"date-time",
            "example":"2025-10-27T10:30:00.789Z"
        },
        "operationType":{
            "maxLength":1024,
            "minLength":0,
            "type":"string",
            "description":"Database action or type of operation represented by this job record. (E.g. INSERT, UPDATE, DELETE)"
        },
        "reason":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for status or operation (e.g. failed status explanation)"
        },
        "comment":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"User-provided free-form comment about this execution"
        },
        "rptKickoffDatetime":{
            "type":"string",
            "description":"Date/time the report run started (ISO-8601 date/time). Example: '2025-10-27T10:00:00.000Z'",
            "format":"date-time",
            "example":"2025-10-27T10:00:00Z"
        },
        "rptName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Report name. Example: 'Subject Listing'",
            "example":"Subject Listing"
        },
        "rptStatCd":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Report status code (business state of run, e.g. SUCCESS, FAILED, SUBMITTED, IN_PROGRESS)",
            "example":"SUCCESS"
        },
        "rptFormat":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Format of generated report. Enumerated (PDF, XLSX, etc.)",
            "example":"PDF"
        },
        "recCount":{
            "type":"integer",
            "description":"Total number of records in this report run (if known)",
            "format":"int32"
        },
        "currSearchSpec":{
            "maxLength":32000,
            "minLength":0,
            "type":"string",
            "description":"Search specification filter string for this run (may be large)"
        },
        "currSortSpec":{
            "maxLength":512,
            "minLength":0,
            "type":"string",
            "description":"Sort specification string for this report run"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version field (for optimistic concurrency/locking)"
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software/application version field (build or runtime version, if needed)"
        },
        "fileStorageId":{
            "type":"string",
            "description":"ID of the associated report file blob in storage (UUID)",
            "format":"uuid"
        }
    }
}

Examples

401 Response

Unauthorized user.

Root Schema : BaseResponse

Type: object

Base response object for all reporting service endpoints, providing a standard structure for status, result, and errorData.

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

Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
status: string

Response status for the request; typically 'success' or 'error'.

Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Response status for the request; typically 'success' or 'error'.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data."
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Base response object for all reporting service endpoints, providing a standard structure for status, result, and errorData."
}

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: string

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
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":"string",
            "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

Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.

Examples