Jobs Property Specification

The tabbed section below shows the list of properties that apply for each context that can be referenced for certain API endpoints.  This list can also be called over the API using the /jobs-sdk/propertyspec?context={context} endpoint. 

'job'context

Property Specifications for Jobs Application for context job

Name: customerAddrCity
Type: String
Case-sensitive: No
Description: The customer's city. The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: customerAddrCountry
Type: String
Case-sensitive: No
Description: The customer's country. The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: customerAddrLine1
Type: String
Case-sensitive: No
Description: First line of the customer's address. The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: customerAddrLine2
Type: String
Case-sensitive: No
Description: Second line of the customer's address. The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: customerAddrPostalCode
Type: String
Case-sensitive: No
Description: The customer's postal(zip) code. The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: customerAddrState
Type: String
Case-sensitive: No
Description: The customer's state. The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: customerContact
Type: String
Case-sensitive: No
Description: Customer contact information (usually an e-mail address). The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: customerName
Type: String
Case-sensitive: No
Description: The name of the customer. The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: customerPhoneNumber
Type: String
Case-sensitive: No
Description: The customer's phone number. The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: deviceId
Type: String
Case-sensitive: Yes
Max Length: 36
Description: The PrintOS device ID of an Indigo DFE or Press device.
Name: duplex
Type: Boolean
Description: Indicates whether or not this job is printed on both sides of the media. A value of true indicates printing on both sides, a value of false indiciates printing on only one side. No value indicates that we do not know whether or not this was a duplex job.
Name: frameSizeX
Type: Integer
Description: Represents the fully imposed image size along the feed direction dimension of a printed sheet or printed web frame in millimeters.
Name: frameSizeY
Type: Integer
Description: Represents the fully imposed image size across the feed direction dimension of a printed sheet or printed web frame.
Name: hpTrackingId
Type: String
Case-sensitive: Yes
Max Length: 20
Description: The value of the HpTrackingId field of the JDF job ticket for this job. A barcode friendly identifier for a job of limited length and character set. HP Indigo presses can print this code on banner sheets, printed job tickets, etc.
Name: impressions
Type: Integer
Description: The total number of impressions for the Print Run.
Name: impressions1Color
Type: Integer
Description: The total number of one color impressions for the Print Run.
Name: impressions2Colors
Type: Integer
Description: The total number of two color impressions for the Print Run.
Name: impressionsType
Type: Enum
Description: Impressions are measured as an integer value based on the number of colors of inks used. This property contains an enum value representing the size of these impressions.
Values:
A3 Value that represents the type of impressions shown are A3 impressions.
B2 Value that represents the type of impressions shown are B2 impressions.
Name: inks
Type: JSON
Max Length: 1000
Description: Provides information about the types of inks used by the Print Run and how much of each was used. The Inks information is stored as a complex object containing the following members:
Name Type Description
counts JSON Array of inks used. Each ink is stored as a complex object containing the following members:
Name Type Description
name String The name of the ink used.
amountUsed Integer The amount of ink used (see 'units' property above for more information).
Consumer Notes: This information can be retrieved as a nested object or as a JSON string. When returning a nested object, the content will vary depending upon whether the results are requested in JSON or XML format. See the examples below to see what this looks like in the different formats. When returning a JSON string, the value is a string version of the JSON example.
Example:
JSON
{ 
                    
  "counts": [ 
                    
    { 
                    
      "name": "Black", 
                    
      "amountUsed": "983" 
                    
    }, 
                    
    { 
                    
      "name": "Cyan", 
                    
      "amountUsed": "980" 
                    
    }, 
                    
    { 
                    
      "name": "Pantone-253", 
                    
      "amountUsed": "980" 
                    
    } 
                    
  ] 
                    
}
                
Example:
XML
<?xml version='1.0' encoding='UTF-8'?> 
                        
<inks> 
                        
  <counts> 
                        
    <count> 
                        
      <name>Black</name> 
                        
      <amountUsed>983</amountUsed> 
                        
    </count> 
                        
    <count> 
                        
      <name>Cyan</name> 
                        
      <amountUsed>980</amountUsed> 
                        
    </count> 
                        
    <count> 
                        
      <name>Pantone-253</name> 
                        
      <amountUsed>980</amountUsed> 
                        
    </count> 
                        
  </counts> 
                        
</inks>
                    
