OEoecd
Item queries

Get name personalisation schemes

get/namepersonalisationscheme/{agencyID}/{resourceID}/{version}/{itemID}

Request

Path parameters

agencyIDstring required

The agency maintaining the artefact to be returned.

It is possible to set more than one agency, using + as separator (e.g. BIS+ECB).

The keyword all can be used to indicate that artefacts maintained by any maintenance agency should be returned.

resourceIDstring required

The id of the artefact to be returned.

It is possible to set more than one id, using + as separator (e.g. CL_FREQ+CL_CONF_STATUS).

The keyword all can be used to indicate that any artefact of the specified resource type, {agencyID} and {version} should be returned.

versionstring required

The version of the artefact to be returned.

It is possible to set more than one version, using + as separator (e.g. 1.0+2.1).

The keyword all can be used to return all versions of the matching resource.

The keyword latest can be used to return the latest production version of the matching resource.

itemIDstring required

The id of the item to be returned.

It is possible to set more than one id, using + as separator (e.g. A+Q+M).

The keyword all can be used to return all items of the matching resource.

Query parameters

references'none' | 'parents' | 'parentsandsiblings' | 'children' | 'descendants' | 'all' | 'datastructure' | 'metadatastructure' | 'categoryscheme' | 'conceptscheme' | 'codelist' | 'hierarchicalcodelist' | 'organisationscheme' | 'agencyscheme' | 'dataproviderscheme' | 'dataconsumerscheme' | 'organisationunitscheme' | 'dataflow' | 'metadataflow' | 'reportingtaxonomy' | 'provisionagreement' | 'structureset' | 'process' | 'categorisation' | 'contentconstraint' | 'actualconstraint' | 'allowedconstraint' | 'attachmentconstraint' | 'transformationscheme' | 'rulesetscheme' | 'userdefinedoperatorscheme' | 'customtypescheme' | 'namepersonalisationscheme' | 'namealiasscheme'

Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.

Possible values are:

  • none: No references will be returned
  • parents: Returns the artefacts that use the artefact matching the query
  • parentsandsiblings: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts
  • children: Returns the artefacts referenced by the artefact to be returned
  • descendants: References of references, up to any level, will be returned
  • all: The combination of parentsandsiblings and descendants
  • In addition, a concrete type of resource may also be used (for example, references=codelist).
detail'allstubs' | 'referencestubs' | 'referencepartial' | 'allcompletestubs' | 'referencecompletestubs' | 'full'

The amount of information to be returned.

Possible values are:

  • allstubs: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name
  • referencestubs: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name
  • referencepartial: Referenced item schemes should only include items used by the artefact to be returned. For example, a concept scheme would only contain the concepts used in a DSD, and its isPartial flag would be set to true
  • allcompletestubs: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information
  • referencecompletestubs: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information
  • full: All available information for all artefacts should be returned

Headers

Accept-Encoding'br' | 'compress' | 'deflate' | 'exi' | 'gzip' | 'identity' | 'pack200-gzip' | 'zstd'

Specifies whether the response should be compressed and how.

identity (the default) indicates that no compression will be performed.

Accept-Languagestring

Specifies the client's preferred language.

If-Modified-Sincestring date-time

Instructs to return the content matching the query only if it has changed since the supplied timestamp.

Response

OK

string required

Changes

No recorded changes to this operation across all 1 revision of this API.