Jobs API

Action	Endpoint
Fetch Documents Job For Transaction	GET/document/{tenantLocator}/documents/transaction/{locator}/jobs/{jobLocator}
Fetch Multiple Documents Jobs For Transaction	GET/document/{tenantLocator}/documents/transaction/{locator}/jobs/list
Fetch Documents Job For Segment	GET/document/{tenantLocator}/documents/segment/{locator}/jobs/{jobLocator}
Fetch Multiple Documents Jobs For Segment	GET/document/{tenantLocator}/documents/segment/{locator}/jobs/list
Fetch Documents Job For Quote	GET/document/{tenantLocator}/documents/quote/{locator}/jobs/{jobLocator}
Fetch Multiple Documents Jobs For Quote	GET/document/{tenantLocator}/documents/quote/{locator}/jobs/list
Trigger Timed Out Documents Job For Transaction	POST/document/{tenantLocator}/documents/transaction/{locator}/trigger
Trigger Timed Out Documents Job For Segment	POST/document/{tenantLocator}/documents/segment/{locator}/trigger
Trigger Timed Out Documents Job For Quote	POST/document/{tenantLocator}/documents/quote/{locator}/trigger
Trigger Failed Document Job For Transaction	POST/document/{tenantLocator}/documents/transaction/{locator}/jobs/{jobLocator}/trigger
Trigger Failed Document Job For Segment	POST/document/{tenantLocator}/documents/segment/{locator}/jobs/{jobLocator}/trigger
Trigger Failed Document Job For Quote	POST/document/{tenantLocator}/documents/quote/{locator}/jobs/{jobLocator}/trigger
Trigger Failed Document Job For Invoice	POST/document/{tenantLocator}/documents/invoices/{locator}/jobs/{jobLocator}/trigger
Fetch Installments Jobs for Quotes	GET/billing/{tenantLocator}/jobs/installments/quotes/{locator}/list
Fetch Installments Jobs for Policy Transactions	GET/billing/{tenantLocator}/jobs/installments/transactions/{locator}/list
Retry Failed Transactions	POST/billing/{tenantLocator}/retryJobs/{policyLocator}/retryFailedTransactions
Fetch Invoice Jobs for Accounts	GET/billing/{tenantLocator}/jobs/invoicing/accounts/{locator}/list
Fetch Invoice Job	GET/billing/{tenantLocator}/jobs/invoicing/{jobLocator}
Fetch Invoice Job Data For Account	GET/billing/{tenantLocator}/jobs/invoices/accounts/{locator}/list
Fetch Invoice Lifecycle Job Data	GET/billing/{tenantLocator}/jobs/invoicesLifecycle/{locator}
Fetch Delinquency Grace Job	GET/billing/{tenantLocator}/jobs/delinquencies/{delinquencyLocator}/list
Fetch Create Delinquencies Job Data For Invoice	GET/billing/{tenantLocator}/jobs/delinquencies/invoices/{invoiceLocator}/list
Fetch Delinquency Event Jobs	GET/billing/{tenantLocator}/jobs/delinquencies/{delinquencyLocator}/events/list
Fetch Anonymization Jobs	GET/compliance/{tenantLocator}/jobs
List Deserialize Schedule Items Jobs	GET/policy/{tenantLocator}/deserializeJobs/{jobType}/list
Fetch Deserialize Schedule Items Job	GET/policy/{tenantLocator}/deserializeJobs/{locator}
Terminate Deserialization Job	PATCH/policy/{tenantLocator}/deserializeJobs/{locator}/terminate
Restart Deserialization Job	PATCH/policy/{tenantLocator}/deserializeJobs/{locator}/restart

Documents Jobs

Fetch Documents Job For Transaction

Fetch Documents Job For TransactionfetchDocumentsJobForTransaction

