Module: job

Enumeration: JobType

Normal	0
Recurring	1
RecurringWithError	2
Issue	3
AdHoc	4
WorkflowJob	5
WorkflowIssue	6

Enumeration: JobState

PLANNED	1
ACTIVE	2
COMPLETED	3

Enumeration: StepState

STARTED	0
PAUSED	1
RESUMED	2

Enumeration: IntegrationStatus

PENDING	1
SUCCESS	2
ERROR	3

Enumeration: JobDeviationType

DEVIATION_INPUT_NA	0	1. Inputs marked N/A
DEVIATION_STEP_NA	1	2. Steps marked N/A
DEVIATION_STEP_GROUP_NA	2	3. Step groups marked N/A
DEVIATION_TEMPLATE_NA	3	4. Templates marked N/A
DEVIATION_INPUT_EMPTY	4	5. Inputs marked empty if parent step is completed
DEVIATION_INPUT_RANGE	5	6. Inputs out of range but is not N/A
DEVIATION_STEP_INCOMPLETE	6	7. Incomplete steps if job is completed
DEVIATION_CONDITIONAL_INCOMPLETE	7	8. Unused conditionals if job is completed
DEVIATION_CALCULATED_INPUT_EMPTY	8	9. Calculated fields missing underlying input fields (one or more empty) if parent step is completed
DEVIATION_INPUT_COMPLETE	9	9. Inputs marked complete if parent step is completed
DEVIATION_VALIDATION_TRIGGERED	10	10. Inputs for expected values with validation rule triggered

Enumeration: JobOrderBy

TITLE	1
CREATED_AT	2
PLANNED_START_AT	3
LAST_MODIFIED_AT	4
JOB_TYPE	5
STARTED_AT	6
COMPLETED_AT	7
LOOKUP_ID	8

Struct: PriorityLevel

Key	Field	Type	Description	Requiredness	Default value
1	priority	i32		default
2	title	string		default
3	id	string	unique identifier for a priority level, not a uuid for now	default
4	archivedAt	i64	priorities cannot currently be archived. this is future proofing for old clients	default

Struct: JobParams

Key	Field	Type	Description	Requiredness	Default value
1	title	string	Title of the job	optional
2	plannedStartAt	i64	expected start date	optional
3	skipPlanning	bool	start immediately (legacy model)	default	true
4	enableMesh	bool		optional
5	startAuto	bool	If true then will start job automatically on planned start at	optional
6	typ	JobType	On creation, Specify the job type. Normal, Issue and AdHoc are accepted on creation. JobType is Normal if null. In updateJob, can be explicitly set to change between: 1) Normal -> AdHoc 2) Recurring -> AdHoc 3) AdHoc -> Normal Any other type changes will be rejected with error. Setting to null performs no type changes.	optional
7	src	messaging.JobPtr	If JobType is Issue, optionally specify a source of the issue. If job is an instance started from an AdHoc (on-demand) job, specify the source job. Currently, only accepting references down to the detail of a step/group.	optional
8	priority	PriorityLevel		optional
9	location	string		optional
10	plannedStartJobRoleIds	list<string>	If JobType is AdHoc, this must be a non-empty, valid job role id list for the user starting an ad hoc job to be assigned the following roles. This is in addition to the roles already assigned to this user during planning.	optional
11	attributes	list<abac.AbacAttribute>	desired attributes on job object should match creating users attributes	optional
12	enableStepTracking	bool		optional
13	expiresAt	i64		optional
14	expiresAfterSeconds	i64		optional
30	dupJobId	string	Job to duplicate from, currently only template ref values are being copied over, skipping the need for validation and reducing traffic	optional

Mutable parts of a Job

Union: TemplateOrSetRef

Key	Field	Type	Description	Requiredness	Default value
1	templateId	string		default
2	templateSetId	string		default

Struct: AddUserParams

Key	Field	Type	Description	Requiredness	Default value
1	userId	string		optional
2	email	string		optional
3	jobRoleId	string		required

Struct: AddPlannerParams

Key	Field	Type	Description	Requiredness	Default value
1	userId	string		optional
2	email	string		optional

Struct: JobModularParams

