GetAssociations()

Returns a list of objects (Forms and Tasks) associated to the Form. Returned values can then be used against the GetForm endpoint.

  • Quota: 10
Table 1. Parameters
Parameter Type Max Length Required Description
apiToken string 20 Y Your API security token configured in Field View.
formId string Y The ID of the form (for example, F1.12345.)
Table 2. Returns
Field Type Description
GetAssociationsResponse GetAssociationsResponse Returns a list of associated child objects, 0 or more.
Important: All dates are returned in UTC.
<GetAssociationsResponse>
	 <GetAssociationsResult>
		<FormAssociationsResponse>
		   <Status>
			  <Code>SUCCESS</Code>
			  <Message>Success. [ActivityId]: ac2a9be0-ab9e-4906-8b02-7f957087e14d</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>
		</Tasks>
		<Forms>
			<FormAssociation>
				<FormID>F1.4112</FormID>
     				<FormTemplateLinkID>17555</FormTemplateLinkID>
   				<CreatedDate>2021-01-13T00:28:52.233Z</CreatedDate>
     				<FormExpiryDate xsi:nil="true" />
    				<ParentFormID>1.3790</ParentFormID>
 				<ParentTypeId>2</ParentTypeId>
 				<Deleted>false</Deleted>
   				<HasComment>false</HasComment>
 				<HasPhoto>false</HasPhoto>
   				<IssuedToOrganisationId xsi:nil="true" />
  	    			<HasDocument>false</HasDocument>
  				<OrganisationId>4</OrganisationId>
				<ProjectId>2</ProjectId>
 				</FormAssociation>
			</FormAssociation>
		   </Forms>
		</FormAssociationsResponse>
	</GetAssociationsResult>
</GetAssociationsResponse>