Jump to

• Request
• Response

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.

  Example:

  CSV

• reportName: string
  Report Name

  Example:

  Subject Data Extract

• reportid: string
  Report ID

  Example:

  BABB1234DD884FA1A9DC1AFDECBA1A35

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: string

Examples

Select an example Example key-value map scheduled report request

Back to Top

Response

Supported Media Types

• application/json

202 Response

Success:

Body ()

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

Select an example Report schedule accepted

401 Response

Validation error.

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

• ErrorResponseData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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."
        },
        "ErrorResponseData":{
            "$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

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-003

  Example: C1-003
• errorMessage: string
  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

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"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"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

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

Select an example User failed validation

Back to Top