GET/document/{tenantLocator}/documents/transaction/{locator}/jobs/{jobLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`jobLocator`	path	`ulid`	Yes

Response:DocumentsJob

Security Group:documents

Permission:

read

Fetch Multiple Documents Jobs For Transaction

Fetch Multiple Documents Jobs For TransactionfetchMultipleDocumentsJobsForTransaction

GET/document/{tenantLocator}/documents/transaction/{locator}/jobs/list

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.

Response:DocumentJobListResponse

Security Group:documents

Permission:

read

Fetch Documents Job For Segment

Fetch Documents Job For SegmentfetchDocumentsJobForSegment

GET/document/{tenantLocator}/documents/segment/{locator}/jobs/{jobLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`jobLocator`	path	`ulid`	Yes

Response:DocumentsJob

Security Group:documents

Permission:

read

Fetch Multiple Documents Jobs For Segment

Fetch Multiple Documents Jobs For SegmentfetchMultipleDocumentsJobsForSegment

GET/document/{tenantLocator}/documents/segment/{locator}/jobs/list

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.

Response:DocumentJobListResponse

Security Group:documents

Permission:

read

Fetch Documents Job For Quote

Fetch Documents Job For QuotefetchDocumentsJobForQuote

GET/document/{tenantLocator}/documents/quote/{locator}/jobs/{jobLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`jobLocator`	path	`ulid`	Yes

Response:DocumentsJob

Security Group:documents

Permission:

read

Fetch Multiple Documents Jobs For Quote

Fetch Multiple Documents Jobs For QuotefetchMultipleDocumentsJobsForQuote

GET/document/{tenantLocator}/documents/quote/{locator}/jobs/list

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.

Response:DocumentJobListResponse

Security Group:documents

Permission:

read

DocumentJobListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`DocumentsJobSummary[]`

DocumentsJob

Required properties

Property	Type	Description
`locator`	`ulid`
`transactionLocator`	`ulid`
`segmentLocator`	`ulid`
`referenceLocator`	`ulid`
`completedAt`	`datetime`
`documentTrigger`	`Enum validated \| priced \| accepted \| underwritten \| issued \| generated`
`isConsolidation`	`boolean`
`processingErrors`	`string`
`referenceType`	`Enum quote \| policy \| invoice \| transaction \| segment \| term`
`status`	`Enum running \| finished \| failed`
`createdAt`	`datetime`
`createdBy`	`uuid`
`childrenJobs`	`ulid[]`
`documents`	`DocumentJobInfo[]`

DocumentJobInfo

Required properties

Property	Type	Description
`locator`	`ulid`
`staticName`	`string`
`name`	`string`
`documentInstanceState`	`string`
`processingErrors`	`string`
`state`	`string`Deprecated

DocumentsJobSummary

Required properties

Property	Type	Description
`locator`	`ulid`
`referenceType`	`Enum quote \| policy \| invoice \| transaction \| segment \| term`
`status`	`Enum running \| finished \| failed`
`createdAt`	`datetime`

The /list endpoints above will return an empty array if the entity does not exist for the given locator. An HTTP 404 error will not be generated.

Retrigger Jobs

Trigger Timed Out Documents Job For Transaction

Trigger Timed Out Documents Job For TransactiontriggerTimedOutDocumentsJobForTransaction

POST/document/{tenantLocator}/documents/transaction/{locator}/trigger

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:DocumentsJobSummary[]

Security Group:documents

Permission:

trigger

Trigger Timed Out Documents Job For Segment

Trigger Timed Out Documents Job For SegmenttriggerTimedOutDocumentsJobForSegment

POST/document/{tenantLocator}/documents/segment/{locator}/trigger

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:DocumentsJobSummary[]

Security Group:documents

Permission:

trigger

Trigger Timed Out Documents Job For Quote

Trigger Timed Out Documents Job For QuotetriggerTimedOutDocumentsJobForQuote

POST/document/{tenantLocator}/documents/quote/{locator}/trigger

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:DocumentsJobSummary[]

Security Group:documents

Permission:

trigger

Trigger Failed Document Job For Transaction

Trigger Failed Document Job For TransactiontriggerFailedDocumentJobForTransaction

POST/document/{tenantLocator}/documents/transaction/{locator}/jobs/{jobLocator}/trigger

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`jobLocator`	path	`ulid`	Yes

Response:DocumentsJobSummary

Security Group:documents

Permission:

trigger

Trigger Failed Document Job For Segment

Trigger Failed Document Job For SegmenttriggerFailedDocumentJobForSegment

POST/document/{tenantLocator}/documents/segment/{locator}/jobs/{jobLocator}/trigger

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`jobLocator`	path	`ulid`	Yes

Response:DocumentsJobSummary

Security Group:documents

Permission:

trigger

Trigger Failed Document Job For Quote

Trigger Failed Document Job For QuotetriggerFailedDocumentJobForQuote

POST/document/{tenantLocator}/documents/quote/{locator}/jobs/{jobLocator}/trigger

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`jobLocator`	path	`ulid`	Yes

Response:DocumentsJobSummary

Security Group:documents

Permission:

trigger

Trigger Failed Document Job For Invoice

Trigger Failed Document Job For InvoicetriggerFailedDocumentJobForInvoice

POST/document/{tenantLocator}/documents/invoices/{locator}/jobs/{jobLocator}/trigger

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`jobLocator`	path	`ulid`	Yes

Response:DocumentsJobSummary

Security Group:documents

Permission:

trigger

Installment Jobs

Fetch Installments Jobs for Quotes

Fetch Installments Jobs for QuotesfetchInstallmentsJobDataForQuotesDeprecated

GET/billing/{tenantLocator}/jobs/installments/quotes/{locator}/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:InstallmentJobDataListResponse

Security Group:jobs

Permissions:

read,list

Fetch Installments Jobs for Policy Transactions

Fetch Installments Jobs for Policy TransactionsfetchInstallmentsJobDataForTransactions

GET/billing/{tenantLocator}/jobs/installments/transactions/{locator}/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:InstallmentJobDataListResponse

Security Group:jobs

Permissions:

read,list

Retry Failed Transactions

Retry Failed TransactionsretryFailedTransactions

POST/billing/{tenantLocator}/retryJobs/{policyLocator}/retryFailedTransactions

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`policyLocator`	path	`ulid`	Yes

Response:ListPageResponseInstallmentJobData

Security Group:retry-jobs

Permission:

write

InstallmentJobDataListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`InstallmentJobData[]`

InstallmentJobData

Required properties

Property	Type	Description
`locator`	`ulid`
`latticeLocator`	`ulid`
`referenceLocator`	`ulid`
`completedAt`	`datetime`
`installmentLocators`	`string`
`jobStatus`	`Enum queued \| finished \| failed \| running`
`processingErrors`	`string`
`createdAt`	`datetime`

ListPageResponseInstallmentJobData

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`InstallmentJobData[]`

Invoice Jobs

Normal Invoicing

Fetch Invoice Jobs for Accounts

Fetch Invoice Jobs for AccountsfetchInvoicingJobsForAccount

GET/billing/{tenantLocator}/jobs/invoicing/accounts/{locator}/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseInvoicingJobData

Security Group:jobs

Permissions:

read,list

ListPageResponseInvoicingJobData

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`InvoicingJobData[]`

Fetch Invoice Job

Fetch Invoice JobfetchInvoicingJob

GET/billing/{tenantLocator}/jobs/invoicing/{jobLocator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`jobLocator`	path	`ulid`	Yes

Response:InvoicingJobData

Security Group:jobs

Permission:

read

InvoicingJobData

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`invoicingData`	`oneOf<EarlyInvoicingGenerationData,ImmediateInvoicingData>`
`jobStatus`	`Enum queued \| finished \| failed \| running`
`createdAt`	`datetime`
`invoiceLocators`	`ulid[]`

Optional properties

Property	Type	Description
`completedAt`	`datetime?`
`processingErrors`	`string?`

ImmediateInvoicingData

Required properties

Property	Type	Description
`accountLocator`	`ulid`
`currencies`	`string[]`

Fetch Invoice Job Data For Account

Fetch Invoice Job Data For AccountfetchInvoiceJobDataForAccount

GET/billing/{tenantLocator}/jobs/invoices/accounts/{locator}/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:InvoiceGenerationJobListResponse

Security Group:jobs

Permissions:

read,list

InvoiceGenerationJobListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`InvoiceGenerationJob[]`

InvoiceGenerationJob

Required properties

Property	Type	Description
`locator`	`ulid`
`invoiceGenerationScheduleLocator`	`ulid`
`generateTime`	`datetime`
`completedAt`	`datetime`
`jobStatus`	`Enum queued \| finished \| failed \| running`
`processingErrors`	`string`
`createdAt`	`datetime`
`createdBy`	`uuid`
`invoiceGenerationInstances`	`InvoiceGenerationInstance[]`

InvoiceGenerationInstance

Required properties

Property	Type	Description
`locator`	`ulid`
`invoiceGenerationJobLocator`	`ulid`
`invoiceLocator`	`ulid`
`generateTime`	`datetime`
`completedAt`	`datetime`
`jobStatus`	`Enum queued \| finished \| failed \| running`
`processingErrors`	`string`
`createdAt`	`datetime`
`createdBy`	`uuid`

Fetch Invoice Lifecycle Job Data

Fetch Invoice Lifecycle Job DatafetchInvoiceLifecycleJobData

GET/billing/{tenantLocator}/jobs/invoicesLifecycle/{locator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:WorkflowContextInvoiceLifecycleJobData

Security Group:jobs

Permission:

read

WorkflowContextInvoiceLifecycleJobData

Required properties

Property	Type	Description
`workflowJobLocator`	`ulid`
`contextData`	`InvoiceLifecycleJobData`
`workflowType`	`Enum LATTICE_AND_INSTALLMENTS_GENERATION \| INVOICE_GENERATION \| INVOICE_LIFECYCLE \| PAYMENT_EXECUTION \| DELINQUENCY_MORATORIUM_EXECUTION`
`createdAt`	`datetime`

Optional properties

Property	Type	Description
`completedAt`	`datetime?`

InvoiceLifecycleJobData

Required properties

Property	Type	Description
`invoiceLocator`	`ulid`
`results`	`InvoiceLifecycleResult[]`
`triggers`	`InvoiceLifecycleTrigger[]`
`triggersHistory`	`InvoiceLifecycleTriggerUpdate[]`

Optional properties

Property	Type	Description
`processingErrors`	`string?`

InvoiceLifecycleTriggerUpdate

Required properties

Property	Type	Description
`comment`	`string`
`newTriggerTime`	`datetime`
`oldTriggerTime`	`datetime`
`triggerType`	`Enum autopay \| due`

InvoiceLifecycleTrigger

Required properties

Property	Type	Description
`triggerTime`	`datetime`
`triggerType`	`Enum autopay \| due`

InvoiceLifecycleResult

Required properties

Property	Type	Description
`resultLocator`	`ulid`
`resultType`	`Enum autopay \| due`

Early Invoicing

EarlyInvoicingGenerationData

Required properties

Property	Type	Description
`accountLocator`	`ulid`
`installmentsToBeInvoiced`	`ulid[]`

Optional properties

Property	Type	Description
`timezone`	`string?`
`invoiceDueTime`	`datetime?`
`invoiceThroughTime`	`datetime?`

Delinquency Jobs

Fetch Delinquency Grace Job

Fetch Delinquency Grace JobfetchDelinquencyGraceJob

GET/billing/{tenantLocator}/jobs/delinquencies/{delinquencyLocator}/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`delinquencyLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:GraceJobDataListResponse

Security Group:jobs

Permissions:

read,list

GraceJobDataListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`GraceJobData[]`

GraceJobData

Required properties

Property	Type	Description
`locator`	`ulid`
`delinquencyLocator`	`ulid`
`jobStatus`	`Enum queued \| finished \| failed \| running`
`updatedAt`	`datetime`
`createdAt`	`datetime`

Optional properties

Property	Type	Description
`outcome`	`string?`
`processingErrors`	`string?`

Fetch Create Delinquencies Job Data For Invoice

Fetch Create Delinquencies Job Data For InvoicefetchCreateDelinquenciesJobDataForInvoice

GET/billing/{tenantLocator}/jobs/delinquencies/invoices/{invoiceLocator}/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`invoiceLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:DelinquencyCreateJobDataListResponse

Security Group:jobs

Permissions:

read,list

DelinquencyCreateJobDataListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`DelinquencyCreateJobData[]`

DelinquencyCreateJobData

Required properties

Property	Type	Description
`locator`	`ulid`
`invoiceLocator`	`ulid`
`dueTime`	`datetime`
`jobStatus`	`Enum queued \| finished \| failed \| running`
`updatedAt`	`datetime`
`createdAt`	`datetime`
`delinquencyLocators`	`ulid[]`

Optional properties

Property	Type	Description
`processingErrors`	`string?`

Fetch Delinquency Event Jobs

Fetch Delinquency Event JobsfetchDelinquencyEventJobs

GET/billing/{tenantLocator}/jobs/delinquencies/{delinquencyLocator}/events/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`delinquencyLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:DelinquencyEventJobDataListResponse

Security Group:jobs

Permissions:

read,list

DelinquencyEventJobDataListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`DelinquencyEventJobData[]`

DelinquencyEventJobData

Required properties

Property	Type	Description
`locator`	`ulid`
`delinquencyEventLocator`	`ulid`
`delinquencyLocator`	`ulid`
`jobStatus`	`Enum queued \| finished \| failed \| running`
`triggerTime`	`datetime`
`updatedAt`	`datetime`
`createdAt`	`datetime`
`updatedDelinquencyEventLocators`	`ulid[]`

Optional properties

Property	Type	Description
`rescheduledByLocator`	`ulid?`
`cancellationType`	`Enum? cancellationRequested \| rescheduled \| tenantRetired \| delinquencySettled \| delinquencyHeld`
`cancelled`	`boolean?`
`processingErrors`	`string?`

Anonymization Jobs

Fetch Anonymization Jobs

Fetch Anonymization JobsfetchAnonymizationJobs

GET/compliance/{tenantLocator}/jobs

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`request`	query	`FetchAnonymizationJobsRequest`	Yes

Response:AnonymizationJobResponse[]

Security Group:compliance

Permission:

read

FetchAnonymizationJobsRequest

Required properties

Property	Type	Description
`jobLocators`	`ulid[]`

AnonymizationJobResponse

Required properties

Property	Type	Description
`jobLocator`	`ulid`
`jobDetails`	`AnonymizationJobDetails`
`jobStatus`	`Enum initialized \| running \| suspended \| completed`
`referenceType`	`Enum none \| account \| quickQuote \| quote \| policy \| contact \| fnol \| payment \| disbursement`
`updatedAt`	`datetime`
`assignedReferenceLocators`	`ulid[]`

Optional properties

Property	Type	Description
`parentJobLocator`	`ulid?`
`processingErrors`	`string?`
`createdBy`	`uuid?`
`anonymizedReferenceLocators`	`ulid[]?`

AnonymizationJobDetails

Required properties

Property	Type	Description
`assignedReferenceLocators`	`ulid[]`

Optional properties

Property	Type	Description
`includeAcceptedQuotes`	`boolean?`
`problematicReferenceLocators`	`ProblematicReferenceLocators?`
`policyStatuses`	`Enum[]? pending \| expired \| cancelled \| cancelPending \| onRisk \| delinquent \| doNotRenew`

ProblematicReferenceLocators

Required properties

Property	Type	Description
`assigned`	`ulid[]`
`children`	`ulid[]`
`failed`	`ulid[]`

Deserialization Jobs

List Deserialize Schedule Items Jobs

List Deserialize Schedule Items JobslistDeserializeScheduleItemsJobs

GET/policy/{tenantLocator}/deserializeJobs/{jobType}/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`jobType`	path	`string`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`state`	query	`string[]?`	No

Response:ListPageResponseDeserializationJob

Security Group:deserializeJobs

Permissions:

read,list

ListPageResponseDeserializationJob

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`DeserializationJob[]`

DeserializationJob

Required properties

Property	Type	Description
`locator`	`ulid`
`jobState`	`Enum initialized \| running \| interrupted \| failed \| completed \| terminated`
`jobType`	`Enum scheduleItems`
`metadata`	`DeserializationRequestMetadata`
`retryCount`	`integer`
`updatedAt`	`datetime`
`createdAt`	`datetime`
`createdBy`	`uuid`

Optional properties

Property	Type	Description
`processingErrors`	`string?`

DeserializationRequestMetadata

Required properties

Property	Type	Description
`referenceLocator`	`ulid`
`staticElementLocator`	`ulid`
`fileName`	`string`
`fileSize`	`integer`
`referenceType`	`string`
`params`	`map<string, string>`

Fetch Deserialize Schedule Items Job

Fetch Deserialize Schedule Items JobfetchDeserializeScheduleItemsJob

GET/policy/{tenantLocator}/deserializeJobs/{locator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:DeserializationJob

Security Group:deserializeJobs

Permission:

read

Terminate Deserialization Job

Terminate Deserialization JobterminateDeserializationJob

PATCH/policy/{tenantLocator}/deserializeJobs/{locator}/terminate

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:void

Security Group:deserializeJobs

Permission:

write

Restart Deserialization Job

Restart Deserialization JobrestartDeserializationJob

PATCH/policy/{tenantLocator}/deserializeJobs/{locator}/restart

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:void

Security Group:deserializeJobs

Permission:

write

Jobs API

On this page