Key	Field	Type	Description	Requiredness	Default value
1	teamId	string		default
2	title	string	Title of the job	default
3	plannedStartAt	i64	expected start date	optional
4	skipPlanning	bool	start immediately (legacy model)	default	true
5	templateRefs	list<TemplateOrSetRef>		default
6	users	list<AddUserParams>		default
7	planners	list<AddPlannerParams>		default
8	documentIds	list<string>		default
9	metadataEntries	list<metadata.MetadataEntry>		default
10	typ	JobType		default
11	src	messaging.JobPtr	If JobType is Issue, optionally specify a source of the issue. If job is an instance started from an AdHoc (on-demand) job, specify the source job. Currently, only accepting references down to the detail of a step/group.	optional
12	priority	PriorityLevel		optional
13	attributes	list<abac.AbacAttribute>		default
14	plannedStartJobRoleIds	list<string>	If JobType is AdHoc, this must be a non-empty, valid job role id list for the user starting an ad hoc job to be assigned the following roles. This is in addition to the roles already assigned to this user during planning.	optional
15	plannedDataSheetIdsList	list<map<string, string>>	Each entry in plannedDataSheetIds should correspond to an element in templateRefs, in and ordered, 1-to-1 fashion. Note that an element of templateRefs can be either a Template or a Template Set -- that is, multiple Templates. So while it's clear how to apply a plannedDataSheetIds element to a single Template, applying it to a Set goes as follows: The plannedDataSheetIds element will apply to all Templates in the Template Set. That means, if Template T1 references Data Sheet Set DS1, and Template T2 references Data Sheet Sets DS1 and DS2, then a Set of {T1, T2} references DS1 and DS2. So for that Template Set, the plannedDataSheeIds element must have key-value pairs for both DS1 and DS2. Additionally, the selected Data Sheet Value for DS1 will apply to both T1 and T2.	optional
16	enableStepTracking	bool		optional
17	expiresAt	i64		optional
18	expiresAfterSeconds	i64		optional
20	enableMesh	bool		optional
30	dupJobId	string	Job to duplicate from, currently only template ref values are being copied over, skipping the need for validation and reducing traffic	optional

Parts of a Job for creation

Struct: IntegrationResponse

Key	Field	Type	Description	Requiredness	Default value
1	status	IntegrationStatus		default
2	message	string		optional
3	timestamp	i64		default
4	correlationId	string		optional

Struct: FieldExecutionData

Key	Field	Type	Description	Requiredness	Default value
1	fieldId	string		default
2	seqId	i64		default
3	execData	field_data.ExecutionData		optional
4	lastUpdatedById	string		optional
5	lastUpdatedAt	i64		optional
6	document	document.Document		optional
7	isNotApplicable	bool		optional
8	isNotApplicableLastUpdatedById	string		optional
9	isNotApplicableLastUpdatedAt	i64		optional
10	integrationResponse	IntegrationResponse		optional
11	documents	list<document.Document>	For document typed execution data, provide doc details. On get, this can be used to estimate download; on send, can specify a pending documents to allocate an ID.	optional
1000	deviceId	string	For Mesh	optional
1001	deviceSeqId	i64		optional

Execution data for a particular input field

Struct: StepExecutionData

Key	Field	Type	Description	Requiredness	Default value
1	stepId	string		default
2	jobBaseStepId	string		default
3	stepComplete	bool		default
4	fieldExecutionData	list<FieldExecutionData>		default
5	isComplete	bool		optional
6	isCompleteLastUpdatedById	string		optional
7	isCompleteLastUpdatedAt	i64		optional
8	isNotApplicable	bool		optional
9	isNotApplicableLastUpdatedById	string		optional
10	isNotApplicableLastUpdatedAt	i64		optional
11	seqId	i64		default
12	state	StepState	For Step Time Tracking Steps can be explicitly started : this is when the timer clock starts state , 0 = Started, 1 = Paused, 2 = Resumed lastUpdatedAt and lastUpdatedBy are used to track time and user when last action was performed for start/pause/resume isCompleteLastUpdatedById and isCompleteLastUpdatedAt should probably be replaced in future by these 2 fields elapsedDurationUser is the elapsed duration for the user	optional
13	lastUpdatedAt	i64		optional
14	lastUpdatedById	string		optional
15	elapsedDurationUser	i64		optional
1000	deviceId	string	For Mesh	optional
1001	deviceSeqId	i64		optional

Execution data for a step

Struct: StepGroupExecutionData

Key	Field	Type	Description	Requiredness	Default value
1	stepGroupId	string		default
2	jobBaseStepId	string		default
3	conditionalIsYes	bool		optional
4	conditionalLastUpdatedById	string		optional
5	conditionalLastUpdatedAt	i64		optional
6	seqId	i64		default
8	isNotApplicable	bool		optional
9	isNotApplicableLastUpdatedById	string		optional
10	isNotApplicableLastUpdatedAt	i64		optional
1000	deviceId	string	For Mesh	optional
1001	deviceSeqId	i64		optional

