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.
Request
Query Parameters
-
format: string
Report file format to be generated.
-
reportName: string
Report Name
-
reportid: string
Report ID
Supported Media Types
- */*
Response
Supported Media Types
- text/html
- application/json
202 Response
Success
Root Schema : ExecutionLog
Type:
Show Source
object
-
comment: string
Minimum Length:
0
Maximum Length:4000
-
currSearchSpec: string
Minimum Length:
0
Maximum Length:32000
-
currSortSpec: string
Minimum Length:
0
Maximum Length:512
-
fileStorageId: string
(uuid)
-
id: string
(uuid)
-
objectVersionNumber: number
-
operationType: string
Minimum Length:
0
Maximum Length:1024
-
reason: string
Minimum Length:
0
Maximum Length:4000
-
recCount: integer
(int32)
-
rptFormat(required): string
Minimum Length:
0
Maximum Length:255
-
rptId: string
(uuid)
-
rptKickoffDatetime(required): string
(date-time)
-
rptName(required): string
Minimum Length:
0
Maximum Length:255
-
rptStatCd: string
Minimum Length:
0
Maximum Length:255
-
runDuration: integer
-
softwareVersionNumber: number
-
userId(required): string
(uuid)
-
versionEnd(required): string
(date-time)
-
versionStart(required): string
(date-time)
401 Response
Validation error
Root Schema : BaseResponse
Type:
Show Source
object
-
errorData: object
ErrorResponseData
Title:
ErrorResponseData
Error Response Details Information -
result: object
result
-
status: string
Nested Schema : ErrorResponseData
Type:
object
Title:
ErrorResponseData
Error Response Details Information
Show Source
-
details: object
Object
Title:
Object
Object with error details information. -
errorCode: string
Error code which is stored in ErrorCode enum. Example : C1-003Example:
C1-003
-
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
Cannot modify object after a study version has been approved
Nested Schema : result
Type:
object
Nested Schema : Object
Type:
object
Title:
Object
Object with error details information.