ISO datetime string
ISO datetime string
HEX colour
The HCMS Content Type's items
Represents the total number of items based on the search. Can be used to achieve paging or infinite scrolling to load more.
Delete CivicPlus HCMS content item.
Allows request to be aborted
The identifier for the HCMS Content to be deleted
The identifier for the Form to determine the HCMS Content Type.
The identifier for the Forms App to determine the HCMS Content Type.
Change the status of a CivicPlus HCMS content item to draft.
Get the details for a single API.NSW Liquor licence based on the licenceID.
const formId = 1
const licenceId = '1-RL22KV'
const result = await formService.getAPINSWLiquorLicence(
formId,
licenceId,
)
Get titles codes from Civica name register
const formId = 1
const results = await formService.getCivicaTitleCodes(formId)
Get a OneBlink Form Element Lookup.
const organisationId = '1234567890ABCDEFG'
const formsAppEnvironmentId = 1
const formElementLookupId = 1
const formElementLookup = await formService.getFormElementLookupById(
organisationId,
formsAppEnvironmentId,
formElementLookupId,
)
if (formElementLookup) {
// Use lookup
}
Get an array of OneBlink Form Element Lookups.
const organisationId = '1234567890ABCDEFG'
const formsAppEnvironmentId = 1
const formElementLookups = await formService.getFormElementLookups(
organisationId,
formsAppEnvironmentId,
)
Get the options for an options set.
The form element options set to generate options from
The environment to pull options from
A signal to abort any asynchronous processing
A result object containing potential options or a predictable error
Get a list of options sets for an organisation.
The identifier for the organisation to fetch options sets for
A signal to abort any asynchronous processing
An array of options sets
Get the Freshdesk Fields associated with a form
The identifier for the form to fetch freshdesk fields for
A signal to abort any asynchronous processing
An array of Freshdesk Fields
Get the details for a single geoscape address based on the Id of a geoscape address resource.
const formId = 1
const addressId = 'ABC123'
const result = await formService.getGeoscapeAddress(formId, addressId)
Get a geoscape address from a latitude and longitude
const lat = 41.9475427
const lng = -87.6562292
const formId = 1
const result = await formService.getGeoscapeReverseGeocoding({
lat,
lng,
formId,
})
Get the details for a single Point address based on the Id of a Point address resource.
const formId = 1
const addressId = 'ABC123'
const result = await formService.getPointAddress(formId, addressId)
Load the options for Form Elements that are using a OneBlink List. Useful to cache all the dynamic options when first opening an application.
The form definition the form element is in. Used to generate conditional logic for the
The form element to have options appended to
A new form element. The element passed in is not mutated.
Parse Freshdesk Field options associated with a form element as form element options.
An array of Freshdesk Fields
The element to array of Freshdesk Fields
An object containing valid options or a predictable error
Change the status of a CivicPlus HCMS content item to published.
Search for API.NSW Liquor licences based on a partial text search.
const result = await formService.searchAPINSWLiquorLicences({
formId: 1,
search: 'SMITH',
})
Search CivicPlus HCMS content items.
Optional OData filter definition.
Optional OData order definition.
Optional OData full text search.
How many items to skip in the result. Can be used to achieve paging or infinite scrolling to load more.
How many items to return in the result. Can be used to achieve paging or infinite scrolling to load more.
Allows request to be aborted
The identifier for the Form to determine the HCMS Content Type.
The identifier for the Forms App to determine the HCMS Content Type.
Search for street names in Civica
const formId = 1
const queryParams = {
search: '1 Station ',
top: 10,
}
const result = await formService.searchCivicaStreetNames(
formId,
queryParams,
)
Search for geoscape addresses based on a partial address.
const formId = 1
const result = await formService.searchGeoscapeAddresses(formId, {
query: '123 N',
maxNumberOfResults: 10
stateTerritory: 'NSW'
})
Search for Point addresses based on a partial address.
const formId = 1
const result = await formService.searchPointAddresses(formId, {
address: '123 N',
maxNumberOfResults: 10
stateTerritory: 'NSW'
})
Form Service
Helper functions for form handling