Execution data for a step group

Union: ExecutionSnippet

Key	Field	Type	Description	Requiredness	Default value
1	stepGroupExecData	StepGroupExecutionData		default
2	stepExecData	StepExecutionData		default

Umbrella type for various data sent during execution

Struct: GetDataOptions

Key	Field	Type	Description	Requiredness	Default value
1	canHandlePendingDocuments	bool		default	false
2	includeAllStepTracking	bool		optional

Struct: GetDataResult

Key	Field	Type	Description	Requiredness	Default value
1	seqId	i64	The maximum sequenceId from the accompanying stepExecutionData list	default
2	stepExecutionData	list<StepExecutionData>		default
3	jobCompletedAt	i64		default
4	snippets	list<ExecutionSnippet>		default
5	jobId	string		default

Struct: SendDataResult

Key	Field	Type	Description	Requiredness	Default value
1	jobId	string		default
2	seqId	i64	The maximum sequenceId from the accompanying snippets list	default
3	snippets	list<ExecutionSnippet>		default

Struct: JobUser

Key	Field	Type	Description	Requiredness	Default value
1	id	string		default
2	jobId	string		default
3	user	user.User		default
4	jobRole	job_role.JobRole		default
5	archivedAt	i64		default

Struct: JobCompletionCode

Key	Field	Type	Description	Requiredness	Default value
1	id	string		required
2	number	i32		required
3	text	string		required

Struct: Job

Key	Field	Type	Description	Requiredness	Default value
1	id	string		default
2	title	string		default
3	stepGroup	step.BaseStep	Top level step group	default
4	team	team.Team		default
5	jobTemplateId	string	Template from which this Job was created	default
6	jobTemplateVersion	i32	The version of the Job Template that was used to create this Job	default
7	completedAt	i64		default
8	documentEmailAddress	string	Unique email address that can be used for submitting documents for this Job	default
9	createdAt	i64		default
11	documents	list<document.Document>		default
12	jobUsers	list<JobUser>		default
13	completedSteps	i32		default
14	totalSteps	i32		default
15	reasonCompleted	string		default
16	isPreview	bool	Preview jobs are for authoring use before publishing	default
17	plannedStartAt	i64	expected start date	default
18	startedAt	i64	0 if job in planning, else actual start date	default
19	creatorId	string		default
20	metadataById	map<string, metadata.MetadataEntry>		default
21	meshEnabled	bool		default
22	startAuto	bool	If true then will start job automatically on planned start at	optional
23	jobType	JobType		default
24	usingEvents	bool		default
25	src	messaging.JobPtr	If JobType is Issue, optionally specify a source of the issue. If job is an instance started from an AdHoc (on-demand) job, specify the source job. Currently, only accepting references down to the detail of a step/group.	optional
26	archivedAt	i64		default
27	location	string		optional
28	plannedStartJobRoleIds	list<string>	If JobType is AdHoc, this must be a non-empty, valid job role id list for the user starting an ad hoc job to be assigned the following roles. This is in addition to the roles already assigned to this user during planning.	optional
29	enableStepTracking	bool		optional
30	archivedBy	user.User		optional
31	canceledBy	user.User		optional
32	canceledAt	i64		default
33	expiresAt	i64		default
34	expiresAfterSeconds	i64		optional
101	completionCode	JobCompletionCode		optional
102	eligibleCompletionCodeIds	list<common.UUID>	DEPRECATED If this job is a workflow job instance, then this list will define the valid completion codes on job completion. It is used to branch the workflow accordingly. Codes are sent by UUID, and retrieved thanks to dedicated completion code endpoints.	optional

Base Job object

Struct: JobStats

Key	Field	Type	Description	Requiredness	Default value
1	completedSteps	i32		default
2	totalSteps	i32		default

Struct: JobActivity

Key	Field	Type	Description	Requiredness	Default value
1	lastMessageAt	i64		default
2	lastMessageSeqId	i64		default
3	lastMessageText	string		default
4	lastExecutionDataAt	i64		default
5	lastExecutionDataSeqId	i64		default
6	lastModifiedAt	i64		default

Struct: JobDocument

Key	Field	Type	Description	Requiredness	Default value
1	fromTemplate	bool		default
2	document	document.Document		default

Struct: JobRecurringRule

