swagger: '2.0' info: version: '1.5.0' title: SDMX RESTful API, v1.5.0 description: > The SDMX RESTful API, released in September 2020. For additional information, check the [official sdmx-rest specification](https://github.com/sdmx-twg/sdmx-rest/tree/master/v2_1/ws/rest/docs) or the [dedicated Wiki](https://github.com/sdmx-twg/sdmx-rest/wiki). contact: {} host: sdw-wsrest.ecb.europa.eu basePath: /service schemes: - https - http consumes: - application/json produces: - application/json paths: /data/{flow}/{key}/{provider}: get: description: Get data summary: Get data tags: - Data queries operationId: Getdata deprecated: false produces: - application/vnd.sdmx.genericdata+xml;version=2.1 - application/vnd.sdmx.structurespecificdata+xml;version=2.1 - application/vnd.sdmx.generictimeseriesdata+xml;version=2.1 - application/vnd.sdmx.structurespecifictimeseriesdata+xml;version=2.1 - application/vnd.sdmx.data+csv;version=1.0.0 - application/vnd.sdmx.data+json;version=1.0.0 parameters: - name: flow in: path required: true type: string pattern: ^([a-zA-Z][a-zA-Z\d_-]*(\.[a-zA-Z][a-zA-Z\d_-]*)*,)?[a-zA-Z\d_@$-]+(,(latest|(\d+(\.\d+)*)))?$ description: >- The **statistical domain** (aka dataflow) of the data to be returned. Examples: * `EXR`: The ID of the domain * `ECB,EXR`: The EXR domain, maintained by the ECB * `ECB,EXR,1.0`: Version 1.0 of the EXR domain, maintained by the ECB - name: key in: path required: true type: string pattern: ^([\.A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: "The (possibly partial) **key identifying the data to be returned**. \n\nThe keyword `all` can be used to indicate that all data belonging to the specified dataflow and provided by the specified provider must be returned.\n\nThe examples below are based on the following key: Frequency, Country, Component of inflation, Unit of measure.\n * `M.DE.000000.ANR`: Full key, matching exactly one series, i.e. the monthly (`M`) rates of change (`ANR`) of overall inflation (`000000`) in Germany (`DE`).\n * `A+M.DE.000000.ANR`: Retrieves both annual and monthly data (`A+M`), matching exactly two series\n * `A+M..000000.ANR`: The second dimension is wildcarded, and it wil therefore match the annual and monthly rates of change of overall inflation in any country." - name: provider in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The **provider of the data** to be retrieved. \n\nThe keyword `all` can be used to indicate that all data matching the supplied key and belonging to the specified dataflow and provided by any data provider must be returned.\n\nExamples:\n\n* `ECB`: Data provided by ECB\n* `CH2+NO2`: Data provided by CH2 or NO2" - name: startPeriod in: query required: false type: string pattern: ^\d{4}-?((\d{2}(-\d{2})?)|A1|S[1|2]|Q[1-4]|T[1-3]|M(0[1-9]|1[0-2])|W(0[1-9]|[1-4][0-9]|5[0-3])|D(0[0-9][1-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-6]))?$ description: "The start of the period for which results should be supplied (inclusive).\n\nCan be expressed using 8601 dates or SDMX reporting periods. \n\nExamples:\n* `2000`: Year (ISO 8601)\n* `2000-01`: Month (ISO 8601)\n* `2000-01-01`: Date (ISO 8601)\n* `2000-Q1`: Quarter (SDMX)\n* `2000-W01`: Week (SDMX)" - name: endPeriod in: query required: false type: string pattern: ^\d{4}-?((\d{2}(-\d{2})?)|A1|S[1|2]|Q[1-4]|T[1-3]|M(0[1-9]|1[0-2])|W(0[1-9]|[1-4][0-9]|5[0-3])|D(0[0-9][1-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-6]))?$ description: "The end of the period for which results should be supplied (inclusive).\n\nCan be expressed using 8601 dates or SDMX reporting periods. \n\nExamples:\n* `2000`: Year (ISO 8601)\n* `2000-01`: Month (ISO 8601)\n* `2000-01-01`: Date (ISO 8601)\n* `2000-S1`: Semester (SDMX)\n* `2000-D001`: Day (SDMX)" - name: updatedAfter in: query required: false type: string format: date-time description: "The last time the query was performed by the client. \n\nThe response should include the latest version of what has changed in the database since that point in time (i.e. additions, revisions or deletions since the last time the query was performed)." - name: firstNObservations in: query required: false type: integer format: int32 minimum: 1 exclusiveMinimum: false description: The maximum number of observations to be returned starting from the oldest one - name: lastNObservations in: query required: false type: integer format: int32 minimum: 1 exclusiveMinimum: false description: The maximum number of observations to be returned starting from the most recent one - name: dimensionAtObservation in: query required: false default: TIME_PERIOD type: string pattern: ^[A-Za-z][A-Za-z\d_-]*$ description: "Indicates **how the data should be packaged**. \n\nThe options are:\n\n* `TIME_PERIOD`: A timeseries view\n* The ID of any other dimension: A cross-sectional view of the data \n* `AllDimensions`: A flat view of the data." - name: detail in: query required: false enum: - full - dataonly - serieskeysonly - nodata default: full type: string description: "The **amount of information** to be returned. \n\nPossible options are: \n\n* `full`: All data and documentation\n* `dataonly`: Everything except attributes\n* `serieskeysonly`: The series keys. This is useful to return the series that match a certain query, without returning the actual data (e.g. overview page)\n* `nodata`: The series, including attributes and annotations, without observations." - name: includeHistory in: query required: false default: false type: boolean description: "Retrieve **previous versions of the data**. \n\nWhen `true`, the response will contain up to two datasets per dissemination, one containing new or updated values and one containing the deleted data (if any)." - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /availableconstraint/{flow}/{key}/{provider}/{componentID}: get: description: Get information about data availability summary: Get information about data availability tags: - Data availability queries operationId: Getinformationaboutdataavailability deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: flow in: path required: true type: string pattern: ^([a-zA-Z][a-zA-Z\d_-]*(\.[a-zA-Z][a-zA-Z\d_-]*)*,)?[a-zA-Z\d_@$-]+(,(latest|(\d+(\.\d+)*)))?$ description: >- The **statistical domain** (aka dataflow) of the data to be returned. Examples: * `EXR`: The ID of the domain * `ECB,EXR`: The EXR domain, maintained by the ECB * `ECB,EXR,1.0`: Version 1.0 of the EXR domain, maintained by the ECB - name: key in: path required: true type: string pattern: ^([\.A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: "The (possibly partial) **key identifying the data to be returned**. \n\nThe keyword `all` can be used to indicate that all data belonging to the specified dataflow and provided by the specified provider must be returned.\n\nThe examples below are based on the following key: Frequency, Country, Component of inflation, Unit of measure.\n * `M.DE.000000.ANR`: Full key, matching exactly one series, i.e. the monthly (`M`) rates of change (`ANR`) of overall inflation (`000000`) in Germany (`DE`).\n * `A+M.DE.000000.ANR`: Retrieves both annual and monthly data (`A+M`), matching exactly two series\n * `A+M..000000.ANR`: The second dimension is wildcarded, and it wil therefore match the annual and monthly rates of change of overall inflation in any country." - name: provider in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The **provider of the data** to be retrieved. \n\nThe keyword `all` can be used to indicate that all data matching the supplied key and belonging to the specified dataflow and provided by any data provider must be returned.\n\nExamples:\n\n* `ECB`: Data provided by ECB\n* `CH2+NO2`: Data provided by CH2 or NO2" - name: componentID in: path required: true type: string pattern: ^[A-Za-z][A-Za-z\d_-]*$ description: The id of the Dimension for which to obtain availability information about. Use all to indicate that data availability should be provided for all dimensions. - name: mode in: query required: false enum: - exact - available default: exact type: string description: Instructs the web service to return a ContentConstraint which defines a Cube Region containing values which will be returned by executing the query (mode="exact") vs a Cube Region showing what values remain valid selections that could be added to the data query (mode="available"). A valid selection is one which results in one or more series existing for the selected value, based on the current data query selection state defined by the current path parameters. - name: references in: query required: false enum: - none - all - datastructure - conceptscheme - codelist - dataproviderscheme - dataflow default: none type: string description: Instructs the web service to return (or not) the artefacts referenced by the ContentConstraint to be returned. - name: startPeriod in: query required: false type: string pattern: ^\d{4}-?((\d{2}(-\d{2})?)|A1|S[1|2]|Q[1-4]|T[1-3]|M(0[1-9]|1[0-2])|W(0[1-9]|[1-4][0-9]|5[0-3])|D(0[0-9][1-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-6]))?$ description: "The start of the period for which results should be supplied (inclusive).\n\nCan be expressed using 8601 dates or SDMX reporting periods. \n\nExamples:\n* `2000`: Year (ISO 8601)\n* `2000-01`: Month (ISO 8601)\n* `2000-01-01`: Date (ISO 8601)\n* `2000-Q1`: Quarter (SDMX)\n* `2000-W01`: Week (SDMX)" - name: endPeriod in: query required: false type: string pattern: ^\d{4}-?((\d{2}(-\d{2})?)|A1|S[1|2]|Q[1-4]|T[1-3]|M(0[1-9]|1[0-2])|W(0[1-9]|[1-4][0-9]|5[0-3])|D(0[0-9][1-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-6]))?$ description: "The end of the period for which results should be supplied (inclusive).\n\nCan be expressed using 8601 dates or SDMX reporting periods. \n\nExamples:\n* `2000`: Year (ISO 8601)\n* `2000-01`: Month (ISO 8601)\n* `2000-01-01`: Date (ISO 8601)\n* `2000-S1`: Semester (SDMX)\n* `2000-D001`: Day (SDMX)" - name: updatedAfter in: query required: false type: string format: date-time description: "The last time the query was performed by the client. \n\nThe response should include the latest version of what has changed in the database since that point in time (i.e. additions, revisions or deletions since the last time the query was performed)." - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /datastructure/{agencyID}/{resourceID}/{version}: get: description: Get data structures summary: Get data structures tags: - Structure queries operationId: Getdatastructures deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /metadatastructure/{agencyID}/{resourceID}/{version}: get: description: Get metadata structures summary: Get metadata structures tags: - Structure queries operationId: Getmetadatastructures deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /dataflow/{agencyID}/{resourceID}/{version}: get: description: Get dataflows summary: Get dataflows tags: - Structure queries operationId: Getdataflows deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /metadataflow/{agencyID}/{resourceID}/{version}: get: description: Get metadadataflows summary: Get metadadataflows tags: - Structure queries operationId: Getmetadadataflows deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /provisionagreement/{agencyID}/{resourceID}/{version}: get: description: Get provision agreements summary: Get provision agreements tags: - Structure queries operationId: Getprovisionagreements deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /structureset/{agencyID}/{resourceID}/{version}: get: description: Get structure sets summary: Get structure sets tags: - Structure queries operationId: Getstructuresets deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /process/{agencyID}/{resourceID}/{version}: get: description: Get processes summary: Get processes tags: - Structure queries operationId: Getprocesses deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /categorisation/{agencyID}/{resourceID}/{version}: get: description: Get categorisations summary: Get categorisations tags: - Structure queries operationId: Getcategorisations deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /contentconstraint/{agencyID}/{resourceID}/{version}: get: description: Get content constraints summary: Get content constraints tags: - Structure queries operationId: Getcontentconstraints deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /actualconstraint/{agencyID}/{resourceID}/{version}: get: description: Get actual constraints summary: Get actual constraints tags: - Structure queries operationId: Getactualconstraints deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /allowedconstraint/{agencyID}/{resourceID}/{version}: get: description: Get allowed constraints summary: Get allowed constraints tags: - Structure queries operationId: Getallowedconstraints deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /attachmentconstraint/{agencyID}/{resourceID}/{version}: get: description: Get attachment constraints summary: Get attachment constraints tags: - Structure queries operationId: Getattachmentconstraints deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /structure/{agencyID}/{resourceID}/{version}: get: description: Get structures summary: Get structures tags: - Structure queries operationId: Getstructures deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /conceptscheme/{agencyID}/{resourceID}/{version}: get: description: Get concept schemes summary: Get concept schemes tags: - Structure queries operationId: Getconceptschemes deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /codelist/{agencyID}/{resourceID}/{version}: get: description: Get codelists summary: Get codelists tags: - Structure queries operationId: Getcodelists deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /categoryscheme/{agencyID}/{resourceID}/{version}: get: description: Get category schemes summary: Get category schemes tags: - Structure queries operationId: Getcategoryschemes deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /hierarchicalcodelist/{agencyID}/{resourceID}/{version}: get: description: Get hierarchical codelists summary: Get hierarchical codelists tags: - Structure queries operationId: Gethierarchicalcodelists deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /organisationscheme/{agencyID}/{resourceID}/{version}: get: description: Get organisation schemes summary: Get organisation schemes tags: - Structure queries operationId: Getorganisationschemes deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /agencyscheme/{agencyID}/{resourceID}/{version}: get: description: Get agency schemes summary: Get agency schemes tags: - Structure queries operationId: Getagencyschemes deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /dataproviderscheme/{agencyID}/{resourceID}/{version}: get: description: Get data provider schemes summary: Get data provider schemes tags: - Structure queries operationId: Getdataproviderschemes deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /dataconsumerscheme/{agencyID}/{resourceID}/{version}: get: description: Get data consumer schemes summary: Get data consumer schemes tags: - Structure queries operationId: Getdataconsumerschemes deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /organisationunitscheme/{agencyID}/{resourceID}/{version}: get: description: Get organisation unit schemes summary: Get organisation unit schemes tags: - Structure queries operationId: Getorganisationunitschemes deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /transformationscheme/{agencyID}/{resourceID}/{version}: get: description: Get transformation schemes summary: Get transformation schemes tags: - Structure queries operationId: Gettransformationschemes deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /rulesetscheme/{agencyID}/{resourceID}/{version}: get: description: Get ruleset schemes summary: Get ruleset schemes tags: - Structure queries operationId: Getrulesetschemes deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /userdefinedoperatorscheme/{agencyID}/{resourceID}/{version}: get: description: Get user defined operator schemes summary: Get user defined operator schemes tags: - Structure queries operationId: Getuserdefinedoperatorschemes deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /customtypescheme/{agencyID}/{resourceID}/{version}: get: description: Get custom type schemes summary: Get custom type schemes tags: - Structure queries operationId: Getcustomtypeschemes deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /namepersonalisationscheme/{agencyID}/{resourceID}/{version}: get: description: Get name personalisation schemes summary: Get name personalisation schemes tags: - Structure queries operationId: Getnamepersonalisationschemes deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /namealiasscheme/{agencyID}/{resourceID}/{version}: get: description: Get name alias schemes summary: Get name alias schemes tags: - Structure queries operationId: Getnamealiasschemes deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /conceptscheme/{agencyID}/{resourceID}/{version}/{itemID}: get: description: Get concepts summary: Get concepts tags: - Item queries operationId: Getconcepts deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: itemID in: path required: true type: string pattern: ^[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*(\+[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*)*$ description: "The id of the item to be returned. \n\nIt is possible to set more than one id, using `+` as separator (e.g. A+Q+M).\n\nThe keyword `all` can be used to return all items of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /codelist/{agencyID}/{resourceID}/{version}/{itemID}: get: description: Get codes summary: Get codes tags: - Item queries operationId: Getcodes deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: itemID in: path required: true type: string pattern: ^[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*(\+[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*)*$ description: "The id of the item to be returned. \n\nIt is possible to set more than one id, using `+` as separator (e.g. A+Q+M).\n\nThe keyword `all` can be used to return all items of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /categoryscheme/{agencyID}/{resourceID}/{version}/{itemID}: get: description: Get categories summary: Get categories tags: - Item queries operationId: Getcategories deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: itemID in: path required: true type: string pattern: ^[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*(\+[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*)*$ description: "The id of the item to be returned. \n\nIt is possible to set more than one id, using `+` as separator (e.g. A+Q+M).\n\nThe keyword `all` can be used to return all items of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /hierarchicalcodelist/{agencyID}/{resourceID}/{version}/{itemID}: get: description: Get hierarchies summary: Get hierarchies tags: - Item queries operationId: Gethierarchies deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: itemID in: path required: true type: string pattern: ^[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*(\+[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*)*$ description: "The id of the item to be returned. \n\nIt is possible to set more than one id, using `+` as separator (e.g. A+Q+M).\n\nThe keyword `all` can be used to return all items of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /organisationscheme/{agencyID}/{resourceID}/{version}/{itemID}: get: description: Get organisations summary: Get organisations tags: - Item queries operationId: Getorganisations deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: itemID in: path required: true type: string pattern: ^[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*(\+[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*)*$ description: "The id of the item to be returned. \n\nIt is possible to set more than one id, using `+` as separator (e.g. A+Q+M).\n\nThe keyword `all` can be used to return all items of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /agencyscheme/{agencyID}/{resourceID}/{version}/{itemID}: get: description: Get agencies summary: Get agencies tags: - Item queries operationId: Getagencies deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: itemID in: path required: true type: string pattern: ^[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*(\+[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*)*$ description: "The id of the item to be returned. \n\nIt is possible to set more than one id, using `+` as separator (e.g. A+Q+M).\n\nThe keyword `all` can be used to return all items of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /dataproviderscheme/{agencyID}/{resourceID}/{version}/{itemID}: get: description: Get data providers summary: Get data providers tags: - Item queries operationId: Getdataproviders deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: itemID in: path required: true type: string pattern: ^[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*(\+[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*)*$ description: "The id of the item to be returned. \n\nIt is possible to set more than one id, using `+` as separator (e.g. A+Q+M).\n\nThe keyword `all` can be used to return all items of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /dataconsumerscheme/{agencyID}/{resourceID}/{version}/{itemID}: get: description: Get data consumers summary: Get data consumers tags: - Item queries operationId: Getdataconsumers deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: itemID in: path required: true type: string pattern: ^[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*(\+[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*)*$ description: "The id of the item to be returned. \n\nIt is possible to set more than one id, using `+` as separator (e.g. A+Q+M).\n\nThe keyword `all` can be used to return all items of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /organisationunitscheme/{agencyID}/{resourceID}/{version}/{itemID}: get: description: Get organisation unit schemes summary: Get organisation unit schemes tags: - Item queries operationId: Getorganisationunitschemes1 deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: itemID in: path required: true type: string pattern: ^[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*(\+[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*)*$ description: "The id of the item to be returned. \n\nIt is possible to set more than one id, using `+` as separator (e.g. A+Q+M).\n\nThe keyword `all` can be used to return all items of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /transformationscheme/{agencyID}/{resourceID}/{version}/{itemID}: get: description: Get transformation schemes summary: Get transformation schemes tags: - Item queries operationId: Gettransformationschemes1 deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: itemID in: path required: true type: string pattern: ^[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*(\+[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*)*$ description: "The id of the item to be returned. \n\nIt is possible to set more than one id, using `+` as separator (e.g. A+Q+M).\n\nThe keyword `all` can be used to return all items of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /rulesetscheme/{agencyID}/{resourceID}/{version}/{itemID}: get: description: Get ruleset schemes summary: Get ruleset schemes tags: - Item queries operationId: Getrulesetschemes1 deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: itemID in: path required: true type: string pattern: ^[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*(\+[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*)*$ description: "The id of the item to be returned. \n\nIt is possible to set more than one id, using `+` as separator (e.g. A+Q+M).\n\nThe keyword `all` can be used to return all items of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /userdefinedoperatorscheme/{agencyID}/{resourceID}/{version}/{itemID}: get: description: Get user defined operator schemes summary: Get user defined operator schemes tags: - Item queries operationId: Getuserdefinedoperatorschemes1 deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: itemID in: path required: true type: string pattern: ^[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*(\+[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*)*$ description: "The id of the item to be returned. \n\nIt is possible to set more than one id, using `+` as separator (e.g. A+Q+M).\n\nThe keyword `all` can be used to return all items of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /customtypescheme/{agencyID}/{resourceID}/{version}/{itemID}: get: description: Get custom type schemes summary: Get custom type schemes tags: - Item queries operationId: Getcustomtypeschemes1 deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: itemID in: path required: true type: string pattern: ^[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*(\+[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*)*$ description: "The id of the item to be returned. \n\nIt is possible to set more than one id, using `+` as separator (e.g. A+Q+M).\n\nThe keyword `all` can be used to return all items of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /namepersonalisationscheme/{agencyID}/{resourceID}/{version}/{itemID}: get: description: Get name personalisation schemes summary: Get name personalisation schemes tags: - Item queries operationId: Getnamepersonalisationschemes1 deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: itemID in: path required: true type: string pattern: ^[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*(\+[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*)*$ description: "The id of the item to be returned. \n\nIt is possible to set more than one id, using `+` as separator (e.g. A+Q+M).\n\nThe keyword `all` can be used to return all items of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /namealiasscheme/{agencyID}/{resourceID}/{version}/{itemID}: get: description: Get name alias schemes summary: Get name alias schemes tags: - Item queries operationId: Getnamealiasschemes1 deprecated: false produces: - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: agencyID in: path required: true type: string pattern: ^(([A-Za-z][A-Za-z\d_-]*)(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+(\+([A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*,)?[A-Za-z\d_@$-]+)*$ description: "The agency maintaining the artefact to be returned. \n\nIt is possible to set more than one agency, using `+` as separator (e.g. BIS+ECB).\n\nThe keyword `all` can be used to indicate that artefacts maintained by any maintenance agency should be returned." - name: resourceID in: path required: true type: string pattern: ^([A-Za-z\d_@$-]+(\+[A-Za-z\d_@$-]+)*)*$ description: >- 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. - name: version in: path required: true type: string pattern: ^(all|latest|[\d]+(\.[\d]+)*(\+[\d]+(\.[\d]+)*)*)$ description: "The version of the artefact to be returned. \n\nIt is possible to set more than one version, using `+` as separator (e.g. 1.0+2.1).\n\nThe keyword `all` can be used to return all versions of the matching resource.\n\nThe keyword `latest` can be used to return the latest production version of the matching resource." - name: itemID in: path required: true type: string pattern: ^[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*(\+[A-Za-z\d_@$-]+(\.[A-Za-z\d_@$-]+)*)*$ description: "The id of the item to be returned. \n\nIt is possible to set more than one id, using `+` as separator (e.g. A+Q+M).\n\nThe keyword `all` can be used to return all items of the matching resource." - name: references in: query required: false enum: - 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 default: none type: string description: "Instructs the web service to return (or not) the artefacts referenced by the artefact to be returned.\n\nPossible values are: \n\n* `none`: No references will be returned\n* `parents`: Returns the artefacts that use the artefact matching the query\n* `parentsandsiblings`: Returns the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts\n* `children`: Returns the artefacts referenced by the artefact to be returned\n* `descendants`: References of references, up to any level, will be returned\n* `all`: The combination of parentsandsiblings and descendants\n* In addition, a concrete type of resource may also be used (for example, references=codelist)." - name: detail in: query required: false enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full default: full type: string description: "The amount of information to be returned. \n\nPossible values are: \n\n* `allstubs`: All artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `referencestubs`: Referenced artefacts should be returned as stubs, containing only identification information, as well as the artefacts' name\n* `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`\n* `allcompletestubs`: All artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `referencecompletestubs`: Referenced artefacts should be returned as complete stubs, containing identification information, the artefacts' name, description, annotations and isFinal information\n* `full`: All available information for all artefacts should be returned" - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: Accept-Language in: header required: false type: string description: Specifies the client's preferred language. - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '413': description: Request entity too large headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} /schema/{context}/{agencyID}/{resourceID}/{version}: get: description: Get XML schemas summary: Get XML schemas tags: - Schema queries operationId: GetXMLschemas deprecated: false produces: - application/vnd.sdmx.schema+xml;version=2.1 - application/vnd.sdmx.structure+xml;version=2.1 - application/vnd.sdmx.structure+json;version=1.0.0 parameters: - name: context in: path required: true enum: - datastructure - metadatastructure - dataflow - metadataflow - provisionagreement type: string description: "The value of this parameter determines the **constraints taken into account** when generating the schema.\n\nPossible options are:\n\n* `datastructure`: Constraints attached to the DSD are applied.\n* `metadatastructure`: Constraints attached to the MSD are applied. \n* `dataflow`: Constraints attached to the dataflow and to the DSD used in the dataflow are applied.\n* `metadataflow`: Constraints attached to the metadataflow and to the MSD used in the metadataflow are applied. \n* `provisionagreement`: Constraints attached to the provision agreement, as well as to the dataflow or metadafalow used in the agreement and the DSD or MSD used in the dataflow or metadataflow are applied." - name: agencyID in: path required: true type: string pattern: ^[A-Za-z][A-Za-z\d_-]*(\.[A-Za-z][A-Za-z\d_-]*)*$ description: The agency maintaining the artefact used to generate the schema to be returned. - name: resourceID in: path required: true type: string pattern: ^[A-Za-z\d_@$-]+$ description: The id of the artefact used to generate the schema to be returned. - name: version in: path required: true type: string pattern: ^(latest|[\d]+(\.[\d]+)*)$ description: >- The version of the artefact used to generate the schema to be returned. The keyword `latest` can be used to return the latest production version of the matching resource. - name: dimensionAtObservation in: query required: false default: TIME_PERIOD type: string pattern: ^[A-Za-z][A-Za-z\d_-]*$ description: "Indicates **how the data should be packaged**. \n\nThe options are:\n\n* `TIME_PERIOD`: A timeseries view\n* The ID of any other dimension: A cross-sectional view of the data \n* `AllDimensions`: A flat view of the data." - name: explicitMeasure in: query required: false default: false type: boolean description: For cross-sectional data validation, indicates whether observations are strongly typed - name: Accept-Encoding in: header required: false enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd default: identity type: string description: "Specifies whether the response should be compressed and how. \n\n`identity` (the default) indicates that no compression will be performed." - name: If-Modified-Since in: header required: false type: string format: date-time description: Instructs to return the content matching the query only if it has changed since the supplied timestamp. responses: '200': description: OK schema: xml: name: response200 attribute: false wrapped: false type: string headers: {} '304': description: No changes headers: {} '400': description: Bad syntax headers: {} '401': description: Unauthorized headers: {} '403': description: Forbidden headers: {} '404': description: Not found headers: {} '406': description: Not acceptable headers: {} '414': description: URI too long headers: {} '500': description: Internal server error headers: {} '501': description: Not implemented headers: {} '503': description: Service unavailable headers: {} definitions: detail: title: detail type: string enum: - full - dataonly - serieskeysonly - nodata Accept-Encoding: title: Accept-Encoding type: string enum: - br - compress - deflate - exi - gzip - identity - pack200-gzip - zstd mode: title: mode type: string enum: - exact - available references: title: references type: string enum: - none - all - datastructure - conceptscheme - codelist - dataproviderscheme - dataflow references1: title: references1 type: string enum: - 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 detail1: title: detail1 type: string enum: - allstubs - referencestubs - referencepartial - allcompletestubs - referencecompletestubs - full context: title: context type: string enum: - datastructure - metadatastructure - dataflow - metadataflow - provisionagreement tags: - name: Data queries description: '' - name: Data availability queries description: '' - name: Structure queries description: '' - name: Item queries description: '' - name: Schema queries description: ''