Name: inkUnits
Type: Enum
Description: Ink usage is measured as an integer value representing the number of units of ink used. This property contains an enum value representing the unit-of-measure of these values.
Values:
IMPRESSIONS Indicates that the values represent the number of impressions printed with that color.
Name: jdfJobId
Type: String
Case-sensitive: Yes
Max Length: 100
Description: The value in the JobID field of the JDF job ticket for this job. The combination of the JDF fields JobID and JobPartID (see JdfJobPartID) is intended to uniquely identify a job in JDF.
Name: jdfJobPartId
Type: String
Case-sensitive: Yes
Max Length: 100
Description: The value in the JobPartID field of the JDF job ticket for this job. The combination of the JDF fields JobID (see JdfJobID) and JobPartID is intended to uniquely identify a job in JDF.
Name: jobCompleteTime
Type: Date
Description: For a DFE job, this is the time it went into a complete or aborted state. For Press jobs, it is the time the job was removed from the device. For Print Run jobs it is the time that the job finished printing or was aborted. For jobs still in progress, should be null. The time is represented as string in ISO-8601 format with the fractional seconds portion providing millisecond accurracy.
Consumer Notes: This always has a timezone of GMT with the date and time reflecting the local date and time on the device. For example, if a job was submitted on Jan 1, 2018 10:00AM New York time, the time in this field would look like 2018-01-01T10:00Z (note that the notion that this occurred in the New York time zone is not represented in the data).
Name: jobCondition
Type: Icon
Max Length: 20
Description: Enumeration indicating whether or not the job is in an needs attention state. The value indicates the severity of the condition. The severity of the state is determined by the provider.
Values:
OK The job is in a good condtion.
INFO The job is in a good condtion, but wants to inform the user of something.
WARN The job is in a warning state indicating that giving the job some attention may be necessary to complete the job or may improve the job in some way.
ERROR The job is in an error state indicating that something is wrong and action is required to complete the job (possibly the job will need to be restarted or resubmitted).
UNKNOWN Job state is unknown. This occurs when a device loses connection to the cloud and needs to resync. At the start of a resync, all jobs on the device are set to Unknown. If the device still knows about this job, then a job-specific resync event will overwrite this state with the current value (otherwise, the job will be left in this state indicating that we do not have sufficient information to determine the final state of the job).
Name: jobCopies
Type: Integer
Description: The number of printed copies requested for the job. The actual number printed may be different.
Name: jobElapseTime
Type: Duration
Description: The time the job took (or has taken so far) in milliseconds. This is the difference between when the job started and when it ended (or 'now' if it is still in progress). This is a total, not net, time. This is based upon the properties jobSubmitTime and jobCompleteTime ('now' is used if jobCompleteTime is null).
Name: jobId
Type: String
Case-sensitive: Yes
Max Length: 50
Description: Unique identifier of job on a device. Only unique within the context of the device the job is running on, but for that device it is unique over time.
Name: jobLastEventTime
Type: Date
Description: Time of the last event about the job (add/update/delete). String time in ISO-8601 format with the fractional seconds portion providing millisecond accurracy.
Consumer Notes: This always has a timezone of GMT with the date and time reflecting the local date and time on the device. For example, if a job was submitted on Jan 1, 2018 10:00AM New York time, the time in this field would look like 2018-01-01T10:00Z (note that the notion that this occurred in the New York time zone is not represented in the data).
Name: jobName
Type: String
Case-sensitive: No
Max Length: 255
Description: The friendly name of the job.
Name: jobPriority
Type: Integer
Description: The priority of the job. The value should be between 1 and 100 with higher values indicating a higher priority.
Name: jobPriorityEnum
Type: Enum
Description: The priority of the job translated to an Enum. Low is less than or equal to 25. Medium is greater than 25 and less than or equal to 50. High is greater than 50 and less than or equal to 75. Rush is greater than 75.
Values:
LOW Job priority <= 25.
MEDIUM Job priority > 25 and <= 50.
HIGH Job priority > 50 and <= 75.
RUSH Job priority > 75.
Name: jobProgress
Type: Enum
Max Length: 20
Description: Enumeration indicating the phase of processing that the job is in. Specific job types may only support a subset of the possible states.
Values:
PRE_RIP The job has arrived and is getting ready to RIP.
RIPPING The job is currently RIPping.
RIPPED The job has completed RIPping at the DFE, but has not been loaded on a Press Controller yet (it may have been assigned to a Press).
LOADING The DFE job has completed RIPping and is loading onto the Press Controller.
AT_PRINT_DEVICE The DFE job has been sent to a Press.
HELD The Press job is in the Held queue.
QUEUED The Press job is in the Print Queue, but is not the job currently being printed.
RETAINED The Press job is in the Retained queue. Normally, a Press job is placed in the Retained queue when it has finished printing. In this case, the value would normally be 'PRINTED'. However, if connectivity was lost during the time the job was placed in the Retain queue, and all the Jobs Data Collector knows is that the job is now in the Retained queue (but it does not know how it got there), then the value will be 'RETAINED'.
PRINTING The Press job is currently being printed.
PRINTED The Press job has successfully completed printing. It may be in the Retained queue or have been deleted (see LocationType for how to deterime which it is). This state can apply to DFE, Press, and Print Run jobs.
COMPLETED The job is considered to be completed. Complete is a terminal state (meaning no more actions can be performed on the job other than 'delete'.
ABORTED The job was aborted. It may or may not have had any successful Print Runs before being aborted. It may have been aborted in the middle of a Print Run. If this was a Print Run job, the Print Run job data can be used to determine how much printing was done before the job was aborted. It may still be in the Retained queue (allowing for possible additional prints), or it may have been deleted (see LocationType for how to determine which it is).
UNKNOWN The job state is unknown. This occurs when a device loses connection to the cloud and needs to resync. At the start of a resync, all jobs on the device are set to 'UNKNOWN'. If the device still knows about this job, then a job-specific resync event will overwrite this state with the current value (otherwise, the job will be left in the 'UNKNWON' state).
Name: jobSubmitTime
Type: Date
Description: The time the job was submitted to the device. The time is represneted as a string in ISO-8601 format with the fractional seconds portion providing millisecond accurracy.
Consumer Notes: This always has a timezone of GMT with the date and time reflecting the local date and time on the device. For example, if a job was submitted on Jan 1, 2018 10:00AM New York time, the time in this field would look like 2018-01-01T10:00Z (note that the notion that this occurred in the New York time zone is not represented in the data).
Name: jobSubstrate
Type: StringList
Max Length: 100
Description: A comma-separated list of the substrate names used by the job.
Name: jobType
Type: Enum
Max Length: 20
Description: Identifies the type of job being represented. The PrintOS Jobs App tracks three types of jobs (DFE, Press, and Print). This property provides a means to determine the job type without needing to know if the id property refers to a DFE or a Press, and if a job is on a press, being able to distinguish Press jobs from Print Run jobs.
Values:
DFE The entry represents a job on a DFE.
PRESS The entry represents a job on a Press.
PRINT_RUN The entry represents and individual print of the Press job on a Press. A single job can be printed multiple times and each time generates a new Print Run job.
Name: jobWorkTimeEstimate
Type: Duration
Description: The estimated time for the job to complete. The time is in seconds. This is the estimated time for the entire print and does not take into account any time that has already been spent on a printing job.
Name: lastPrintedTime
Type: Date
Description: For a job that has finished printing or has been aborted multiple times this is the time the job finished printing most recently (note this does not distinguish between successful versus failed or aborted prints). For jobs that have never printed, it will be null. The time is represented as a string in ISO-8601 format with the fractional seconds portion providing millisecond accurracy.
Consumer Notes: This always has a timezone of GMT with the date and time reflecting the local date and time on the device. For example, if a job was submitted on Jan 1, 2018 10:00AM New York time, the time in this field would look like 2018-01-01T10:00Z (note that the notion that this occurred in the New York time zone is not represented in the data).
Name: location
Type: String
Case-sensitive: No
Max Length: 255
Description: Identifies the current location of the job. The type of value stored in this field is determined by the locationType property. For Indigo DFE jobs, it should contain the PrintOS Device ID of the DFE before the job goes to the press and when it is on a Press it should be the Press's PrintOS Device ID. For Indigo Press Jobs, it should contain the the ID of the Press queue the job is in. Once the job is complete the behavior depends upon whether or not the job is still on the device. If it is, the location should continue to contain a correct location; otherwise (e.g., it has been deleted), it should be set to null. When locationType is QUEUE, the location values will be: HELD, QUEUED, or RETAINED.
Name: locationType
Type: Enum
Max Length: 20
Description: Enumeration indicating the type of value stored in the location property. If location contains a value, then this field must be set; otherwise, it should also be set to null or DELETED (if the job has been deleted).
Values:
POS_DEVICE_ID The data in the Location property is a PrintOS device ID (UUID).
DELETED The job has been deleted and no longer exists on the device.
QUEUE The information in the Location property is the ID of one of the Press device queues.
Name: marker
Type: Long
Description: This field is used as an aid to reading job records using the APIs. The marker of a record can be passed to the API as an anchor to get the next page of records after (or before) the marker. When paging through the results, the marker value in the last record returned by the previous call should be used as the 'startMarker' parameter in the next request.
Name: parentDevId
Type: String
Case-sensitive: Yes
Max Length: 36
Description: Press jobs may be associated with a job on a DFE (this is not always known). When the parent job is known, this property contains the PrintOS device ID of the DFE hosting the parent job. See the parentJobId property for additional information.
Name: parentJobId
Type: String
Case-sensitive: Yes
Max Length: 50
Description: Some jobs have a parent job (e.g., a Press job may have a parent DFE job, and a Print Run job may have a parent Press job). When the parent job is known, this property contains the job ID of the parent job on the parent job device. Job ID's are only unique within the context of a device (i.e., a PrintOS device ID). If this is a Press job, then the parentDevId property will contain the PrintOS device ID of the DFE hosting the parent job. If this is a Print Run, then the id property will contain the PrintOS device ID of the Press hosting the parent job.
Name: queueOrderIndex
Type: Long
Description: Value indicating the job's place in the queue. Larger values are later in the queue. For things like DFE jobs that are not stored as an ordered queue, the value of this property roughly squenences jobs in the order they were submitted.
Name: resolution
Type: Integer
Description: Print resolution of the job in dots-per-inch.
Name: substrates
Type: JSON
Max Length: 800
Description: Provides information about the types of substrates used by the Print Run and how much of each was used. The Substrates information is stored as a complex object containing the following members:
Name Type Description
count JSON Array of substrates used. Each substrate is stored as a complex object containing the following members:
Name Type Description
name String The name of the substrate used.
amountUsed Integer The amount of substrate used (see 'units' property above for more information).
Consumer Notes: This information can be retrieved as a nested object or as a JSON string. When returning a nested object, the content will vary depending upon whether the results are requested in JSON or XML format. See the examples below to see what this looks like in the different formats. When returning a JSON string, the value is a string version of the JSON example.
Example:
JSON
{ 
                    
  "counts": [ 
                    
    { 
                    
      "name": "MaxPaper", 
                    
      "amountUsed": "583" 
                    
    }, 
                    
    { 
                    
      "name": "Glossy", 
                    
      "amountUsed": "400" 
                    
    }, 
                    
  ] 
                    
}
                
Example:
XML
<?xml version='1.0' encoding='UTF-8'?> 
                        
<substrates> 
                        
  <counts> 
                        
    <count> 
                        
      <name>MaxPaper</name> 
                        
      <amountUsed>583</amountUsed> 
                        
    </count> 
                        
    <count> 
                        
      <name>Glossy</name> 
                        
      <amountUsed>400</amountUsed> 
                        
    </count> 
                        
  </counts> 
                        
</substrates>
                    
Name: substrateUnits
Type: Enum
Description: Substrate usage is measured as an integer value representing the number of units of substrate used. This property contains an enum value representing the unit-of-measure of these values.
Values:
SHEETS Substrate value represents the number of sheets of paper printed.
Name: ticketTemplate
Type: String
Case-sensitive: No
Max Length: 128
Description: Name of the ticket template to use when printing the job.
'dfe' context

Property Specifications for Jobs Application for context dfe

Name: customerAddrCity
Type: String
Case-sensitive: No
Description: The customer's city. The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: customerAddrCountry
Type: String
Case-sensitive: No
Description: The customer's country. The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: customerAddrLine1
Type: String
Case-sensitive: No
Description: First line of the customer's address. The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: customerAddrLine2
Type: String
Case-sensitive: No
Description: Second line of the customer's address. The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: customerAddrPostalCode
Type: String
Case-sensitive: No
Description: The customer's postal(zip) code. The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: customerAddrState
Type: String
Case-sensitive: No
Description: The customer's state. The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: customerContact
Type: String
Case-sensitive: No
Description: Customer contact information (usually an e-mail address). The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: customerName
Type: String
Case-sensitive: No
Description: The name of the customer. The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: customerPhoneNumber
Type: String
Case-sensitive: No
Description: The customer's phone number. The customer information is supplied for Indigo Press jobs as part of the JDF job description submitted to the DFE.
Name: deviceId
Type: String
Case-sensitive: Yes
Max Length: 36
Description: The PrintOS device ID of an Indigo DFE or Press device.
Name: duplex
Type: Boolean
Description: Indicates whether or not this job is printed on both sides of the media. A value of true indicates printing on both sides, a value of false indiciates printing on only one side. No value indicates that we do not know whether or not this was a duplex job.
Name: hpTrackingId
Type: String
Case-sensitive: Yes
Max Length: 20
Description: The value of the HpTrackingId field of the JDF job ticket for this job. A barcode friendly identifier for a job of limited length and character set. HP Indigo presses can print this code on banner sheets, printed job tickets, etc.
Name: jdfJobId
Type: String
Case-sensitive: Yes
Max Length: 100
Description: The value in the JobID field of the JDF job ticket for this job. The combination of the JDF fields JobID and JobPartID (see JdfJobPartID) is intended to uniquely identify a job in JDF.
Name: jdfJobPartId
Type: String
Case-sensitive: Yes
Max Length: 100
Description: The value in the JobPartID field of the JDF job ticket for this job. The combination of the JDF fields JobID (see JdfJobID) and JobPartID is intended to uniquely identify a job in JDF.
Name: jobCompleteTime
Type: Date
Description: For a DFE job, this is the time it went into a complete or aborted state. For Press jobs, it is the time the job was removed from the device. For Print Run jobs it is the time that the job finished printing or was aborted. For jobs still in progress, should be null. The time is represented as string in ISO-8601 format with the fractional seconds portion providing millisecond accurracy.
Consumer Notes: This always has a timezone of GMT with the date and time reflecting the local date and time on the device. For example, if a job was submitted on Jan 1, 2018 10:00AM New York time, the time in this field would look like 2018-01-01T10:00Z (note that the notion that this occurred in the New York time zone is not represented in the data).
Name: jobCondition
Type: Icon
Max Length: 20
Description: Enumeration indicating whether or not the job is in an needs attention state. The value indicates the severity of the condition. The severity of the state is determined by the provider.
Values:
OK The job is in a good condtion.
INFO The job is in a good condtion, but wants to inform the user of something.
WARN The job is in a warning state indicating that giving the job some attention may be necessary to complete the job or may improve the job in some way.
ERROR The job is in an error state indicating that something is wrong and action is required to complete the job (possibly the job will need to be restarted or resubmitted).
UNKNOWN Job state is unknown. This occurs when a device loses connection to the cloud and needs to resync. At the start of a resync, all jobs on the device are set to Unknown. If the device still knows about this job, then a job-specific resync event will overwrite this state with the current value (otherwise, the job will be left in this state indicating that we do not have sufficient information to determine the final state of the job).
Name: jobCopies
Type: Integer
Description: The number of printed copies requested for the job. The actual number printed may be different.
Name: jobElapseTime
Type: Duration
Description: The time the job took (or has taken so far) in milliseconds. This is the difference between when the job started and when it ended (or 'now' if it is still in progress). This is a total, not net, time. This is based upon the properties jobSubmitTime and jobCompleteTime ('now' is used if jobCompleteTime is null).
Name: jobId
Type: String
Case-sensitive: Yes
Max Length: 50
Description: Unique identifier of job on a device. Only unique within the context of the device the job is running on, but for that device it is unique over time.
Name: jobLastEventTime
Type: Date
Description: Time of the last event about the job (add/update/delete). String time in ISO-8601 format with the fractional seconds portion providing millisecond accurracy.
Consumer Notes: This always has a timezone of GMT with the date and time reflecting the local date and time on the device. For example, if a job was submitted on Jan 1, 2018 10:00AM New York time, the time in this field would look like 2018-01-01T10:00Z (note that the notion that this occurred in the New York time zone is not represented in the data).
Name: jobName
Type: String
Case-sensitive: No
Max Length: 255
Description: The friendly name of the job.
Name: jobPriority
Type: Integer
Description: The priority of the job. The value should be between 1 and 100 with higher values indicating a higher priority.
Name: jobPriorityEnum
Type: Enum
Description: The priority of the job translated to an Enum. Low is less than or equal to 25. Medium is greater than 25 and less than or equal to 50. High is greater than 50 and less than or equal to 75. Rush is greater than 75.
Values:
LOW Job priority <= 25.
MEDIUM Job priority > 25 and <= 50.
HIGH Job priority > 50 and <= 75.
RUSH Job priority > 75.
Name: jobProgress
Type: Enum
Max Length: 20
Description: Enumeration indicating the phase of processing that the job is in. Specific job types may only support a subset of the possible states.
Values:
PRE_RIP The job has arrived and is getting ready to RIP.
RIPPING The job is currently RIPping.
RIPPED The job has completed RIPping at the DFE, but has not been loaded on a Press Controller yet (it may have been assigned to a Press).
LOADING The DFE job has completed RIPping and is loading onto the Press Controller.
AT_PRINT_DEVICE The DFE job has been sent to a Press.
HELD The Press job is in the Held queue.
QUEUED The Press job is in the Print Queue, but is not the job currently being printed.
RETAINED The Press job is in the Retained queue. Normally, a Press job is placed in the Retained queue when it has finished printing. In this case, the value would normally be 'PRINTED'. However, if connectivity was lost during the time the job was placed in the Retain queue, and all the Jobs Data Collector knows is that the job is now in the Retained queue (but it does not know how it got there), then the value will be 'RETAINED'.
PRINTING The Press job is currently being printed.
PRINTED The Press job has successfully completed printing. It may be in the Retained queue or have been deleted (see LocationType for how to deterime which it is). This state can apply to DFE, Press, and Print Run jobs.
COMPLETED The job is considered to be completed. Complete is a terminal state (meaning no more actions can be performed on the job other than 'delete'.
ABORTED The job was aborted. It may or may not have had any successful Print Runs before being aborted. It may have been aborted in the middle of a Print Run. If this was a Print Run job, the Print Run job data can be used to determine how much printing was done before the job was aborted. It may still be in the Retained queue (allowing for possible additional prints), or it may have been deleted (see LocationType for how to determine which it is).
UNKNOWN The job state is unknown. This occurs when a device loses connection to the cloud and needs to resync. At the start of a resync, all jobs on the device are set to 'UNKNOWN'. If the device still knows about this job, then a job-specific resync event will overwrite this state with the current value (otherwise, the job will be left in the 'UNKNWON' state).
Name: jobSubmitTime
Type: Date
Description: The time the job was submitted to the device. The time is represneted as a string in ISO-8601 format with the fractional seconds portion providing millisecond accurracy.
Consumer Notes: This always has a timezone of GMT with the date and time reflecting the local date and time on the device. For example, if a job was submitted on Jan 1, 2018 10:00AM New York time, the time in this field would look like 2018-01-01T10:00Z (note that the notion that this occurred in the New York time zone is not represented in the data).
Name: jobSubstrate
Type: StringList
Max Length: 100
Description: A comma-separated list of the substrate names used by the job.
Name: jobType
Type: Enum
Max Length: 20
Description: Identifies the type of job being represented. The PrintOS Jobs App tracks three types of jobs (DFE, Press, and Print). This property provides a means to determine the job type without needing to know if the id property refers to a DFE or a Press, and if a job is on a press, being able to distinguish Press jobs from Print Run jobs.
Values:
DFE The entry represents a job on a DFE.
PRESS The entry represents a job on a Press.
PRINT_RUN The entry represents and individual print of the Press job on a Press. A single job can be printed multiple times and each time generates a new Print Run job.
Name: lastPrintedTime
Type: Date
Description: For a job that has finished printing or has been aborted multiple times this is the time the job finished printing most recently (note this does not distinguish between successful versus failed or aborted prints). For jobs that have never printed, it will be null. The time is represented as a string in ISO-8601 format with the fractional seconds portion providing millisecond accurracy.
Consumer Notes: This always has a timezone of GMT with the date and time reflecting the local date and time on the device. For example, if a job was submitted on Jan 1, 2018 10:00AM New York time, the time in this field would look like 2018-01-01T10:00Z (note that the notion that this occurred in the New York time zone is not represented in the data).
Name: location
Type: String
Case-sensitive: No
Max Length: 255
Description: Identifies the current location of the job. The type of value stored in this field is determined by the locationType property. For Indigo DFE jobs, it should contain the PrintOS Device ID of the DFE before the job goes to the press and when it is on a Press it should be the Press's PrintOS Device ID. For Indigo Press Jobs, it should contain the the ID of the Press queue the job is in. Once the job is complete the behavior depends upon whether or not the job is still on the device. If it is, the location should continue to contain a correct location; otherwise (e.g., it has been deleted), it should be set to null. When locationType is QUEUE, the location values will be: HELD, QUEUED, or RETAINED.
Name: locationType
Type: Enum
Max Length: 20
Description: Enumeration indicating the type of value stored in the location property. If location contains a value, then this field must be set; otherwise, it should also be set to null or DELETED (if the job has been deleted).
Values:
POS_DEVICE_ID The data in the Location property is a PrintOS device ID (UUID).
DELETED The job has been deleted and no longer exists on the device.
QUEUE The information in the Location property is the ID of one of the Press device queues.
Name: marker
Type: Long
Description: This field is used as an aid to reading job records using the APIs. The marker of a record can be passed to the API as an anchor to get the next page of records after (or before) the marker. When paging through the results, the marker value in the last record returned by the previous call should be used as the 'startMarker' parameter in the next request.
Name: queueOrderIndex
Type: Long
Description: Value indicating the job's place in the queue. Larger values are later in the queue. For things like DFE jobs that are not stored as an ordered queue, the value of this property roughly squenences jobs in the order they were submitted.
Name: resolution
Type: Integer
Description: Print resolution of the job in dots-per-inch.
Name: ticketTemplate
Type: String
Case-sensitive: No
Max Length: 128
Description: Name of the ticket template to use when printing the job.
'press' context

Property Specifications for Jobs Application for context press

Name: deviceId
Type: String
Case-sensitive: Yes
Max Length: 36
Description: The PrintOS device ID of an Indigo DFE or Press device.
Name: duplex
Type: Boolean
Description: Indicates whether or not this job is printed on both sides of the media. A value of true indicates printing on both sides, a value of false indiciates printing on only one side. No value indicates that we do not know whether or not this was a duplex job.
Name: frameSizeX
Type: Integer
Description: Represents the fully imposed image size along the feed direction dimension of a printed sheet or printed web frame in millimeters.
Name: frameSizeY
Type: Integer
Description: Represents the fully imposed image size across the feed direction dimension of a printed sheet or printed web frame.
Name: hpTrackingId
Type: String
Case-sensitive: Yes
Max Length: 20
Description: The value of the HpTrackingId field of the JDF job ticket for this job. A barcode friendly identifier for a job of limited length and character set. HP Indigo presses can print this code on banner sheets, printed job tickets, etc.
Name: impressions
Type: Integer
Description: The total number of impressions for the Print Run.
Name: impressions1Color
Type: Integer
Description: The total number of one color impressions for the Print Run.
Name: impressions2Colors
Type: Integer
Description: The total number of two color impressions for the Print Run.
Name: impressionsType
Type: Enum
Description: Impressions are measured as an integer value based on the number of colors of inks used. This property contains an enum value representing the size of these impressions.
Values:
A3 Value that represents the type of impressions shown are A3 impressions.
B2 Value that represents the type of impressions shown are B2 impressions.
Name: inks
Type: JSON
Max Length: 1000
Description: Provides information about the types of inks used by the Print Run and how much of each was used. The Inks information is stored as a complex object containing the following members:
Name Type Description
counts JSON Array of inks used. Each ink is stored as a complex object containing the following members:
Name Type Description
name String The name of the ink used.
amountUsed Integer The amount of ink used (see 'units' property above for more information).
Consumer Notes: This information can be retrieved as a nested object or as a JSON string. When returning a nested object, the content will vary depending upon whether the results are requested in JSON or XML format. See the examples below to see what this looks like in the different formats. When returning a JSON string, the value is a string version of the JSON example.
Example:
JSON
{ 
                    
  "counts": [ 
                    
    { 
                    
      "name": "Black", 
                    
      "amountUsed": "983" 
                    
    }, 
                    
    { 
                    
      "name": "Cyan", 
                    
      "amountUsed": "980" 
                    
    }, 
                    
    { 
                    
      "name": "Pantone-253", 
                    
      "amountUsed": "980" 
                    
    } 
                    
  ] 
                    
}
                
Example:
XML
<?xml version='1.0' encoding='UTF-8'?> 
                        
<inks> 
                        
  <counts> 
                        
    <count> 
                        
      <name>Black</name> 
                        
      <amountUsed>983</amountUsed> 
                        
    </count> 
                        
    <count> 
                        
      <name>Cyan</name> 
                        
      <amountUsed>980</amountUsed> 
                        
    </count> 
                        
    <count> 
                        
      <name>Pantone-253</name> 
                        
      <amountUsed>980</amountUsed> 
                        
    </count> 
                        
  </counts> 
                        
</inks>
                    
Name: inkUnits
Type: Enum
Description: Ink usage is measured as an integer value representing the number of units of ink used. This property contains an enum value representing the unit-of-measure of these values.
Values:
IMPRESSIONS Indicates that the values represent the number of impressions printed with that color.
Name: jdfJobId
Type: String
Case-sensitive: Yes
Max Length: 100
Description: The value in the JobID field of the JDF job ticket for this job. The combination of the JDF fields JobID and JobPartID (see JdfJobPartID) is intended to uniquely identify a job in JDF.
Name: jdfJobPartId
Type: String
Case-sensitive: Yes
Max Length: 100
Description: The value in the JobPartID field of the JDF job ticket for this job. The combination of the JDF fields JobID (see JdfJobID) and JobPartID is intended to uniquely identify a job in JDF.
Name: jobCompleteTime
Type: Date
Description: For a DFE job, this is the time it went into a complete or aborted state. For Press jobs, it is the time the job was removed from the device. For Print Run jobs it is the time that the job finished printing or was aborted. For jobs still in progress, should be null. The time is represented as string in ISO-8601 format with the fractional seconds portion providing millisecond accurracy.
Consumer Notes: This always has a timezone of GMT with the date and time reflecting the local date and time on the device. For example, if a job was submitted on Jan 1, 2018 10:00AM New York time, the time in this field would look like 2018-01-01T10:00Z (note that the notion that this occurred in the New York time zone is not represented in the data).
Name: jobCondition
Type: Icon
Max Length: 20
Description: Enumeration indicating whether or not the job is in an needs attention state. The value indicates the severity of the condition. The severity of the state is determined by the provider.
Values:
OK The job is in a good condtion.
INFO The job is in a good condtion, but wants to inform the user of something.
WARN The job is in a warning state indicating that giving the job some attention may be necessary to complete the job or may improve the job in some way.
ERROR The job is in an error state indicating that something is wrong and action is required to complete the job (possibly the job will need to be restarted or resubmitted).
UNKNOWN Job state is unknown. This occurs when a device loses connection to the cloud and needs to resync. At the start of a resync, all jobs on the device are set to Unknown. If the device still knows about this job, then a job-specific resync event will overwrite this state with the current value (otherwise, the job will be left in this state indicating that we do not have sufficient information to determine the final state of the job).
Name: jobCopies
Type: Integer
Description: The number of printed copies requested for the job. The actual number printed may be different.
Name: jobElapseTime
Type: Duration
Description: The time the job took (or has taken so far) in milliseconds. This is the difference between when the job started and when it ended (or 'now' if it is still in progress). This is a total, not net, time. This is based upon the properties jobSubmitTime and jobCompleteTime ('now' is used if jobCompleteTime is null).
Name: jobId
Type: String
Case-sensitive: Yes
Max Length: 50
Description: Unique identifier of job on a device. Only unique within the context of the device the job is running on, but for that device it is unique over time.
Name: jobLastEventTime
Type: Date
Description: Time of the last event about the job (add/update/delete). String time in ISO-8601 format with the fractional seconds portion providing millisecond accurracy.
Consumer Notes: This always has a timezone of GMT with the date and time reflecting the local date and time on the device. For example, if a job was submitted on Jan 1, 2018 10:00AM New York time, the time in this field would look like 2018-01-01T10:00Z (note that the notion that this occurred in the New York time zone is not represented in the data).
Name: jobName
Type: String
Case-sensitive: No
Max Length: 255
Description: The friendly name of the job.
Name: jobPriority
Type: Integer
Description: The priority of the job. The value should be between 1 and 100 with higher values indicating a higher priority.
Name: jobPriorityEnum
Type: Enum
Description: The priority of the job translated to an Enum. Low is less than or equal to 25. Medium is greater than 25 and less than or equal to 50. High is greater than 50 and less than or equal to 75. Rush is greater than 75.
Values:
LOW Job priority <= 25.
MEDIUM Job priority > 25 and <= 50.
HIGH Job priority > 50 and <= 75.
RUSH Job priority > 75.
Name: jobProgress
Type: Enum
Max Length: 20
Description: Enumeration indicating the phase of processing that the job is in. Specific job types may only support a subset of the possible states.
Values:
PRE_RIP The job has arrived and is getting ready to RIP.
RIPPING The job is currently RIPping.
RIPPED The job has completed RIPping at the DFE, but has not been loaded on a Press Controller yet (it may have been assigned to a Press).
LOADING The DFE job has completed RIPping and is loading onto the Press Controller.
AT_PRINT_DEVICE The DFE job has been sent to a Press.
HELD The Press job is in the Held queue.
QUEUED The Press job is in the Print Queue, but is not the job currently being printed.
RETAINED The Press job is in the Retained queue. Normally, a Press job is placed in the Retained queue when it has finished printing. In this case, the value would normally be 'PRINTED'. However, if connectivity was lost during the time the job was placed in the Retain queue, and all the Jobs Data Collector knows is that the job is now in the Retained queue (but it does not know how it got there), then the value will be 'RETAINED'.
PRINTING The Press job is currently being printed.
PRINTED The Press job has successfully completed printing. It may be in the Retained queue or have been deleted (see LocationType for how to deterime which it is). This state can apply to DFE, Press, and Print Run jobs.
COMPLETED The job is considered to be completed. Complete is a terminal state (meaning no more actions can be performed on the job other than 'delete'.
ABORTED The job was aborted. It may or may not have had any successful Print Runs before being aborted. It may have been aborted in the middle of a Print Run. If this was a Print Run job, the Print Run job data can be used to determine how much printing was done before the job was aborted. It may still be in the Retained queue (allowing for possible additional prints), or it may have been deleted (see LocationType for how to determine which it is).
UNKNOWN The job state is unknown. This occurs when a device loses connection to the cloud and needs to resync. At the start of a resync, all jobs on the device are set to 'UNKNOWN'. If the device still knows about this job, then a job-specific resync event will overwrite this state with the current value (otherwise, the job will be left in the 'UNKNWON' state).
Name: jobSubmitTime
Type: Date
Description: The time the job was submitted to the device. The time is represneted as a string in ISO-8601 format with the fractional seconds portion providing millisecond accurracy.
Consumer Notes: This always has a timezone of GMT with the date and time reflecting the local date and time on the device. For example, if a job was submitted on Jan 1, 2018 10:00AM New York time, the time in this field would look like 2018-01-01T10:00Z (note that the notion that this occurred in the New York time zone is not represented in the data).
Name: jobSubstrate
Type: StringList
Max Length: 100
Description: A comma-separated list of the substrate names used by the job.
Name: jobType
Type: Enum
Max Length: 20
Description: Identifies the type of job being represented. The PrintOS Jobs App tracks three types of jobs (DFE, Press, and Print). This property provides a means to determine the job type without needing to know if the id property refers to a DFE or a Press, and if a job is on a press, being able to distinguish Press jobs from Print Run jobs.
Values:
DFE The entry represents a job on a DFE.
PRESS The entry represents a job on a Press.
PRINT_RUN The entry represents and individual print of the Press job on a Press. A single job can be printed multiple times and each time generates a new Print Run job.
Name: jobWorkTimeEstimate
Type: Duration
Description: The estimated time for the job to complete. The time is in seconds. This is the estimated time for the entire print and does not take into account any time that has already been spent on a printing job.
Name: lastPrintedTime
Type: Date
Description: For a job that has finished printing or has been aborted multiple times this is the time the job finished printing most recently (note this does not distinguish between successful versus failed or aborted prints). For jobs that have never printed, it will be null. The time is represented as a string in ISO-8601 format with the fractional seconds portion providing millisecond accurracy.
Consumer Notes: This always has a timezone of GMT with the date and time reflecting the local date and time on the device. For example, if a job was submitted on Jan 1, 2018 10:00AM New York time, the time in this field would look like 2018-01-01T10:00Z (note that the notion that this occurred in the New York time zone is not represented in the data).
Name: location
Type: String
Case-sensitive: No
Max Length: 255
Description: Identifies the current location of the job. The type of value stored in this field is determined by the locationType property. For Indigo DFE jobs, it should contain the PrintOS Device ID of the DFE before the job goes to the press and when it is on a Press it should be the Press's PrintOS Device ID. For Indigo Press Jobs, it should contain the the ID of the Press queue the job is in. Once the job is complete the behavior depends upon whether or not the job is still on the device. If it is, the location should continue to contain a correct location; otherwise (e.g., it has been deleted), it should be set to null. When locationType is QUEUE, the location values will be: HELD, QUEUED, or RETAINED.
Name: locationType
Type: Enum
Max Length: 20
Description: Enumeration indicating the type of value stored in the location property. If location contains a value, then this field must be set; otherwise, it should also be set to null or DELETED (if the job has been deleted).
Values:
POS_DEVICE_ID The data in the Location property is a PrintOS device ID (UUID).
DELETED The job has been deleted and no longer exists on the device.
QUEUE The information in the Location property is the ID of one of the Press device queues.
Name: marker
Type: Long
Description: This field is used as an aid to reading job records using the APIs. The marker of a record can be passed to the API as an anchor to get the next page of records after (or before) the marker. When paging through the results, the marker value in the last record returned by the previous call should be used as the 'startMarker' parameter in the next request.
Name: parentDevId
Type: String
Case-sensitive: Yes
Max Length: 36
Description: Press jobs may be associated with a job on a DFE (this is not always known). When the parent job is known, this property contains the PrintOS device ID of the DFE hosting the parent job. See the parentJobId property for additional information.
Name: parentJobId
Type: String
Case-sensitive: Yes
Max Length: 50
Description: Some jobs have a parent job (e.g., a Press job may have a parent DFE job, and a Print Run job may have a parent Press job). When the parent job is known, this property contains the job ID of the parent job on the parent job device. Job ID's are only unique within the context of a device (i.e., a PrintOS device ID). If this is a Press job, then the parentDevId property will contain the PrintOS device ID of the DFE hosting the parent job. If this is a Print Run, then the id property will contain the PrintOS device ID of the Press hosting the parent job.
Name: queueOrderIndex
Type: Long
Description: Value indicating the job's place in the queue. Larger values are later in the queue. For things like DFE jobs that are not stored as an ordered queue, the value of this property roughly squenences jobs in the order they were submitted.
Name: resolution
Type: Integer
Description: Print resolution of the job in dots-per-inch.
Name: substrates
Type: JSON
Max Length: 800
Description: Provides information about the types of substrates used by the Print Run and how much of each was used. The Substrates information is stored as a complex object containing the following members:
Name Type Description
count JSON Array of substrates used. Each substrate is stored as a complex object containing the following members:
Name Type Description
name String The name of the substrate used.
amountUsed Integer The amount of substrate used (see 'units' property above for more information).
Consumer Notes: This information can be retrieved as a nested object or as a JSON string. When returning a nested object, the content will vary depending upon whether the results are requested in JSON or XML format. See the examples below to see what this looks like in the different formats. When returning a JSON string, the value is a string version of the JSON example.
Example:
JSON
{ 
                    
  "counts": [ 
                    
    { 
                    
      "name": "MaxPaper", 
                    
      "amountUsed": "583" 
                    
    }, 
                    
    { 
                    
      "name": "Glossy", 
                    
      "amountUsed": "400" 
                    
    }, 
                    
  ] 
                    
}
                
Example:
XML
<?xml version='1.0' encoding='UTF-8'?> 
                        
<substrates> 
                        
  <counts> 
                        
    <count> 
                        
      <name>MaxPaper</name> 
                        
      <amountUsed>583</amountUsed> 
                        
    </count> 
                        
    <count> 
                        
      <name>Glossy</name> 
                        
      <amountUsed>400</amountUsed> 
                        
    </count> 
                        
  </counts> 
                        
</substrates>
                    
Name: substrateUnits
Type: Enum
Description: Substrate usage is measured as an integer value representing the number of units of substrate used. This property contains an enum value representing the unit-of-measure of these values.
Values:
SHEETS Substrate value represents the number of sheets of paper printed.
'printrun' context

Property Specifications for Jobs Application for context printrun

Name: deviceId
Type: String
Case-sensitive: Yes
Max Length: 36
Description: The PrintOS device ID of an Indigo DFE or Press device.
Name: duplex
Type: Boolean
Description: Indicates whether or not this job is printed on both sides of the media. A value of true indicates printing on both sides, a value of false indiciates printing on only one side. No value indicates that we do not know whether or not this was a duplex job.
Name: impressions
Type: Integer
Description: The total number of impressions for the Print Run.
Name: impressions1Color
Type: Integer
Description: The total number of one color impressions for the Print Run.
Name: impressions2Colors
Type: Integer
Description: The total number of two color impressions for the Print Run.
Name: impressionsType
Type: Enum
Description: Impressions are measured as an integer value based on the number of colors of inks used. This property contains an enum value representing the size of these impressions.
Values:
A3 Value that represents the type of impressions shown are A3 impressions.
B2 Value that represents the type of impressions shown are B2 impressions.
Name: inks
Type: JSON
Max Length: 1000
Description: Provides information about the types of inks used by the Print Run and how much of each was used. The Inks information is stored as a complex object containing the following members:
Name Type Description
counts JSON Array of inks used. Each ink is stored as a complex object containing the following members:
Name Type Description
name String The name of the ink used.
amountUsed Integer The amount of ink used (see 'units' property above for more information).
Consumer Notes: This information can be retrieved as a nested object or as a JSON string. When returning a nested object, the content will vary depending upon whether the results are requested in JSON or XML format. See the examples below to see what this looks like in the different formats. When returning a JSON string, the value is a string version of the JSON example.
Example:
JSON
{ 
                    
  "counts": [ 
                    
    { 
                    
      "name": "Black", 
                    
      "amountUsed": "983" 
                    
    }, 
                    
    { 
                    
      "name": "Cyan", 
                    
      "amountUsed": "980" 
                    
    }, 
                    
    { 
                    
      "name": "Pantone-253", 
                    
      "amountUsed": "980" 
                    
    } 
                    
  ] 
                    
}
                
Example:
XML
<?xml version='1.0' encoding='UTF-8'?> 
                        
<inks> 
                        
  <counts> 
                        
    <count> 
                        
      <name>Black</name> 
                        
      <amountUsed>983</amountUsed> 
                        
    </count> 
                        
    <count> 
                        
      <name>Cyan</name> 
                        
      <amountUsed>980</amountUsed> 
                        
    </count> 
                        
    <count> 
                        
      <name>Pantone-253</name> 
                        
      <amountUsed>980</amountUsed> 
                        
    </count> 
                        
  </counts> 
                        
</inks>
                    
Name: inkUnits
Type: Enum
Description: Ink usage is measured as an integer value representing the number of units of ink used. This property contains an enum value representing the unit-of-measure of these values.
Values:
IMPRESSIONS Indicates that the values represent the number of impressions printed with that color.
Name: jobCompleteTime
Type: Date
Description: For a DFE job, this is the time it went into a complete or aborted state. For Press jobs, it is the time the job was removed from the device. For Print Run jobs it is the time that the job finished printing or was aborted. For jobs still in progress, should be null. The time is represented as string in ISO-8601 format with the fractional seconds portion providing millisecond accurracy.
Consumer Notes: This always has a timezone of GMT with the date and time reflecting the local date and time on the device. For example, if a job was submitted on Jan 1, 2018 10:00AM New York time, the time in this field would look like 2018-01-01T10:00Z (note that the notion that this occurred in the New York time zone is not represented in the data).
Name: jobCopies
Type: Integer
Description: The number of printed copies requested for the job. The actual number printed may be different.
Name: jobElapseTime
Type: Duration
Description: The time the job took (or has taken so far) in milliseconds. This is the difference between when the job started and when it ended (or 'now' if it is still in progress). This is a total, not net, time. This is based upon the properties jobSubmitTime and jobCompleteTime ('now' is used if jobCompleteTime is null).
Name: jobId
Type: String
Case-sensitive: Yes
Max Length: 50
Description: Unique identifier of job on a device. Only unique within the context of the device the job is running on, but for that device it is unique over time.
Name: jobLastEventTime
Type: Date
Description: Time of the last event about the job (add/update/delete). String time in ISO-8601 format with the fractional seconds portion providing millisecond accurracy.
Consumer Notes: This always has a timezone of GMT with the date and time reflecting the local date and time on the device. For example, if a job was submitted on Jan 1, 2018 10:00AM New York time, the time in this field would look like 2018-01-01T10:00Z (note that the notion that this occurred in the New York time zone is not represented in the data).
Name: jobName
Type: String
Case-sensitive: No
Max Length: 255
Description: The friendly name of the job.
Name: jobProgress
Type: Enum
Max Length: 20
Description: Enumeration indicating the phase of processing that the job is in. Specific job types may only support a subset of the possible states.
Values:
PRE_RIP The job has arrived and is getting ready to RIP.
RIPPING The job is currently RIPping.
RIPPED The job has completed RIPping at the DFE, but has not been loaded on a Press Controller yet (it may have been assigned to a Press).
LOADING The DFE job has completed RIPping and is loading onto the Press Controller.
AT_PRINT_DEVICE The DFE job has been sent to a Press.
HELD The Press job is in the Held queue.
QUEUED The Press job is in the Print Queue, but is not the job currently being printed.
RETAINED The Press job is in the Retained queue. Normally, a Press job is placed in the Retained queue when it has finished printing. In this case, the value would normally be 'PRINTED'. However, if connectivity was lost during the time the job was placed in the Retain queue, and all the Jobs Data Collector knows is that the job is now in the Retained queue (but it does not know how it got there), then the value will be 'RETAINED'.
PRINTING The Press job is currently being printed.
PRINTED The Press job has successfully completed printing. It may be in the Retained queue or have been deleted (see LocationType for how to deterime which it is). This state can apply to DFE, Press, and Print Run jobs.
COMPLETED The job is considered to be completed. Complete is a terminal state (meaning no more actions can be performed on the job other than 'delete'.
ABORTED The job was aborted. It may or may not have had any successful Print Runs before being aborted. It may have been aborted in the middle of a Print Run. If this was a Print Run job, the Print Run job data can be used to determine how much printing was done before the job was aborted. It may still be in the Retained queue (allowing for possible additional prints), or it may have been deleted (see LocationType for how to determine which it is).
UNKNOWN The job state is unknown. This occurs when a device loses connection to the cloud and needs to resync. At the start of a resync, all jobs on the device are set to 'UNKNOWN'. If the device still knows about this job, then a job-specific resync event will overwrite this state with the current value (otherwise, the job will be left in the 'UNKNWON' state).
Name: jobSubmitTime
Type: Date
Description: The time the job was submitted to the device. The time is represneted as a string in ISO-8601 format with the fractional seconds portion providing millisecond accurracy.
Consumer Notes: This always has a timezone of GMT with the date and time reflecting the local date and time on the device. For example, if a job was submitted on Jan 1, 2018 10:00AM New York time, the time in this field would look like 2018-01-01T10:00Z (note that the notion that this occurred in the New York time zone is not represented in the data).
Name: jobType
Type: Enum
Max Length: 20
Description: Identifies the type of job being represented. The PrintOS Jobs App tracks three types of jobs (DFE, Press, and Print). This property provides a means to determine the job type without needing to know if the id property refers to a DFE or a Press, and if a job is on a press, being able to distinguish Press jobs from Print Run jobs.
Values:
DFE The entry represents a job on a DFE.
PRESS The entry represents a job on a Press.
PRINT_RUN The entry represents and individual print of the Press job on a Press. A single job can be printed multiple times and each time generates a new Print Run job.
Name: marker
Type: Long
Description: This field is used as an aid to reading job records using the APIs. The marker of a record can be passed to the API as an anchor to get the next page of records after (or before) the marker. When paging through the results, the marker value in the last record returned by the previous call should be used as the 'startMarker' parameter in the next request.
Name: parentJobId
Type: String
Case-sensitive: Yes
Max Length: 50
Description: Some jobs have a parent job (e.g., a Press job may have a parent DFE job, and a Print Run job may have a parent Press job). When the parent job is known, this property contains the job ID of the parent job on the parent job device. Job ID's are only unique within the context of a device (i.e., a PrintOS device ID). If this is a Press job, then the parentDevId property will contain the PrintOS device ID of the DFE hosting the parent job. If this is a Print Run, then the id property will contain the PrintOS device ID of the Press hosting the parent job.
Name: substrates
Type: JSON
Max Length: 800
Description: Provides information about the types of substrates used by the Print Run and how much of each was used. The Substrates information is stored as a complex object containing the following members:
Name Type Description
count JSON Array of substrates used. Each substrate is stored as a complex object containing the following members:
Name Type Description
name String The name of the substrate used.
amountUsed Integer The amount of substrate used (see 'units' property above for more information).
Consumer Notes: This information can be retrieved as a nested object or as a JSON string. When returning a nested object, the content will vary depending upon whether the results are requested in JSON or XML format. See the examples below to see what this looks like in the different formats. When returning a JSON string, the value is a string version of the JSON example.
Example:
JSON
{ 
                    
  "counts": [ 
                    
    { 
                    
      "name": "MaxPaper", 
                    
      "amountUsed": "583" 
                    
    }, 
                    
    { 
                    
      "name": "Glossy", 
                    
      "amountUsed": "400" 
                    
    }, 
                    
  ] 
                    
}
                
Example:
XML
<?xml version='1.0' encoding='UTF-8'?> 
                        
<substrates> 
                        
  <counts> 
                        
    <count> 
                        
      <name>MaxPaper</name> 
                        
      <amountUsed>583</amountUsed> 
                        
    </count> 
                        
    <count> 
                        
      <name>Glossy</name> 
                        
      <amountUsed>400</amountUsed> 
                        
    </count> 
                        
  </counts> 
                        
</substrates>
                    
Name: substrateUnits
Type: Enum
Description: Substrate usage is measured as an integer value representing the number of units of substrate used. This property contains an enum value representing the unit-of-measure of these values.
Values:
SHEETS Substrate value represents the number of sheets of paper printed.
'historic' context

Property Specifications for Jobs Application for context historic

Name: deviceId
Type: String
Case-sensitive: Yes
Max Length: 36
Description: The PrintOS device ID of an Indigo DFE or Press device.
Name: duplex
Type: Boolean
Description: Indicates whether or not this job is printed on both sides of the media. A value of true indicates printing on both sides, a value of false indiciates printing on only one side. No value indicates that we do not know whether or not this was a duplex job.
Name: epmImpressions
Type: Integer
Description: The total number of EPM impressions for the Print Run.
Name: impressions
Type: Integer
Description: The total number of impressions for the Print Run.
Name: impressions1Color
Type: Integer
Description: The total number of one color impressions for the Print Run.
Name: impressions2Colors
Type: Integer
Description: The total number of two color impressions for the Print Run.
Name: impressionsNColors
Type: Integer
Description: The total number of 3-or-more color impressions for the Print Run.
Name: impressionsType
Type: Enum
Max Length: 32
Description: Impressions are measured as an integer value based on the number of colors of inks used. This property contains an enum value representing the size of these impressions.
Values:
A3 Value that represents the type of impressions shown are A3 impressions.
B1 Value that represents the type of impressions shown are B1 impressions.
B2 Value that represents the type of impressions shown are B2 impressions.
Name: inks
Type: JSON
Max Length: 1000
Description: Provides information about the types of inks used by the Print Run and how much of each was used. The Inks information is stored as a complex object containing the following members:
Name Type Description
counts JSON Array of inks used. Each ink is stored as a complex object containing the following members:
Name Type Description
name String The name of the ink used.
amountUsed Integer The amount of ink used (see 'units' property above for more information).
Consumer Notes: This information can be retrieved as a nested object or as a JSON string. When returning a nested object, the content will vary depending upon whether the results are requested in JSON or XML format. See the examples below to see what this looks like in the different formats. When returning a JSON string, the value is a string version of the JSON example.
Example:
JSON
{ 
                    
  "counts": [ 
                    
    { 
                    
      "name": "Black", 
                    
      "amountUsed": "983" 
                    
    }, 
                    
    { 
                    
      "name": "Cyan", 
                    
      "amountUsed": "980" 
                    
    }, 
                    
    { 
                    
      "name": "Pantone-253", 
                    
      "amountUsed": "980" 
                    
    } 
                    
  ] 
                    
}
                
Example:
XML
<?xml version='1.0' encoding='UTF-8'?> 
                        
<inks> 
                        
  <counts> 
                        
    <count> 
                        
      <name>Black</name> 
                        
      <amountUsed>983</amountUsed> 
                        
    </count> 
                        
    <count> 
                        
      <name>Cyan</name> 
                        
      <amountUsed>980</amountUsed> 
                        
    </count> 
                        
    <count> 
                        
      <name>Pantone-253</name> 
                        
      <amountUsed>980</amountUsed> 
                        
    </count> 
                        
  </counts> 
                        
</inks>
                    
Name: inkUnits
Type: Enum
Description: Ink usage is measured as an integer value representing the number of units of ink used. This property contains an enum value representing the unit-of-measure of these values.
Values:
IMPRESSIONS Indicates that the values represent the number of impressions printed with that color.
Name: jobCollation
Type: Boolean
Description: When collation is true individual sheets or frames will be arranged in sequence for each copy. For example, if you are printing two copies of a three-sheet job, all sheets of copy 1 are printed in order, followed by all sheets of copy 2. If collation is false, all copies of sheet/frame 1 are printed, followed by all copies of sheet/frame 2, followed by all copies of sheet/frame 3.
Name: jobCompleteTime
Type: Date
Description: For a DFE job, this is the time it went into a complete or aborted state. For Press jobs, it is the time the job was removed from the device. For Print Run jobs it is the time that the job finished printing or was aborted. For jobs still in progress, should be null. The time is represented as string in ISO-8601 format with the fractional seconds portion providing millisecond accurracy.
Consumer Notes: This always has a timezone of GMT with the date and time reflecting the local date and time on the device. For example, if a job was submitted on Jan 1, 2018 10:00AM New York time, the time in this field would look like 2018-01-01T10:00Z (note that the notion that this occurred in the New York time zone is not represented in the data).
Name: jobElapseTime
Type: Duration
Description: The time the job took (or has taken so far) in milliseconds. This is the difference between when the job started and when it ended (or 'now' if it is still in progress). This is a total, not net, time. This is based upon the properties jobSubmitTime and jobCompleteTime ('now' is used if jobCompleteTime is null).
Name: jobName
Type: String
Case-sensitive: No
Max Length: 255
Description: The friendly name of the job.
Name: jobProgress
Type: Enum
Max Length: 20
Description: Enumeration indicating the phase of processing that the job is in.
Values:
PRINTED The Press job has successfully completed printing. It may be in the Retained queue or have been deleted (see LocationType for how to deterime which it is). This state can apply to DFE, Press, and Print Run jobs.
ABORTED The job was aborted. It may or may not have had any successful Print Runs before being aborted. It may have been aborted in the middle of a Print Run. If this was a Print Run job, the Print Run job data can be used to determine how much printing was done before the job was aborted. It may still be in the Retained queue (allowing for possible additional prints), or it may have been deleted (see LocationType for how to determine which it is).
Name: jobSubmitTime
Type: Date
Description: The time the job was submitted to the device. The time is represneted as a string in ISO-8601 format with the fractional seconds portion providing millisecond accurracy.
Consumer Notes: This always has a timezone of GMT with the date and time reflecting the local date and time on the device. For example, if a job was submitted on Jan 1, 2018 10:00AM New York time, the time in this field would look like 2018-01-01T10:00Z (note that the notion that this occurred in the New York time zone is not represented in the data).
Name: marker
Type: Long
Description: This field is used as an aid to reading job records using the APIs. The marker of a record can be passed to the API as an anchor to get the next page of records after (or before) the marker. When paging through the results, the marker value in the last record returned by the previous call should be used as the 'startMarker' parameter in the next request.
Name: oneShotImpressions
Type: Integer
Description: The total number of one shot impressions for the Print Run.
Name: pressSerialNumber
Type: String
Case-sensitive: Yes
Max Length: 64
Description: The press serial number providing the job data.
Name: printedSheets
Type: Integer
Description: The total number of printed sheets for the Print Run.
Name: repeatLength
Type: Integer
Description: The repeat length of a job printed on a WEB press in micrometers (0.000001 meters).
Name: substrates
Type: JSON
Max Length: 800
Description: Provides information about the types of substrates used by the Print Run and how much of each was used. The Substrates information is stored as a complex object containing the following members:
Name Type Description
count JSON Array of substrates used. Each substrate is stored as a complex object containing the following members:
Name Type Description
name String The name of the substrate used.
amountUsed Integer The amount of substrate used (see 'units' property above for more information).
Consumer Notes: This information can be retrieved as a nested object or as a JSON string. When returning a nested object, the content will vary depending upon whether the results are requested in JSON or XML format. See the examples below to see what this looks like in the different formats. When returning a JSON string, the value is a string version of the JSON example.
Example:
JSON
{ 
                    
  "counts": [ 
                    
    { 
                    
      "name": "MaxPaper", 
                    
      "amountUsed": "583" 
                    
    }, 
                    
    { 
                    
      "name": "Glossy", 
                    
      "amountUsed": "400" 
                    
    }, 
                    
  ] 
                    
}
                
Example:
XML
<?xml version='1.0' encoding='UTF-8'?> 
                        
<substrates> 
                        
  <counts> 
                        
    <count> 
                        
      <name>MaxPaper</name> 
                        
      <amountUsed>583</amountUsed> 
                        
    </count> 
                        
    <count> 
                        
      <name>Glossy</name> 
                        
      <amountUsed>400</amountUsed> 
                        
    </count> 
                        
  </counts> 
                        
</substrates>
                    
Name: substrateUnits
Type: Enum
Description: Substrate usage is measured as an integer value representing the number of units of substrate used. This property contains an enum value representing the unit-of-measure of these values.
Values:
SHEETS Substrate value represents the number of sheets of paper printed.
MILLIMETERS Substrate value represents the length of the substrate used in millimeters (0.001 meters).