Skip to main content
PATCH
Edit a custom report's name/columns/formats

Authorizations

Authorization
string
header
required

Issue keys in Settings → API. Send them as Authorization: Bearer ont_… (an X-Api-Key: ont_… header is also accepted). Session-cookie routes are used by the OnTime web apps and are shown for completeness.

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
name
string
Required string length: 1 - 120
columns
string[]
Minimum array length: 1
formats
enum<string>[]
Available options:
CSV,
Excel,
PDF

Response

200 - application/json

Success

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
name
string
required
category
enum<string>
required
Available options:
Attendance,
Leave,
Payroll,
Compliance,
Custom
description
string
required
source
string
required
columns
string[]
required
formats
enum<string>[]
required
Available options:
CSV,
Excel,
PDF
starred
boolean
required
isCustom
boolean
required
runnable
boolean
required
templateKey
string | null
required
param
enum<string>
required
Available options:
month,
fy,
none
scheduleFreq
enum<string>
required
Available options:
None,
Daily,
Weekly,
Monthly
scheduleFormats
enum<string>[]
required
Available options:
CSV,
Excel,
PDF
deliverTo
string<email>[]
required
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
nextRunAt
string | null
required
lastRunAt
string | null
required
rowCount
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991