Module: reference

References allow for templates and jobs to have a dynamic element to them. Without references, the template and job hierarchy is very static, which creates the need for many templates to exist that are very similar. References allow for some planning-time/runtime flexibility allowing for one set of work instructions to cover a number of similar use cases.

Module	Services	Data types	Constants
reference		ActorNameRef AutoPopulatedFieldRef DataSheetRef ExternalIdpAuthTokenRef FieldTitleRef FieldValueRef IdpAuthTokenRef IssueIdRef IssueTitleRef IssueUrlRef IssueUuidRef JobBaseStepIdRef JobIdRef JobMetadataRef JobTemplateIdRef JobTemplateTitleRef JobTitleRef JobUrlRef JobUuidRef NoRef NumberWrapper Placeholder RefSource Reference StepIdRef StepTitleRef StringWrapper Target TextValueRef UserEmailRef

Enumerations

Enumeration: RefSource

`JOB_METADATA`	`1`
`DATA_SHEET_SET`	`2`
`DATA_SHEET_DEFINITION`	`3`

Enumeration: Placeholder

`JOB_TITLE`	`1`
`FIELD_VALUE`	`2`
`JOB_ID`	`3`
`JOB_UUID`	`4`
`ACTOR_NAME`	`5`
`DATASHEET`	`6`
`JOB_METADATA`	`7`
`TEXT_VALUE`	`8`
`FIELD_TITLE`	`9`
`JOB_URL`	`10`
`STEP_ID`	`11`
`STEP_TITLE`	`12`
`JOB_TEMPLATE_ID`	`13`
`JOB_TEMPLATE_TITLE`	`14`
`USER_EMAIL`	`15`
`ISSUE_ID`	`16`
`ISSUE_UUID`	`17`
`ISSUE_TITLE`	`18`
`ISSUE_URL`	`19`
`JOB_BASE_STEP_ID`	`20`
`IDP_AUTH_TOKEN`	`21`
`EXTERNAL_IDP_AUTH_TOKEN`	`22`

Data structures

Struct: JobMetadataRef

Key	Field	Type	Description	Requiredness	Default value
1	metadataId	`string`		required
2	key	`string`		optional

Struct: DataSheetRef

Key	Field	Type	Requiredness
1	definitionId	`string`	required
2	setId	`string`	required
3	definitionName	`string`	optional
4	setName	`string`	optional

Struct: JobTitleRef

Key	Field	Type	Description	Requiredness	Default value

Struct: JobIdRef

Key	Field	Type	Description	Requiredness	Default value

Struct: JobUuidRef

Key	Field	Type	Description	Requiredness	Default value

Struct: JobUrlRef

Key	Field	Type	Description	Requiredness	Default value

Struct: FieldValueRef

Key	Field	Type	Description	Requiredness	Default value
1	clientId	`string`		default

Struct: FieldTitleRef

Key	Field	Type	Description	Requiredness	Default value
1	clientId	`string`		default

Struct: ActorNameRef

Key	Field	Type	Description	Requiredness	Default value

Struct: TextValueRef

Key	Field	Type	Description	Requiredness	Default value
1	value	`string`		default

Struct: StepIdRef

Key	Field	Type	Description	Requiredness	Default value
1	clientId	`string`		default

Struct: StepTitleRef

Key	Field	Type	Description	Requiredness	Default value
1	clientId	`string`		default

Struct: JobBaseStepIdRef

Key	Field	Type	Description	Requiredness	Default value
1	clientId	`string`		default

Struct: JobTemplateIdRef

Key	Field	Type	Description	Requiredness	Default value

Struct: JobTemplateTitleRef

Key	Field	Type	Description	Requiredness	Default value

Struct: UserEmailRef

Key	Field	Type	Description	Requiredness	Default value

Struct: IssueIdRef

Key	Field	Type	Description	Requiredness	Default value

Struct: IssueUuidRef

Key	Field	Type	Description	Requiredness	Default value

Struct: IssueUrlRef

Key	Field	Type	Description	Requiredness	Default value

Struct: IssueTitleRef

Key	Field	Type	Description	Requiredness	Default value

Struct: IdpAuthTokenRef

Key	Field	Type	Description	Requiredness	Default value

Struct: ExternalIdpAuthTokenRef

Key	Field	Type	Description	Requiredness	Default value

Union: Reference

Key	Field	Type	Requiredness
1	jobMetadataRef	`JobMetadataRef`	default
2	dataSheetRef	`DataSheetRef`	default
3	fieldValueRef	`FieldValueRef`	default
4	jobTitleRef	`JobTitleRef`	default
5	jobIdRef	`JobIdRef`	default
6	jobUuidRef	`JobUuidRef`	default
7	actorNameRef	`ActorNameRef`	default
8	textValueRef	`TextValueRef`	default
9	fieldTitleRef	`FieldTitleRef`	default
10	jobUrlRef	`JobUrlRef`	default
11	stepIdRef	`StepIdRef`	default
12	stepTitleRef	`StepTitleRef`	default
13	jobTemplateIdRef	`JobTemplateIdRef`	default
14	jobTemplateTitleRef	`JobTemplateTitleRef`	default
15	userEmailRef	`UserEmailRef`	default
16	issueIdRef	`IssueIdRef`	default
17	issueUuidRef	`IssueUuidRef`	default
18	issueUrlRef	`IssueUrlRef`	default
19	issueTitleRef	`IssueTitleRef`	default
20	jobBaseStepIdRef	`JobBaseStepIdRef`	default
21	idpAuthTokenRef	`IdpAuthTokenRef`	default
22	externalIdpAuthTokenRef	`ExternalIdpAuthTokenRef`	default

Struct: AutoPopulatedFieldRef

Key	Field	Type	Description	Requiredness	Default value
1	clientId	`string`		default
2	fieldId	`string`		default

Struct: NoRef

Key	Field	Type	Description	Requiredness	Default value

Union: Target

Key	Field	Type	Description	Requiredness	Default value
1	autoPopulatedFieldRef	`AutoPopulatedFieldRef`		default
2	noRef	`NoRef`		default

Struct: StringWrapper

Key	Field	Type	Requiredness
1	template	`string`	required
2	references	`list<Reference>`	optional
3	resolved	`string`	optional

Struct: NumberWrapper

Key	Field	Type	Description	Requiredness	Default value
1	reference	`Reference`		optional
2	number	`common.PreciseNumber`		optional