JobRepr

Top  Previous  Next

Description

Representation of a Job without status information. Used to create an update jobs.

 

XML Representation

<?xml version="1.0"?>

<Job Type="%Import|Export|SchemaSync|Transaction%" Status="%Created|Queued%">

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

</Job>

 

JSON Representation

 

"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