Register a new scheduled task
Register a new scheduled task
Scheduled task to register
|
type
string
required
Value
report
|
||||
|
cron
string
required |
||||
|
enabled
boolean
required |
||||
|
name
string
required |
||||
|
recipients
array of objects (ReportRecipient)
required
|
||||
|
Array [
] |
||||
|
from
string
required |
||||
|
title
string
required |
||||
|
isHtml
boolean
required |
||||
|
hqlType
string
required
Enum
heql
hcql
hrql
hpql
hdql
|
||||
|
host
string | null
|
||||
|
status
string | null
Enum
warning
failure
success
running
|
||||
|
lastExecutionDate
integer | null
|
||||
|
lastCompletionDate
integer | null
|
||||
|
detail
string | null
|
||||
|
executionId
string | null
|
||||
|
fileName
string | null
|
||||
|
body
string | null
|
||||
|
compressCsv
boolean
Should the report be compressed using GZ. It will divide by two the size of the csv |
||||
|
hqlQuery
string | null
|
||||
|
hqlFields
array of string | null
|
||||
|
hqlSortedBy
array of objects | null (SortElement)
|
||||
|
Array [
] |
||||
|
description
string | null
|
||||
|
type
string
required
Value
thirdparty
|
|||||||
|
cron
string
required |
|||||||
|
dryRun
boolean
required |
|||||||
|
enabled
boolean
required |
|||||||
|
module
string
required |
|||||||
|
profile
string
required |
|||||||
|
connector
string
required |
|||||||
|
enroll
boolean
required |
|||||||
|
revoke
boolean
required |
|||||||
|
renew
boolean
required |
|||||||
|
host
string | null
|
|||||||
|
status
string | null
Enum
warning
failure
success
running
|
|||||||
|
lastExecutionDate
integer | null
|
|||||||
|
lastCompletionDate
integer | null
|
|||||||
|
detail
string | null
|
|||||||
|
executionId
string | null
|
|||||||
|
results
object | null (ThirdPartyConnectorSynchronizationResult)
|
|||||||
|
|||||||
|
description
string | null
|
|||||||
-
200 Scheduled task successfully registered
application/json_idstring (Internal ID) requiredObject internal ID
typestring requiredValuereportcronstring requiredenabledboolean requirednamestring requiredrecipientsarray of objects (ReportRecipient) requiredArray [
typestring requiredEnumstaticteam_contactteam_manageremailstring | nullteamstring | null]
fromstring requiredtitlestring requiredisHtmlboolean requiredhqlTypestring requiredEnumheqlhcqlhrqlhpqlhdqlhoststring | nullstatusstring | nullEnumwarningfailuresuccessrunninglastExecutionDateinteger | nulllastCompletionDateinteger | nulldetailstring | nullexecutionIdstring | nullfileNamestring | nullbodystring | nullcompressCsvbooleanShould the report be compressed using GZ. It will divide by two the size of the csv
hqlQuerystring | nullhqlFieldsarray of string | nullhqlSortedByarray of objects | null (SortElement)Array [
elementstring requiredThe name of the field the query should be sorted by. Must be one of the fields of the search query
orderstring requiredThe order to use for the sort. Asc and Desc sort the values, and KeyAsc and KeyDesc sort by the key, in case of a key-value element
EnumAscDescKeyAscKeyDesc]
descriptionstring | null_idstring (Internal ID) requiredObject internal ID
typestring requiredValuethirdpartycronstring requireddryRunboolean requiredenabledboolean requiredmodulestring requiredprofilestring requiredconnectorstring requiredenrollboolean requiredrevokeboolean requiredrenewboolean requiredhoststring | nullstatusstring | nullEnumwarningfailuresuccessrunninglastExecutionDateinteger | nulllastCompletionDateinteger | nulldetailstring | nullexecutionIdstring | nullresultsobject | null (ThirdPartyConnectorSynchronizationResult)enroll_successinteger | nullenroll_failureinteger | nullrenew_successinteger | nullrenew_failureinteger | nullrevoke_successinteger | nullrevoke_failureinteger | nulldescriptionstring | null -
400 Bad Request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSCHED-TASK-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Scheduled Tasktitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Scheduled Taskdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSCHED-TASK-004messagestring requiredA short, human-readable summary of the problem type
ValueScheduled Task already existstitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueScheduled Task already existsdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
401 Unauthorized request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid credentials or principal does not existtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid credentials or principal does not existdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-003messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is not trustedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is not trusteddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-004messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-005messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is revokedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is revokeddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-006messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticatedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticateddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-007messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Identity Providertitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Identity Providerdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-008messagestring requiredA short, human-readable summary of the problem type
ValueInvalid redirect pathtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid redirect pathdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-009messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticated or authentication expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticated or authentication expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
403 Forbidden action
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSEC-PERM-001messagestring requiredA short, human-readable summary of the problem type
ValueInsufficient privilegestitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInsufficient privilegesdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Licensedetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-004messagestring requiredA short, human-readable summary of the problem type
ValueExpired Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueExpired Licensedetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
404 Not Found
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSCHED-TASK-003messagestring requiredA short, human-readable summary of the problem type
ValueScheduled Task not foundtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueScheduled Task not founddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
500 Internal Server error
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSCHED-TASK-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807