JobStatusRepr

JobStatusRepr

Top Previous Next

Description

Representation of a long-running job that includes the current job status information.

XML Representation

<JobStatus

Type="%Import|Export|SchemaSync|Transaction%"

Status="%Created|Queued|Processing|Completed|CompletedWithErrors"

Address="%job resource uri%">

<Parameters>%job parameters list%</Parameters>

<Id>%job id%</Id>

<Identity>%identity of job submitter%</Identity>

<WorkerId>%worker thread identity string%</WorkerId>

<StatusMessage>%status message string%</StatusMessage>

<Created>%date/time%</Created>

<Updated>%date/time%</Updated>

<Completed>%date/time</Completed>

<Progress> See JobProgressRepr</Progress>

<JobData>

<JobData ...>See JobDataReference</JobData>*

</JobData>

</JobStatus>

JSON Representation

{

"Id":"%job id%",

"Address":"%job resource uri%",

"Identity":"%identity of job submitter%",

"WorkerId":"%worker thread identity string%",

"StatusMessage":"%status message string%",

"Created":%date/time%,

"Updated":%date/time%,

"Completed":%date/time%,

"Progress" : instance of JobProgressRepr

"JobData": array of JobDataReference,

"JobType":2,

"Status":2,

"Parameters":"%job parameters list%"

}

Notes

•	For the JSON representation, the JobType property can have the following values:

JSON Property Value	Equivalent XML Attribute Value	Description
0	Null	Reserved
1	TopicMapTransaction	Process a set of topic map update operations defined by a TransactionRepr
2	Import	Import data into a topic map
3	Export	Export data from a topic map
4	SchemaSync	Synchronize a topic map with its referenced schema.

•	For the JSON representation, the Status property can be assigned the following values:

JSON Property Value	Equivalent XML Attribute Value	Description
0	Created	Status for a job that has been created in the store, but not queued for processing yet
1	Queued	Status for a job that is queued for processing.
2	Processing	Status for a job that is being actively processed by a worker.
3	Completed	Status for a job that has completed processing successfully.
4	CompletedWithErrors	Status for a job that has encountered an error that prevented successful processing
99	Unknown	Reserved for future use

•	For both representations, the parameters list is a semi-colon separated list of parameter=value pairs. E.g. "ParamName=ParamValue;ParamName2=ParamValue2"

See Also

JobProgressRepr