GetAssociations()

Returns a list of objects (Forms and Tasks) associated to the Task. Returned values can then be used against the GetForm or GetTask endpoints.

  • Quota: 10

Table 1. Parameters
ParameterTypeMax LengthRequired Description
apiTokenstring20YYour API security token configured in Field View.
taskIdstringYThe ID of the task (for example, T1.12345.)
Table 2. Returns
FieldTypeDescription
GetAssociationsResponseGetAssociationsResponseReturns a list of associated child objects, 0 or more.
Important: All dates are returned in UTC.
<GetAssociationsResponse>
	 <GetAssociationsResult>
		<TaskAssociationsResponse>
		   <Status>
			  <Code>SUCCESS</Code>
			  <Message>Success. [ActivityId]: bfc2509d-d36b-466c-835c-0e5fde5bc723</Message>
		   </Status>
		   <Tasks>
			  <TaskAssociation>
     				<TaskID>T1.1335</TaskID>
      				<Description>test</Description>
     				<IssuedDate>2021-01-13T00:29:19.977Z</IssuedDate>
      				<IssuedToPackageID xsi:nil="true" />
      				<TargetDate>2021-01-19T08:00:00Z</TargetDate>
      				<ActualFinishDate>2021-01-28T08:00:00Z</ActualFinishDate>
      				<Cost>0</Cost>
      				<LastModified>2021-01-13T00:29:19.977Z</LastModified>
      				<TaskTypeId>1000</TaskTypeId>
      				<IssuedToOrgansationID>4</IssuedToOrgansationID>
      				<IssuedByOrganisationID>4</IssuedByOrganisationID>
      				<IssuedByUserID>0.0</IssuedByUserID>
      				<CausedByOrganisationID xsi:nil="true" />
      				<ParentID>1.3793</ParentID>
      				<ParentTypeID>3</ParentTypeID>
    			</TaskAssociation>
			<TaskAssociation>
				 <TaskID>T1.456789</TaskID>
				 <Description>Task 2</Description>
				 <IssuedDate>2018-05-03T19:39:41.2Z</IssuedDate>
				 <IssuedToPackageID>1</IssuedToPackageID>
				 <TargetDate xsi:nil="true"/>
				 <ActualFinishDate xsi:nil="true"/>
				 <Cost>0</Cost>
				 <LastModified>2018-05-16T18:06:01.893Z</LastModified>
				 <TaskTypeId>2</TaskTypeId>
				 <IssuedToOrgansationID>3</IssuedToOrgansationID>
				 <IssuedByOrganisationID>4</IssuedByOrganisationID>
				 <IssuedByUserID>1.1</IssuedByUserID>
				 <CausedByOrganisationID xsi:nil="true"/>
				 <ParentID>1.3793</ParentID>
      				 <ParentTypeID>3</ParentTypeID>
			</TaskAssociation>
		   </Tasks>
		   <Forms>
			   <FormAssociation>
				 <FormID>F1.12345</FormID>
				 <FormTemplateLinkID>1</FormTemplateLinkID>
				 <FormTitle>Hot Works Permit</FormTitle>
				 <CreatedDate>2013-09-05T09:58:38Z</CreatedDate>
				 <FormExpiryDate xsi:nil="true"/>
				 <ParentFormID>1.3793</ParentFormID>
				 <ParentTypeId xsi:nil="true"/>
				 <Deleted>false</Deleted>
				 <HasComment>false</HasComment>
				 <HasPhoto>false</HasPhoto>
				 <IssuedToOrganisationId xsi:nil="true"/>
				 <HasDocument xsi:nil="true"/>
				 <OrganisationId>1</OrganisationId>
				 <ProjectId>2</ProjectId>
			  </FormAssociation>
		   </Forms>
		</TaskAssociationsResponse>
	</GetAssociationsResult>
</GetAssociationsResponse>