Key	Field	Type	Description	Requiredness	Default value
1	rule	schedule.RecurringRule	The rule for when you want the job to recur	default
2	startImm	bool	True if you want to start immediately	optional

Struct: RecurredJobInfo

Key	Field	Type	Description	Requiredness	Default value
1	recurringJobId	string		default
2	recurringRule	JobRecurringRule		default

Struct: IssueJobLink

Key	Field	Type	Description	Requiredness	Default value
1	issueId	string		default
2	srcPtr	messaging.JobPtr	Points to the job element the issue was created from	default
3	memberIds	set<string>	Lists the users who belong to this issue. NOTE: this is not used by mobile and events	default
4	issueTitle	string	Name of the issue	default
5	issueCreatorId	string	UserId of the creator	default
6	issueCreatedAt	i64	CreatedAt timestamp of the issue	default
7	lookupId	string	human readable identifier	optional
8	priority	PriorityLevel	priority of the issue	optional

Represent an issue whose src points to an element in this job.
Note: when adding fields, remember to add corresponding field in IssueLinkOp

Struct: JobDeviationRef

Key	Field	Type	Description	Requiredness	Default value
1	deviationStepGroupId	string		optional
2	deviationStepId	string		optional
3	deviationStepFieldId	string		optional
4	deviationFieldTriggerId	string		optional
5	deviationId	string		optional
11	sourceStepGroupId	string		optional
12	sourceStepId	string		optional
13	sourceTemplateId	string		optional
14	sourceTemplateVersion	i32		optional
15	templateIndex	i32		optional
16	hierarchyPosition	string		optional

A combination of ids are used based on deviation type

Struct: JobModular

Key	Field	Type	Description	Requiredness	Default value
1	id	string	Job UUID	default
2	title	string		default
3	jobTemplateId	string		default
4	jobTemplateInternalVersion	i32		default
5	teamId	string		default
6	completedAt	i64		default
7	reasonCompleted	string		default
8	createdAt	i64		default
9	updatedAt	i64		default
10	isPreview	bool	Preview jobs are for authoring use before publishing	default
11	documentEmailAddress	string	Unique email address that can be used for submitting documents for this Job	default
12	plannedStartAt	i64	expected start date	default
13	startedAt	i64	0 if job in planning, else actual start date	default
14	creatorId	string		default
15	metadataById	map<string, metadata.MetadataEntry>		default
16	meshEnabled	bool		default
17	recurringRule	JobRecurringRule	This will be filled in for the recurring job seed	optional
18	recurredInfo	RecurredJobInfo	This will be filled in for the job which was created from the seed	optional
19	schedule	schedule.Schedule	the associated schedule instance for recurring job seeds	optional
20	startAuto	bool	If true then will start job automatically on planned start at	optional
21	jobType	JobType		default
22	usingEvents	bool		default
23	src	messaging.JobPtr	If JobType is Issue, optionally specify a source of the issue. If job is an instance started from an AdHoc (on-demand) job, specify the source job. Currently, only accepting references down to the detail of a step/group.	optional
24	lookupId	string	This field will be populated with a human readable globally unique identifier. This idenfitier will have the format <Job|Issue>-<number> (current) <team_domain>-<j|i>-<number> (legacy)	optional
25	priority	PriorityLevel		optional
26	archivedAt	i64		default
27	location	string		optional
28	plannedStartJobRoleIds	list<string>	If JobType is AdHoc, this must be a non-empty, valid job role id list for the user starting an ad hoc job to be assigned the following roles. This is in addition to the roles already assigned to this user during planning.	optional
29	startedBy	user.User		optional
30	completedBy	user.User		optional
31	archivedBy	user.User		optional
32	canceledBy	user.User		optional
33	canceledAt	i64		default
34	expiresAt	i64		default
35	expiresAfterSeconds	i64		optional
101	team	team.TeamModular		optional
102	jobTemplate	job_template.JobTemplateModular		optional
103	rootHeaders	group_headers.StepGroupHeaders	deprecated since multiple templates can be applied to a job	optional
104	stepGroup	step.BaseStep		optional
105	documents	list<document.Document>	deprecated in favor of jobDocuments	optional
106	jobUsers	list<JobUser>		optional
107	stats	JobStats		optional
108	activity	JobActivity		optional
109	templates	list<job_template.JobTemplateModular>	supercedes jobTemplate	optional
110	creator	user.User		optional
111	roles	list<job_role.JobRole>		optional
112	jobDocuments	list<JobDocument>		optional
113	permissions	job_role.JobPermissions	the union of the current user's role permissions for the job	optional
114	messages	list<messaging.Message>		optional
115	snippets	list<ExecutionSnippet>		optional
116	issues	list<IssueJobLink>		optional
117	deviationCounts	map<JobDeviationType, i32>	no entry for type with 0 deviations	optional
118	deviations	map<JobDeviationType, list<JobDeviationRef>>	no entry for type with 0 deviations	optional
119	attributes	list<abac.AbacAttribute>		optional
120	completionCode	JobCompletionCode		optional
121	eligibleCompletionCodeIds	list<common.UUID>	DEPRECATED If this job is a workflow job instance, then this list will define the valid completion codes on job completion. It is used to branch the workflow accordingly. Codes are sent by UUID, and retrieved thanks to dedicated completion code endpoints.	optional
125	references	map<reference.RefSource, set<string>>		optional
126	enableStepTracking	bool		optional

