{ "openapi": "3.0.1", "info": { "title": "AIHW.Meteor.Api", "version": "1.0" }, "paths": { "/api/v{apiVersion}/ClassificationSchemes": { "get": { "tags": [ "ClassificationSchemes" ], "summary": "Get a list of Classification Schemes matching a search term.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "A search string to filter Classification Schemes on.", "schema": { "type": "string" } }, { "name": "pageIndex", "in": "query", "description": "The 0 based page offset for this result set.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "A field to sort results by. If supplied, this value must be \"lastupdatedat\", \"createdat\" or \"name\".", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of the results. If supplied, this value must be \"asc\" or \"desc\".", "schema": { "type": "string" } }, { "name": "registrationStatuses", "in": "query", "description": "Filter metadata items by registration status. A list of one or more registration statuses in the form \"?registrationStatuses=X®istrationStatuses=Y\". Replace X and Y with the status/es to filter by. Any number of registration statuses can be provided. This is an exact-match search. For the list of possible statuses see: [Registration statuses](https://meteor.aihw.gov.au/content/752877).", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "registrationAuthorityName", "in": "query", "description": "Filter metadata items by registration authority. This is an exact-match search. For the list of possible statuses see: [Registration authorities](https://meteor.aihw.gov.au/content/460515).", "schema": { "type": "string" } }, { "name": "fromCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "fromRevisionDateUtc", "in": "query", "description": "Filter metadata items by revison date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toRevisionDateUtc", "in": "query", "description": "Filter metadata items by revision date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } } } } } } }, "/api/v{apiVersion}/ClassificationSchemes/{meteorIdentifier}": { "get": { "tags": [ "ClassificationSchemes" ], "summary": "Read a Classification Scheme by its METEOR identifier. Only published Classification Schemes are returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of the classification scheme.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClassificationScheme" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationScheme" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClassificationScheme" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ClassificationScheme" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ClassificationScheme" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/DataElementConcepts": { "get": { "tags": [ "DataElementConcepts" ], "summary": "Get a list of Data Element Concepts matching a search term.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "A search string to filter Data Element Concepts on.", "schema": { "type": "string" } }, { "name": "pageIndex", "in": "query", "description": "The 0 based page offset for this result set.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "A field to sort results by. If supplied, this value must be \"lastupdatedat\", \"createdat\" or \"name\".", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of the results. If supplied, this value must be \"asc\" or \"desc\".", "schema": { "type": "string" } }, { "name": "registrationStatuses", "in": "query", "description": "Filter metadata items by registration status. A list of one or more registration statuses in the form \"?registrationStatuses=X®istrationStatuses=Y\". Replace X and Y with the status/es to filter by. Any number of registration statuses can be provided. This is an exact-match search. For the list of possible statuses see: [Registration statuses](https://meteor.aihw.gov.au/content/752877).", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "registrationAuthorityName", "in": "query", "description": "Filter metadata items by registration authority. This is an exact-match search. For the list of possible statuses see: [Registration authorities](https://meteor.aihw.gov.au/content/460515).", "schema": { "type": "string" } }, { "name": "fromCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "fromRevisionDateUtc", "in": "query", "description": "Filter metadata items by revison date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toRevisionDateUtc", "in": "query", "description": "Filter metadata items by revision date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } } } } } } }, "/api/v{apiVersion}/DataElementConcepts/{meteorIdentifier}": { "get": { "tags": [ "DataElementConcepts" ], "summary": "Read a Data Element Concept by its METEOR identifier. Only published Data Element Concepts are returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of the data element concept.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DataElementConcept" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DataElementConcept" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DataElementConcept" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DataElementConcept" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DataElementConcept" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/DataElements": { "get": { "tags": [ "DataElements" ], "summary": "Get a list of Data Elements matching a search term.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "A search string to filter Data Elements on.", "schema": { "type": "string" } }, { "name": "pageIndex", "in": "query", "description": "The 0 based page offset for this result set.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "A field to sort results by. If supplied, this value must be \"lastupdatedat\", \"createdat\" or \"name\".", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of the results. If supplied, this value must be \"asc\" or \"desc\".", "schema": { "type": "string" } }, { "name": "registrationStatuses", "in": "query", "description": "Filter metadata items by registration status. A list of one or more registration statuses in the form \"?registrationStatuses=X®istrationStatuses=Y\". Replace X and Y with the status/es to filter by. Any number of registration statuses can be provided. This is an exact-match search. For the list of possible statuses see: [Registration statuses](https://meteor.aihw.gov.au/content/752877).", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "registrationAuthorityName", "in": "query", "description": "Filter metadata items by registration authority. This is an exact-match search. For the list of possible statuses see: [Registration authorities](https://meteor.aihw.gov.au/content/460515).", "schema": { "type": "string" } }, { "name": "fromCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "fromRevisionDateUtc", "in": "query", "description": "Filter metadata items by revison date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toRevisionDateUtc", "in": "query", "description": "Filter metadata items by revision date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } } } } } } }, "/api/v{apiVersion}/DataElements/{meteorIdentifier}": { "get": { "tags": [ "DataElements" ], "summary": "Read a DataElement by its METEOR identifier. Only published Data Elements are returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of a Data Element.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DataElement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DataElement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DataElement" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DataElement" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DataElement" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/DataSetSpecifications": { "get": { "tags": [ "DataSetSpecifications" ], "summary": "Get a list of Data Set Specifications matching a search term.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "A search string to filter Data Set Specifications on.", "schema": { "type": "string" } }, { "name": "pageIndex", "in": "query", "description": "The 0 based page offset for this result set.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "A field to sort results by. If supplied, this value must be \"lastupdatedat\", \"createdat\" or \"name\".", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of the results. If supplied, this value must be \"asc\" or \"desc\".", "schema": { "type": "string" } }, { "name": "registrationStatuses", "in": "query", "description": "Filter metadata items by registration status. A list of one or more registration statuses in the form \"?registrationStatuses=X®istrationStatuses=Y\". Replace X and Y with the status/es to filter by. Any number of registration statuses can be provided. This is an exact-match search. For the list of possible statuses see: [Registration statuses](https://meteor.aihw.gov.au/content/752877).", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "registrationAuthorityName", "in": "query", "description": "Filter metadata items by registration authority. This is an exact-match search. For the list of possible statuses see: [Registration authorities](https://meteor.aihw.gov.au/content/460515).", "schema": { "type": "string" } }, { "name": "fromCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "fromRevisionDateUtc", "in": "query", "description": "Filter metadata items by revison date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toRevisionDateUtc", "in": "query", "description": "Filter metadata items by revision date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } } } } } } }, "/api/v{apiVersion}/DataSetSpecifications/{meteorIdentifier}": { "get": { "tags": [ "DataSetSpecifications" ], "summary": "Read a Data Set Specification by its METEOR identifier. Only published Data Set Specification are returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of a Data Set Specification.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DataSetSpecification" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DataSetSpecification" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DataSetSpecification" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DataSetSpecification" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DataSetSpecification" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/DataSetSpecifications/{meteorIdentifier}/opspec": { "get": { "tags": [ "DataSetSpecifications" ], "summary": "Read Operational Specification for a Data Set Specification by its METEOR identifier. Only published item is returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of a Data Set Specification.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OperationalSpecification" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OperationalSpecification" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OperationalSpecification" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OperationalSpecification" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OperationalSpecification" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/DataSources": { "get": { "tags": [ "DataSources" ], "summary": "Get a list of Data Sources matching a search term.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "A search string to filter Data Sources on.", "schema": { "type": "string" } }, { "name": "pageIndex", "in": "query", "description": "The 0 based page offset for this result set.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "A field to sort results by. If supplied, this value must be \"lastupdatedat\", \"createdat\" or \"name\".", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of the results. If supplied, this value must be \"asc\" or \"desc\".", "schema": { "type": "string" } }, { "name": "fromCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "fromRevisionDateUtc", "in": "query", "description": "Filter metadata items by revison date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toRevisionDateUtc", "in": "query", "description": "Filter metadata items by revision date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } } } } } } }, "/api/v{apiVersion}/DataSources/{meteorIdentifier}": { "get": { "tags": [ "DataSources" ], "summary": "Read a Data Source by its METEOR identifier. Only published Data Source are returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of a Data Source.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DataSource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DataSource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DataSource" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DataSource" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DataSource" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/Files/{meteorIdentifier}": { "get": { "tags": [ "Files" ], "summary": "Read a list of downlable nodes within a set of METEOR files.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of a file set.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileSet" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FileSet" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FileSet" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/Files/{meteorIdentifier}/{nodeId}": { "get": { "tags": [ "Files" ], "summary": "Read a File by its METEOR identifier. Only published Files are returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of a file set.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "nodeId", "in": "path", "description": "The nodeId of a specific file within the file set.", "required": true, "schema": { "type": "string" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DownloadItemResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DownloadItemResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DownloadItemResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DownloadItemResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DownloadItemResult" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/FrameworkDimensions": { "get": { "tags": [ "FrameworkDimensions" ], "summary": "Get a list of Framework Dimensions matching a search term.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "A search string to filter Framework Dimensions on.", "schema": { "type": "string" } }, { "name": "pageIndex", "in": "query", "description": "The 0 based page offset for this result set.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "A field to sort results by. If supplied, this value must be \"lastupdatedat\", \"createdat\" or \"name\".", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of the results. If supplied, this value must be \"asc\" or \"desc\".", "schema": { "type": "string" } }, { "name": "fromCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "fromRevisionDateUtc", "in": "query", "description": "Filter metadata items by revison date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toRevisionDateUtc", "in": "query", "description": "Filter metadata items by revision date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } } } } } } }, "/api/v{apiVersion}/FrameworkDimensions/{meteorIdentifier}": { "get": { "tags": [ "FrameworkDimensions" ], "summary": "Read a Framework Dimension by its METEOR identifier. Only published Framework Dimensions are returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of a Framework Dimension.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FrameworkDimension" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FrameworkDimension" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FrameworkDimension" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FrameworkDimension" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FrameworkDimension" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/GlossaryItems": { "get": { "tags": [ "GlossaryItems" ], "summary": "Get a list of Glossary Items matching a search term.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "A search string to filter Glossary Items on.", "schema": { "type": "string" } }, { "name": "pageIndex", "in": "query", "description": "The 0 based page offset for this result set.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "A field to sort results by. If supplied, this value must be \"lastupdatedat\", \"createdat\" or \"name\".", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of the results. If supplied, this value must be \"asc\" or \"desc\".", "schema": { "type": "string" } }, { "name": "registrationStatuses", "in": "query", "description": "Filter metadata items by registration status. A list of one or more registration statuses in the form \"?registrationStatuses=X®istrationStatuses=Y\". Replace X and Y with the status/es to filter by. Any number of registration statuses can be provided. This is an exact-match search. For the list of possible statuses see: [Registration statuses](https://meteor.aihw.gov.au/content/752877).", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "registrationAuthorityName", "in": "query", "description": "Filter metadata items by registration authority. This is an exact-match search. For the list of possible statuses see: [Registration authorities](https://meteor.aihw.gov.au/content/460515).", "schema": { "type": "string" } }, { "name": "fromCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "fromRevisionDateUtc", "in": "query", "description": "Filter metadata items by revison date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toRevisionDateUtc", "in": "query", "description": "Filter metadata items by revision date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } } } } } } }, "/api/v{apiVersion}/GlossaryItems/{meteorIdentifier}": { "get": { "tags": [ "GlossaryItems" ], "summary": "Read a Glossary Item by its METEOR identifier. Only published Glossary Items are returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of a Glossary Item.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GlossaryItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GlossaryItem" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/GlossaryItem" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/GlossaryItem" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/HealthCheck": { "get": { "tags": [ "HealthCheck" ], "summary": "Reports the current status of the METEOR API, database connection is not tested.", "parameters": [ { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Health check passed.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HealthCheckResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HealthCheckResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HealthCheckResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/HealthCheckResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/HealthCheckResponse" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/v{apiVersion}/metadataimages/{meteorIdentifier}": { "get": { "tags": [ "Images" ], "summary": "Read an image by its METEOR identifier.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of a METEOR image.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileSet" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FileSet" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FileSet" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/Indicators": { "get": { "tags": [ "Indicators" ], "summary": "Get a list of METEOR Indicators matching a search term. Only public Indicators are returned.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "A search string to filter Indicators on.", "schema": { "type": "string" } }, { "name": "pageIndex", "in": "query", "description": "The 0 based page offset for this result set.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "A field to sort results by. If supplied, this value must be \"lastupdatedat\", \"createdat\" or \"name\".", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of the results. If supplied, this value must be \"asc\" or \"desc\".", "schema": { "type": "string" } }, { "name": "registrationStatuses", "in": "query", "description": "Filter metadata items by registration status. A list of one or more registration statuses in the form \"?registrationStatuses=X®istrationStatuses=Y\". Replace X and Y with the status/es to filter by. Any number of registration statuses can be provided. This is an exact-match search. For the list of possible statuses see: [Registration statuses](https://meteor.aihw.gov.au/content/752877).", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "registrationAuthorityName", "in": "query", "description": "Filter metadata items by registration authority. This is an exact-match search. For the list of possible statuses see: [Registration authorities](https://meteor.aihw.gov.au/content/460515).", "schema": { "type": "string" } }, { "name": "fromCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "fromRevisionDateUtc", "in": "query", "description": "Filter metadata items by revison date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toRevisionDateUtc", "in": "query", "description": "Filter metadata items by revision date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } } } } } } }, "/api/v{apiVersion}/Indicators/{meteorIdentifier}": { "get": { "tags": [ "Indicators" ], "summary": "Read an Indicator by its METEOR identifier. Only public Indicators are returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of an Indicator.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Indicator" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Indicator" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Indicator" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Indicator" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Indicator" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/IndicatorSets": { "get": { "tags": [ "IndicatorSets" ], "summary": "Get a list of METEOR Indicator Sets matching a search term. Only public Indicator Sets are returned.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "A search string to filter Indicator Sets on.", "schema": { "type": "string" } }, { "name": "pageIndex", "in": "query", "description": "The 0 based page offset for this result set.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "A field to sort results by. If supplied, this value must be \"lastupdatedat\", \"createdat\" or \"name\".", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of the results. If supplied, this value must be \"asc\" or \"desc\".", "schema": { "type": "string" } }, { "name": "registrationStatuses", "in": "query", "description": "Filter metadata items by registration status. A list of one or more registration statuses in the form \"?registrationStatuses=X®istrationStatuses=Y\". Replace X and Y with the status/es to filter by. Any number of registration statuses can be provided. This is an exact-match search. For the list of possible statuses see: [Registration statuses](https://meteor.aihw.gov.au/content/752877).", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "registrationAuthorityName", "in": "query", "description": "Filter metadata items by registration authority. This is an exact-match search. For the list of possible statuses see: [Registration authorities](https://meteor.aihw.gov.au/content/460515).", "schema": { "type": "string" } }, { "name": "fromCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "fromRevisionDateUtc", "in": "query", "description": "Filter metadata items by revison date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toRevisionDateUtc", "in": "query", "description": "Filter metadata items by revision date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } } } } } } }, "/api/v{apiVersion}/IndicatorSets/{meteorIdentifier}": { "get": { "tags": [ "IndicatorSets" ], "summary": "Read an Indicator Set by its METEOR identifier. Only public Indicator Sets are returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of an Indicator Set.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IndicatorSet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IndicatorSet" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IndicatorSet" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IndicatorSet" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/IndicatorSet" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/ObjectClasses": { "get": { "tags": [ "ObjectClasses" ], "summary": "Get a list of METEOR Object Classes matching a search term. Only public Object Classes are returned.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "A search string to filter Object Classes on.", "schema": { "type": "string" } }, { "name": "pageIndex", "in": "query", "description": "The 0 based page offset for this result set.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "A field to sort results by. If supplied, this value must be \"lastupdatedat\", \"createdat\" or \"name\".", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of the results. If supplied, this value must be \"asc\" or \"desc\".", "schema": { "type": "string" } }, { "name": "registrationStatuses", "in": "query", "description": "Filter metadata items by registration status. A list of one or more registration statuses in the form \"?registrationStatuses=X®istrationStatuses=Y\". Replace X and Y with the status/es to filter by. Any number of registration statuses can be provided. This is an exact-match search. For the list of possible statuses see: [Registration statuses](https://meteor.aihw.gov.au/content/752877).", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "registrationAuthorityName", "in": "query", "description": "Filter metadata items by registration authority. This is an exact-match search. For the list of possible statuses see: [Registration authorities](https://meteor.aihw.gov.au/content/460515).", "schema": { "type": "string" } }, { "name": "fromCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "fromRevisionDateUtc", "in": "query", "description": "Filter metadata items by revison date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toRevisionDateUtc", "in": "query", "description": "Filter metadata items by revision date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } } } } } } }, "/api/v{apiVersion}/ObjectClasses/{meteorIdentifier}": { "get": { "tags": [ "ObjectClasses" ], "summary": "Read a Object Class by its METEOR identifier. Only public Object Classes are returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR Identifier of an Object Class.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ObjectClass" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ObjectClass" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ObjectClass" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ObjectClass" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ObjectClass" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/ObjectClassSpecialisations": { "get": { "tags": [ "ObjectClassSpecialisations" ], "summary": "Get a list of Object Class Specialisations matching a search term.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "A search string to filter Object Class Specialisations on.", "schema": { "type": "string" } }, { "name": "pageIndex", "in": "query", "description": "The 0 based page offset for this result set.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "A field to sort results by. If supplied, this value must be \"lastupdatedat\", \"createdat\" or \"name\".", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of the results. If supplied, this value must be \"asc\" or \"desc\".", "schema": { "type": "string" } }, { "name": "fromCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "fromRevisionDateUtc", "in": "query", "description": "Filter metadata items by revison date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toRevisionDateUtc", "in": "query", "description": "Filter metadata items by revision date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } } } } } } }, "/api/v{apiVersion}/ObjectClassSpecialisations/{meteorIdentifier}": { "get": { "tags": [ "ObjectClassSpecialisations" ], "summary": "Read a Object Class Specialisation by its METEOR identifier. Only public Object Class Specialisations are returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of a Object Class Specialisation.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ObjectClassSpecialisation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ObjectClassSpecialisation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ObjectClassSpecialisation" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ObjectClassSpecialisation" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ObjectClassSpecialisation" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/Organisations/{id}": { "get": { "tags": [ "Organisations" ], "summary": "Read a Organisation by its Id. Only public Organisations are returned.", "parameters": [ { "name": "id", "in": "path", "description": "The Id of an Organisation.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiOrganisation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiOrganisation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiOrganisation" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiOrganisation" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ApiOrganisation" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/Organisations": { "get": { "tags": [ "Organisations" ], "summary": "Get a list of all organisations you have permission to view. Optionally retired organisations can be returned.", "parameters": [ { "name": "includeRetired", "in": "query", "description": "Optionally, include retired organisations.", "schema": { "type": "boolean", "default": true } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOrganisation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOrganisation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOrganisation" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOrganisation" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiOrganisation" } } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/OutcomeAreas": { "get": { "tags": [ "OutcomeAreas" ], "summary": "Get a list of Outcome Areas matching a search term.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "A search string to filter Outcome Areas on.", "schema": { "type": "string" } }, { "name": "pageIndex", "in": "query", "description": "The 0 based page offset for this result set.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "A field to sort results by. If supplied, this value must be \"lastupdatedat\", \"createdat\" or \"name\".", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of the results. If supplied, this value must be \"asc\" or \"desc\".", "schema": { "type": "string" } }, { "name": "registrationStatuses", "in": "query", "description": "Filter metadata items by registration status. A list of one or more registration statuses in the form \"?registrationStatuses=X®istrationStatuses=Y\". Replace X and Y with the status/es to filter by. Any number of registration statuses can be provided. This is an exact-match search. For the list of possible statuses see: [Registration statuses](https://meteor.aihw.gov.au/content/752877).", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "registrationAuthorityName", "in": "query", "description": "Filter metadata items by registration authority. This is an exact-match search. For the list of possible statuses see: [Registration authorities](https://meteor.aihw.gov.au/content/460515).", "schema": { "type": "string" } }, { "name": "fromCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "fromRevisionDateUtc", "in": "query", "description": "Filter metadata items by revison date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toRevisionDateUtc", "in": "query", "description": "Filter metadata items by revision date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } } } } } } }, "/api/v{apiVersion}/OutcomeAreas/{meteorIdentifier}": { "get": { "tags": [ "OutcomeAreas" ], "summary": "Read a Outcome Area by its METEOR identifier. Only published Outcome Areas are returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of the outcome areas.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OutcomeArea" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OutcomeArea" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OutcomeArea" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OutcomeArea" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OutcomeArea" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/Properties": { "get": { "tags": [ "Properties" ], "summary": "Get a list of Properties matching a search term.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "A search string to filter Properties on.", "schema": { "type": "string" } }, { "name": "pageIndex", "in": "query", "description": "The 0 based page offset for this result set.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "A field to sort results by. If supplied, this value must be \"lastupdatedat\", \"createdat\" or \"name\".", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of the results. If supplied, this value must be \"asc\" or \"desc\".", "schema": { "type": "string" } }, { "name": "registrationStatuses", "in": "query", "description": "Filter metadata items by registration status. A list of one or more registration statuses in the form \"?registrationStatuses=X®istrationStatuses=Y\". Replace X and Y with the status/es to filter by. Any number of registration statuses can be provided. This is an exact-match search. For the list of possible statuses see: [Registration statuses](https://meteor.aihw.gov.au/content/752877).", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "registrationAuthorityName", "in": "query", "description": "Filter metadata items by registration authority. This is an exact-match search. For the list of possible statuses see: [Registration authorities](https://meteor.aihw.gov.au/content/460515).", "schema": { "type": "string" } }, { "name": "fromCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "fromRevisionDateUtc", "in": "query", "description": "Filter metadata items by revison date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toRevisionDateUtc", "in": "query", "description": "Filter metadata items by revision date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } } } } } } }, "/api/v{apiVersion}/Properties/{meteorIdentifier}": { "get": { "tags": [ "Properties" ], "summary": "Read a Property by its METEOR identifier. Only public Properties are returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of a Property.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Property" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Property" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Property" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Property" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Property" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/PropertyGroups": { "get": { "tags": [ "PropertyGroups" ], "summary": "Get a list of Property Groups matching a search term.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "A search string to filter Property Groups on.", "schema": { "type": "string" } }, { "name": "pageIndex", "in": "query", "description": "The 0 based page offset for this result set.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "A field to sort results by. If supplied, this value must be \"lastupdatedat\", \"createdat\" or \"name\".", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of the results. If supplied, this value must be \"asc\" or \"desc\".", "schema": { "type": "string" } }, { "name": "fromCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "fromRevisionDateUtc", "in": "query", "description": "Filter metadata items by revison date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toRevisionDateUtc", "in": "query", "description": "Filter metadata items by revision date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } } } } } } }, "/api/v{apiVersion}/PropertyGroups/{meteorIdentifier}": { "get": { "tags": [ "PropertyGroups" ], "summary": "Read a Property Group by its METEOR identifier. Only public Property Groups are returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of a Property Group.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PropertyGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PropertyGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PropertyGroup" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PropertyGroup" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PropertyGroup" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/QualityStatements": { "get": { "tags": [ "QualityStatements" ], "summary": "Get a list of Quality Statements matching a search term.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "A search string to filter Quality Statements on.", "schema": { "type": "string" } }, { "name": "pageIndex", "in": "query", "description": "The 0 based page offset for this result set.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "A field to sort results by. If supplied, this value must be \"lastupdatedat\", \"createdat\" or \"name\".", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of the results. If supplied, this value must be \"asc\" or \"desc\".", "schema": { "type": "string" } }, { "name": "registrationStatuses", "in": "query", "description": "Filter metadata items by registration status. A list of one or more registration statuses in the form \"?registrationStatuses=X®istrationStatuses=Y\". Replace X and Y with the status/es to filter by. Any number of registration statuses can be provided. This is an exact-match search. For the list of possible statuses see: [Registration statuses](https://meteor.aihw.gov.au/content/752877).", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "registrationAuthorityName", "in": "query", "description": "Filter metadata items by registration authority. This is an exact-match search. For the list of possible statuses see: [Registration authorities](https://meteor.aihw.gov.au/content/460515).", "schema": { "type": "string" } }, { "name": "fromCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "fromRevisionDateUtc", "in": "query", "description": "Filter metadata items by revison date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toRevisionDateUtc", "in": "query", "description": "Filter metadata items by revision date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } } } } } } }, "/api/v{apiVersion}/QualityStatements/{meteorIdentifier}": { "get": { "tags": [ "QualityStatements" ], "summary": "Read a Quality Statement by its METEOR identifier. Only public Quality Statements are returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of a Quality Statement.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QualityStatement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QualityStatement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QualityStatement" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/QualityStatement" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/QualityStatement" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/RegistrationAuthorities/{id}": { "get": { "tags": [ "RegistrationAuthorities" ], "summary": "Read a Registration Authority by its METEOR identifier. Only public Registration Authorities are returned. A list of registration authorities and their ids is available at [Registration authorities](https://meteor.aihw.gov.au/content/460515).", "parameters": [ { "name": "id", "in": "path", "description": "The METEOR identifier of a Registration Authority.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiRegistrationAuthorityDetail" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiRegistrationAuthorityDetail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiRegistrationAuthorityDetail" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiRegistrationAuthorityDetail" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ApiRegistrationAuthorityDetail" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/v{apiVersion}/RegistrationAuthorities": { "get": { "tags": [ "RegistrationAuthorities" ], "summary": "Read all Registration Authorities you have access to.", "parameters": [ { "name": "includeRetired", "in": "query", "description": "Optionally, include any retired Registration Authorities you have access to.", "schema": { "type": "boolean" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiRegistrationAuthority" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiRegistrationAuthority" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiRegistrationAuthority" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiRegistrationAuthority" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiRegistrationAuthority" } } } } } } } }, "/api/v{apiVersion}/ValueDomains": { "get": { "tags": [ "ValueDomains" ], "summary": "Get a list of Value Domains matching a search term.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "A search string to filter Value Domains on.", "schema": { "type": "string" } }, { "name": "pageIndex", "in": "query", "description": "The 0 based page offset for this result set.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "A field to sort results by. If supplied, this value must be \"lastupdatedat\", \"createdat\" or \"name\".", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "The sort order of the results. If supplied, this value must be \"asc\" or \"desc\".", "schema": { "type": "string" } }, { "name": "registrationStatuses", "in": "query", "description": "Filter metadata items by registration status. A list of one or more registration statuses in the form \"?registrationStatuses=X®istrationStatuses=Y\". Replace X and Y with the status/es to filter by. Any number of registration statuses can be provided. This is an exact-match search. For the list of possible statuses see: [Registration statuses](https://meteor.aihw.gov.au/content/752877).", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "registrationAuthorityName", "in": "query", "description": "Filter metadata items by registration authority. This is an exact-match search. For the list of possible statuses see: [Registration authorities](https://meteor.aihw.gov.au/content/460515).", "schema": { "type": "string" } }, { "name": "fromCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toCreatedDateUtc", "in": "query", "description": "Filter metadata items by created date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "fromRevisionDateUtc", "in": "query", "description": "Filter metadata items by revison date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'from' dates are inclusive.", "schema": { "type": "string" } }, { "name": "toRevisionDateUtc", "in": "query", "description": "Filter metadata items by revision date. If supplied, this value must be in the format \"dd/mm/YYYY\". Date ranges for 'to' dates are exclusive.", "schema": { "type": "string" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContentItemSummaryPagedCollection" } } } } } } }, "/api/v{apiVersion}/ValueDomains/{meteorIdentifier}": { "get": { "tags": [ "ValueDomains" ], "summary": "Read a Value Domain by its METEOR identifier. Only public Value Domains are returned.", "parameters": [ { "name": "meteorIdentifier", "in": "path", "description": "The METEOR identifier of a Value Domain.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "apiVersion", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValueDomain" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValueDomain" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValueDomain" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ValueDomain" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ValueDomain" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } } }, "components": { "schemas": { "ApiOrganisation": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "isRetired": { "type": "boolean" } }, "additionalProperties": false }, "ApiRegistrationAuthority": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "isRetired": { "type": "boolean" } }, "additionalProperties": false }, "ApiRegistrationAuthorityDetail": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "isRetired": { "type": "boolean" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApiSubscription": { "required": [ "createdAt", "email", "salt", "secret" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "apiSubscriptionId": { "type": "string", "format": "uuid" }, "productId": { "type": "integer", "format": "int32" }, "email": { "maxLength": 100, "minLength": 1, "type": "string" }, "salt": { "maxLength": 100, "minLength": 1, "type": "string" }, "secret": { "maxLength": 32, "minLength": 1, "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "product": { "$ref": "#/components/schemas/Product" } }, "additionalProperties": false }, "AppMessage": { "type": "object", "properties": { "appEnum": { "$ref": "#/components/schemas/Enum" }, "severity": { "$ref": "#/components/schemas/Severity" }, "objectName": { "type": "string", "nullable": true }, "objectMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Assembly": { "type": "object", "properties": { "definedTypes": { "type": "array", "items": { "$ref": "#/components/schemas/TypeInfo" }, "nullable": true, "readOnly": true }, "exportedTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "codeBase": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "entryPoint": { "$ref": "#/components/schemas/MethodInfo" }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "imageRuntimeVersion": { "type": "string", "nullable": true, "readOnly": true }, "isDynamic": { "type": "boolean", "readOnly": true }, "location": { "type": "string", "nullable": true, "readOnly": true }, "reflectionOnly": { "type": "boolean", "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "isFullyTrusted": { "type": "boolean", "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "escapedCodeBase": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "manifestModule": { "$ref": "#/components/schemas/Module" }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/Module" }, "nullable": true, "readOnly": true }, "globalAssemblyCache": { "type": "boolean", "readOnly": true, "deprecated": true }, "hostContext": { "type": "integer", "format": "int64", "readOnly": true }, "securityRuleSet": { "$ref": "#/components/schemas/SecurityRuleSet" } }, "additionalProperties": false }, "CallingConventions": { "enum": [ 1, 2, 3, 32, 64 ], "type": "integer", "format": "int32" }, "ClassificationScheme": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "referenceDocuments": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "registrations": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItemRegistration" }, "nullable": true }, "classificationStructure": { "type": "string", "nullable": true }, "context": { "type": "string", "nullable": true }, "definition": { "type": "string", "nullable": true }, "guideForUse": { "type": "string", "nullable": true }, "revisionStatus": { "type": "string", "nullable": true }, "collectionMethods": { "type": "string", "nullable": true }, "synonymousNames": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "submittingOrganisations": { "type": "array", "items": { "$ref": "#/components/schemas/SubmittingOrganisation" }, "nullable": true }, "registryManagementAttributes": { "$ref": "#/components/schemas/RegistryManagementAttributes" } }, "additionalProperties": false }, "ConstructorInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/MethodAttributes" }, "methodImplementationFlags": { "$ref": "#/components/schemas/MethodImplAttributes" }, "callingConvention": { "$ref": "#/components/schemas/CallingConventions" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isConstructor": { "type": "boolean", "readOnly": true }, "isFinal": { "type": "boolean", "readOnly": true }, "isHideBySig": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isVirtual": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isConstructedGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethodDefinition": { "type": "boolean", "readOnly": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "methodHandle": { "$ref": "#/components/schemas/RuntimeMethodHandle" }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" } }, "additionalProperties": false }, "ContentItemSummary": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "registrations": { "type": "array", "items": { "type": "string" }, "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true } }, "additionalProperties": false }, "ContentItemSummaryPagedCollection": { "type": "object", "properties": { "remainingPages": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ContentItemSummary" }, "nullable": true } }, "additionalProperties": false }, "CreateSubscriptionRequest": { "type": "object", "properties": { "productId": { "type": "integer", "format": "int32" }, "email": { "type": "string", "nullable": true }, "salt": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateSubscriptionResult": { "type": "object", "properties": { "postActions": { "type": "array", "items": { "$ref": "#/components/schemas/TaskFunc" }, "nullable": true }, "success": { "type": "boolean" }, "permissionDenied": { "type": "boolean" }, "appMessages": { "type": "array", "items": { "$ref": "#/components/schemas/AppMessage" }, "nullable": true }, "highestSeverity": { "$ref": "#/components/schemas/Severity" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/AppMessage" }, "nullable": true, "readOnly": true }, "id": { "type": "integer", "format": "int32" }, "apiSubscriptionId": { "type": "string", "format": "uuid" }, "productId": { "type": "integer", "format": "int32" }, "email": { "type": "string", "nullable": true }, "salt": { "type": "string", "nullable": true }, "secret": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time", "nullable": true }, "isActive": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CustomAttributeData": { "type": "object", "properties": { "attributeType": { "$ref": "#/components/schemas/Type" }, "constructor": { "$ref": "#/components/schemas/ConstructorInfo" }, "constructorArguments": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeTypedArgument" }, "nullable": true, "readOnly": true }, "namedArguments": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeNamedArgument" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "CustomAttributeNamedArgument": { "type": "object", "properties": { "memberInfo": { "$ref": "#/components/schemas/MemberInfo" }, "typedValue": { "$ref": "#/components/schemas/CustomAttributeTypedArgument" }, "memberName": { "type": "string", "nullable": true, "readOnly": true }, "isField": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "CustomAttributeTypedArgument": { "type": "object", "properties": { "argumentType": { "$ref": "#/components/schemas/Type" }, "value": { "nullable": true } }, "additionalProperties": false }, "DataElement": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "referenceDocuments": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "shortName": { "type": "string", "nullable": true }, "definition": { "type": "string", "nullable": true }, "context": { "type": "string", "nullable": true }, "guideForUse": { "type": "string", "nullable": true }, "collectionMethods": { "type": "string", "nullable": true }, "registrations": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItemRegistration" }, "nullable": true }, "synonymousNames": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "submittingOrganisations": { "type": "array", "items": { "$ref": "#/components/schemas/SubmittingOrganisation" }, "nullable": true }, "registryManagementAttributes": { "$ref": "#/components/schemas/RegistryManagementAttributes" } }, "additionalProperties": false }, "DataElementConcept": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "referenceDocuments": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "registrations": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItemRegistration" }, "nullable": true }, "definition": { "type": "string", "nullable": true }, "context": { "type": "string", "nullable": true }, "guideForUse": { "type": "string", "nullable": true }, "collectionMethods": { "type": "string", "nullable": true }, "synonymousNames": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "submittingOrganisations": { "type": "array", "items": { "$ref": "#/components/schemas/SubmittingOrganisation" }, "nullable": true }, "registryManagementAttributes": { "$ref": "#/components/schemas/RegistryManagementAttributes" } }, "additionalProperties": false }, "DataSetSpecification": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "referenceDocuments": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "type": { "type": "string", "nullable": true }, "scope": { "type": "string", "nullable": true }, "statisticalUnit": { "type": "string", "nullable": true }, "implementationStartDate": { "type": "string", "format": "date-time", "nullable": true }, "implementationEndDate": { "type": "string", "format": "date-time", "nullable": true }, "registrations": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItemRegistration" }, "nullable": true }, "dataSetSpecifications": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedDataSetSpecification" }, "nullable": true }, "dataElements": { "type": "array", "items": { "$ref": "#/components/schemas/DataSetSpecificationMetadataItem" }, "nullable": true }, "guideForUse": { "type": "string", "nullable": true }, "collectionMethods": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "submittingOrganisations": { "type": "array", "items": { "$ref": "#/components/schemas/SubmittingOrganisation" }, "nullable": true }, "registryManagementAttributes": { "$ref": "#/components/schemas/RegistryManagementAttributes" } }, "additionalProperties": false }, "DataSetSpecificationMetadataItem": { "type": "object", "properties": { "sequenceNumber": { "type": "integer", "format": "int32" }, "obligation": { "type": "string", "nullable": true }, "maximumOccurrences": { "type": "integer", "format": "int32" }, "conditionalObligation": { "type": "string", "nullable": true }, "dataSetSpecificInformation": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true } }, "additionalProperties": false }, "DataSource": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "referenceDocuments": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "comments": { "type": "string", "nullable": true }, "implementationEndDate": { "type": "string", "format": "date-time", "nullable": true }, "description": { "type": "string", "nullable": true }, "nationalReportingArrangement": { "type": "string", "nullable": true }, "frequency": { "type": "string", "nullable": true }, "dataCustodian": { "type": "string", "nullable": true }, "dataCustodianContactDetails": { "type": "string", "nullable": true }, "linkToDataSource": { "type": "string", "nullable": true }, "submittingOrganisationContactDetails": { "type": "string", "nullable": true }, "implementationStartDate": { "type": "string", "format": "date-time", "nullable": true }, "submittingOrganisations": { "type": "array", "items": { "$ref": "#/components/schemas/SubmittingOrganisation" }, "nullable": true }, "registryManagementAttributes": { "$ref": "#/components/schemas/RegistryManagementAttributes" } }, "additionalProperties": false }, "DownloadItemResult": { "type": "object", "properties": { "postActions": { "type": "array", "items": { "$ref": "#/components/schemas/TaskFunc" }, "nullable": true }, "success": { "type": "boolean" }, "permissionDenied": { "type": "boolean" }, "appMessages": { "type": "array", "items": { "$ref": "#/components/schemas/AppMessage" }, "nullable": true }, "highestSeverity": { "$ref": "#/components/schemas/Severity" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/AppMessage" }, "nullable": true, "readOnly": true }, "content": { "type": "string", "format": "binary", "nullable": true }, "contentLength": { "type": "integer", "format": "int64", "readOnly": true }, "contentType": { "type": "string", "nullable": true, "readOnly": true }, "errorCode": { "$ref": "#/components/schemas/DownloadItemResultCode" }, "errorMessage": { "type": "string", "nullable": true, "readOnly": true }, "exception": { "$ref": "#/components/schemas/Exception" }, "fileName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "DownloadItemResultCode": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "format": "int32" }, "Enum": { "type": "object", "additionalProperties": false }, "EventAttributes": { "enum": [ 0, 512, 1024 ], "type": "integer", "format": "int32" }, "EventInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "attributes": { "$ref": "#/components/schemas/EventAttributes" }, "isSpecialName": { "type": "boolean", "readOnly": true }, "addMethod": { "$ref": "#/components/schemas/MethodInfo" }, "removeMethod": { "$ref": "#/components/schemas/MethodInfo" }, "raiseMethod": { "$ref": "#/components/schemas/MethodInfo" }, "isMulticast": { "type": "boolean", "readOnly": true }, "eventHandlerType": { "$ref": "#/components/schemas/Type" } }, "additionalProperties": false }, "Exception": { "type": "object", "properties": { "targetSite": { "$ref": "#/components/schemas/MethodBase" }, "message": { "type": "string", "nullable": true, "readOnly": true }, "data": { "type": "object", "additionalProperties": { }, "nullable": true, "readOnly": true }, "innerException": { "$ref": "#/components/schemas/Exception" }, "helpLink": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "hResult": { "type": "integer", "format": "int32" }, "stackTrace": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "FieldAttributes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 16, 32, 64, 128, 256, 512, 1024, 4096, 8192, 32768, 38144 ], "type": "integer", "format": "int32" }, "FieldInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "attributes": { "$ref": "#/components/schemas/FieldAttributes" }, "fieldType": { "$ref": "#/components/schemas/Type" }, "isInitOnly": { "type": "boolean", "readOnly": true }, "isLiteral": { "type": "boolean", "readOnly": true }, "isNotSerialized": { "type": "boolean", "readOnly": true, "deprecated": true }, "isPinvokeImpl": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "fieldHandle": { "$ref": "#/components/schemas/RuntimeFieldHandle" } }, "additionalProperties": false }, "FileSet": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FrameworkDimension": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "registryManagementAttributes": { "$ref": "#/components/schemas/RegistryManagementAttributes" } }, "additionalProperties": false }, "GenerateFullHmacTokenRequest": { "required": [ "apiKey", "method", "requestId", "subscriptionId", "timestamp", "url" ], "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "requestId": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "apiKey": { "minLength": 1, "type": "string" }, "method": { "minLength": 1, "type": "string" }, "url": { "minLength": 1, "type": "string" }, "body": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GenerateKeyResult": { "type": "object", "properties": { "postActions": { "type": "array", "items": { "$ref": "#/components/schemas/TaskFunc" }, "nullable": true }, "success": { "type": "boolean" }, "permissionDenied": { "type": "boolean" }, "appMessages": { "type": "array", "items": { "$ref": "#/components/schemas/AppMessage" }, "nullable": true }, "highestSeverity": { "$ref": "#/components/schemas/Severity" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/AppMessage" }, "nullable": true, "readOnly": true }, "apiSubscriptionId": { "type": "string", "format": "uuid" }, "subscriptionKey": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "GenerateSimpleHmacTokenRequest": { "required": [ "apiKey", "subscriptionId" ], "type": "object", "properties": { "subscriptionId": { "type": "string", "format": "uuid", "default": "" }, "apiKey": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "GenericParameterAttributes": { "enum": [ 0, 1, 2, 3, 4, 8, 16, 28 ], "type": "integer", "format": "int32" }, "GlossaryItem": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "referenceDocuments": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "definition": { "type": "string", "nullable": true }, "context": { "type": "string", "nullable": true }, "guideForUse": { "type": "string", "nullable": true }, "collectionMethods": { "type": "string", "nullable": true }, "registrations": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItemRegistration" }, "nullable": true }, "synonymousNames": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "submittingOrganisations": { "type": "array", "items": { "$ref": "#/components/schemas/SubmittingOrganisation" }, "nullable": true }, "registryManagementAttributes": { "$ref": "#/components/schemas/RegistryManagementAttributes" } }, "additionalProperties": false }, "HealthCheckResponse": { "type": "object", "properties": { "serverAccess": { "type": "boolean" }, "relationalStorageAccess": { "type": "boolean" }, "build": { "type": "string", "nullable": true }, "envrionment": { "type": "string", "nullable": true }, "databaseName": { "type": "string", "nullable": true }, "requestHeaders": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringKeyValuePair" }, "nullable": true } }, "additionalProperties": false }, "HmacResult": { "type": "object", "properties": { "postActions": { "type": "array", "items": { "$ref": "#/components/schemas/TaskFunc" }, "nullable": true }, "success": { "type": "boolean" }, "permissionDenied": { "type": "boolean" }, "appMessages": { "type": "array", "items": { "$ref": "#/components/schemas/AppMessage" }, "nullable": true }, "highestSeverity": { "$ref": "#/components/schemas/Severity" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/AppMessage" }, "nullable": true, "readOnly": true }, "hmac": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ICustomAttributeProvider": { "type": "object", "additionalProperties": false }, "Indicator": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "referenceDocuments": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "registrations": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItemRegistration" }, "nullable": true }, "commonName": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "rationale": { "type": "string", "nullable": true }, "populationGroupAgeFrom": { "type": "string", "nullable": true }, "populationGroupAgeTo": { "type": "string", "nullable": true }, "computationDescription": { "type": "string", "nullable": true }, "computation": { "type": "string", "nullable": true }, "numerator": { "type": "string", "nullable": true }, "denominator": { "type": "string", "nullable": true }, "disaggregation": { "type": "string", "nullable": true }, "representationClass": { "type": "string", "nullable": true }, "dataType": { "type": "string", "nullable": true }, "unitOfMeasure": { "type": "string", "nullable": true }, "format": { "type": "string", "nullable": true }, "methodology": { "type": "string", "nullable": true }, "formulae": { "type": "string", "nullable": true }, "reportingRequirements": { "type": "string", "nullable": true }, "organisationResponsibleForProvidingData": { "type": "string", "nullable": true }, "accountability": { "type": "string", "nullable": true }, "internationalComparison": { "type": "string", "nullable": true }, "benchmark": { "type": "string", "nullable": true }, "furtherDataDevelopment": { "type": "string", "nullable": true }, "otherIssuesCaveats": { "type": "string", "nullable": true }, "shortName": { "type": "string", "nullable": true }, "numeratorDataElements": { "type": "array", "items": { "$ref": "#/components/schemas/IndicatorDataElementSetReference" }, "nullable": true }, "denominatorDataElements": { "type": "array", "items": { "$ref": "#/components/schemas/IndicatorDataElementSetReference" }, "nullable": true }, "disaggregationDataElements": { "type": "array", "items": { "$ref": "#/components/schemas/IndicatorDataElementSetReference" }, "nullable": true }, "releaseDate": { "type": "string", "format": "date-time", "nullable": true }, "synonymousNames": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "submittingOrganisations": { "type": "array", "items": { "$ref": "#/components/schemas/SubmittingOrganisation" }, "nullable": true }, "registryManagementAttributes": { "$ref": "#/components/schemas/RegistryManagementAttributes" } }, "additionalProperties": false }, "IndicatorDataElementSetReference": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "guideForUse": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true } }, "additionalProperties": false }, "IndicatorSet": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "referenceDocuments": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "type": { "nullable": true }, "registrations": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItemRegistration" }, "nullable": true }, "description": { "type": "string", "nullable": true }, "nationalReportingArrangement": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "implementationStartDate": { "type": "string", "format": "date-time", "nullable": true }, "implementationEndDate": { "type": "string", "format": "date-time", "nullable": true }, "submittingOrganisations": { "type": "array", "items": { "$ref": "#/components/schemas/SubmittingOrganisation" }, "nullable": true }, "registryManagementAttributes": { "$ref": "#/components/schemas/RegistryManagementAttributes" } }, "additionalProperties": false }, "IntPtr": { "type": "object", "additionalProperties": false }, "LayoutKind": { "enum": [ 0, 2, 3 ], "type": "integer", "format": "int32" }, "MemberInfo": { "type": "object", "properties": { "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "MemberTypes": { "enum": [ 1, 2, 4, 8, 16, 32, 64, 128, 191 ], "type": "integer", "format": "int32" }, "MetadataItemRegistration": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "state": { "type": "string", "nullable": true }, "registrationAuthorityId": { "type": "integer", "format": "int32" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "registrationAuthorityName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MethodAttributes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 53248 ], "type": "integer", "format": "int32" }, "MethodBase": { "type": "object", "properties": { "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/MethodAttributes" }, "methodImplementationFlags": { "$ref": "#/components/schemas/MethodImplAttributes" }, "callingConvention": { "$ref": "#/components/schemas/CallingConventions" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isConstructor": { "type": "boolean", "readOnly": true }, "isFinal": { "type": "boolean", "readOnly": true }, "isHideBySig": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isVirtual": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isConstructedGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethodDefinition": { "type": "boolean", "readOnly": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "methodHandle": { "$ref": "#/components/schemas/RuntimeMethodHandle" }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "MethodImplAttributes": { "enum": [ 0, 1, 2, 3, 4, 8, 16, 32, 64, 128, 256, 512, 4096, 65535 ], "type": "integer", "format": "int32" }, "MethodInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/MethodAttributes" }, "methodImplementationFlags": { "$ref": "#/components/schemas/MethodImplAttributes" }, "callingConvention": { "$ref": "#/components/schemas/CallingConventions" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isConstructor": { "type": "boolean", "readOnly": true }, "isFinal": { "type": "boolean", "readOnly": true }, "isHideBySig": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isVirtual": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isConstructedGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethodDefinition": { "type": "boolean", "readOnly": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "methodHandle": { "$ref": "#/components/schemas/RuntimeMethodHandle" }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "returnParameter": { "$ref": "#/components/schemas/ParameterInfo" }, "returnType": { "$ref": "#/components/schemas/Type" }, "returnTypeCustomAttributes": { "$ref": "#/components/schemas/ICustomAttributeProvider" } }, "additionalProperties": false }, "Module": { "type": "object", "properties": { "assembly": { "$ref": "#/components/schemas/Assembly" }, "fullyQualifiedName": { "type": "string", "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "mdStreamVersion": { "type": "integer", "format": "int32", "readOnly": true }, "moduleVersionId": { "type": "string", "format": "uuid", "readOnly": true }, "scopeName": { "type": "string", "nullable": true, "readOnly": true }, "moduleHandle": { "$ref": "#/components/schemas/ModuleHandle" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "ModuleHandle": { "type": "object", "properties": { "mdStreamVersion": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "ObjectClass": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "referenceDocuments": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "definition": { "type": "string", "nullable": true }, "context": { "type": "string", "nullable": true }, "guideForUse": { "type": "string", "nullable": true }, "collectionMethods": { "type": "string", "nullable": true }, "registrations": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItemRegistration" }, "nullable": true }, "synonymousNames": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "submittingOrganisations": { "type": "array", "items": { "$ref": "#/components/schemas/SubmittingOrganisation" }, "nullable": true }, "registryManagementAttributes": { "$ref": "#/components/schemas/RegistryManagementAttributes" } }, "additionalProperties": false }, "ObjectClassSpecialisation": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "registryManagementAttributes": { "$ref": "#/components/schemas/RegistryManagementAttributes" } }, "additionalProperties": false }, "OperationalSpecification": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "referenceDocuments": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "type": { "type": "string", "nullable": true }, "clusterItems": { "type": "array", "items": { "$ref": "#/components/schemas/OperationalSpecificationtem" }, "nullable": true } }, "additionalProperties": false }, "OperationalSpecificationtem": { "type": "object", "properties": { "sequenceNumber": { "type": "integer", "format": "int32" }, "obligation": { "type": "string", "nullable": true }, "maximumOccurrences": { "type": "integer", "format": "int32" }, "conditionalObligation": { "type": "string", "nullable": true }, "dataSetSpecificInformation": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "meteorIdentifier": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "shortName": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "representationDatatype": { "type": "string", "nullable": true }, "format": { "type": "string", "nullable": true }, "maximum": { "type": "integer", "format": "int32", "nullable": true }, "permissibleValues": { "type": "array", "items": { "$ref": "#/components/schemas/PermissibleValue" }, "nullable": true }, "supplementaryValues": { "type": "array", "items": { "$ref": "#/components/schemas/PermissibleValue" }, "nullable": true }, "clusterItems": { "type": "array", "items": { "$ref": "#/components/schemas/OperationalSpecificationtem" }, "nullable": true }, "dataTypeAndLength": { "type": "string", "nullable": true }, "startPosition": { "type": "integer", "format": "int32" }, "valueAndMeaningString": { "type": "string", "nullable": true }, "valueAndMeaning": { "type": "array", "items": { "$ref": "#/components/schemas/PermissibleValue" }, "nullable": true } }, "additionalProperties": false }, "OutcomeArea": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "referenceDocuments": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "nationalReportingArrangement": { "type": "string", "nullable": true }, "registrations": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItemRegistration" }, "nullable": true }, "implementationStartDate": { "type": "string", "format": "date-time", "nullable": true }, "implementationEndDate": { "type": "string", "format": "date-time", "nullable": true }, "description": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "submittingOrganisations": { "type": "array", "items": { "$ref": "#/components/schemas/SubmittingOrganisation" }, "nullable": true }, "registryManagementAttributes": { "$ref": "#/components/schemas/RegistryManagementAttributes" } }, "additionalProperties": false }, "ParameterAttributes": { "enum": [ 0, 1, 2, 4, 8, 16, 4096, 8192, 16384, 32768, 61440 ], "type": "integer", "format": "int32" }, "ParameterInfo": { "type": "object", "properties": { "attributes": { "$ref": "#/components/schemas/ParameterAttributes" }, "member": { "$ref": "#/components/schemas/MemberInfo" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "parameterType": { "$ref": "#/components/schemas/Type" }, "position": { "type": "integer", "format": "int32", "readOnly": true }, "isIn": { "type": "boolean", "readOnly": true }, "isLcid": { "type": "boolean", "readOnly": true }, "isOptional": { "type": "boolean", "readOnly": true }, "isOut": { "type": "boolean", "readOnly": true }, "isRetval": { "type": "boolean", "readOnly": true }, "defaultValue": { "nullable": true, "readOnly": true }, "rawDefaultValue": { "nullable": true, "readOnly": true }, "hasDefaultValue": { "type": "boolean", "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "PermissibleValue": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "Product": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "Property": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "referenceDocuments": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "context": { "type": "string", "nullable": true }, "definition": { "type": "string", "nullable": true }, "registrations": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItemRegistration" }, "nullable": true }, "guideForUse": { "type": "string", "nullable": true }, "collectionMethods": { "type": "string", "nullable": true }, "synonymousNames": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "submittingOrganisations": { "type": "array", "items": { "$ref": "#/components/schemas/SubmittingOrganisation" }, "nullable": true }, "registryManagementAttributes": { "$ref": "#/components/schemas/RegistryManagementAttributes" } }, "additionalProperties": false }, "PropertyAttributes": { "enum": [ 0, 512, 1024, 4096, 8192, 16384, 32768, 62464 ], "type": "integer", "format": "int32" }, "PropertyGroup": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "registryManagementAttributes": { "$ref": "#/components/schemas/RegistryManagementAttributes" } }, "additionalProperties": false }, "PropertyInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "propertyType": { "$ref": "#/components/schemas/Type" }, "attributes": { "$ref": "#/components/schemas/PropertyAttributes" }, "isSpecialName": { "type": "boolean", "readOnly": true }, "canRead": { "type": "boolean", "readOnly": true }, "canWrite": { "type": "boolean", "readOnly": true }, "getMethod": { "$ref": "#/components/schemas/MethodInfo" }, "setMethod": { "$ref": "#/components/schemas/MethodInfo" } }, "additionalProperties": false }, "QualityStatement": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "referenceDocuments": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "synonymousNames": { "type": "string", "nullable": true }, "registrations": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItemRegistration" }, "nullable": true }, "summary": { "type": "string", "nullable": true }, "institutionalEnvironment": { "type": "string", "nullable": true }, "timeliness": { "type": "string", "nullable": true }, "accessibility": { "type": "string", "nullable": true }, "interpretability": { "type": "string", "nullable": true }, "relevance": { "type": "string", "nullable": true }, "accuracy": { "type": "string", "nullable": true }, "coherence": { "type": "string", "nullable": true }, "implementationStartDate": { "type": "string", "format": "date-time", "nullable": true }, "submittingOrganisations": { "type": "array", "items": { "$ref": "#/components/schemas/SubmittingOrganisation" }, "nullable": true }, "registryManagementAttributes": { "$ref": "#/components/schemas/RegistryManagementAttributes" } }, "additionalProperties": false }, "RegistryManagementAttributes": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "lastUpdatedAt": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedBy": { "type": "string", "nullable": true }, "stewardContactDetails": { "type": "string", "nullable": true }, "submittingOrganisationContactDetails": { "type": "string", "nullable": true }, "unresolvedIssues": { "type": "array", "items": { "$ref": "#/components/schemas/UnresolvedIssue" }, "nullable": true }, "workgroupName": { "type": "string", "nullable": true }, "workgroupId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "RelatedDataSetSpecification": { "type": "object", "properties": { "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "sequenceNumber": { "type": "number", "format": "double" }, "obligation": { "type": "string", "nullable": true }, "maximumOccurrences": { "type": "number", "format": "double" }, "conditionalObligation": { "type": "string", "nullable": true }, "dataSetSpecificInformation": { "type": "string", "nullable": true }, "registrations": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItemRegistration" }, "nullable": true } }, "additionalProperties": false }, "ResourceLink": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "method": { "type": "string", "nullable": true }, "rel": { "type": "string", "nullable": true }, "entityId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RotateOrExpireApiKeyRequest": { "type": "object", "properties": { "action": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RotateOrExpireApiKeyResult": { "type": "object", "properties": { "postActions": { "type": "array", "items": { "$ref": "#/components/schemas/TaskFunc" }, "nullable": true }, "success": { "type": "boolean" }, "permissionDenied": { "type": "boolean" }, "appMessages": { "type": "array", "items": { "$ref": "#/components/schemas/AppMessage" }, "nullable": true }, "highestSeverity": { "$ref": "#/components/schemas/Severity" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/AppMessage" }, "nullable": true, "readOnly": true }, "keyId": { "type": "integer", "format": "int32" }, "keyExpiresAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "RuntimeFieldHandle": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/IntPtr" } }, "additionalProperties": false }, "RuntimeMethodHandle": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/IntPtr" } }, "additionalProperties": false }, "RuntimeTypeHandle": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/IntPtr" } }, "additionalProperties": false }, "SecurityRuleSet": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "Severity": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "StringStringKeyValuePair": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StructLayoutAttribute": { "type": "object", "properties": { "typeId": { "nullable": true, "readOnly": true }, "value": { "$ref": "#/components/schemas/LayoutKind" } }, "additionalProperties": false }, "SubmittingOrganisation": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true } }, "additionalProperties": false }, "TaskFunc": { "type": "object", "properties": { "target": { "nullable": true, "readOnly": true }, "method": { "$ref": "#/components/schemas/MethodInfo" } }, "additionalProperties": false }, "Type": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "isInterface": { "type": "boolean", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "namespace": { "type": "string", "nullable": true, "readOnly": true }, "assemblyQualifiedName": { "type": "string", "nullable": true, "readOnly": true }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "assembly": { "$ref": "#/components/schemas/Assembly" }, "module": { "$ref": "#/components/schemas/Module" }, "isNested": { "type": "boolean", "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "declaringMethod": { "$ref": "#/components/schemas/MethodBase" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "underlyingSystemType": { "$ref": "#/components/schemas/Type" }, "isTypeDefinition": { "type": "boolean", "readOnly": true }, "isArray": { "type": "boolean", "readOnly": true }, "isByRef": { "type": "boolean", "readOnly": true }, "isPointer": { "type": "boolean", "readOnly": true }, "isConstructedGenericType": { "type": "boolean", "readOnly": true }, "isGenericParameter": { "type": "boolean", "readOnly": true }, "isGenericTypeParameter": { "type": "boolean", "readOnly": true }, "isGenericMethodParameter": { "type": "boolean", "readOnly": true }, "isGenericType": { "type": "boolean", "readOnly": true }, "isGenericTypeDefinition": { "type": "boolean", "readOnly": true }, "isSZArray": { "type": "boolean", "readOnly": true }, "isVariableBoundArray": { "type": "boolean", "readOnly": true }, "isByRefLike": { "type": "boolean", "readOnly": true }, "isFunctionPointer": { "type": "boolean", "readOnly": true }, "isUnmanagedFunctionPointer": { "type": "boolean", "readOnly": true }, "hasElementType": { "type": "boolean", "readOnly": true }, "genericTypeArguments": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "genericParameterPosition": { "type": "integer", "format": "int32", "readOnly": true }, "genericParameterAttributes": { "$ref": "#/components/schemas/GenericParameterAttributes" }, "attributes": { "$ref": "#/components/schemas/TypeAttributes" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isImport": { "type": "boolean", "readOnly": true }, "isSealed": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isClass": { "type": "boolean", "readOnly": true }, "isNestedAssembly": { "type": "boolean", "readOnly": true }, "isNestedFamANDAssem": { "type": "boolean", "readOnly": true }, "isNestedFamily": { "type": "boolean", "readOnly": true }, "isNestedFamORAssem": { "type": "boolean", "readOnly": true }, "isNestedPrivate": { "type": "boolean", "readOnly": true }, "isNestedPublic": { "type": "boolean", "readOnly": true }, "isNotPublic": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isAutoLayout": { "type": "boolean", "readOnly": true }, "isExplicitLayout": { "type": "boolean", "readOnly": true }, "isLayoutSequential": { "type": "boolean", "readOnly": true }, "isAnsiClass": { "type": "boolean", "readOnly": true }, "isAutoClass": { "type": "boolean", "readOnly": true }, "isUnicodeClass": { "type": "boolean", "readOnly": true }, "isCOMObject": { "type": "boolean", "readOnly": true }, "isContextful": { "type": "boolean", "readOnly": true }, "isEnum": { "type": "boolean", "readOnly": true }, "isMarshalByRef": { "type": "boolean", "readOnly": true }, "isPrimitive": { "type": "boolean", "readOnly": true }, "isValueType": { "type": "boolean", "readOnly": true }, "isSignatureType": { "type": "boolean", "readOnly": true }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "structLayoutAttribute": { "$ref": "#/components/schemas/StructLayoutAttribute" }, "typeInitializer": { "$ref": "#/components/schemas/ConstructorInfo" }, "typeHandle": { "$ref": "#/components/schemas/RuntimeTypeHandle" }, "guid": { "type": "string", "format": "uuid", "readOnly": true }, "baseType": { "$ref": "#/components/schemas/Type" }, "isSerializable": { "type": "boolean", "readOnly": true, "deprecated": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "isVisible": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "TypeAttributes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 16, 24, 32, 128, 256, 1024, 2048, 4096, 8192, 16384, 65536, 131072, 196608, 262144, 264192, 1048576, 12582912 ], "type": "integer", "format": "int32" }, "TypeInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true }, "isInterface": { "type": "boolean", "readOnly": true }, "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "namespace": { "type": "string", "nullable": true, "readOnly": true }, "assemblyQualifiedName": { "type": "string", "nullable": true, "readOnly": true }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "assembly": { "$ref": "#/components/schemas/Assembly" }, "module": { "$ref": "#/components/schemas/Module" }, "isNested": { "type": "boolean", "readOnly": true }, "declaringType": { "$ref": "#/components/schemas/Type" }, "declaringMethod": { "$ref": "#/components/schemas/MethodBase" }, "reflectedType": { "$ref": "#/components/schemas/Type" }, "underlyingSystemType": { "$ref": "#/components/schemas/Type" }, "isTypeDefinition": { "type": "boolean", "readOnly": true }, "isArray": { "type": "boolean", "readOnly": true }, "isByRef": { "type": "boolean", "readOnly": true }, "isPointer": { "type": "boolean", "readOnly": true }, "isConstructedGenericType": { "type": "boolean", "readOnly": true }, "isGenericParameter": { "type": "boolean", "readOnly": true }, "isGenericTypeParameter": { "type": "boolean", "readOnly": true }, "isGenericMethodParameter": { "type": "boolean", "readOnly": true }, "isGenericType": { "type": "boolean", "readOnly": true }, "isGenericTypeDefinition": { "type": "boolean", "readOnly": true }, "isSZArray": { "type": "boolean", "readOnly": true }, "isVariableBoundArray": { "type": "boolean", "readOnly": true }, "isByRefLike": { "type": "boolean", "readOnly": true }, "isFunctionPointer": { "type": "boolean", "readOnly": true }, "isUnmanagedFunctionPointer": { "type": "boolean", "readOnly": true }, "hasElementType": { "type": "boolean", "readOnly": true }, "genericTypeArguments": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "genericParameterPosition": { "type": "integer", "format": "int32", "readOnly": true }, "genericParameterAttributes": { "$ref": "#/components/schemas/GenericParameterAttributes" }, "attributes": { "$ref": "#/components/schemas/TypeAttributes" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isImport": { "type": "boolean", "readOnly": true }, "isSealed": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isClass": { "type": "boolean", "readOnly": true }, "isNestedAssembly": { "type": "boolean", "readOnly": true }, "isNestedFamANDAssem": { "type": "boolean", "readOnly": true }, "isNestedFamily": { "type": "boolean", "readOnly": true }, "isNestedFamORAssem": { "type": "boolean", "readOnly": true }, "isNestedPrivate": { "type": "boolean", "readOnly": true }, "isNestedPublic": { "type": "boolean", "readOnly": true }, "isNotPublic": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isAutoLayout": { "type": "boolean", "readOnly": true }, "isExplicitLayout": { "type": "boolean", "readOnly": true }, "isLayoutSequential": { "type": "boolean", "readOnly": true }, "isAnsiClass": { "type": "boolean", "readOnly": true }, "isAutoClass": { "type": "boolean", "readOnly": true }, "isUnicodeClass": { "type": "boolean", "readOnly": true }, "isCOMObject": { "type": "boolean", "readOnly": true }, "isContextful": { "type": "boolean", "readOnly": true }, "isEnum": { "type": "boolean", "readOnly": true }, "isMarshalByRef": { "type": "boolean", "readOnly": true }, "isPrimitive": { "type": "boolean", "readOnly": true }, "isValueType": { "type": "boolean", "readOnly": true }, "isSignatureType": { "type": "boolean", "readOnly": true }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "structLayoutAttribute": { "$ref": "#/components/schemas/StructLayoutAttribute" }, "typeInitializer": { "$ref": "#/components/schemas/ConstructorInfo" }, "typeHandle": { "$ref": "#/components/schemas/RuntimeTypeHandle" }, "guid": { "type": "string", "format": "uuid", "readOnly": true }, "baseType": { "$ref": "#/components/schemas/Type" }, "isSerializable": { "type": "boolean", "readOnly": true, "deprecated": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "isVisible": { "type": "boolean", "readOnly": true }, "genericTypeParameters": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true }, "declaredConstructors": { "type": "array", "items": { "$ref": "#/components/schemas/ConstructorInfo" }, "nullable": true, "readOnly": true }, "declaredEvents": { "type": "array", "items": { "$ref": "#/components/schemas/EventInfo" }, "nullable": true, "readOnly": true }, "declaredFields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldInfo" }, "nullable": true, "readOnly": true }, "declaredMembers": { "type": "array", "items": { "$ref": "#/components/schemas/MemberInfo" }, "nullable": true, "readOnly": true }, "declaredMethods": { "type": "array", "items": { "$ref": "#/components/schemas/MethodInfo" }, "nullable": true, "readOnly": true }, "declaredNestedTypes": { "type": "array", "items": { "$ref": "#/components/schemas/TypeInfo" }, "nullable": true, "readOnly": true }, "declaredProperties": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyInfo" }, "nullable": true, "readOnly": true }, "implementedInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/Type" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "UnitOfMeasure": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "precision": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "UnresolvedIssue": { "type": "object", "properties": { "issue": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateSubscriptionRequest": { "type": "object", "properties": { "isActive": { "type": "boolean" } }, "additionalProperties": false }, "ValueDomain": { "type": "object", "properties": { "meteorIdentifier": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "referenceDocuments": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceLink" }, "nullable": true }, "format": { "type": "string", "nullable": true }, "representationClass": { "type": "string", "nullable": true }, "representationDataType": { "type": "string", "nullable": true }, "definition": { "type": "string", "nullable": true }, "context": { "type": "string", "nullable": true }, "maximum": { "type": "integer", "format": "int32" }, "unitOfMeasure": { "$ref": "#/components/schemas/UnitOfMeasure" }, "proposedUnitOfMeasure": { "type": "string", "nullable": true }, "permissibleValues": { "type": "array", "items": { "$ref": "#/components/schemas/PermissibleValue" }, "nullable": true }, "supplementaryValues": { "type": "array", "items": { "$ref": "#/components/schemas/PermissibleValue" }, "nullable": true }, "registrations": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItemRegistration" }, "nullable": true }, "guideForUse": { "type": "string", "nullable": true }, "collectionMethods": { "type": "string", "nullable": true }, "synonymousNames": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "submittingOrganisations": { "type": "array", "items": { "$ref": "#/components/schemas/SubmittingOrganisation" }, "nullable": true }, "registryManagementAttributes": { "$ref": "#/components/schemas/RegistryManagementAttributes" } }, "additionalProperties": false } } } }