IM-JS Class: StructureQuery

Class: StructureQuery

bean. StructureQuery

This class is used to construct a query to be used with IMJS#getMaintainables

Name	Type	Argument	Default	Description
`structureType`	string \| bean.base.MaintainableBean	<optional>	structure	The structure type to query for. Possible values are: agencyscheme, dataproviderscheme, dataconsumerscheme codelist, categoryscheme, conceptscheme, dataflow, datastructure, metadataflow, metadatastructure, hierarchicalcodelist provisionagreement
`agencyId`	string	<optional>	all	The agency id of the structure
`resourceID`	string	<optional>	all	the id of the structure itself
`version`	string	<optional>	all	the version of the structure
`detail`	string	<optional>	full	Possible values are: "allstubs" (all artefacts should be returned as stubs), "referencestubs" (referenced artefacts should be returned as stubs) and "full" (all available information for all artefacts should be returned)
`references`	string	<optional>	none	Possible values are: "none" (no references will be returned), "parents" (the artefacts that use the artefact matching the query), "parentsandsiblings" (the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts), "children" (artefacts referenced by the artefact to be returned), "descendants" (references of references, up to any level, will also be returned), "all" (the combination of parentsandsiblings and descendants)

getQueryUrl()

Get the query URL from this object

The query url, this will include the entry url

toString()

toString returns StructureQuery#getQueryUrl

the Query url