Struct: CompleteOpts

Key	Field	Type	Description	Requiredness	Default value
1	completionCode	completion_code.CompletionCode		optional
2	reason	string		optional
3	completedAt	i64		optional

Struct: JobSelectOpts

Key	Field	Type	Description	Requiredness	Default value
1	includeTeam	bool		default
2	includeTemplate	bool		default
3	includeRootHeaders	bool	includeRootHeaders is no longer functional since support of multi-template jobs has been implemented	default
4	includeSteps	bool		default
5	includeDocuments	bool		default
6	includeUsers	bool		default
7	includeStats	bool		default
8	includeActivity	bool		default
9	includeTemplates	bool		default
10	includeCreator	bool		default
11	includeRoles	bool		default
12	includePermissions	bool		default
13	includeExecSnippets	bool		default
14	includeMessages	bool		default
15	includeIssues	bool		default
16	includeDeviationCounts	bool		default
17	includeDeviations	bool		default
25	includeRefMap	bool		default
30	includePlannedDataSheetIds	bool	Only valid when job is still in planning	default
31	includeSnapshottedDataSheetValues	bool	Only valid when job has started	default
32	includeAttributes	bool		default

Union: JobFetchResult

Key	Field	Type	Description	Requiredness	Default value
1	job	JobModular		default
2	err	common.SystemException		default

Return type for Fetch. Either a valid JobModular result or an error

Struct: JobTextSearch

Key	Field	Type	Description	Requiredness	Default value
1	query	string		default

Struct: JobWhereOpts

Key	Field	Type	Description	Requiredness	Default value
1	teamId	string		optional
2	userId	string	If not self, teamId required.	optional
3	isComplete	bool		optional
4	isPreview	bool		optional
5	isStarted	bool		optional
6	txt	JobTextSearch		optional
7	templateMetadata	list<metadata.MetadataEntry>	See MetadataValue for specific metadata filter criteria	optional
8	creatorId	string	If not self, teamId required. Will yield a positive match only for the creator of the job	optional
9	plannerId	string	If not self, teamId required. Will match jobs where the plannerId == the userId of ANY of job planners belonging to that job	optional
10	jobMetadata	list<metadata.MetadataEntry>		optional
11	modifiedSinceTime	i64		optional
12	modifiedBeforeTime	i64		optional
13	includeRecurringJobs	bool		optional
14	jobTypes	set<JobType>	If set, will only include the selected JobTypes, and will override includeRecurringJobs If unset, will not include issues, and abide by includeRecurringJobs	optional
15	archivedOnly	bool	If set to true, will only include archived jobs If set to false, will include all jobs If unset (default), will only include unarchived jobs	optional
16	minCreatedAt	i64	Allow users to filter jobs by their createdAt timestamp	optional
17	maxCreatedAt	i64		optional
18	startedSinceTime	i64		optional
19	startedBeforeTime	i64		optional
20	pageReq	common.PageReq		optional
21	sourceTemplateIds	list<string>		optional
22	priorities	list<i32>	For issues only, must only use issue job type in jobTypes	optional
23	srcJobIds	list<string>	For issues only, must only use issue job type in jobTypes	optional
24	completedSinceTime	i64		optional
25	completedBeforeTime	i64		optional
26	teamIds	list<string>	Overrides teamId when set: queries across teams user has admin permission on	optional
27	allUserTeams	bool	Overrides teamIds and teamId when set: Queries across ALL teams user has permissions on This includes admin permissions for all jobs and executor permissions for on demand jobs	optional
28	allSourceTemplateIds	bool	When set to true, jobs matched must contain all `sourceTemplateIds` defined. By default, they are multi-select, i.e. jobs with any of `sourceTemplateIds` are matched.	optional
29	attributes	list<abac.AbacAttribute>	allows job filtering by attributes	optional
30	canceledOnly	bool	If set to true, will only include canceled jobs If set to false, will include all jobs If unset (default), will only include uncanceled jobs	optional

