Skip to content

JobTemplateDetails

Interface

Job template detailed information.

Properties

PropertyTypeNotes
activitiesActivity[]

Activities associated with the job template.

categorystring

Category used for grouping job templates.

defaultAssignedTostring

Default assignment when creating jobs.

defaultAssignedTypeAssignedType

Default assigned type when creating jobs.

defaultDescriptionstring

Default description used when creating jobs.

defaultDueDateDate

Default due date for the job.

defaultFinalStatusstring

Default final status when a job is closed.

defaultJobDurationnumber

Default job duration for setting the job due date. Expected number of days to complete a job after the start date. Use this in place of defaultDueDate .

defaultJobNamestring

Default naming for jobs. For example, JOB_[index] .

defaultPrioritystring

Default priority when a job is created.

defaultStartDateDate

Default start date used when jobStartDateType=SpecificDate .

defaultStatusstring

Default status when a job is created.

descriptionstring

Description for the job template.

diagramIdstring

Id of the diagram associated with the job template.

diagramNamestring

Name of the diagram associated with the job template.

extendedPropertyTableDefinitionsExtendedPropertyTableDefinition[]

Extended property tables associated with the job template.

jobStartDateTypeJobStartDateType

Start date type used when creating jobs.

jobTemplateIdstring

Job template Id. Only required for existing job templates.

jobTemplateNamestring

Job template name.

stateJobTemplateState

State of the job template. Default to draft if not specified.

activities

optional
Interface Property
activities: Activity[]

Activities associated with the job template.

category

optional
Interface Property
category: string

Category used for grouping job templates.

defaultAssignedTo

optional
Interface Property
defaultAssignedTo: string

Default assignment when creating jobs.

defaultAssignedType

optional
Interface Property
defaultAssignedType: AssignedType

Default assigned type when creating jobs.

defaultDescription

optional
Interface Property
defaultDescription: string

Default description used when creating jobs.

defaultDueDate

optional
Interface Property
defaultDueDate: Date

Default due date for the job.

defaultFinalStatus

optional
Interface Property
defaultFinalStatus: string

Default final status when a job is closed.

defaultJobDuration

optional
Interface Property
defaultJobDuration: number

Default job duration for setting the job due date. Expected number of days to complete a job after the start date. Use this in place of defaultDueDate .

defaultJobName

optional
Interface Property
defaultJobName: string

Default naming for jobs. For example, JOB_[index] .

defaultPriority

Interface Property
defaultPriority: string

Default priority when a job is created.

defaultStartDate

optional
Interface Property
defaultStartDate: Date

Default start date used when jobStartDateType=SpecificDate .

defaultStatus

optional
Interface Property
defaultStatus: string

Default status when a job is created.

description

optional
Interface Property
description: string

Description for the job template.

diagramId

optional
Interface Property
diagramId: string

Id of the diagram associated with the job template.

diagramName

optional
Interface Property
diagramName: string

Name of the diagram associated with the job template.

extendedPropertyTableDefinitions

optional
Interface Property
extendedPropertyTableDefinitions: ExtendedPropertyTableDefinition[]

Extended property tables associated with the job template.

jobStartDateType

optional
Interface Property
jobStartDateType: JobStartDateType

Start date type used when creating jobs.

jobTemplateId

optional
Interface Property
jobTemplateId: string

Job template Id. Only required for existing job templates.

jobTemplateName

Interface Property
jobTemplateName: string

Job template name.

state

optional
Interface Property
state: JobTemplateState

State of the job template. Default to draft if not specified.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.