{
"swagger": "2.0",
"info": {
"version": "v1",
"title": "Bexis 2 APIs"
},
"host": "demo.bexis2.uni-jena.de",
"schemes": [
"https"
],
"paths": {
"/api/Attachment": {
"get": {
"tags": [
"ATTACHMENT"
],
"summary": "With the Get function you get an overview of the exiting datasets and there attachments.",
"description": "With the Get function you get an overview of the exiting datasets and there attachments.",
"operationId": "AttachmentOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ApiDatasetAttachmentsModel"
}
}
}
}
}
},
"/api/Attachment/{id}": {
"get": {
"tags": [
"ATTACHMENT"
],
"summary": "With the Get function you get an overview of one specific dataset and there attachments.",
"description": "With the Get function you get an overview of one specific dataset and there attachments.",
"operationId": "AttachmentOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
},
"put": {
"tags": [
"ATTACHMENT"
],
"operationId": "AttachmentIn_Put",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Attachment/{id}/{attachmentid}": {
"get": {
"tags": [
"ATTACHMENT"
],
"summary": "This Get function has been extended by a parameter id. The id refers to the dataset. The metadata will be loaded from the dataset",
"operationId": "AttachmentOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Dataset Id",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "attachmentid",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/AttachmentIn": {
"post": {
"tags": [
"ATTACHMENTIN"
],
"operationId": "AttachmentIn_uploadFiles",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "attachments",
"in": "query",
"required": true,
"type": "array",
"items": {},
"collectionFormat": "multi"
},
{
"name": "datasetId",
"in": "query",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "description",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "userName",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "dm.preferedBatchSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/api/Concept": {
"get": {
"tags": [
"CONCEPT"
],
"operationId": "ConceptOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Concept"
}
}
}
}
}
},
"/api/curationentries": {
"get": {
"tags": [
"CURATIONENTRIES"
],
"operationId": "CurationEntry_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
},
"put": {
"tags": [
"CURATIONENTRIES"
],
"operationId": "CurationEntry_Put",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "curationEntryModel",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CurationEntryModel"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
},
"post": {
"tags": [
"CURATIONENTRIES"
],
"operationId": "CurationEntry_Post",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "curationEntryModel",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CurationEntryModel"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Data": {
"get": {
"tags": [
"DATA"
],
"summary": "Get a list of all dataset ids",
"operationId": "DataOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"format": "int64",
"type": "integer"
}
}
}
}
},
"put": {
"tags": [
"DATA"
],
"operationId": "DataIn_Put",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/DataApiModel"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Data/{id}": {
"get": {
"tags": [
"DATA"
],
"summary": "In addition to the id, it is possible to have projection and selection criteria passed to the action via query string parameters",
"description": "The action accepts the following additional parameters via the query string\r\n 1: header: is a comman separated list of variable names that determines which variables of the dataset version tuples should take part in the result set\r\n 2: filter: is a logical expression that filters the tuples of the chosen dataset. The expression should have been written against the variables of the dataset only.\r\n logical operators, nesting, precedence, and SOME functions should be supported.",
"operationId": "DataOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Dataset Id",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "header",
"in": "query",
"description": "Is a comman separated list of variable names that determines which variables of the dataset. e.g: Var1,Var2,var3",
"required": false,
"type": "string"
},
{
"name": "filter",
"in": "query",
"description": "is a logical expression that filters the tuples of the chosen dataset. e.g. : Var1='Value'",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Data/{id}/{versionId}": {
"get": {
"tags": [
"DATA"
],
"summary": "In addition to the id and version id, it is possible to have projection and selection criteria passed to the action via query string parameters",
"description": "The action accepts the following additional parameters via the query string\r\n 1: header: is a comman separated list of ids that determines which variables of the dataset version tuples should take part in the result set\r\n 2: filter: is a logical expression that filters the tuples of the chosen dataset. The expression should have been written against the variables of the dataset only.\r\n logical operators, nesting, precedence, and SOME functions should be supported.",
"operationId": "DataOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Dataset Id",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "versionId",
"in": "path",
"description": "Version Id of the dataset",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "header",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "filter",
"in": "query",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Data/{id}/version_number/{version_number}": {
"get": {
"tags": [
"DATA"
],
"summary": "In addition to the id and version number, it is possible to have projection and selection criteria passed to the action via query string parameters",
"description": "The action accepts the following additional parameters via the query string\r\n 1: header: is a comman separated list of ids that determines which variables of the dataset version tuples should take part in the result set\r\n 2: filter: is a logical expression that filters the tuples of the chosen dataset. The expression should have been written against the variables of the dataset only.\r\n logical operators, nesting, precedence, and SOME functions should be supported.",
"operationId": "DataOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Dataset Id",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "version_number",
"in": "path",
"description": "Version number of the dataset",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "header",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "filter",
"in": "query",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Data/{id}/version_name/{version_name}": {
"get": {
"tags": [
"DATA"
],
"summary": "In addition to the id and version name, it is possible to have projection and selection criteria passed to the action via query string parameters",
"description": "The action accepts the following additional parameters via the query string\r\n 1: header: is a comman separated list of ids that determines which variables of the dataset version tuples should take part in the result set\r\n 2: filter: is a logical expression that filters the tuples of the chosen dataset. The expression should have been written against the variables of the dataset only.\r\n logical operators, nesting, precedence, and SOME functions should be supported.",
"operationId": "DataOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Dataset Id",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "version_name",
"in": "path",
"description": "Version name of the dataset",
"required": true,
"type": "string"
},
{
"name": "header",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "filter",
"in": "query",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Data/{id}/tag/{tag}": {
"get": {
"tags": [
"DATA"
],
"summary": "In addition to the id and tag, it is possible to have projection and selection criteria passed to the action via query string parameters",
"description": "The action accepts the following additional parameters via the query string\r\n 1: header: is a comman separated list of ids that determines which variables of the dataset version tuples should take part in the result set\r\n 2: filter: is a logical expression that filters the tuples of the chosen dataset. The expression should have been written against the variables of the dataset only.\r\n logical operators, nesting, precedence, and SOME functions should be supported.",
"operationId": "DataOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Dataset Id",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "tag",
"in": "path",
"description": "tag number of the dataset",
"required": true,
"type": "number",
"format": "double"
},
{
"name": "header",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "filter",
"in": "query",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/DataQuality": {
"get": {
"tags": [
"DATAQUALITY"
],
"summary": "Get a list of all dataset ids",
"operationId": "DataQualityOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
}
}
}
},
"/api/DataQuality/{id}": {
"get": {
"tags": [
"DATAQUALITY"
],
"operationId": "DataQualityOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Dataset Id",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/dataset": {
"get": {
"tags": [
"DATASET"
],
"summary": "Get a list of all datasets Id´s in the system.",
"operationId": "DatasetOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ApiSimpleDatasetModel"
}
}
}
},
"post": {
"tags": [
"DATASET"
],
"summary": "",
"operationId": "DatasetIn_Post",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "dataset",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/PostApiDatasetModel"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/dataset/{id}": {
"get": {
"tags": [
"DATASET"
],
"summary": "Get dataset information of the latest version of a dataset by id.",
"operationId": "DatasetOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifier of a dataset",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ApiDatasetModel"
}
}
}
}
},
"/api/dataset/{id}/{versionId}": {
"get": {
"tags": [
"DATASET"
],
"summary": "Get dataset information of a specific version of a dataset by id and version id.",
"operationId": "DatasetOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifier of a dataset",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "versionId",
"in": "path",
"description": "Version Id of a dataset",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ApiDatasetModel"
}
}
}
}
},
"/api/dataset/{id}/version_number/{version_number}": {
"get": {
"tags": [
"DATASET"
],
"summary": "Get dataset information of a specific version of a dataset by id and version number.",
"operationId": "DatasetOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifier of a dataset",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "version_number",
"in": "path",
"description": "Version of a dataset",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ApiDatasetModel"
}
}
}
}
},
"/api/dataset/{id}/version_name/{version_name}": {
"get": {
"tags": [
"DATASET"
],
"summary": "Get dataset information of a specific version of a dataset by id and version name.",
"operationId": "DatasetOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifier of a dataset",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "version_name",
"in": "path",
"description": "Version name of a dataset",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ApiDatasetModel"
}
}
}
}
},
"/api/dataset/{id}/tag/{tag}": {
"get": {
"tags": [
"DATASET"
],
"summary": "Get dataset informations of a specific version of a dataset by id and tag.",
"operationId": "DatasetOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifier of a dataset",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "tag",
"in": "path",
"description": "tag number of a dataset",
"required": true,
"type": "number",
"format": "double"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ApiDatasetModel"
}
}
}
}
},
"/api/datasets/citations": {
"get": {
"tags": [
"DATASETS"
],
"operationId": "Citation_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "format",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3
]
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
},
"post": {
"tags": [
"DATASETS"
],
"operationId": "Citation_Post",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CitationDatasetIds"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/datasets/{datasetId}/citations": {
"get": {
"tags": [
"DATASETS"
],
"operationId": "Citation_GetCitationFromLatestVersion",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "datasetId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "format",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3
]
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CitationModel"
}
}
}
}
},
"/api/datasets/{datasetId}/citations/{versionNumber}": {
"get": {
"tags": [
"DATASETS"
],
"operationId": "Citation_GetCitationFromSpecificVersionNumber",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "datasetId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "versionNumber",
"in": "path",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "format",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3
]
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CitationModel"
}
}
}
}
},
"/api/datasets/{datasetid}/curation": {
"get": {
"tags": [
"DATASETS"
],
"operationId": "CurationEntry_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "datasetid",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/datasets/{id}/tags/simple": {
"get": {
"tags": [
"DATASETS"
],
"operationId": "TagInfoView_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/datasets/{id}/tags": {
"get": {
"tags": [
"DATASETS"
],
"operationId": "TagInfoEdit_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/DataStatistic": {
"get": {
"tags": [
"DATASTATISTIC"
],
"summary": "Get a list of all dataset ids",
"operationId": "DataStatisticOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
}
}
}
},
"/api/DataStatistic/{id}": {
"get": {
"tags": [
"DATASTATISTIC"
],
"summary": "Get unique values, max and min values, and max and min length for all variables",
"operationId": "DataStatisticOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Dataset Id",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ApiDataStatisticModel"
}
}
}
}
},
"/api/DataStatistic/{id}/{variableId}": {
"get": {
"tags": [
"DATASTATISTIC"
],
"summary": "Get unique values, max and min values, and max and min length for one variable",
"operationId": "DataStatisticOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Dataset Id",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "variableId",
"in": "path",
"description": "Variable id",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ApiDataStatisticModel"
}
}
}
}
},
"/api/DataTable": {
"post": {
"tags": [
"DATATABLE"
],
"operationId": "DataTable_Get",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "command",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/DataTableSendModel"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DataTableRecieveModel"
}
}
}
}
},
"/api/File/{id}": {
"put": {
"tags": [
"FILE"
],
"operationId": "File_Put",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/File": {
"post": {
"tags": [
"FILE"
],
"operationId": "File_uploadFiles",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "attachments",
"in": "query",
"required": true,
"type": "array",
"items": {},
"collectionFormat": "multi"
},
{
"name": "datasetId",
"in": "query",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "description",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "userName",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "dm.preferedBatchSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/api/groups/{groupId}": {
"get": {
"tags": [
"GROUPS"
],
"operationId": "Groups_GetById",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "groupId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
},
"put": {
"tags": [
"GROUPS"
],
"operationId": "Groups_PutByIdAsync",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "groupId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateGroupModel"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
},
"delete": {
"tags": [
"GROUPS"
],
"operationId": "Groups_DeleteByIdAsync",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "groupId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/groups": {
"get": {
"tags": [
"GROUPS"
],
"operationId": "Groups_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
},
"post": {
"tags": [
"GROUPS"
],
"operationId": "Groups_Post",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateGroupModel"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Link": {
"get": {
"tags": [
"LINK"
],
"operationId": "Link_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"put": {
"tags": [
"LINK"
],
"operationId": "Link_Put",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "value",
"in": "body",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"post": {
"tags": [
"LINK"
],
"operationId": "Link_Post",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "value",
"in": "body",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"LINK"
],
"operationId": "Link_Delete",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/api/LinkElementType": {
"get": {
"tags": [
"LINKELEMENTTYPE"
],
"operationId": "LinkElementType_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LEType"
}
}
}
}
}
},
"/api/Mapping": {
"get": {
"tags": [
"MAPPING"
],
"operationId": "MappingOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Mapping"
}
}
}
}
}
},
"/api/Mapping/{sourceElementId}/{sourceElementType}/{targetElementId}/{targetElementType}": {
"get": {
"tags": [
"MAPPING"
],
"summary": "",
"description": "",
"operationId": "MappingOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "sourceElementId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "sourceElementType",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "targetElementId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "targetElementType",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Meanings/Index": {
"get": {
"tags": [
"MEANINGS"
],
"operationId": "Meanings_Index",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Meanings/Details": {
"get": {
"tags": [
"MEANINGS"
],
"operationId": "Meanings_Details",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Meanings/DetailExternalLinks": {
"get": {
"tags": [
"MEANINGS"
],
"operationId": "Meanings_DetailExternalLinks",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Meanings/getPrefixes": {
"get": {
"tags": [
"MEANINGS"
],
"operationId": "Meanings_getPrefixes",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Meanings/getPrefixfromUri": {
"get": {
"tags": [
"MEANINGS"
],
"operationId": "Meanings_getPrefixfromUri",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Meanings": {
"get": {
"tags": [
"MEANINGS"
],
"operationId": "Meanings_getExternalLinks",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/MeaningsAdmin/Create": {
"post": {
"tags": [
"MEANINGSADMIN"
],
"operationId": "MeaningsAdmin_Create",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Meaning"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/MeaningsAdmin/EditMeaning": {
"post": {
"tags": [
"MEANINGSADMIN"
],
"operationId": "MeaningsAdmin_EditMeaning",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Meaning"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/MeaningsAdmin/Delete": {
"post": {
"tags": [
"MEANINGSADMIN"
],
"operationId": "MeaningsAdmin_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
},
"delete": {
"tags": [
"MEANINGSADMIN"
],
"operationId": "MeaningsAdmin_Delete",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/MeaningsAdmin/getVariables": {
"get": {
"tags": [
"MEANINGSADMIN"
],
"operationId": "MeaningsAdmin_getVariables",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/MeaningsAdmin/updateRelatedManings": {
"post": {
"tags": [
"MEANINGSADMIN"
],
"operationId": "MeaningsAdmin_updateRelatedManings",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "request",
"in": "query",
"required": true,
"type": "object"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/MeaningsAdmin/createExternalLink": {
"post": {
"tags": [
"MEANINGSADMIN"
],
"operationId": "MeaningsAdmin_createExternalLink",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ExternalLink"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/MeaningsAdmin/editExternalLinks": {
"put": {
"tags": [
"MEANINGSADMIN"
],
"operationId": "MeaningsAdmin_editExternalLinks",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ExternalLink"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/MeaningsAdmin/deleteExternalLinks": {
"delete": {
"tags": [
"MEANINGSADMIN"
],
"operationId": "MeaningsAdmin_deleteExternalLinks",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/MeaningsAdmin/updatePreviousLinks": {
"put": {
"tags": [
"MEANINGSADMIN"
],
"operationId": "MeaningsAdmin_updatePreviousLinks",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/MeaningsAdmin/createPrefixCategory": {
"post": {
"tags": [
"MEANINGSADMIN"
],
"operationId": "MeaningsAdmin_createPrefixCategory",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PrefixCategory"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/MeaningsAdmin/editPrefixCategory": {
"put": {
"tags": [
"MEANINGSADMIN"
],
"operationId": "MeaningsAdmin_editPrefixCategory",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PrefixCategory"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/MeaningsAdmin/deletePrefixCategory": {
"delete": {
"tags": [
"MEANINGSADMIN"
],
"operationId": "MeaningsAdmin_deletePrefixCategory",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "query",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Metadata/{id}": {
"get": {
"tags": [
"METADATA"
],
"summary": "Get metadata for a dataset as XML (default) or JSON (internal, complete or simplified structure)",
"description": "## format\r\nBased on the existing transformation options, the converted metadata can be obtained via format.\r\n \r\n## simplifiedJson\r\nif you set the accept of the request to return a json, you can manipulate the json with this parameter.
\r\n0 = returns the metadata with full internal structure
\r\n1 = returns a simplified form of the structure with all fields and attributes
\r\n2 = returns the metadata in a simplified structure and does not add all fields and attributes that are empty.",
"operationId": "MetadataOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Dataset Id",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "format",
"in": "query",
"description": "Internal,External,Subset",
"required": false,
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2
]
},
{
"name": "subsetType",
"in": "query",
"description": "Based on the existing concept mappings, the converted metadata can be obtained via subsetType.",
"required": false,
"type": "string"
},
{
"name": "simplifiedJson",
"in": "query",
"description": "accept 0,1,2",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
},
"put": {
"tags": [
"METADATA"
],
"summary": "Import metadata via json or xml to a specifiy entity",
"description": "In the Metadata PUT Api there are two different ways to import metadata.\r\n\r\n1. XML\r\nSend an xml in the xml content to update the metadata, each xpath is checked and if there is a possible mapping, the fields are updated.\r\n\r\n2. JSON\r\nIn relation to the dataset with a metadatastructure, the incoming metadata as json is validated against the associated JSON schema. Only if the json is valid, the metadata is updated.",
"operationId": "MetadataIn_Put",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "identifier for an specifiy entity e.g. dataset in the system",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Metadata": {
"get": {
"tags": [
"METADATA"
],
"summary": "Get list of exiting datasets from which metadata can be loaded.",
"description": "With the Get function you get an overview of the exiting datasets from which you can load metadata.\r\nThe format indicates the possible conversions. Without format the system internal metadata xml document is loaded.",
"operationId": "MetadataOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MetadataViewObject"
}
}
}
}
}
},
"/api/Metadata/{id}/{versionId}": {
"get": {
"tags": [
"METADATA"
],
"summary": "Get metadata for a dataset as XML (default) or JSON (internal, complete or simplified structure)",
"description": "## format\r\nBased on the existing transformation options, the converted metadata can be obtained via format.\r\n \r\n## simplifiedJson\r\nif you set the accept of the request to return a json, you can manipulate the json with this parameter.
\r\n0 = returns the metadata with full internal structure
\r\n1 = returns a simplified form of the structure with all fields and attributes
\r\n2 = returns the metadata in a simplified structure and does not add all fields and attributes that are empty.",
"operationId": "MetadataOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Dataset Id",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "versionId",
"in": "path",
"description": "Version Id",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "format",
"in": "query",
"description": "Internal,External,Subset",
"required": false,
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2
]
},
{
"name": "subsetType",
"in": "query",
"description": "Based on the existing concept mappings, the converted metadata can be obtained via subsetType.",
"required": false,
"type": "string"
},
{
"name": "simplifiedJson",
"in": "query",
"description": "accept 0,1,2",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Metadata/{id}/version_number/{version_number}": {
"get": {
"tags": [
"METADATA"
],
"summary": "Get metadata for a dataset as XML (default) or JSON (internal, complete or simplified structure)",
"description": "## format\r\nBased on the existing transformation options, the converted metadata can be obtained via format.\r\n \r\n## simplifiedJson\r\nif you set the accept of the request to return a json, you can manipulate the json with this parameter.
\r\n0 = returns the metadata with full internal structure
\r\n1 = returns a simplified form of the structure with all fields and attributes
\r\n2 = returns the metadata in a simplified structure and does not add all fields and attributes that are empty.",
"operationId": "MetadataOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Dataset Id",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "version_number",
"in": "path",
"description": "Version number",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "format",
"in": "query",
"description": "Internal,External,Subset",
"required": false,
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2
]
},
{
"name": "subsetType",
"in": "query",
"description": "Based on the existing concept mappings, the converted metadata can be obtained via subsetType.",
"required": false,
"type": "string"
},
{
"name": "simplifiedJson",
"in": "query",
"description": "accept 0,1,2",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Metadata/{id}/version_name/{version_name}": {
"get": {
"tags": [
"METADATA"
],
"summary": "Get metadata for a dataset as XML (default) or JSON (internal, complete or simplified structure)",
"description": "## format\r\nBased on the existing transformation options, the converted metadata can be obtained via format.\r\n \r\n## simplifiedJson\r\nif you set the accept of the request to return a json, you can manipulate the json with this parameter.
\r\n0 = returns the metadata with full internal structure
\r\n1 = returns a simplified form of the structure with all fields and attributes
\r\n2 = returns the metadata in a simplified structure and does not add all fields and attributes that are empty.",
"operationId": "MetadataOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Dataset Id",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "version_name",
"in": "path",
"description": "Version name",
"required": true,
"type": "string"
},
{
"name": "format",
"in": "query",
"description": "Internal,External,Subset",
"required": false,
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2
]
},
{
"name": "subsetType",
"in": "query",
"description": "Based on the existing concept mappings, the converted metadata can be obtained via subsetType.",
"required": false,
"type": "string"
},
{
"name": "simplifiedJson",
"in": "query",
"description": "accept 0,1,2",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Metadata/{id}/tag/{tag}": {
"get": {
"tags": [
"METADATA"
],
"summary": "Get metadata for a dataset as XML (default) or JSON (internal, complete or simplified structure)",
"description": "## format\r\nBased on the existing transformation options, the converted metadata can be obtained via format.\r\n \r\n## simplfiedJson\r\nif you set the accept of the request to return a json, you can manipulate the json with this parameter.
\r\n0 = returns the metadata with full internal structure
\r\n1 = returns a simplified form of the structure with all fields and attributes
\r\n2 = returns the metadata in a simplified structure and does not add all fields and attributes that are empty.",
"operationId": "MetadataOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Dataset Id",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "tag",
"in": "path",
"description": "Tag Nr",
"required": true,
"type": "number",
"format": "double"
},
{
"name": "format",
"in": "query",
"description": "Internal,External,Subset",
"required": false,
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2
]
},
{
"name": "subsetType",
"in": "query",
"description": "Based on the existing concept mappings, the converted metadata can be obtained via subsetType.",
"required": false,
"type": "string"
},
{
"name": "simplifiedJson",
"in": "query",
"description": "accept 0,1,2",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/MetadataBySchema/{name}": {
"get": {
"tags": [
"METADATABYSCHEMA"
],
"summary": "Get all metadata of all datasets based on the given metadata schema name as XML",
"operationId": "MetadataOut_GetBySchema",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/MetadataStatistic": {
"post": {
"tags": [
"METADATASTATISTIC"
],
"summary": "Get a list of unique metadata values, count and list of occurrence for a given XPath.",
"description": "Data is directly returned from the database. A valid token is needed to access also non-public dataset.",
"operationId": "MetadataStatisticOut_Post",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PostApiMetadataStatisticModel"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/MetadataStructure": {
"get": {
"tags": [
"METADATASTRUCTURE"
],
"summary": "this function return an overview about existing metadata structures",
"operationId": "MetadataStructureOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MetadataStructureViewObject"
}
}
}
}
},
"/api/MetadataStructure/{id}": {
"get": {
"tags": [
"METADATASTRUCTURE"
],
"summary": "this api get a metadata structure based on the incoming api.\r\nit converts the structure into a json schema",
"description": "the API returns the selected metadata structure in json schema.\r\neach object contains a @ref attribute of type string, simple types contain a #text where the value is entered.\r\neven a simple value therefore consists of @ref and #text.\r\n@ref will beused fpor internal or external references, #text is used to store input values",
"operationId": "MetadataStructureOut_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/parties/{partyId}": {
"get": {
"tags": [
"PARTIES"
],
"operationId": "Parties_GetByIdAsync",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "partyId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/partyCustomAttributes/{partyTypeId}": {
"get": {
"tags": [
"PARTYCUSTOMATTRIBUTES"
],
"operationId": "PartyCustomAttributes_GetByPartyTypeIdAsync",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "partyTypeId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/partyRelationships": {
"get": {
"tags": [
"PARTYRELATIONSHIPS"
],
"operationId": "PartyRelationships_GetAsync",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/partyRelationships/{partyRelationshipId}": {
"get": {
"tags": [
"PARTYRELATIONSHIPS"
],
"operationId": "PartyRelationships_GetByPartyRelationshipIdAsync",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "partyRelationshipId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/partyRelationshipTypes": {
"get": {
"tags": [
"PARTYRELATIONSHIPTYPES"
],
"operationId": "PartyRelationshipTypes_GetAsync",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/partyRelationshipTypes/{partyRelationshipTypeId}": {
"get": {
"tags": [
"PARTYRELATIONSHIPTYPES"
],
"operationId": "PartyRelationshipTypes_GetByPartyRelationshipTypeIdAsync",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "partyRelationshipTypeId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/partyTypes": {
"get": {
"tags": [
"PARTYTYPES"
],
"operationId": "PartyTypes_GetAsync",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/partyTypes/{partyTypeId}": {
"get": {
"tags": [
"PARTYTYPES"
],
"operationId": "PartyTypes_GetByPartyTypeIdAsync",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "partyTypeId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/personNameComponents": {
"post": {
"tags": [
"PERSONNAMECOMPONENTS"
],
"summary": "Get the separate parts of a person's name.",
"operationId": "PersonNameComponents_Post",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "name",
"in": "body",
"description": "complete name of the person",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/publications": {
"get": {
"tags": [
"PUBLICATIONS"
],
"operationId": "Publications_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
},
"post": {
"tags": [
"PUBLICATIONS"
],
"operationId": "Publications_Post",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreatePublicationModel"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/publications/{publicationId}": {
"get": {
"tags": [
"PUBLICATIONS"
],
"operationId": "Publications_GetById",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "publicationId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
},
"put": {
"tags": [
"PUBLICATIONS"
],
"operationId": "Publications_PutById",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "publicationId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UpdatePublicationModel"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/publications/{id}/{operation}": {
"put": {
"tags": [
"PUBLICATIONS"
],
"operationId": "Publications_OperateById",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "publicationId",
"in": "query",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "operation",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/SearchApi/getData": {
"get": {
"tags": [
"SEARCHAPI"
],
"operationId": "SearchApi_getData",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/Structures": {
"get": {
"tags": [
"STRUCTURES"
],
"summary": "Return a list of id´s from all structures",
"operationId": "Structures_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"format": "int64",
"type": "integer"
}
}
}
}
}
},
"/api/Structures/{id}": {
"get": {
"tags": [
"STRUCTURES"
],
"summary": "Return a structure based on the id.",
"operationId": "Structures_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "identifier of the structure",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DataStructureDataTable"
}
}
}
}
},
"/api/taginfo": {
"put": {
"tags": [
"TAGINFO"
],
"operationId": "TagInfoEdit_Put",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/TagInfoEditModel"
}
},
{
"name": "type",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3
]
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
},
"post": {
"tags": [
"TAGINFO"
],
"operationId": "TagInfoEdit_Post",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/TagInfoEditModel"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/tokens": {
"get": {
"tags": [
"TOKENS"
],
"summary": "Get the token based on basic authentication",
"operationId": "Tokens_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/tokens/verify": {
"post": {
"tags": [
"TOKENS"
],
"summary": "",
"operationId": "Tokens_Verify",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "token",
"in": "query",
"description": "",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/users/{userId}": {
"get": {
"tags": [
"USERS"
],
"operationId": "Users_GetByIdAsync",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
},
"put": {
"tags": [
"USERS"
],
"operationId": "Users_PutByIdAsync",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateUserModel"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
},
"delete": {
"tags": [
"USERS"
],
"operationId": "Users_DeleteByIdAsync",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/users/{userId}/groups": {
"get": {
"tags": [
"USERS"
],
"operationId": "Users_GetGroupsByUserIdAsync",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
},
"put": {
"tags": [
"USERS"
],
"operationId": "Users_PutGroupsByUserIdAsync",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "groupNames",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
},
"delete": {
"tags": [
"USERS"
],
"operationId": "Users_DeleteByIdAsync",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "groupNames",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/users": {
"get": {
"tags": [
"USERS"
],
"operationId": "Users_GetAsync",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
},
"post": {
"tags": [
"USERS"
],
"operationId": "Users_PostAsync",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateUserModel"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/versions/database": {
"get": {
"tags": [
"VERSIONS"
],
"summary": "",
"operationId": "Versions_GetVersionFromDatabase",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/versions/site": {
"get": {
"tags": [
"VERSIONS"
],
"summary": "",
"operationId": "Versions_GetVersionFromSite",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/versions/workspace": {
"get": {
"tags": [
"VERSIONS"
],
"summary": "",
"operationId": "Versions_GetVersionFromWorkspace",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
},
"/api/versions": {
"get": {
"tags": [
"VERSIONS"
],
"summary": "",
"operationId": "Versions_GetVersions",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
}
}
}
},
"definitions": {
"ApiDatasetAttachmentsModel": {
"type": "object",
"properties": {
"DatasetId": {
"format": "int64",
"type": "integer"
},
"Attachments": {
"type": "array",
"items": {
"$ref": "#/definitions/ApiSimpleAttachmentModel"
}
}
}
},
"ApiSimpleAttachmentModel": {
"type": "object",
"properties": {
"Id": {
"format": "int64",
"type": "integer"
},
"Name": {
"type": "string"
},
"MimeType": {
"type": "string"
}
}
},
"HttpContent": {
"type": "object",
"properties": {
"Headers": {
"type": "array",
"items": {
"$ref": "#/definitions/KeyValuePair[String,IEnumerable[String]]"
},
"readOnly": true
}
}
},
"KeyValuePair[String,IEnumerable[String]]": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"DatasetManager": {
"type": "object",
"properties": {
"PreferedBatchSize": {
"format": "int32",
"type": "integer"
},
"DatasetRepo": {
"$ref": "#/definitions/IReadOnlyRepository[Dataset]",
"readOnly": true
},
"DatasetVersionRepo": {
"$ref": "#/definitions/IReadOnlyRepository[DatasetVersion]",
"readOnly": true
},
"DataTupleRepo": {
"$ref": "#/definitions/IReadOnlyRepository[DataTuple]",
"readOnly": true
},
"DataTupleVersionRepo": {
"$ref": "#/definitions/IReadOnlyRepository[DataTupleVersion]",
"readOnly": true
}
}
},
"IReadOnlyRepository[Dataset]": {
"type": "object",
"properties": {
"UnitOfWork": {
"$ref": "#/definitions/IUnitOfWork",
"readOnly": true
}
}
},
"IReadOnlyRepository[DatasetVersion]": {
"type": "object",
"properties": {
"UnitOfWork": {
"$ref": "#/definitions/IUnitOfWork",
"readOnly": true
}
}
},
"IReadOnlyRepository[DataTuple]": {
"type": "object",
"properties": {
"UnitOfWork": {
"$ref": "#/definitions/IUnitOfWork",
"readOnly": true
}
}
},
"IReadOnlyRepository[DataTupleVersion]": {
"type": "object",
"properties": {
"UnitOfWork": {
"$ref": "#/definitions/IUnitOfWork",
"readOnly": true
}
}
},
"IUnitOfWork": {
"type": "object",
"properties": {
"PersistenceManager": {
"$ref": "#/definitions/IPersistenceManager",
"readOnly": true
}
}
},
"IPersistenceManager": {
"type": "object",
"properties": {
"Factory": {
"type": "object",
"readOnly": true
},
"UnitOfWorkFactory": {
"$ref": "#/definitions/IUnitOfWorkFactory",
"readOnly": true
},
"PreferredPushSize": {
"format": "int32",
"type": "integer",
"readOnly": true
}
}
},
"IUnitOfWorkFactory": {
"type": "object",
"properties": {}
},
"Concept": {
"type": "object",
"properties": {
"Id": {
"format": "int64",
"type": "integer"
},
"Name": {
"type": "string"
}
}
},
"CurationEntryModel": {
"type": "object",
"properties": {
"Id": {
"format": "int64",
"type": "integer"
},
"Topic": {
"type": "string"
},
"Type": {
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
],
"type": "integer"
},
"DatasetId": {
"format": "int64",
"type": "integer"
},
"Name": {
"type": "string"
},
"Description": {
"type": "string"
},
"Solution": {
"type": "string"
},
"Position": {
"format": "int32",
"type": "integer"
},
"Source": {
"type": "string"
},
"Notes": {
"type": "array",
"items": {
"$ref": "#/definitions/CurationNoteModel"
}
},
"CreationDate": {
"format": "date-time",
"type": "string"
},
"CreatorId": {
"format": "int64",
"type": "integer"
},
"UserIsDone": {
"type": "boolean"
},
"IsApproved": {
"type": "boolean"
},
"LastChangeDatetime_User": {
"format": "date-time",
"type": "string"
},
"LastChangeDatetime_Curator": {
"format": "date-time",
"type": "string"
}
}
},
"CurationNoteModel": {
"type": "object",
"properties": {
"Id": {
"format": "int64",
"type": "integer"
},
"UserType": {
"format": "int32",
"enum": [
0,
1
],
"type": "integer"
},
"CreationDate": {
"format": "date-time",
"type": "string"
},
"Comment": {
"type": "string"
},
"UserId": {
"format": "int64",
"type": "integer"
}
}
},
"DataApiModel": {
"type": "object",
"properties": {
"DatasetId": {
"format": "int64",
"type": "integer"
},
"Columns": {
"type": "array",
"items": {
"type": "string"
}
},
"Data": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"PostApiDatasetModel": {
"type": "object",
"properties": {
"Title": {
"type": "string"
},
"Description": {
"type": "string"
},
"DataStructureId": {
"format": "int64",
"type": "integer"
},
"MetadataStructureId": {
"format": "int64",
"type": "integer"
},
"EntityTemplateId": {
"format": "int64",
"type": "integer"
}
}
},
"ApiSimpleDatasetModel": {
"type": "object",
"properties": {
"Id": {
"format": "int64",
"type": "integer"
},
"Title": {
"type": "string"
},
"Versions": {
"type": "array",
"items": {
"$ref": "#/definitions/ApiSimpleDatasetVersionModel"
}
}
}
},
"ApiSimpleDatasetVersionModel": {
"type": "object",
"properties": {
"Id": {
"format": "int64",
"type": "integer"
},
"Number": {
"format": "int64",
"type": "integer"
},
"Tag": {
"format": "double",
"type": "number"
}
}
},
"ApiDatasetModel": {
"description": "Return model of Dataset API",
"type": "object",
"properties": {
"Id": {
"format": "int64",
"type": "integer"
},
"Version": {
"format": "int64",
"type": "integer"
},
"VersionId": {
"format": "int64",
"type": "integer"
},
"Title": {
"type": "string"
},
"Description": {
"type": "string"
},
"DataStructureId": {
"format": "int64",
"type": "integer"
},
"MetadataStructureId": {
"format": "int64",
"type": "integer"
},
"IsPublic": {
"type": "boolean"
},
"PublicationDate": {
"type": "string"
},
"AdditionalInformations": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"Parties": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"VersionDate": {
"type": "string"
},
"Names": {
"type": "object",
"readOnly": true
},
"Links": {
"$ref": "#/definitions/LinksOverview"
}
}
},
"LinksOverview": {
"type": "object",
"properties": {
"From": {
"type": "array",
"items": {
"$ref": "#/definitions/ReferenceModel"
}
},
"To": {
"type": "array",
"items": {
"$ref": "#/definitions/ReferenceModel"
}
}
}
},
"ReferenceModel": {
"type": "object",
"properties": {
"RefId": {
"format": "int64",
"type": "integer"
},
"Target": {
"$ref": "#/definitions/ReferenceElementModel"
},
"Source": {
"$ref": "#/definitions/ReferenceElementModel"
},
"Context": {
"type": "string"
},
"ReferenceType": {
"type": "string"
}
}
},
"ReferenceElementModel": {
"type": "object",
"properties": {
"Id": {
"format": "int64",
"type": "integer"
},
"Version": {
"format": "int32",
"type": "integer"
},
"TypeId": {
"format": "int64",
"type": "integer"
},
"Type": {
"type": "string"
},
"Title": {
"type": "string"
},
"LatestVersion": {
"type": "boolean"
}
}
},
"CitationDatasetIds": {
"type": "object",
"properties": {
"DatasetIds": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"CitationModel": {
"type": "object",
"properties": {
"CitationString": {
"type": "string"
}
}
},
"ApiDataStatisticModel": {
"description": "Return model of Data Statistic API",
"type": "object",
"properties": {
"VariableId": {
"format": "int64",
"type": "integer"
},
"VariableName": {
"type": "string"
},
"VariableDescription": {
"type": "string"
},
"DataTypeName": {
"type": "string"
},
"DataTypeSystemType": {
"type": "string"
},
"DataTypeDisplayPattern": {
"type": "string"
},
"Unit": {
"type": "string"
},
"uniqueValues": {
"type": "object"
},
"count": {
"type": "string"
},
"max": {
"type": "string"
},
"min": {
"type": "string"
},
"maxLength": {
"type": "string"
},
"minLength": {
"type": "string"
},
"missingValues": {
"type": "object"
}
}
},
"DataTableSendModel": {
"type": "object",
"properties": {
"Id": {
"format": "int64",
"type": "integer"
},
"Version": {
"format": "int64",
"type": "integer"
},
"Offset": {
"format": "int32",
"type": "integer"
},
"Limit": {
"format": "int32",
"type": "integer"
},
"Q": {
"type": "string"
},
"Filter": {
"type": "array",
"items": {
"$ref": "#/definitions/DataTableFilter"
}
},
"Order": {
"type": "array",
"items": {
"$ref": "#/definitions/DataTableOrderBy"
}
}
}
},
"DataTableFilter": {
"type": "object",
"properties": {
"Column": {
"type": "string"
},
"FilterBy": {
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15
],
"type": "integer"
},
"Value": {
"type": "string"
}
}
},
"DataTableOrderBy": {
"type": "object",
"properties": {
"Column": {
"type": "string"
},
"Direction": {
"format": "int32",
"enum": [
0,
1
],
"type": "integer"
}
}
},
"DataTableRecieveModel": {
"type": "object",
"properties": {
"Count": {
"format": "int64",
"type": "integer"
},
"Data": {
"type": "object"
},
"Columns": {
"type": "array",
"items": {
"$ref": "#/definitions/DataTableColumn"
}
},
"Send": {
"$ref": "#/definitions/DataTableSendModel"
}
}
},
"DataTableColumn": {
"type": "object",
"properties": {
"Column": {
"type": "string"
},
"Key": {
"type": "string"
},
"Exclude": {
"type": "boolean"
},
"Instructions": {
"$ref": "#/definitions/DataTableInstruction"
}
}
},
"DataTableInstruction": {
"type": "object",
"properties": {
"MissingValues": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"DisplayPattern": {
"type": "string"
}
}
},
"UpdateGroupModel": {
"required": [
"Name"
],
"type": "object",
"properties": {
"Description": {
"type": "string"
},
"GroupType": {
"format": "int32",
"type": "integer"
},
"Id": {
"format": "int64",
"type": "integer"
},
"Name": {
"type": "string"
}
}
},
"CreateGroupModel": {
"required": [
"Name"
],
"type": "object",
"properties": {
"Description": {
"type": "string"
},
"Name": {
"type": "string"
},
"Type": {
"format": "int32",
"type": "integer"
}
}
},
"LEType": {
"type": "object",
"properties": {
"Id": {
"format": "int64",
"type": "integer"
},
"Name": {
"type": "string"
}
}
},
"Mapping": {
"type": "object",
"properties": {
"Level": {
"format": "int64",
"type": "integer"
},
"Source": {
"$ref": "#/definitions/LinkElement"
},
"Target": {
"$ref": "#/definitions/LinkElement"
},
"TransformationRule": {
"$ref": "#/definitions/TransformationRule"
},
"Parent": {
"$ref": "#/definitions/Mapping"
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"LinkElement": {
"type": "object",
"properties": {
"ElementId": {
"format": "int64",
"type": "integer"
},
"Name": {
"type": "string"
},
"XPath": {
"type": "string"
},
"IsSequence": {
"type": "boolean"
},
"Type": {
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18
],
"type": "integer"
},
"Complexity": {
"format": "int32",
"enum": [
0,
1,
2
],
"type": "integer"
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"TransformationRule": {
"type": "object",
"properties": {
"RegEx": {
"type": "string"
},
"Mask": {
"type": "string"
},
"DefaultValue": {
"type": "string"
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"Meaning": {
"required": [
"Name",
"ShortName",
"Description",
"Selectable",
"Approved"
],
"type": "object",
"properties": {
"ExternalLinks": {
"type": "array",
"items": {
"$ref": "#/definitions/MeaningEntry"
}
},
"Related_meaning": {
"type": "array",
"items": {
"$ref": "#/definitions/Meaning"
}
},
"Constraints": {
"type": "array",
"items": {
"$ref": "#/definitions/Constraint"
}
},
"Name": {
"type": "string"
},
"ShortName": {
"type": "string"
},
"Description": {
"type": "string"
},
"Selectable": {
"type": "boolean"
},
"Approved": {
"type": "boolean"
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"MeaningEntry": {
"type": "object",
"properties": {
"MappingRelation": {
"$ref": "#/definitions/ExternalLink"
},
"MappedLinks": {
"type": "array",
"items": {
"$ref": "#/definitions/ExternalLink"
}
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"Constraint": {
"type": "object",
"properties": {
"Provider": {
"format": "int32",
"enum": [
0,
1
],
"type": "integer"
},
"ConstraintSelectionPredicate": {
"type": "string"
},
"CultureId": {
"type": "string"
},
"Name": {
"type": "string"
},
"Description": {
"type": "string"
},
"Negated": {
"type": "boolean"
},
"Context": {
"type": "string"
},
"MessageTemplate": {
"type": "string"
},
"NegatedMessageTemplate": {
"type": "string"
},
"CreationDate": {
"format": "date-time",
"type": "string"
},
"LastModified": {
"format": "date-time",
"type": "string"
},
"LastModifiedUserRef": {
"format": "int64",
"type": "integer"
},
"DataContainer": {
"$ref": "#/definitions/DataContainer"
},
"VariableConstraints": {
"type": "array",
"items": {
"$ref": "#/definitions/Variable"
}
},
"ErrorMessage": {
"type": "string",
"readOnly": true
},
"FormalDescription": {
"type": "string",
"readOnly": true
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"ExternalLink": {
"required": [
"URI",
"Name",
"Type"
],
"type": "object",
"properties": {
"URI": {
"type": "string"
},
"Name": {
"type": "string"
},
"Type": {
"format": "int32",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"Prefix": {
"$ref": "#/definitions/ExternalLink"
},
"prefixCategory": {
"$ref": "#/definitions/PrefixCategory"
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"DataContainer": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"ShortName": {
"type": "string"
},
"Description": {
"type": "string"
},
"IsMultiValue": {
"type": "boolean"
},
"IsBuiltIn": {
"type": "boolean"
},
"Scope": {
"type": "string"
},
"ContainerType": {
"format": "int32",
"enum": [
0,
1
],
"type": "integer"
},
"MeasurementScale": {
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5
],
"type": "integer"
},
"EntitySelectionPredicate": {
"type": "string"
},
"Self": {
"$ref": "#/definitions/DataContainer",
"readOnly": true
},
"DataType": {
"$ref": "#/definitions/DataType"
},
"Unit": {
"$ref": "#/definitions/Unit"
},
"Methodology": {
"$ref": "#/definitions/Methodology"
},
"Constraints": {
"type": "array",
"items": {
"$ref": "#/definitions/Constraint"
}
},
"ExtendedProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/ExtendedProperty"
}
},
"GlobalizationInfos": {
"type": "array",
"items": {
"$ref": "#/definitions/GlobalizationInfo"
}
},
"AggregateFunctions": {
"type": "array",
"items": {
"$ref": "#/definitions/AggregateFunction"
}
},
"StateInfo": {
"$ref": "#/definitions/EntityStateInfo"
},
"CreationInfo": {
"$ref": "#/definitions/EntityAuditInfo"
},
"ModificationInfo": {
"$ref": "#/definitions/EntityAuditInfo"
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"Variable": {
"type": "object",
"properties": {
"DataType": {
"$ref": "#/definitions/DataType"
},
"Unit": {
"$ref": "#/definitions/Unit"
},
"VariableConstraints": {
"type": "array",
"items": {
"$ref": "#/definitions/Constraint"
}
},
"MissingValues": {
"type": "array",
"items": {
"$ref": "#/definitions/MissingValue"
}
},
"Meanings": {
"type": "array",
"items": {
"$ref": "#/definitions/Meaning"
}
},
"DisplayPatternId": {
"format": "int32",
"type": "integer"
},
"MinCardinality": {
"format": "int32",
"type": "integer"
},
"MaxCardinality": {
"format": "int32",
"type": "integer"
},
"Label": {
"type": "string"
},
"Description": {
"type": "string"
},
"DefaultValue": {
"type": "string"
},
"FixedValue": {
"type": "string"
},
"MissingValue": {
"type": "string"
},
"IsValueOptional": {
"type": "boolean"
},
"OrderNo": {
"format": "int32",
"type": "integer"
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"PrefixCategory": {
"required": [
"Name",
"Description"
],
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Description": {
"type": "string"
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"DataType": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Description": {
"type": "string"
},
"SystemType": {
"type": "string"
},
"DataContainers": {
"type": "array",
"items": {
"$ref": "#/definitions/DataContainer"
}
},
"ApplicableUnits": {
"type": "array",
"items": {
"$ref": "#/definitions/Unit"
}
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"Unit": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Abbreviation": {
"type": "string"
},
"Description": {
"type": "string"
},
"MeasurementSystem": {
"format": "int32",
"enum": [
0,
1,
2,
3,
4
],
"type": "integer"
},
"Dimension": {
"$ref": "#/definitions/Dimension"
},
"DataContainers": {
"type": "array",
"items": {
"$ref": "#/definitions/DataContainer"
}
},
"ConversionsIamTheSource": {
"type": "array",
"items": {
"$ref": "#/definitions/ConversionMethod"
}
},
"ConversionsIamTheTarget": {
"type": "array",
"items": {
"$ref": "#/definitions/ConversionMethod"
}
},
"AssociatedDataTypes": {
"type": "array",
"items": {
"$ref": "#/definitions/DataType"
}
},
"ExternalLink": {
"$ref": "#/definitions/ExternalLink"
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"Methodology": {
"type": "object",
"properties": {
"AppliedStandards": {
"type": "string"
},
"Procedure": {
"type": "string"
},
"Tolerance": {
"type": "string"
},
"Tools": {
"type": "string"
},
"DataContainers": {
"type": "array",
"items": {
"$ref": "#/definitions/DataContainer"
}
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"ExtendedProperty": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Description": {
"type": "string"
},
"DataContainer": {
"$ref": "#/definitions/DataContainer"
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"GlobalizationInfo": {
"type": "object",
"properties": {
"CultureId": {
"type": "string"
},
"DisplayName": {
"type": "string"
},
"Description": {
"type": "string"
},
"DataContainer": {
"$ref": "#/definitions/DataContainer"
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"AggregateFunction": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Description": {
"type": "string"
},
"DataContainers": {
"type": "array",
"items": {
"$ref": "#/definitions/DataContainer"
}
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"EntityStateInfo": {
"type": "object",
"properties": {
"State": {
"type": "string"
},
"Timestamp": {
"format": "date-time",
"type": "string"
},
"Comment": {
"type": "string"
}
}
},
"EntityAuditInfo": {
"type": "object",
"properties": {
"ActionType": {
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"Performer": {
"type": "string"
},
"Comment": {
"type": "string"
},
"Timestamp": {
"format": "date-time",
"type": "string"
}
}
},
"MissingValue": {
"type": "object",
"properties": {
"DisplayName": {
"type": "string"
},
"Placeholder": {
"type": "string"
},
"Description": {
"type": "string"
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"Dimension": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Specification": {
"type": "string"
},
"Description": {
"type": "string"
},
"Units": {
"type": "array",
"items": {
"$ref": "#/definitions/Unit"
}
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"ConversionMethod": {
"type": "object",
"properties": {
"Description": {
"type": "string"
},
"Formula": {
"type": "string"
},
"Source": {
"$ref": "#/definitions/Unit"
},
"Target": {
"$ref": "#/definitions/Unit"
},
"Id": {
"format": "int64",
"type": "integer"
},
"VersionNo": {
"format": "int32",
"type": "integer"
},
"Extra": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"MetadataViewObject": {
"type": "object",
"properties": {
"DatasetId": {
"format": "int64",
"type": "integer"
},
"SubsetType": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PostApiMetadataStatisticModel": {
"description": "Return model of Metadata Statistic API",
"type": "object",
"properties": {
"Xpath": {
"description": "Xpath e.g. Metadata/methods/methodsType/measurements/measurementsType/sampleAnalysis/",
"type": "string"
},
"DatasetVersionIdsInclude": {
"description": "List of Dataset version IDs to include instead of dataset id (latests versions)",
"type": "array",
"items": {
"type": "string"
}
},
"DatasetIdsInclude": {
"description": "List of Dataset IDs to include",
"type": "array",
"items": {
"type": "string"
}
},
"DatasetIdsExclude": {
"description": "List of Dataset IDs to exclude",
"type": "array",
"items": {
"type": "string"
}
},
"MetadatastructureIdsInclude": {
"description": "List of Metdata structure IDs to include",
"type": "array",
"items": {
"type": "string"
}
},
"MetadatastructureIdsExclude": {
"description": "List of Metdata structure IDs to exclude",
"type": "array",
"items": {
"type": "string"
}
},
"RegexInclude": {
"description": "Regex to define text to include",
"type": "string"
},
"RegexExclude": {
"description": "Regex to define text to exclude",
"type": "string"
}
}
},
"MetadataStructureViewObject": {
"type": "object",
"properties": {
"Id": {
"format": "int64",
"type": "integer"
},
"Name": {
"type": "string"
},
"EntityType": {
"type": "string"
}
}
},
"CreatePublicationModel": {
"type": "object",
"properties": {
"BrokerId": {
"format": "int64",
"type": "integer"
},
"Status": {
"type": "string"
}
}
},
"UpdatePublicationModel": {
"type": "object",
"properties": {
"Id": {
"format": "int64",
"type": "integer"
}
}
},
"DataStructureDataTable": {
"type": "object",
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"title": {
"type": "string"
},
"desciption": {
"type": "string"
},
"inUse": {
"type": "boolean"
},
"variables": {
"type": "object"
}
}
},
"TagInfoEditModel": {
"type": "object",
"properties": {
"versionId": {
"format": "int64",
"type": "integer"
},
"versionNr": {
"format": "int64",
"type": "integer"
},
"releaseNote": {
"type": "string"
},
"show": {
"type": "boolean"
},
"tagId": {
"format": "int64",
"type": "integer"
},
"tagNr": {
"format": "double",
"type": "number"
},
"publish": {
"type": "boolean"
},
"releaseDate": {
"format": "date-time",
"type": "string"
},
"systemDescription": {
"type": "string"
},
"systemAuthor": {
"type": "string"
},
"systemDate": {
"format": "date-time",
"type": "string"
},
"link": {
"type": "string"
}
}
},
"UpdateUserModel": {
"required": [
"Email"
],
"type": "object",
"properties": {
"Email": {
"type": "string"
},
"Id": {
"format": "int64",
"type": "integer"
},
"UserName": {
"type": "string"
}
}
},
"CreateUserModel": {
"required": [
"Email",
"UserName"
],
"type": "object",
"properties": {
"Email": {
"type": "string"
},
"UserName": {
"type": "string"
}
}
}
},
"securityDefinitions": {
"Authorization": {
"type": "apiKey",
"description": "Filling bearer token here",
"name": "Bearer",
"in": "header"
},
"basic": {
"type": "basic",
"description": "Basic HTTP Authentication"
}
}
}