Returns currentUser's jobs by default (teamId/userId unset). If teamId set, returns all jobs for that team. If teamId and userId set, returns all jobs for that team containing that user. If templateMetadata or jobMetadata is set, teamId must be set.

Struct: JobOrder

Key	Field	Type	Description	Requiredness	Default value
1	field	JobOrderBy		default
2	asc	bool		default	true

Struct: JobQueryResult

Key	Field	Type	Description	Requiredness	Default value
1	jobs	list<JobModular>		default
2	pageInfo	common.PageInfo		optional

Struct: JobQueryUpdatedResult

Key	Field	Type	Description	Requiredness	Default value
1	timestamp	i64		default
2	jobs	list<JobModular>		default
3	removedJobIds	list<string>		default

Struct: JobFilterQueryOpts

Key	Field	Type	Description	Requiredness	Default value
1	selectOpts	JobSelectOpts		optional
2	order	list<JobOrder>		optional
3	pageReq	common.PageReq		optional
4	title	string		optional
5	tzLocation	string	Client IANA time zone location, e.g. "America/Los_Angeles", defaults to "UTC"	optional
6	tzOffset	i64	Client time zone offset, in seconds east of UTC; only used when tzLocation is unset	optional

Additional options to override the filter's stored selectOpts, order and to request for pagination when querying.

Function: JobService.query

JobQueryResult query(JobSelectOpts selectOpts,
                     JobWhereOpts whereOpts,
                     list<JobOrder> order)
    throws common.SystemException

Query a list of Jobs

Function: JobService.queryWithFilter

JobQueryResult queryWithFilter(string filterId,
                               JobFilterQueryOpts opts)
    throws common.SystemException

Query a list of Jobs using a stored custom filter

Function: JobService.queryUpdated

JobQueryUpdatedResult queryUpdated(JobSelectOpts selectOpts,
                                   i64 lastUpdated,
                                   set<JobType> jobTypes)
    throws common.SystemException

Query a list of Jobs that have been changed since the lastUpdated time If lastUpdated == 0, then same as calling query(). The call will result the same as calling query() with JobWhereOpts all default values. (i.e. all the jobs you belong too that have been started, previews that haven't been closed, etc. )

Function: JobService.fetch

map<string, JobFetchResult> fetch(JobSelectOpts selectOpts,
                                list<string> jobIds)
    throws common.SystemException

Fetch a specific list of Jobs.

Each element in the jobIds list must be either
1) A job uuid OR
2) A job lookupId in the format of <team-domain>-j-<lookup-id> for jobs and <team-domain>-i-<lookup-id> for issues
The keys in the return value will be either job uuids or unique lookupId identifiers depending on what was passed in.

Function: JobService.createBlank

JobModular createBlank(string teamId,
                       JobParams params,
                       list<abac.AbacAttribute> attributes)
    throws common.SystemException

Create a job with a blank (empty) template; returned struct has all non-empty components filled in.

Function: JobService.instantiateRecurringJob

JobModular instantiateRecurringJob(string jobId)
    throws common.SystemException

Use this function to instantiate a new 'copy' of the recurring job. This is basically to force create it outside of the normal recurring flow

Function: JobService.retryRecurringJob

void retryRecurringJob(string jobId)
    throws common.SystemException

Force run any pending instances of this recurring job. If the recurring job has been paused due to many errors, it will unpause and retry. Will throw an error if something goes wrong

Function: JobService.updateRecurringRule

JobModular updateRecurringRule(string jobId,
                               JobRecurringRule recurringRule)
    throws common.SystemException

Update the schedule at which the job will be created

Function: JobService.createPreview

Job createPreview(string templateId,
                  JobParams params)
    throws common.SystemException

Create a preview job

Function: JobService.createModular

JobModular createModular(JobModularParams params)
    throws common.SystemException

Function: JobService.addTemplates

JobModular addTemplates(string jobId,
                        list<string> templateIds,
                        i32 position)
    throws common.SystemException

Add templates to a job (when in planning); position to add before, -1 to add at end

Function: JobService.cloneTemplate

