Create a job to generate pdf report

post

https://api.operations1.app/tenants/{tenantId}/reports/{reportId}/pdfs

Throws HTTP 400 Bad Request if there are already 5 job in pending state for the same report.

Path Params

tenantId

string

required

length between 1 and 100

Consists of the subdomain. The tenantId for https://company.operations1.app/ is company.

reportId

integer

required

1 to 9007199254740991

Body Params

appLocaleCode

string

enum

required

reportLocaleCode

string

enum

mediaThumbnailsSize

string

enum

Allowed:

timezone

string

length ≤ 100

The timezone to use for timestamps in the pdf report. The available timezones are listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

showExecutionInformation

boolean

showClassCharacteristics

boolean

showDocumentInformation

boolean

showOrderInformation

boolean

showTimestamps

boolean

showUserPersonalInformation

boolean

showDocumentMedia

boolean

showStepOverview

boolean

showStepContent

boolean

contentFilter

string

enum

showUnmatchedConditionalInteractions

boolean

Headers

accept-version

required

Defines the API version. Using a date is recommended for stability. Avoid using latest in production, as it refers to the most up-to-date functionality, which may include breaking changes. For more details, see our article on versioning.

Responses

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Default Response

401This error ist returned if authentication of the request was not successful. For more information read our article about authentication.

403This error is returned if you do not have the necessary permissions for the endpoint.

404Report not found

429This error is returned if your request was not executed due to rate limit. For more information read our article about rate limiting.

defaultGeneral errors