Generate a scheduled report
post
/ec-reporting-svc/rest/v1.0/scheduled/reports
Generates a report through a scheduler invocation, based on the given key-value pair of strings as JSON body and query parameters.
Right: ReportingPost.
Right: ReportingPost.
Request
Query Parameters
-
format: string
Report file format to be generated.Example:
CSV -
reportName: string
Report NameExample:
Subject Data Extract -
reportid: string
Report IDExample:
BABB1234DD884FA1A9DC1AFDECBA1A35
Supported Media Types
- application/json
Root Schema : schema
Type:
stringExamples
Back to Top
Response
Supported Media Types
- application/json
202 Response
Success:
Root Schema : ExecutionLog
Type:
Show Source
object-
comment: string
Minimum Length:
0Maximum Length:4000User-provided free-form comment about this execution -
currSearchSpec: string
Minimum Length:
0Maximum Length:32000Search specification filter string for this run (may be large) -
currSortSpec: string
Minimum Length:
0Maximum Length:512Sort 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:
0Maximum Length:1024Database action or type of operation represented by this job record. (E.g. INSERT, UPDATE, DELETE) -
reason: string
Minimum Length:
0Maximum Length:4000Reason 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:
0Maximum Length:255Format 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:
0Maximum Length:255Report name. Example: 'Subject Listing'Example:Subject Listing -
rptStatCd: string
Minimum Length:
0Maximum Length:255Report 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
Examples
401 Response
Validation error.
Root Schema : BaseResponse
Type:
objectBase 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
Nested Schema : ErrorResponseData
Type:
objectStructure 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
Nested Schema : result
Type:
objectGeneric result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
Examples