JobModular cloneTemplate(string jobId,
                         string templateJobBaseStepId,
                         i32 position)
    throws common.SystemException

Clone a template already inside a job (use the jobBaseStepId of the template). The job needs to be started Note : It will copy any added steps, and it will use the same template version even if the template was updated It literally is a clone of the template hierarchy currently in the job

Function: JobService.multiActionTemplates

JobModular multiActionTemplates(string jobId,
                                list<common.ListActions> movements)
    throws common.SystemException

Set full list of templates on a job. This replaces the need for consecutive api calls when moving, removing, editing and adding templates
To add a template with data sheet definition references, use AddAction with extraInfo set to the data sheet set id -> data sheet id map
To edit a template's data sheet selections on a job in planning state, use EditAction with extraInfo set to the updated data sheet set id -> data sheet id map; note that you cannot edit a template on a started job

Function: JobService.multiAddTemplates

JobModular multiAddTemplates(string jobId,
                             list<common.AddAction> adds)
    throws common.SystemException

Add multiple templates to an active job.

Function: JobService.addStep

Job addStep(string jobId,
            string parentJobBaseStepId,
            step.BaseStep step,
            i32 position)
    throws common.SystemException

Add a step to a job.

• parentJobBaseStepId is the jobBaseStepId of the parent step group to be added to
• Position is the position at which you want to insert the new child. Position == -1 inserts it at the end

Function: JobService.addStepGroup

Job addStepGroup(string jobId,
                 string parentJobBaseStepId,
                 step.BaseStep step,
                 i32 position)
    throws common.SystemException

Add a step group to a job

Function: JobService.cloneStep

Job cloneStep(string jobId,
              string parentJobBaseStepId,
              string stepId,
              i32 position)
    throws common.SystemException

Clone a step in a job

Function: JobService.cloneJobStepGroup

Job cloneJobStepGroup(string jobId,
                      string parentJobBaseStepId,
                      string jobBaseStepGroupId,
                      i32 position)
    throws common.SystemException

Clone a step group along with changes that were made to it

Function: JobService.addDocument

Job addDocument(string jobId,
                string documentId)
    throws common.SystemException

Add a document to a Job

Function: JobService.updateDocumentPosition

Job updateDocumentPosition(string jobId,
                           string documentId,
                           i32 position)
    throws common.SystemException

Update a document position to a Job

Function: JobService.removeDocument

Job removeDocument(string jobId,
                   string documentId)
    throws common.SystemException

Remove a document from a job

Function: JobService.addUser

Job addUser(string jobId,
            string userId,
            string email,
            string jobRoleId)
    throws common.SystemException

Add a user to a job. To add a user by userId, send email as an empty string. To add a user by email, send userId as empty string. NOTE: If you add a non-existing user by email to a team located in a regional datacenter, the user is included in the result with sentinel value for the id. This is because a routine is kicked off that asynchronously requests the user to be provisioned in the global datacenter, waits for the user to sync over and then fires off a beacon notification. The sentinel value is a UUID with all 0s.

Function: JobService.archiveUser

void archiveUser(string jobId,
                 string userId,
                 string roleId)
    throws common.SystemException

Archive a user's role in a job. Archive all of a user's roles by passing "" to roleId.

Function: JobService.updateMetadata

map<string, metadata.MetadataEntry> updateMetadata(string jobId,
                                                 map<string, metadata.MetadataValue> updated,
                                                 list<string> removedIds)
    throws common.SystemException

Update the metadata (parameters) on a job. Updated are the values to be added or updated on the job. RemovedIds are the IDs of the values to be removed from the job.

Function: JobService.sendExecData

i64 sendExecData(string jobId,
                 list<ExecutionSnippet> execSnippets)
    throws common.SystemException

(Recommend using sendExecDataWithResult) Send all types of execution data. Returns the maximum seqId of the execution data created.

Function: JobService.sendExecDataWithResult

SendDataResult sendExecDataWithResult(string jobId,
                                      list<ExecutionSnippet> execSnippets)
    throws common.SystemException

Send all types of execution data. Returns a SendDataResult which includes the maximum seqId of the execution data created, AND the execution data with IDs filled in, both seqIds and pending document IDs. Supports async document upload with pending IDs allocated inline.

Function: JobService.getData

GetDataResult getData(string jobId,
                      i64 seqId,
                      GetDataOptions options)
    throws common.SystemException

Get Execution Data for a Job Send the last seqId received as an argument, to get everything > that value

Function: JobService.complete

