jobInstanceDto Data Type

The Class JobInstanceDto.

Namespace
(Default)
Properties
name data type type namespace min/max occurs constraints description
jobTemplate string attribute 1/1   Job template.
timerCode string attribute 0/1   Job scheduling timer code.
active boolean element 0/1   Is job active. A negative of Disabled. Deprecated in 5.0.1. Use Disabled field instead.
customFields customFieldsDto element 0/1   Custom fields.
followingJob string element 0/1   Following job to execute.
jobCategory jobCategoryEnum element 1/1 required Job category.
limitToSingleNode boolean element 0/1   Can job be run in parallel on several cluster nodes. Value of True indicates that job can be run on a single node at a time.
parameter string element 0/1   Parameter to job execution.
runOnNodes string element 0/1   What cluster nodes job could/should run on. A comma separated list of custer nodes. A job can/will be run on any node if value is null.
verboseReport boolean element 0/1   Whether a verbose error log will be kept.
Properties inherited from enableBusinessDto
code string attribute 1/1   The code
description string attribute 0/1   The description
id long attribute 0/1   The id.
auditable auditableDto element 0/1    
auditableField auditableFieldDto element 0/unbounded    
disabled boolean element 0/1   Is entity disabled. Value is ignored in Update action - use enable/disable API instead.
updatedCode string element 0/1   The updated code.

Example

<JobInstance code="..." description="..." id="..." jobTemplate="..." timerCode="...">
  <jobCategory>...</jobCategory>
  <followingJob>...</followingJob>
  <parameter>...</parameter>
  <customFields>
    <customField code="..." description="..." valueDate="..." valuePeriodEndDate="..." valuePeriodPriority="..." valuePeriodStartDate="...">
      <fieldType>...</fieldType>
      <languageDescriptions/>
      <stringValue>...</stringValue>
      <dateValue>...</dateValue>
      <longValue>...</longValue>
      <doubleValue>...</doubleValue>
      <booleanValue>...</booleanValue>
      <listValue>
        <value/>
      </listValue>
      <mapValue>...</mapValue>
      <entityReferenceValue/>
      <indexType>...</indexType>
      <fileValue>...</fileValue>
      <formattedValue/>
      <guiPosition>...</guiPosition>
    </customField>
    <inheritedCustomField code="..." description="..." valueDate="..." valuePeriodEndDate="..." valuePeriodPriority="..." valuePeriodStartDate="...">
      <fieldType>...</fieldType>
      <languageDescriptions/>
      <stringValue>...</stringValue>
      <dateValue>...</dateValue>
      <longValue>...</longValue>
      <doubleValue>...</doubleValue>
      <booleanValue>...</booleanValue>
      <listValue>
        <value/>
      </listValue>
      <mapValue>...</mapValue>
      <entityReferenceValue/>
      <indexType>...</indexType>
      <fileValue>...</fileValue>
      <formattedValue/>
      <guiPosition>...</guiPosition>
    </inheritedCustomField>
  </customFields>
  <runOnNodes>...</runOnNodes>
  <limitToSingleNode>...</limitToSingleNode>
  <verboseReport>...</verboseReport>
  <disabled>...</disabled>
  <auditable created="..." creator="..." updated="..." updater="..."/>
  <auditableFields>
    <auditableField actor="..." changeOrigin="..." code="..." created="..." currentState="..." description="..." entityClass="..." fieldName="..." id="..." originName="..." previousState="...">
      <auditable/>
      <auditableFields>
        <auditableField/>
      </auditableFields>
      <updatedCode>...</updatedCode>
    </auditableField>
  </auditableFields>
  <updatedCode>...</updatedCode>
</JobInstance>