void complete(string jobId,
              string reason)
    throws common.SystemException

(DEPRECATED, use completeWithOpts) Mark the job completed - since a completion code cannot be supplied, the team's default code will be used when this method is invoked

Function: JobService.completeWithOpts

void completeWithOpts(string jobId,
                      CompleteOpts opts)
    throws common.SystemException

Mark the job completed with options

Function: JobService.uncomplete

void uncomplete(string jobId)
    throws common.SystemException

Mark the job not completed

Function: JobService.updateJob

Job updateJob(string jobId,
              JobParams params)
    throws common.SystemException

Update job details

Function: JobService.start

void start(string jobId)
    throws common.SystemException

Complete planning stage; before this is called, execution data may not be recorded

Function: JobService.instantiateAdHocJob

JobModular instantiateAdHocJob(string jobId)
    throws common.SystemException

Instantiate a new instance of an ad hoc job
After starting a new normal job based on this ad hoc job,
the ad hoc job itself does not change state.
Returns the instantiated active job with pre-planned roles assigned to the executor.

Function: JobService.getPriorityLevels

list<PriorityLevel> getPriorityLevels(string teamId)
    throws common.SystemException

Fetch available priority levels, and their titles, returned in priority order highest to lowest

Function: JobService.archive

JobModular archive(string jobId)
    throws common.SystemException

Mark a job as archived. Can only archive completed and canceled jobs.

Function: JobService.unarchive

JobModular unarchive(string jobId)
    throws common.SystemException

Mark a job as unarchived. Reverts job back to its previous state.

Function: JobService.updateAttributes

list<abac.AbacAttribute> updateAttributes(common.UUID jobId,
                                          list<abac.AbacAttribute> attributes)
    throws common.SystemException

Clobber all job attributes with the provided map

Function: JobService.updateAttributesRestricted

abac.AbacUpdateAttributeResult updateAttributesRestricted(common.UUID jobId,
                                                          list<abac.AbacAttribute> attributes,
                                                          abac.AbacUploadBehaviour behave)
    throws common.SystemException

Update attributes on a job with restrictions Performs the same actions as updateAttributes, but with several safety checks. If a safety check fails, this function will skip the update, and return the current attribute state and an error object describing the safety violation param jobId: job to update param attributes: the new AttributeValues to associated with Attribute attributeId on job jobId param behave: determine the behaviour of the endpoint, merge or clobber. Default: clobber

Function: JobService.updateAttribute

list<abac.AbacAttribute> updateAttribute(common.UUID jobId,
                                         common.UUID attributeId,
                                         list<abac.AbacAttributeValue> values,
                                         abac.AbacUploadBehaviour behave)
    throws common.SystemException

Update a single attribute on a job returns the current attribute state of the job param jobId: job to update param attributeId: the AttributeId of the team level attribute to be updated param values: the new AttributeValues to associated with Attribute attributeId on job jobId param behave: determine the behaviour of the endpoint, merge or clobber. Default: clobber

Function: JobService.updateAttributeRestricted

abac.AbacUpdateAttributeResult updateAttributeRestricted(common.UUID jobId,
                                                         common.UUID attributeId,
                                                         list<abac.AbacAttributeValue> values,
                                                         abac.AbacUploadBehaviour behave)
    throws common.SystemException

Update a single attribute on a job with restrictions Performs the same actions as updateAttribute, but with several safety checks. If a safety check fails, this function will skip the update, and return the current attribute state and an error object describing the safety violation param jobId: job to update param attributeId: the AttributeId of the team level attribute to be updated param values: the new AttributeValues to associated with Attribute attributeId on job jobId param behave: determine the behaviour of the endpoint, merge or clobber. Default: clobber

Function: JobService.updateOfflineJobs

JobModular updateOfflineJobs(string jobId,
                             list<job_template.TemplateInfo> templateInfo,
                             list<step.StepInfo> stepInfo)
    throws common.SystemException

Bulk Update offline jobs by addig templates/steps/step groups return value will be the updated job param jobId: job to update param TemplateInfo: Contains information about the new template that was added param StepInfo: Contains information about the new stesps/step groups that were added

Function: JobService.cancel

JobModular cancel(string jobId)
    throws common.SystemException

Sets the job as canceled at the given time and by the current user. Can only cancel active and planned jobs. param jobId: job to cancel

Function: JobService.uncancel

JobModular uncancel(string jobId)
    throws common.SystemException

Restores the job to its original state: active or planned. param jobId: job to uncancel