From 762f4903ad85c8b781d1ced367b9746feae148bf Mon Sep 17 00:00:00 2001 From: Stuart Pullinger Date: Fri, 22 Nov 2019 11:52:29 +0000 Subject: [PATCH 1/4] Update swagger generator to reference named schemas instead of inlining them. Fixes #116 --- src/swagger/swagger_generator.py | 40 ++++++++++++++++++++++++-------- 1 file changed, 30 insertions(+), 10 deletions(-) diff --git a/src/swagger/swagger_generator.py b/src/swagger/swagger_generator.py index 8fe0d1e4..46a100e0 100644 --- a/src/swagger/swagger_generator.py +++ b/src/swagger/swagger_generator.py @@ -64,6 +64,10 @@ def __init__(self, entity_name, model): self.properties_dict = {} for column in model.__table__.columns: self.properties_dict[column.name] = {"type": self._map_db_type_to_json_type(str(column.type))} + self.entity_schema = {f"{SwaggerGenerator.singularise(entity_name)}": { + "type": "object", + "properties": self.properties_dict}} + self.entity_no_id_endpoint = { f"/{entity_name.lower()}": { "get": { @@ -81,8 +85,7 @@ def __init__(self, entity_name, model): "content": { "application/json": { "schema": { - "type": "object", - "properties": self.properties_dict + "$ref": f"#/components/schemas/{SwaggerGenerator.singularise(entity_name)}" } } } @@ -119,8 +122,7 @@ def __init__(self, entity_name, model): "content": { "application/json": { "schema": { - "type": "object", - "properties": self.properties_dict + "$ref": f"#/components/schemas/{SwaggerGenerator.singularise(entity_name)}" } } } @@ -142,7 +144,7 @@ def __init__(self, entity_name, model): "content": { "application/json": { "schema": { - "type": "object" + "$ref": f"#/components/schemas/{SwaggerGenerator.singularise(entity_name)}" } } } @@ -154,8 +156,7 @@ def __init__(self, entity_name, model): "content": { "application/json": { "schema": { - "type": "object", - "properties": self.properties_dict + "$ref": f"#/components/schemas/{SwaggerGenerator.singularise(entity_name)}" } } } @@ -208,8 +209,7 @@ def __init__(self, entity_name, model): "content": { "application/json": { "schema": { - "type": "object", - "properties": self.properties_dict + "$ref": f"#/components/schemas/{SwaggerGenerator.singularise(entity_name)}" } } } @@ -251,6 +251,7 @@ def __init__(self, entity_name, model): class SwaggerSpecification(object): def __init__(self): self.paths = [] + self.schemas = [] self.top_part = { 'openapi': "3.0.0", "info": { @@ -263,16 +264,24 @@ def __init__(self): "url": "http://localhost:5000" } ], - "paths": {} + "paths": {}, + "components": { + "schemas":{} + } } def add_path(self, path): self.paths.append(path) + def add_schema(self, schema): + self.schemas.append(schema) + def get_spec_as_dict(self): spec = {} for path in self.paths: self.top_part["paths"].update(path) + for schema in self.schemas: + self.top_part["components"]["schemas"].update(schema) spec.update(self.top_part) return spec @@ -292,6 +301,16 @@ def pascal_to_normal(input): words = re.findall(r"[A-Z]?[a-z]+|[A-Z]{2,}(?=[A-Z][a-z]|\d|\W|$)|\d+", input) return " ".join(map(str.lower, words)) + @staticmethod + def singularise(plural_word:str): + if plural_word.lower().endswith('ies'): + singular_word = plural_word[:-3] + ('Y' if plural_word.isupper() else 'y') + elif plural_word.lower().endswith('s'): + singular_word = plural_word[:-1] + else: + raise ValueError(f"Don't know how to singularise {plural_word}") + return singular_word + def write_swagger_spec(self): """ Writes the openapi.yaml file @@ -304,6 +323,7 @@ def write_swagger_spec(self): swagger_spec.add_path(entity.entity_count_endpoint) swagger_spec.add_path(entity.entity_id_endpoint) swagger_spec.add_path(entity.entity_no_id_endpoint) + swagger_spec.add_schema(entity.entity_schema) swagger_dict = swagger_spec.get_spec_as_dict() yaml.Dumper.ignore_aliases = lambda *args: True with open(SwaggerGenerator.FILE_PATH, "w+") as target: From 97cbb72abbf28a0f01287f1c17b36e8a833d2daf Mon Sep 17 00:00:00 2001 From: Stuart Pullinger Date: Fri, 22 Nov 2019 11:53:30 +0000 Subject: [PATCH 2/4] Updating openapi.yaml to version with named schemas --- src/swagger/openapi.yaml | 4271 +++++++++----------------------------- 1 file changed, 1026 insertions(+), 3245 deletions(-) diff --git a/src/swagger/openapi.yaml b/src/swagger/openapi.yaml index 46599851..5ddac4cd 100644 --- a/src/swagger/openapi.yaml +++ b/src/swagger/openapi.yaml @@ -1,3 +1,844 @@ +components: + schemas: + Application: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + FACILITY_ID: + type: integer + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + VERSION: + type: string + type: object + DataCollection: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + DOI: + type: string + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + type: object + DataCollectionDatafile: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + DATACOLLECTION_ID: + type: integer + DATAFILE_ID: + type: integer + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + type: object + DataCollectionDataset: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + DATACOLLECTION_ID: + type: integer + DATASET_ID: + type: integer + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + type: object + DataCollectionParameter: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + DATACOLLECTION_ID: + type: integer + DATETIME_VALUE: + type: string + ERROR: + type: number + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + NUMERIC_VALUE: + type: number + PARAMETER_TYPE_ID: + type: integer + RANGEBOTTOM: + type: number + RANGETOP: + type: number + STRING_VALUE: + type: string + type: object + Datafile: + properties: + CHECKSUM: + type: string + CREATE_ID: + type: string + CREATE_TIME: + type: string + DATAFILECREATETIME: + type: string + DATAFILEFORMAT_ID: + type: integer + DATAFILEMODTIME: + type: string + DATASET_ID: + type: integer + DESCRIPTION: + type: string + DOI: + type: string + FILESIZE: + type: integer + ID: + type: integer + LOCATION: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + type: object + DatafileFormat: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + DESCRIPTION: + type: string + FACILITY_ID: + type: integer + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + TYPE: + type: string + VERSION: + type: string + type: object + DatafileParameter: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + DATAFILE_ID: + type: integer + DATETIME_VALUE: + type: string + ERROR: + type: number + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + NUMERIC_VALUE: + type: number + PARAMETER_TYPE_ID: + type: integer + RANGEBOTTOM: + type: number + RANGETOP: + type: number + STRING_VALUE: + type: string + type: object + Dataset: + properties: + COMPLETE: + type: boolean + CREATE_ID: + type: string + CREATE_TIME: + type: string + DESCRIPTION: + type: string + DOI: + type: string + END_DATE: + type: string + ID: + type: integer + INVESTIGATION_ID: + type: integer + LOCATION: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + SAMPLE_ID: + type: integer + STARTDATE: + type: string + TYPE_ID: + type: integer + type: object + DatasetType: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + DESCRIPTION: + type: string + FACILITY_ID: + type: integer + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + type: object + Facility: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + DAYSUNTILRELEASE: + type: integer + DESCRIPTION: + type: string + FULLNAME: + type: string + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + URL: + type: string + type: object + FacilityCycle: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + DESCRIPTION: + type: string + ENDDATE: + type: string + FACILITY_ID: + type: integer + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + STARTDATE: + type: string + type: object + Grouping: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + type: object + Instrument: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + DESCRIPTION: + type: string + FACILITY_ID: + type: integer + FULLNAME: + type: string + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + TYPE: + type: string + URL: + type: string + type: object + InstrumentScientist: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + ID: + type: integer + INSTRUMENT_ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + USER_ID: + type: integer + type: object + Investigation: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + DOI: + type: string + ENDDATE: + type: string + FACILITY_ID: + type: integer + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + RELEASEDATE: + type: string + STARTDATE: + type: string + SUMMARY: + type: string + TITLE: + type: string + TYPE_ID: + type: integer + VISIT_ID: + type: string + type: object + InvestigationGroup: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + GROUP_ID: + type: integer + ID: + type: integer + INVESTIGATION_ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + ROLE: + type: string + type: object + InvestigationInstrument: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + ID: + type: integer + INSTRUMENT_ID: + type: integer + INVESTIGATION_ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + type: object + InvestigationParameter: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + DATETIME_VALUE: + type: string + ERROR: + type: number + ID: + type: integer + INVESTIGATION_ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + NUMERIC_VALUE: + type: number + PARAMETER_TYPE_ID: + type: integer + RANGEBOTTOM: + type: number + RANGETOP: + type: number + STRING_VALUE: + type: string + type: object + InvestigationType: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + DESCRIPTION: + type: string + FACILITY_ID: + type: integer + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + type: object + InvestigationUser: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + ID: + type: integer + INVESTIGATION_ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + ROLE: + type: string + USER_ID: + type: integer + type: object + Job: + properties: + APPLICATION_ID: + type: integer + ARGUMENTS: + type: string + CREATE_ID: + type: string + CREATE_TIME: + type: string + ID: + type: integer + INPUTDATACOLLECTION_ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + OUTPUTDATACOLLECTION_ID: + type: integer + type: object + Keyword: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + ID: + type: integer + INVESTIGATION_ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + type: object + ParameterType: + properties: + APPLICABLETODATACOLLECTION: + type: boolean + APPLICABLETODATAFILE: + type: boolean + APPLICABLETODATASET: + type: boolean + APPLICABLETOINVESTIGATION: + type: boolean + APPLICABLETOSAMPLE: + type: boolean + CREATE_ID: + type: string + CREATE_TIME: + type: string + DESCRIPTION: + type: string + ENFORCED: + type: boolean + FACILITY_ID: + type: integer + ID: + type: integer + MAXIMUMNUMERICVALUE: + type: number + MINIMUMNUMERICVALUE: + type: number + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + UNITS: + type: string + UNITSFULLNAME: + type: string + VALUETYPE: + type: integer + VERIFIED: + type: boolean + type: object + PermissibleStringValue: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + PARAMETERTYPE_ID: + type: integer + VALUE: + type: string + type: object + PublicStep: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + FIELD: + type: string + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + ORIGIN: + type: string + type: object + Publication: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + DOI: + type: string + FULLREFERENCE: + type: string + ID: + type: integer + INVESTIGATION_ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + REPOSITORY: + type: string + REPOSITORYID: + type: string + URL: + type: string + type: object + RelatedDatafile: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + DEST_DATAFILE_ID: + type: integer + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + RELATION: + type: string + SOURCE_DATAFILE_ID: + type: integer + type: object + Rule: + properties: + ATTRIBUTE: + type: string + BEAN: + type: string + C: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + CRUDFLAGS: + type: string + CRUDJPQL: + type: string + D: + type: integer + GROUPING_ID: + type: integer + ID: + type: integer + INCLUDEJPQL: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + R: + type: integer + RESTRICTED: + type: integer + SEARCHJPQL: + type: string + U: + type: integer + WHAT: + type: string + type: object + Sample: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + ID: + type: integer + INVESTIGATION_ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + SAMPLETYPE_ID: + type: integer + type: object + SampleParameter: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + DATETIME_VALUE: + type: string + ERROR: + type: number + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + NUMERIC_VALUE: + type: number + PARAMETER_TYPE_ID: + type: integer + RANGEBOTTOM: + type: number + RANGETOP: + type: number + SAMPLE_ID: + type: integer + STRING_VALUE: + type: string + type: object + SampleType: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + FACILITY_ID: + type: integer + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + MOLECULARFORMULA: + type: string + NAME: + type: string + SAFETYINFORMATION: + type: string + type: object + Shift: + properties: + COMMENT: + type: string + CREATE_ID: + type: string + CREATE_TIME: + type: string + ENDDATE: + type: string + ID: + type: integer + INVESTIGATION_ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + STARTDATE: + type: string + type: object + Study: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + DESCRIPTION: + type: string + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + STARTDATE: + type: string + STATUS: + type: integer + USER_ID: + type: integer + type: object + StudyInvestigation: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + ID: + type: integer + INVESTIGATION_ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + STUDY_ID: + type: integer + type: object + User: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + EMAIL: + type: string + FULLNAME: + type: string + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + ORCIDID: + type: string + type: object + UserGroup: + properties: + CREATE_ID: + type: string + CREATE_TIME: + type: string + GROUP_ID: + type: integer + ID: + type: integer + MOD_ID: + type: string + MOD_TIME: + type: string + USER_ID: + type: integer + type: object info: description: ICAT API to interface with the DataGateway title: DataGateway API @@ -64,24 +905,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - VERSION: - type: string - type: object + $ref: '#/components/schemas/Application' description: The applications found '401': description: When no credentials are provided @@ -97,7 +921,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/Application' description: Update one or multiple applications required: true responses: @@ -105,24 +929,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - VERSION: - type: string - type: object + $ref: '#/components/schemas/Application' description: The updated entity '401': description: When no credentials are provided @@ -146,24 +953,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - VERSION: - type: string - type: object + $ref: '#/components/schemas/Application' description: The created applications '401': description: When no credentials are provided @@ -241,24 +1031,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - VERSION: - type: string - type: object + $ref: '#/components/schemas/Application' description: The matching applications '401': description: When no credentials are provided @@ -329,22 +1102,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATACOLLECTION_ID: - type: integer - DATAFILE_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object + $ref: '#/components/schemas/DataCollectionDatafile' description: The data collection datafiles found '401': description: When no credentials are provided @@ -360,7 +1118,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/DataCollectionDatafile' description: Update one or multiple data collection datafiles required: true responses: @@ -368,22 +1126,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATACOLLECTION_ID: - type: integer - DATAFILE_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object + $ref: '#/components/schemas/DataCollectionDatafile' description: The updated entity '401': description: When no credentials are provided @@ -407,22 +1150,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATACOLLECTION_ID: - type: integer - DATAFILE_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object + $ref: '#/components/schemas/DataCollectionDatafile' description: The created data collection datafiles '401': description: When no credentials are provided @@ -500,22 +1228,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATACOLLECTION_ID: - type: integer - DATAFILE_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object + $ref: '#/components/schemas/DataCollectionDatafile' description: The matching data collection datafiles '401': description: When no credentials are provided @@ -586,22 +1299,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATACOLLECTION_ID: - type: integer - DATASET_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object + $ref: '#/components/schemas/DataCollectionDataset' description: The data collection datasets found '401': description: When no credentials are provided @@ -617,7 +1315,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/DataCollectionDataset' description: Update one or multiple data collection datasets required: true responses: @@ -625,22 +1323,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATACOLLECTION_ID: - type: integer - DATASET_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object + $ref: '#/components/schemas/DataCollectionDataset' description: The updated entity '401': description: When no credentials are provided @@ -664,22 +1347,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATACOLLECTION_ID: - type: integer - DATASET_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object + $ref: '#/components/schemas/DataCollectionDataset' description: The created data collection datasets '401': description: When no credentials are provided @@ -757,22 +1425,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATACOLLECTION_ID: - type: integer - DATASET_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object + $ref: '#/components/schemas/DataCollectionDataset' description: The matching data collection datasets '401': description: When no credentials are provided @@ -843,34 +1496,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATACOLLECTION_ID: - type: integer - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - STRING_VALUE: - type: string - type: object + $ref: '#/components/schemas/DataCollectionParameter' description: The data collection parameters found '401': description: When no credentials are provided @@ -886,7 +1512,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/DataCollectionParameter' description: Update one or multiple data collection parameters required: true responses: @@ -894,34 +1520,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATACOLLECTION_ID: - type: integer - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - STRING_VALUE: - type: string - type: object + $ref: '#/components/schemas/DataCollectionParameter' description: The updated entity '401': description: When no credentials are provided @@ -945,34 +1544,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATACOLLECTION_ID: - type: integer - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - STRING_VALUE: - type: string - type: object + $ref: '#/components/schemas/DataCollectionParameter' description: The created data collection parameters '401': description: When no credentials are provided @@ -1050,34 +1622,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATACOLLECTION_ID: - type: integer - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - STRING_VALUE: - type: string - type: object + $ref: '#/components/schemas/DataCollectionParameter' description: The matching data collection parameters '401': description: When no credentials are provided @@ -1148,20 +1693,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DOI: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object + $ref: '#/components/schemas/DataCollection' description: The data collections found '401': description: When no credentials are provided @@ -1177,7 +1709,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/DataCollection' description: Update one or multiple data collections required: true responses: @@ -1185,20 +1717,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DOI: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object + $ref: '#/components/schemas/DataCollection' description: The updated entity '401': description: When no credentials are provided @@ -1222,20 +1741,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DOI: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object + $ref: '#/components/schemas/DataCollection' description: The created data collections '401': description: When no credentials are provided @@ -1313,20 +1819,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DOI: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object + $ref: '#/components/schemas/DataCollection' description: The matching data collections '401': description: When no credentials are provided @@ -1397,28 +1890,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - TYPE: - type: string - VERSION: - type: string - type: object + $ref: '#/components/schemas/DatafileFormat' description: The datafile formats found '401': description: When no credentials are provided @@ -1434,7 +1906,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/DatafileFormat' description: Update one or multiple datafile formats required: true responses: @@ -1442,28 +1914,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - TYPE: - type: string - VERSION: - type: string - type: object + $ref: '#/components/schemas/DatafileFormat' description: The updated entity '401': description: When no credentials are provided @@ -1487,28 +1938,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - TYPE: - type: string - VERSION: - type: string - type: object + $ref: '#/components/schemas/DatafileFormat' description: The created datafile formats '401': description: When no credentials are provided @@ -1586,28 +2016,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - TYPE: - type: string - VERSION: - type: string - type: object + $ref: '#/components/schemas/DatafileFormat' description: The matching datafile formats '401': description: When no credentials are provided @@ -1678,34 +2087,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATAFILE_ID: - type: integer - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - STRING_VALUE: - type: string - type: object + $ref: '#/components/schemas/DatafileParameter' description: The datafile parameters found '401': description: When no credentials are provided @@ -1721,7 +2103,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/DatafileParameter' description: Update one or multiple datafile parameters required: true responses: @@ -1729,34 +2111,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATAFILE_ID: - type: integer - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - STRING_VALUE: - type: string - type: object + $ref: '#/components/schemas/DatafileParameter' description: The updated entity '401': description: When no credentials are provided @@ -1780,34 +2135,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATAFILE_ID: - type: integer - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - STRING_VALUE: - type: string - type: object + $ref: '#/components/schemas/DatafileParameter' description: The created datafile parameters '401': description: When no credentials are provided @@ -1885,34 +2213,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATAFILE_ID: - type: integer - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - STRING_VALUE: - type: string - type: object + $ref: '#/components/schemas/DatafileParameter' description: The matching datafile parameters '401': description: When no credentials are provided @@ -1983,38 +2284,7 @@ paths: content: application/json: schema: - properties: - CHECKSUM: - type: string - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATAFILECREATETIME: - type: string - DATAFILEFORMAT_ID: - type: integer - DATAFILEMODTIME: - type: string - DATASET_ID: - type: integer - DESCRIPTION: - type: string - DOI: - type: string - FILESIZE: - type: integer - ID: - type: integer - LOCATION: - type: string - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/Datafile' description: The datafiles found '401': description: When no credentials are provided @@ -2030,7 +2300,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/Datafile' description: Update one or multiple datafiles required: true responses: @@ -2038,38 +2308,7 @@ paths: content: application/json: schema: - properties: - CHECKSUM: - type: string - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATAFILECREATETIME: - type: string - DATAFILEFORMAT_ID: - type: integer - DATAFILEMODTIME: - type: string - DATASET_ID: - type: integer - DESCRIPTION: - type: string - DOI: - type: string - FILESIZE: - type: integer - ID: - type: integer - LOCATION: - type: string - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/Datafile' description: The updated entity '401': description: When no credentials are provided @@ -2093,38 +2332,7 @@ paths: content: application/json: schema: - properties: - CHECKSUM: - type: string - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATAFILECREATETIME: - type: string - DATAFILEFORMAT_ID: - type: integer - DATAFILEMODTIME: - type: string - DATASET_ID: - type: integer - DESCRIPTION: - type: string - DOI: - type: string - FILESIZE: - type: integer - ID: - type: integer - LOCATION: - type: string - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/Datafile' description: The created datafiles '401': description: When no credentials are provided @@ -2202,38 +2410,7 @@ paths: content: application/json: schema: - properties: - CHECKSUM: - type: string - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATAFILECREATETIME: - type: string - DATAFILEFORMAT_ID: - type: integer - DATAFILEMODTIME: - type: string - DATASET_ID: - type: integer - DESCRIPTION: - type: string - DOI: - type: string - FILESIZE: - type: integer - ID: - type: integer - LOCATION: - type: string - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/Datafile' description: The matching datafiles '401': description: When no credentials are provided @@ -2304,38 +2481,7 @@ paths: content: application/json: schema: - properties: - COMPLETE: - type: boolean - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - DOI: - type: string - END_DATE: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - LOCATION: - type: string - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - SAMPLE_ID: - type: integer - STARTDATE: - type: string - TYPE_ID: - type: integer - type: object + $ref: '#/components/schemas/Dataset' description: The datasets found '401': description: When no credentials are provided @@ -2351,7 +2497,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/Dataset' description: Update one or multiple datasets required: true responses: @@ -2359,38 +2505,7 @@ paths: content: application/json: schema: - properties: - COMPLETE: - type: boolean - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - DOI: - type: string - END_DATE: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - LOCATION: - type: string - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - SAMPLE_ID: - type: integer - STARTDATE: - type: string - TYPE_ID: - type: integer - type: object + $ref: '#/components/schemas/Dataset' description: The updated entity '401': description: When no credentials are provided @@ -2414,38 +2529,7 @@ paths: content: application/json: schema: - properties: - COMPLETE: - type: boolean - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - DOI: - type: string - END_DATE: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - LOCATION: - type: string - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - SAMPLE_ID: - type: integer - STARTDATE: - type: string - TYPE_ID: - type: integer - type: object + $ref: '#/components/schemas/Dataset' description: The created datasets '401': description: When no credentials are provided @@ -2523,38 +2607,7 @@ paths: content: application/json: schema: - properties: - COMPLETE: - type: boolean - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - DOI: - type: string - END_DATE: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - LOCATION: - type: string - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - SAMPLE_ID: - type: integer - STARTDATE: - type: string - TYPE_ID: - type: integer - type: object + $ref: '#/components/schemas/Dataset' description: The matching datasets '401': description: When no credentials are provided @@ -2625,24 +2678,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/DatasetType' description: The dataset types found '401': description: When no credentials are provided @@ -2658,7 +2694,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/DatasetType' description: Update one or multiple dataset types required: true responses: @@ -2666,24 +2702,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/DatasetType' description: The updated entity '401': description: When no credentials are provided @@ -2707,24 +2726,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/DatasetType' description: The created dataset types '401': description: When no credentials are provided @@ -2802,24 +2804,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/DatasetType' description: The matching dataset types '401': description: When no credentials are provided @@ -2890,28 +2875,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DAYSUNTILRELEASE: - type: integer - DESCRIPTION: - type: string - FULLNAME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - URL: - type: string - type: object + $ref: '#/components/schemas/Facility' description: The facilities found '401': description: When no credentials are provided @@ -2927,7 +2891,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/Facility' description: Update one or multiple facilities required: true responses: @@ -2935,28 +2899,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DAYSUNTILRELEASE: - type: integer - DESCRIPTION: - type: string - FULLNAME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - URL: - type: string - type: object + $ref: '#/components/schemas/Facility' description: The updated entity '401': description: When no credentials are provided @@ -2980,28 +2923,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DAYSUNTILRELEASE: - type: integer - DESCRIPTION: - type: string - FULLNAME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - URL: - type: string - type: object + $ref: '#/components/schemas/Facility' description: The created facilities '401': description: When no credentials are provided @@ -3079,28 +3001,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DAYSUNTILRELEASE: - type: integer - DESCRIPTION: - type: string - FULLNAME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - URL: - type: string - type: object + $ref: '#/components/schemas/Facility' description: The matching facilities '401': description: When no credentials are provided @@ -3171,28 +3072,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - ENDDATE: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - STARTDATE: - type: string - type: object + $ref: '#/components/schemas/FacilityCycle' description: The facility cycles found '401': description: When no credentials are provided @@ -3208,7 +3088,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/FacilityCycle' description: Update one or multiple facility cycles required: true responses: @@ -3216,28 +3096,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - ENDDATE: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - STARTDATE: - type: string - type: object + $ref: '#/components/schemas/FacilityCycle' description: The updated entity '401': description: When no credentials are provided @@ -3261,28 +3120,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - ENDDATE: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - STARTDATE: - type: string - type: object + $ref: '#/components/schemas/FacilityCycle' description: The created facility cycles '401': description: When no credentials are provided @@ -3360,28 +3198,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - ENDDATE: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - STARTDATE: - type: string - type: object + $ref: '#/components/schemas/FacilityCycle' description: The matching facility cycles '401': description: When no credentials are provided @@ -3452,20 +3269,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/Grouping' description: The groupings found '401': description: When no credentials are provided @@ -3481,7 +3285,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/Grouping' description: Update one or multiple groupings required: true responses: @@ -3489,20 +3293,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/Grouping' description: The updated entity '401': description: When no credentials are provided @@ -3526,20 +3317,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/Grouping' description: The created groupings '401': description: When no credentials are provided @@ -3617,20 +3395,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/Grouping' description: The matching groupings '401': description: When no credentials are provided @@ -3701,30 +3466,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - FULLNAME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - TYPE: - type: string - URL: - type: string - type: object + $ref: '#/components/schemas/Instrument' description: The instruments found '401': description: When no credentials are provided @@ -3740,7 +3482,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/Instrument' description: Update one or multiple instruments required: true responses: @@ -3748,30 +3490,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - FULLNAME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - TYPE: - type: string - URL: - type: string - type: object + $ref: '#/components/schemas/Instrument' description: The updated entity '401': description: When no credentials are provided @@ -3795,30 +3514,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - FULLNAME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - TYPE: - type: string - URL: - type: string - type: object + $ref: '#/components/schemas/Instrument' description: The created instruments '401': description: When no credentials are provided @@ -3896,30 +3592,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - FULLNAME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - TYPE: - type: string - URL: - type: string - type: object + $ref: '#/components/schemas/Instrument' description: The matching instruments '401': description: When no credentials are provided @@ -3990,22 +3663,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INSTRUMENT_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - USER_ID: - type: integer - type: object + $ref: '#/components/schemas/InstrumentScientist' description: The instrument scientists found '401': description: When no credentials are provided @@ -4021,7 +3679,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/InstrumentScientist' description: Update one or multiple instrument scientists required: true responses: @@ -4029,22 +3687,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INSTRUMENT_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - USER_ID: - type: integer - type: object + $ref: '#/components/schemas/InstrumentScientist' description: The updated entity '401': description: When no credentials are provided @@ -4068,22 +3711,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INSTRUMENT_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - USER_ID: - type: integer - type: object + $ref: '#/components/schemas/InstrumentScientist' description: The created instrument scientists '401': description: When no credentials are provided @@ -4161,22 +3789,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INSTRUMENT_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - USER_ID: - type: integer - type: object + $ref: '#/components/schemas/InstrumentScientist' description: The matching instrument scientists '401': description: When no credentials are provided @@ -4247,24 +3860,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - GROUP_ID: - type: integer - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - ROLE: - type: string - type: object + $ref: '#/components/schemas/InvestigationGroup' description: The investigation groups found '401': description: When no credentials are provided @@ -4280,7 +3876,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/InvestigationGroup' description: Update one or multiple investigation groups required: true responses: @@ -4288,24 +3884,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - GROUP_ID: - type: integer - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - ROLE: - type: string - type: object + $ref: '#/components/schemas/InvestigationGroup' description: The updated entity '401': description: When no credentials are provided @@ -4329,24 +3908,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - GROUP_ID: - type: integer - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - ROLE: - type: string - type: object + $ref: '#/components/schemas/InvestigationGroup' description: The created investigation groups '401': description: When no credentials are provided @@ -4424,24 +3986,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - GROUP_ID: - type: integer - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - ROLE: - type: string - type: object + $ref: '#/components/schemas/InvestigationGroup' description: The matching investigation groups '401': description: When no credentials are provided @@ -4512,22 +4057,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INSTRUMENT_ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object + $ref: '#/components/schemas/InvestigationInstrument' description: The investigation instruments found '401': description: When no credentials are provided @@ -4543,7 +4073,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/InvestigationInstrument' description: Update one or multiple investigation instruments required: true responses: @@ -4551,22 +4081,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INSTRUMENT_ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object + $ref: '#/components/schemas/InvestigationInstrument' description: The updated entity '401': description: When no credentials are provided @@ -4590,22 +4105,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INSTRUMENT_ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object + $ref: '#/components/schemas/InvestigationInstrument' description: The created investigation instruments '401': description: When no credentials are provided @@ -4683,22 +4183,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INSTRUMENT_ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object + $ref: '#/components/schemas/InvestigationInstrument' description: The matching investigation instruments '401': description: When no credentials are provided @@ -4769,34 +4254,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - STRING_VALUE: - type: string - type: object + $ref: '#/components/schemas/InvestigationParameter' description: The investigation parameters found '401': description: When no credentials are provided @@ -4812,7 +4270,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/InvestigationParameter' description: Update one or multiple investigation parameters required: true responses: @@ -4820,34 +4278,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - STRING_VALUE: - type: string - type: object + $ref: '#/components/schemas/InvestigationParameter' description: The updated entity '401': description: When no credentials are provided @@ -4871,34 +4302,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - STRING_VALUE: - type: string - type: object + $ref: '#/components/schemas/InvestigationParameter' description: The created investigation parameters '401': description: When no credentials are provided @@ -4976,34 +4380,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - STRING_VALUE: - type: string - type: object + $ref: '#/components/schemas/InvestigationParameter' description: The matching investigation parameters '401': description: When no credentials are provided @@ -5074,38 +4451,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DOI: - type: string - ENDDATE: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - RELEASEDATE: - type: string - STARTDATE: - type: string - SUMMARY: - type: string - TITLE: - type: string - TYPE_ID: - type: integer - VISIT_ID: - type: string - type: object + $ref: '#/components/schemas/Investigation' description: The investigations found '401': description: When no credentials are provided @@ -5121,7 +4467,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/Investigation' description: Update one or multiple investigations required: true responses: @@ -5129,38 +4475,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DOI: - type: string - ENDDATE: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - RELEASEDATE: - type: string - STARTDATE: - type: string - SUMMARY: - type: string - TITLE: - type: string - TYPE_ID: - type: integer - VISIT_ID: - type: string - type: object + $ref: '#/components/schemas/Investigation' description: The updated entity '401': description: When no credentials are provided @@ -5184,38 +4499,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DOI: - type: string - ENDDATE: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - RELEASEDATE: - type: string - STARTDATE: - type: string - SUMMARY: - type: string - TITLE: - type: string - TYPE_ID: - type: integer - VISIT_ID: - type: string - type: object + $ref: '#/components/schemas/Investigation' description: The created investigations '401': description: When no credentials are provided @@ -5293,38 +4577,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DOI: - type: string - ENDDATE: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - RELEASEDATE: - type: string - STARTDATE: - type: string - SUMMARY: - type: string - TITLE: - type: string - TYPE_ID: - type: integer - VISIT_ID: - type: string - type: object + $ref: '#/components/schemas/Investigation' description: The matching investigations '401': description: When no credentials are provided @@ -5395,24 +4648,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/InvestigationType' description: The investigation types found '401': description: When no credentials are provided @@ -5428,7 +4664,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/InvestigationType' description: Update one or multiple investigation types required: true responses: @@ -5436,24 +4672,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/InvestigationType' description: The updated entity '401': description: When no credentials are provided @@ -5477,24 +4696,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/InvestigationType' description: The created investigation types '401': description: When no credentials are provided @@ -5572,24 +4774,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/InvestigationType' description: The matching investigation types '401': description: When no credentials are provided @@ -5660,24 +4845,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - ROLE: - type: string - USER_ID: - type: integer - type: object + $ref: '#/components/schemas/InvestigationUser' description: The investigation users found '401': description: When no credentials are provided @@ -5693,7 +4861,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/InvestigationUser' description: Update one or multiple investigation users required: true responses: @@ -5701,24 +4869,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - ROLE: - type: string - USER_ID: - type: integer - type: object + $ref: '#/components/schemas/InvestigationUser' description: The updated entity '401': description: When no credentials are provided @@ -5742,24 +4893,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - ROLE: - type: string - USER_ID: - type: integer - type: object + $ref: '#/components/schemas/InvestigationUser' description: The created investigation users '401': description: When no credentials are provided @@ -5837,24 +4971,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - ROLE: - type: string - USER_ID: - type: integer - type: object + $ref: '#/components/schemas/InvestigationUser' description: The matching investigation users '401': description: When no credentials are provided @@ -5925,26 +5042,7 @@ paths: content: application/json: schema: - properties: - APPLICATION_ID: - type: integer - ARGUMENTS: - type: string - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INPUTDATACOLLECTION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - OUTPUTDATACOLLECTION_ID: - type: integer - type: object + $ref: '#/components/schemas/Job' description: The jobs found '401': description: When no credentials are provided @@ -5960,7 +5058,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/Job' description: Update one or multiple jobs required: true responses: @@ -5968,26 +5066,7 @@ paths: content: application/json: schema: - properties: - APPLICATION_ID: - type: integer - ARGUMENTS: - type: string - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INPUTDATACOLLECTION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - OUTPUTDATACOLLECTION_ID: - type: integer - type: object + $ref: '#/components/schemas/Job' description: The updated entity '401': description: When no credentials are provided @@ -6011,26 +5090,7 @@ paths: content: application/json: schema: - properties: - APPLICATION_ID: - type: integer - ARGUMENTS: - type: string - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INPUTDATACOLLECTION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - OUTPUTDATACOLLECTION_ID: - type: integer - type: object + $ref: '#/components/schemas/Job' description: The created jobs '401': description: When no credentials are provided @@ -6108,26 +5168,7 @@ paths: content: application/json: schema: - properties: - APPLICATION_ID: - type: integer - ARGUMENTS: - type: string - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INPUTDATACOLLECTION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - OUTPUTDATACOLLECTION_ID: - type: integer - type: object + $ref: '#/components/schemas/Job' description: The matching jobs '401': description: When no credentials are provided @@ -6198,22 +5239,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/Keyword' description: The keywords found '401': description: When no credentials are provided @@ -6229,7 +5255,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/Keyword' description: Update one or multiple keywords required: true responses: @@ -6237,22 +5263,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/Keyword' description: The updated entity '401': description: When no credentials are provided @@ -6276,22 +5287,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/Keyword' description: The created keywords '401': description: When no credentials are provided @@ -6369,22 +5365,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object + $ref: '#/components/schemas/Keyword' description: The matching keywords '401': description: When no credentials are provided @@ -6455,48 +5436,7 @@ paths: content: application/json: schema: - properties: - APPLICABLETODATACOLLECTION: - type: boolean - APPLICABLETODATAFILE: - type: boolean - APPLICABLETODATASET: - type: boolean - APPLICABLETOINVESTIGATION: - type: boolean - APPLICABLETOSAMPLE: - type: boolean - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - ENFORCED: - type: boolean - FACILITY_ID: - type: integer - ID: - type: integer - MAXIMUMNUMERICVALUE: - type: number - MINIMUMNUMERICVALUE: - type: number - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - UNITS: - type: string - UNITSFULLNAME: - type: string - VALUETYPE: - type: integer - VERIFIED: - type: boolean - type: object + $ref: '#/components/schemas/ParameterType' description: The parameter types found '401': description: When no credentials are provided @@ -6512,7 +5452,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/ParameterType' description: Update one or multiple parameter types required: true responses: @@ -6520,48 +5460,7 @@ paths: content: application/json: schema: - properties: - APPLICABLETODATACOLLECTION: - type: boolean - APPLICABLETODATAFILE: - type: boolean - APPLICABLETODATASET: - type: boolean - APPLICABLETOINVESTIGATION: - type: boolean - APPLICABLETOSAMPLE: - type: boolean - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - ENFORCED: - type: boolean - FACILITY_ID: - type: integer - ID: - type: integer - MAXIMUMNUMERICVALUE: - type: number - MINIMUMNUMERICVALUE: - type: number - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - UNITS: - type: string - UNITSFULLNAME: - type: string - VALUETYPE: - type: integer - VERIFIED: - type: boolean - type: object + $ref: '#/components/schemas/ParameterType' description: The updated entity '401': description: When no credentials are provided @@ -6585,48 +5484,7 @@ paths: content: application/json: schema: - properties: - APPLICABLETODATACOLLECTION: - type: boolean - APPLICABLETODATAFILE: - type: boolean - APPLICABLETODATASET: - type: boolean - APPLICABLETOINVESTIGATION: - type: boolean - APPLICABLETOSAMPLE: - type: boolean - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - ENFORCED: - type: boolean - FACILITY_ID: - type: integer - ID: - type: integer - MAXIMUMNUMERICVALUE: - type: number - MINIMUMNUMERICVALUE: - type: number - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - UNITS: - type: string - UNITSFULLNAME: - type: string - VALUETYPE: - type: integer - VERIFIED: - type: boolean - type: object + $ref: '#/components/schemas/ParameterType' description: The created parameter types '401': description: When no credentials are provided @@ -6704,48 +5562,7 @@ paths: content: application/json: schema: - properties: - APPLICABLETODATACOLLECTION: - type: boolean - APPLICABLETODATAFILE: - type: boolean - APPLICABLETODATASET: - type: boolean - APPLICABLETOINVESTIGATION: - type: boolean - APPLICABLETOSAMPLE: - type: boolean - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - ENFORCED: - type: boolean - FACILITY_ID: - type: integer - ID: - type: integer - MAXIMUMNUMERICVALUE: - type: number - MINIMUMNUMERICVALUE: - type: number - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - UNITS: - type: string - UNITSFULLNAME: - type: string - VALUETYPE: - type: integer - VERIFIED: - type: boolean - type: object + $ref: '#/components/schemas/ParameterType' description: The matching parameter types '401': description: When no credentials are provided @@ -6816,22 +5633,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - PARAMETERTYPE_ID: - type: integer - VALUE: - type: string - type: object + $ref: '#/components/schemas/PermissibleStringValue' description: The permissible string values found '401': description: When no credentials are provided @@ -6847,7 +5649,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/PermissibleStringValue' description: Update one or multiple permissible string values required: true responses: @@ -6855,22 +5657,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - PARAMETERTYPE_ID: - type: integer - VALUE: - type: string - type: object + $ref: '#/components/schemas/PermissibleStringValue' description: The updated entity '401': description: When no credentials are provided @@ -6894,22 +5681,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - PARAMETERTYPE_ID: - type: integer - VALUE: - type: string - type: object + $ref: '#/components/schemas/PermissibleStringValue' description: The created permissible string values '401': description: When no credentials are provided @@ -6987,22 +5759,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - PARAMETERTYPE_ID: - type: integer - VALUE: - type: string - type: object + $ref: '#/components/schemas/PermissibleStringValue' description: The matching permissible string values '401': description: When no credentials are provided @@ -7073,30 +5830,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DOI: - type: string - FULLREFERENCE: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - REPOSITORY: - type: string - REPOSITORYID: - type: string - URL: - type: string - type: object + $ref: '#/components/schemas/Publication' description: The publications found '401': description: When no credentials are provided @@ -7112,7 +5846,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/Publication' description: Update one or multiple publications required: true responses: @@ -7120,30 +5854,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DOI: - type: string - FULLREFERENCE: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - REPOSITORY: - type: string - REPOSITORYID: - type: string - URL: - type: string - type: object + $ref: '#/components/schemas/Publication' description: The updated entity '401': description: When no credentials are provided @@ -7167,30 +5878,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DOI: - type: string - FULLREFERENCE: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - REPOSITORY: - type: string - REPOSITORYID: - type: string - URL: - type: string - type: object + $ref: '#/components/schemas/Publication' description: The created publications '401': description: When no credentials are provided @@ -7268,30 +5956,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DOI: - type: string - FULLREFERENCE: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - REPOSITORY: - type: string - REPOSITORYID: - type: string - URL: - type: string - type: object + $ref: '#/components/schemas/Publication' description: The matching publications '401': description: When no credentials are provided @@ -7362,22 +6027,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - FIELD: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - ORIGIN: - type: string - type: object + $ref: '#/components/schemas/PublicStep' description: The public steps found '401': description: When no credentials are provided @@ -7393,7 +6043,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/PublicStep' description: Update one or multiple public steps required: true responses: @@ -7401,22 +6051,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - FIELD: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - ORIGIN: - type: string - type: object + $ref: '#/components/schemas/PublicStep' description: The updated entity '401': description: When no credentials are provided @@ -7440,22 +6075,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - FIELD: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - ORIGIN: - type: string - type: object + $ref: '#/components/schemas/PublicStep' description: The created public steps '401': description: When no credentials are provided @@ -7533,22 +6153,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - FIELD: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - ORIGIN: - type: string - type: object + $ref: '#/components/schemas/PublicStep' description: The matching public steps '401': description: When no credentials are provided @@ -7619,24 +6224,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DEST_DATAFILE_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - RELATION: - type: string - SOURCE_DATAFILE_ID: - type: integer - type: object + $ref: '#/components/schemas/RelatedDatafile' description: The related datafiles found '401': description: When no credentials are provided @@ -7652,7 +6240,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/RelatedDatafile' description: Update one or multiple related datafiles required: true responses: @@ -7660,24 +6248,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DEST_DATAFILE_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - RELATION: - type: string - SOURCE_DATAFILE_ID: - type: integer - type: object + $ref: '#/components/schemas/RelatedDatafile' description: The updated entity '401': description: When no credentials are provided @@ -7701,24 +6272,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DEST_DATAFILE_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - RELATION: - type: string - SOURCE_DATAFILE_ID: - type: integer - type: object + $ref: '#/components/schemas/RelatedDatafile' description: The created related datafiles '401': description: When no credentials are provided @@ -7796,24 +6350,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DEST_DATAFILE_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - RELATION: - type: string - SOURCE_DATAFILE_ID: - type: integer - type: object + $ref: '#/components/schemas/RelatedDatafile' description: The matching related datafiles '401': description: When no credentials are provided @@ -7884,44 +6421,7 @@ paths: content: application/json: schema: - properties: - ATTRIBUTE: - type: string - BEAN: - type: string - C: - type: integer - CREATE_ID: - type: string - CREATE_TIME: - type: string - CRUDFLAGS: - type: string - CRUDJPQL: - type: string - D: - type: integer - GROUPING_ID: - type: integer - ID: - type: integer - INCLUDEJPQL: - type: string - MOD_ID: - type: string - MOD_TIME: - type: string - R: - type: integer - RESTRICTED: - type: integer - SEARCHJPQL: - type: string - U: - type: integer - WHAT: - type: string - type: object + $ref: '#/components/schemas/Rule' description: The rules found '401': description: When no credentials are provided @@ -7937,7 +6437,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/Rule' description: Update one or multiple rules required: true responses: @@ -7945,44 +6445,7 @@ paths: content: application/json: schema: - properties: - ATTRIBUTE: - type: string - BEAN: - type: string - C: - type: integer - CREATE_ID: - type: string - CREATE_TIME: - type: string - CRUDFLAGS: - type: string - CRUDJPQL: - type: string - D: - type: integer - GROUPING_ID: - type: integer - ID: - type: integer - INCLUDEJPQL: - type: string - MOD_ID: - type: string - MOD_TIME: - type: string - R: - type: integer - RESTRICTED: - type: integer - SEARCHJPQL: - type: string - U: - type: integer - WHAT: - type: string - type: object + $ref: '#/components/schemas/Rule' description: The updated entity '401': description: When no credentials are provided @@ -8006,44 +6469,7 @@ paths: content: application/json: schema: - properties: - ATTRIBUTE: - type: string - BEAN: - type: string - C: - type: integer - CREATE_ID: - type: string - CREATE_TIME: - type: string - CRUDFLAGS: - type: string - CRUDJPQL: - type: string - D: - type: integer - GROUPING_ID: - type: integer - ID: - type: integer - INCLUDEJPQL: - type: string - MOD_ID: - type: string - MOD_TIME: - type: string - R: - type: integer - RESTRICTED: - type: integer - SEARCHJPQL: - type: string - U: - type: integer - WHAT: - type: string - type: object + $ref: '#/components/schemas/Rule' description: The created rules '401': description: When no credentials are provided @@ -8121,44 +6547,7 @@ paths: content: application/json: schema: - properties: - ATTRIBUTE: - type: string - BEAN: - type: string - C: - type: integer - CREATE_ID: - type: string - CREATE_TIME: - type: string - CRUDFLAGS: - type: string - CRUDJPQL: - type: string - D: - type: integer - GROUPING_ID: - type: integer - ID: - type: integer - INCLUDEJPQL: - type: string - MOD_ID: - type: string - MOD_TIME: - type: string - R: - type: integer - RESTRICTED: - type: integer - SEARCHJPQL: - type: string - U: - type: integer - WHAT: - type: string - type: object + $ref: '#/components/schemas/Rule' description: The matching rules '401': description: When no credentials are provided @@ -8229,34 +6618,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - SAMPLE_ID: - type: integer - STRING_VALUE: - type: string - type: object + $ref: '#/components/schemas/SampleParameter' description: The sample parameters found '401': description: When no credentials are provided @@ -8272,7 +6634,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/SampleParameter' description: Update one or multiple sample parameters required: true responses: @@ -8280,34 +6642,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - SAMPLE_ID: - type: integer - STRING_VALUE: - type: string - type: object + $ref: '#/components/schemas/SampleParameter' description: The updated entity '401': description: When no credentials are provided @@ -8331,34 +6666,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - SAMPLE_ID: - type: integer - STRING_VALUE: - type: string - type: object + $ref: '#/components/schemas/SampleParameter' description: The created sample parameters '401': description: When no credentials are provided @@ -8436,34 +6744,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - SAMPLE_ID: - type: integer - STRING_VALUE: - type: string - type: object + $ref: '#/components/schemas/SampleParameter' description: The matching sample parameters '401': description: When no credentials are provided @@ -8534,24 +6815,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - SAMPLETYPE_ID: - type: integer - type: object + $ref: '#/components/schemas/Sample' description: The samples found '401': description: When no credentials are provided @@ -8567,7 +6831,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/Sample' description: Update one or multiple samples required: true responses: @@ -8575,24 +6839,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - SAMPLETYPE_ID: - type: integer - type: object + $ref: '#/components/schemas/Sample' description: The updated entity '401': description: When no credentials are provided @@ -8616,24 +6863,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - SAMPLETYPE_ID: - type: integer - type: object + $ref: '#/components/schemas/Sample' description: The created samples '401': description: When no credentials are provided @@ -8711,24 +6941,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - SAMPLETYPE_ID: - type: integer - type: object + $ref: '#/components/schemas/Sample' description: The matching samples '401': description: When no credentials are provided @@ -8799,26 +7012,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - MOLECULARFORMULA: - type: string - NAME: - type: string - SAFETYINFORMATION: - type: string - type: object + $ref: '#/components/schemas/SampleType' description: The sample types found '401': description: When no credentials are provided @@ -8834,7 +7028,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/SampleType' description: Update one or multiple sample types required: true responses: @@ -8842,26 +7036,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - MOLECULARFORMULA: - type: string - NAME: - type: string - SAFETYINFORMATION: - type: string - type: object + $ref: '#/components/schemas/SampleType' description: The updated entity '401': description: When no credentials are provided @@ -8885,26 +7060,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - MOLECULARFORMULA: - type: string - NAME: - type: string - SAFETYINFORMATION: - type: string - type: object + $ref: '#/components/schemas/SampleType' description: The created sample types '401': description: When no credentials are provided @@ -8982,26 +7138,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - MOLECULARFORMULA: - type: string - NAME: - type: string - SAFETYINFORMATION: - type: string - type: object + $ref: '#/components/schemas/SampleType' description: The matching sample types '401': description: When no credentials are provided @@ -9072,26 +7209,7 @@ paths: content: application/json: schema: - properties: - COMMENT: - type: string - CREATE_ID: - type: string - CREATE_TIME: - type: string - ENDDATE: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - STARTDATE: - type: string - type: object + $ref: '#/components/schemas/Shift' description: The shifts found '401': description: When no credentials are provided @@ -9107,7 +7225,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/Shift' description: Update one or multiple shifts required: true responses: @@ -9115,26 +7233,7 @@ paths: content: application/json: schema: - properties: - COMMENT: - type: string - CREATE_ID: - type: string - CREATE_TIME: - type: string - ENDDATE: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - STARTDATE: - type: string - type: object + $ref: '#/components/schemas/Shift' description: The updated entity '401': description: When no credentials are provided @@ -9158,26 +7257,7 @@ paths: content: application/json: schema: - properties: - COMMENT: - type: string - CREATE_ID: - type: string - CREATE_TIME: - type: string - ENDDATE: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - STARTDATE: - type: string - type: object + $ref: '#/components/schemas/Shift' description: The created shifts '401': description: When no credentials are provided @@ -9255,26 +7335,7 @@ paths: content: application/json: schema: - properties: - COMMENT: - type: string - CREATE_ID: - type: string - CREATE_TIME: - type: string - ENDDATE: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - STARTDATE: - type: string - type: object + $ref: '#/components/schemas/Shift' description: The matching shifts '401': description: When no credentials are provided @@ -9345,28 +7406,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - STARTDATE: - type: string - STATUS: - type: integer - USER_ID: - type: integer - type: object + $ref: '#/components/schemas/Study' description: The studies found '401': description: When no credentials are provided @@ -9382,7 +7422,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/Study' description: Update one or multiple studies required: true responses: @@ -9390,28 +7430,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - STARTDATE: - type: string - STATUS: - type: integer - USER_ID: - type: integer - type: object + $ref: '#/components/schemas/Study' description: The updated entity '401': description: When no credentials are provided @@ -9435,28 +7454,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - STARTDATE: - type: string - STATUS: - type: integer - USER_ID: - type: integer - type: object + $ref: '#/components/schemas/Study' description: The created studies '401': description: When no credentials are provided @@ -9534,28 +7532,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - STARTDATE: - type: string - STATUS: - type: integer - USER_ID: - type: integer - type: object + $ref: '#/components/schemas/Study' description: The matching studies '401': description: When no credentials are provided @@ -9626,22 +7603,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - STUDY_ID: - type: integer - type: object + $ref: '#/components/schemas/StudyInvestigation' description: The study investigations found '401': description: When no credentials are provided @@ -9657,7 +7619,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/StudyInvestigation' description: Update one or multiple study investigations required: true responses: @@ -9665,22 +7627,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - STUDY_ID: - type: integer - type: object + $ref: '#/components/schemas/StudyInvestigation' description: The updated entity '401': description: When no credentials are provided @@ -9704,22 +7651,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - STUDY_ID: - type: integer - type: object + $ref: '#/components/schemas/StudyInvestigation' description: The created study investigations '401': description: When no credentials are provided @@ -9797,22 +7729,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - STUDY_ID: - type: integer - type: object + $ref: '#/components/schemas/StudyInvestigation' description: The matching study investigations '401': description: When no credentials are provided @@ -9883,22 +7800,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - GROUP_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - USER_ID: - type: integer - type: object + $ref: '#/components/schemas/UserGroup' description: The user groups found '401': description: When no credentials are provided @@ -9914,7 +7816,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/UserGroup' description: Update one or multiple user groups required: true responses: @@ -9922,22 +7824,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - GROUP_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - USER_ID: - type: integer - type: object + $ref: '#/components/schemas/UserGroup' description: The updated entity '401': description: When no credentials are provided @@ -9961,22 +7848,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - GROUP_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - USER_ID: - type: integer - type: object + $ref: '#/components/schemas/UserGroup' description: The created user groups '401': description: When no credentials are provided @@ -10054,22 +7926,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - GROUP_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - USER_ID: - type: integer - type: object + $ref: '#/components/schemas/UserGroup' description: The matching user groups '401': description: When no credentials are provided @@ -10140,26 +7997,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - EMAIL: - type: string - FULLNAME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - ORCIDID: - type: string - type: object + $ref: '#/components/schemas/User' description: The users found '401': description: When no credentials are provided @@ -10175,7 +8013,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/User' description: Update one or multiple users required: true responses: @@ -10183,26 +8021,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - EMAIL: - type: string - FULLNAME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - ORCIDID: - type: string - type: object + $ref: '#/components/schemas/User' description: The updated entity '401': description: When no credentials are provided @@ -10226,26 +8045,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - EMAIL: - type: string - FULLNAME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - ORCIDID: - type: string - type: object + $ref: '#/components/schemas/User' description: The created users '401': description: When no credentials are provided @@ -10323,26 +8123,7 @@ paths: content: application/json: schema: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - EMAIL: - type: string - FULLNAME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - ORCIDID: - type: string - type: object + $ref: '#/components/schemas/User' description: The matching users '401': description: When no credentials are provided From 889e84a575a262aeab7f49bbbbed7e92161159c8 Mon Sep 17 00:00:00 2001 From: Stuart Pullinger Date: Fri, 22 Nov 2019 13:43:17 +0000 Subject: [PATCH 3/4] Retain insertion order when dumping to YAML --- src/swagger/swagger_generator.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/swagger/swagger_generator.py b/src/swagger/swagger_generator.py index 46a100e0..20a4399a 100644 --- a/src/swagger/swagger_generator.py +++ b/src/swagger/swagger_generator.py @@ -327,7 +327,7 @@ def write_swagger_spec(self): swagger_dict = swagger_spec.get_spec_as_dict() yaml.Dumper.ignore_aliases = lambda *args: True with open(SwaggerGenerator.FILE_PATH, "w+") as target: - target.write(yaml.dump(swagger_dict)) + target.write(yaml.dump(swagger_dict, sort_keys=False)) target.close() From 351f7e870823dfbea5cf91e13ca7a7f4d55f7f2c Mon Sep 17 00:00:00 2001 From: Stuart Pullinger Date: Fri, 22 Nov 2019 13:45:22 +0000 Subject: [PATCH 4/4] Updated openapi.yaml with entries in insertion order --- src/swagger/openapi.yaml | 8060 +++++++++++++++++++------------------- 1 file changed, 4030 insertions(+), 4030 deletions(-) diff --git a/src/swagger/openapi.yaml b/src/swagger/openapi.yaml index 5ddac4cd..d0e7411b 100644 --- a/src/swagger/openapi.yaml +++ b/src/swagger/openapi.yaml @@ -1,8138 +1,8138 @@ -components: - schemas: - Application: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - VERSION: - type: string - type: object - DataCollection: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DOI: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object - DataCollectionDatafile: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATACOLLECTION_ID: - type: integer - DATAFILE_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object - DataCollectionDataset: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATACOLLECTION_ID: - type: integer - DATASET_ID: - type: integer - ID: +openapi: 3.0.0 +info: + title: DataGateway API + description: ICAT API to interface with the DataGateway + version: '0' +servers: +- url: http://localhost:5000 +paths: + /applications/count: + get: + summary: Return the count of the applications + tags: + - entities + parameters: + - description: Apply a where filter to all entities. The filter can take the + form of {"field":{:"value"}, where the possible operators are + like, gte, lte, in and eq + in: query + required: false + name: where + schema: + type: object + example: + ID: + eq: 1 + - description: Return unique values for the fields requested + in: query + required: false + name: distinct + schema: + type: object + example: + - FIELD 1 + - FIELD 2 + responses: + '200': + description: The count of the applications + '401': + description: When no credentials are provided + '403': + description: When bad credentials are given + /applications/{id}: + get: + summary: Find the applications matching the ID + tags: + - entities + parameters: + - description: The id of an entity + in: path + required: true + name: id + schema: type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object - DataCollectionParameter: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATACOLLECTION_ID: + example: 4 + responses: + '200': + description: The matching applications + content: + application/json: + schema: + $ref: '#/components/schemas/Application' + '404': + description: When no result is found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + delete: + summary: Delete the applications matching the ID + tags: + - entities + parameters: + - description: The id of an entity + in: path + required: true + name: id + schema: type: integer - DATETIME_VALUE: - type: string - ERROR: + example: 4 + responses: + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + /applications: + get: + summary: Get applications based on filters + tags: + - entities + parameters: + - description: Apply a where filter to all entities. The filter can take the + form of {"field":{:"value"}, where the possible operators are + like, gte, lte, in and eq + in: query + required: false + name: where + schema: + type: object + example: + ID: + eq: 1 + - description: Return unique values for the fields requested + in: query + required: false + name: distinct + schema: + type: object + example: + - FIELD 1 + - FIELD 2 + - description: Given the names of related entities, include them in the results. + Only one include parameter is allowed + in: query + required: false + name: include + schema: + type: object + example: + Relation 1: + - Relation A + - Relation B + - description: Limit the number of entities returned + in: query + required: false + name: limit + schema: type: number - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: + example: 4 + - description: Given a field and direction, order the returned entities + in: query + required: false + name: order + schema: type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: + example: ID DESC + - description: Offset the returned entities by a given number + in: query + required: false + name: skip + schema: type: number - STRING_VALUE: - type: string - type: object - Datafile: - properties: - CHECKSUM: - type: string - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATAFILECREATETIME: - type: string - DATAFILEFORMAT_ID: - type: integer - DATAFILEMODTIME: - type: string - DATASET_ID: - type: integer - DESCRIPTION: - type: string - DOI: - type: string - FILESIZE: - type: integer - ID: - type: integer - LOCATION: - type: string - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object - DatafileFormat: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - ID: + example: 5 + responses: + '200': + description: The applications found + content: + application/json: + schema: + $ref: '#/components/schemas/Application' + '404': + description: When no results are found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + post: + summary: Add new applications + tags: + - entities + requestBody: + description: Create one or multiple applications + required: true + content: + application/json: + schema: + type: object + responses: + '200': + description: The created applications + content: + application/json: + schema: + $ref: '#/components/schemas/Application' + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + patch: + summary: Update applications + tags: + - entities + requestBody: + description: Update one or multiple applications + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Application' + responses: + '200': + description: The updated entity + content: + application/json: + schema: + $ref: '#/components/schemas/Application' + '404': + description: When the entity to update could not be found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + /datacollectiondatafiles/count: + get: + summary: Return the count of the data collection datafiles + tags: + - entities + parameters: + - description: Apply a where filter to all entities. The filter can take the + form of {"field":{:"value"}, where the possible operators are + like, gte, lte, in and eq + in: query + required: false + name: where + schema: + type: object + example: + ID: + eq: 1 + - description: Return unique values for the fields requested + in: query + required: false + name: distinct + schema: + type: object + example: + - FIELD 1 + - FIELD 2 + responses: + '200': + description: The count of the data collection datafiles + '401': + description: When no credentials are provided + '403': + description: When bad credentials are given + /datacollectiondatafiles/{id}: + get: + summary: Find the data collection datafiles matching the ID + tags: + - entities + parameters: + - description: The id of an entity + in: path + required: true + name: id + schema: type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - TYPE: - type: string - VERSION: - type: string - type: object - DatafileParameter: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATAFILE_ID: + example: 4 + responses: + '200': + description: The matching data collection datafiles + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollectionDatafile' + '404': + description: When no result is found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + delete: + summary: Delete the data collection datafiles matching the ID + tags: + - entities + parameters: + - description: The id of an entity + in: path + required: true + name: id + schema: type: integer - DATETIME_VALUE: - type: string - ERROR: + example: 4 + responses: + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + /datacollectiondatafiles: + get: + summary: Get data collection datafiles based on filters + tags: + - entities + parameters: + - description: Apply a where filter to all entities. The filter can take the + form of {"field":{:"value"}, where the possible operators are + like, gte, lte, in and eq + in: query + required: false + name: where + schema: + type: object + example: + ID: + eq: 1 + - description: Return unique values for the fields requested + in: query + required: false + name: distinct + schema: + type: object + example: + - FIELD 1 + - FIELD 2 + - description: Given the names of related entities, include them in the results. + Only one include parameter is allowed + in: query + required: false + name: include + schema: + type: object + example: + Relation 1: + - Relation A + - Relation B + - description: Limit the number of entities returned + in: query + required: false + name: limit + schema: type: number - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: + example: 4 + - description: Given a field and direction, order the returned entities + in: query + required: false + name: order + schema: type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: + example: ID DESC + - description: Offset the returned entities by a given number + in: query + required: false + name: skip + schema: type: number - STRING_VALUE: - type: string - type: object - Dataset: - properties: - COMPLETE: - type: boolean - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - DOI: - type: string - END_DATE: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - LOCATION: - type: string - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - SAMPLE_ID: - type: integer - STARTDATE: - type: string - TYPE_ID: - type: integer - type: object - DatasetType: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object - Facility: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DAYSUNTILRELEASE: - type: integer - DESCRIPTION: - type: string - FULLNAME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - URL: - type: string - type: object - FacilityCycle: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - ENDDATE: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - STARTDATE: - type: string - type: object - Grouping: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object - Instrument: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - FULLNAME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - TYPE: - type: string - URL: - type: string - type: object - InstrumentScientist: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INSTRUMENT_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - USER_ID: - type: integer - type: object - Investigation: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DOI: - type: string - ENDDATE: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - RELEASEDATE: - type: string - STARTDATE: - type: string - SUMMARY: - type: string - TITLE: - type: string - TYPE_ID: - type: integer - VISIT_ID: - type: string - type: object - InvestigationGroup: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - GROUP_ID: - type: integer - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - ROLE: - type: string - type: object - InvestigationInstrument: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INSTRUMENT_ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - type: object - InvestigationParameter: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - STRING_VALUE: - type: string - type: object - InvestigationType: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object - InvestigationUser: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - ROLE: - type: string - USER_ID: - type: integer - type: object - Job: - properties: - APPLICATION_ID: - type: integer - ARGUMENTS: - type: string - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INPUTDATACOLLECTION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - OUTPUTDATACOLLECTION_ID: - type: integer - type: object - Keyword: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - type: object - ParameterType: - properties: - APPLICABLETODATACOLLECTION: - type: boolean - APPLICABLETODATAFILE: - type: boolean - APPLICABLETODATASET: - type: boolean - APPLICABLETOINVESTIGATION: - type: boolean - APPLICABLETOSAMPLE: - type: boolean - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - ENFORCED: - type: boolean - FACILITY_ID: - type: integer - ID: - type: integer - MAXIMUMNUMERICVALUE: - type: number - MINIMUMNUMERICVALUE: - type: number - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - UNITS: - type: string - UNITSFULLNAME: - type: string - VALUETYPE: - type: integer - VERIFIED: - type: boolean - type: object - PermissibleStringValue: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - PARAMETERTYPE_ID: - type: integer - VALUE: - type: string - type: object - PublicStep: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - FIELD: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - ORIGIN: - type: string - type: object - Publication: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DOI: - type: string - FULLREFERENCE: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - REPOSITORY: - type: string - REPOSITORYID: - type: string - URL: - type: string - type: object - RelatedDatafile: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DEST_DATAFILE_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - RELATION: - type: string - SOURCE_DATAFILE_ID: - type: integer - type: object - Rule: - properties: - ATTRIBUTE: - type: string - BEAN: - type: string - C: - type: integer - CREATE_ID: - type: string - CREATE_TIME: - type: string - CRUDFLAGS: - type: string - CRUDJPQL: - type: string - D: - type: integer - GROUPING_ID: - type: integer - ID: - type: integer - INCLUDEJPQL: - type: string - MOD_ID: - type: string - MOD_TIME: - type: string - R: - type: integer - RESTRICTED: - type: integer - SEARCHJPQL: - type: string - U: - type: integer - WHAT: - type: string - type: object - Sample: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - SAMPLETYPE_ID: - type: integer - type: object - SampleParameter: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DATETIME_VALUE: - type: string - ERROR: - type: number - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NUMERIC_VALUE: - type: number - PARAMETER_TYPE_ID: - type: integer - RANGEBOTTOM: - type: number - RANGETOP: - type: number - SAMPLE_ID: - type: integer - STRING_VALUE: - type: string - type: object - SampleType: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - FACILITY_ID: - type: integer - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - MOLECULARFORMULA: - type: string - NAME: - type: string - SAFETYINFORMATION: - type: string - type: object - Shift: - properties: - COMMENT: - type: string - CREATE_ID: - type: string - CREATE_TIME: - type: string - ENDDATE: - type: string - ID: - type: integer - INVESTIGATION_ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - STARTDATE: - type: string - type: object - Study: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - DESCRIPTION: - type: string - ID: - type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - STARTDATE: - type: string - STATUS: + example: 5 + responses: + '200': + description: The data collection datafiles found + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollectionDatafile' + '404': + description: When no results are found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + post: + summary: Add new data collection datafiles + tags: + - entities + requestBody: + description: Create one or multiple data collection datafiles + required: true + content: + application/json: + schema: + type: object + responses: + '200': + description: The created data collection datafiles + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollectionDatafile' + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + patch: + summary: Update data collection datafiles + tags: + - entities + requestBody: + description: Update one or multiple data collection datafiles + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollectionDatafile' + responses: + '200': + description: The updated entity + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollectionDatafile' + '404': + description: When the entity to update could not be found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + /datacollectiondatasets/count: + get: + summary: Return the count of the data collection datasets + tags: + - entities + parameters: + - description: Apply a where filter to all entities. The filter can take the + form of {"field":{:"value"}, where the possible operators are + like, gte, lte, in and eq + in: query + required: false + name: where + schema: + type: object + example: + ID: + eq: 1 + - description: Return unique values for the fields requested + in: query + required: false + name: distinct + schema: + type: object + example: + - FIELD 1 + - FIELD 2 + responses: + '200': + description: The count of the data collection datasets + '401': + description: When no credentials are provided + '403': + description: When bad credentials are given + /datacollectiondatasets/{id}: + get: + summary: Find the data collection datasets matching the ID + tags: + - entities + parameters: + - description: The id of an entity + in: path + required: true + name: id + schema: type: integer - USER_ID: + example: 4 + responses: + '200': + description: The matching data collection datasets + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollectionDataset' + '404': + description: When no result is found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + delete: + summary: Delete the data collection datasets matching the ID + tags: + - entities + parameters: + - description: The id of an entity + in: path + required: true + name: id + schema: type: integer - type: object - StudyInvestigation: - properties: - CREATE_ID: - type: string - CREATE_TIME: + example: 4 + responses: + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + /datacollectiondatasets: + get: + summary: Get data collection datasets based on filters + tags: + - entities + parameters: + - description: Apply a where filter to all entities. The filter can take the + form of {"field":{:"value"}, where the possible operators are + like, gte, lte, in and eq + in: query + required: false + name: where + schema: + type: object + example: + ID: + eq: 1 + - description: Return unique values for the fields requested + in: query + required: false + name: distinct + schema: + type: object + example: + - FIELD 1 + - FIELD 2 + - description: Given the names of related entities, include them in the results. + Only one include parameter is allowed + in: query + required: false + name: include + schema: + type: object + example: + Relation 1: + - Relation A + - Relation B + - description: Limit the number of entities returned + in: query + required: false + name: limit + schema: + type: number + example: 4 + - description: Given a field and direction, order the returned entities + in: query + required: false + name: order + schema: type: string - ID: + example: ID DESC + - description: Offset the returned entities by a given number + in: query + required: false + name: skip + schema: + type: number + example: 5 + responses: + '200': + description: The data collection datasets found + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollectionDataset' + '404': + description: When no results are found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + post: + summary: Add new data collection datasets + tags: + - entities + requestBody: + description: Create one or multiple data collection datasets + required: true + content: + application/json: + schema: + type: object + responses: + '200': + description: The created data collection datasets + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollectionDataset' + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + patch: + summary: Update data collection datasets + tags: + - entities + requestBody: + description: Update one or multiple data collection datasets + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollectionDataset' + responses: + '200': + description: The updated entity + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollectionDataset' + '404': + description: When the entity to update could not be found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + /datacollectionparameters/count: + get: + summary: Return the count of the data collection parameters + tags: + - entities + parameters: + - description: Apply a where filter to all entities. The filter can take the + form of {"field":{:"value"}, where the possible operators are + like, gte, lte, in and eq + in: query + required: false + name: where + schema: + type: object + example: + ID: + eq: 1 + - description: Return unique values for the fields requested + in: query + required: false + name: distinct + schema: + type: object + example: + - FIELD 1 + - FIELD 2 + responses: + '200': + description: The count of the data collection parameters + '401': + description: When no credentials are provided + '403': + description: When bad credentials are given + /datacollectionparameters/{id}: + get: + summary: Find the data collection parameters matching the ID + tags: + - entities + parameters: + - description: The id of an entity + in: path + required: true + name: id + schema: type: integer - INVESTIGATION_ID: + example: 4 + responses: + '200': + description: The matching data collection parameters + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollectionParameter' + '404': + description: When no result is found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + delete: + summary: Delete the data collection parameters matching the ID + tags: + - entities + parameters: + - description: The id of an entity + in: path + required: true + name: id + schema: type: integer - MOD_ID: - type: string - MOD_TIME: + example: 4 + responses: + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + /datacollectionparameters: + get: + summary: Get data collection parameters based on filters + tags: + - entities + parameters: + - description: Apply a where filter to all entities. The filter can take the + form of {"field":{:"value"}, where the possible operators are + like, gte, lte, in and eq + in: query + required: false + name: where + schema: + type: object + example: + ID: + eq: 1 + - description: Return unique values for the fields requested + in: query + required: false + name: distinct + schema: + type: object + example: + - FIELD 1 + - FIELD 2 + - description: Given the names of related entities, include them in the results. + Only one include parameter is allowed + in: query + required: false + name: include + schema: + type: object + example: + Relation 1: + - Relation A + - Relation B + - description: Limit the number of entities returned + in: query + required: false + name: limit + schema: + type: number + example: 4 + - description: Given a field and direction, order the returned entities + in: query + required: false + name: order + schema: type: string - STUDY_ID: + example: ID DESC + - description: Offset the returned entities by a given number + in: query + required: false + name: skip + schema: + type: number + example: 5 + responses: + '200': + description: The data collection parameters found + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollectionParameter' + '404': + description: When no results are found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + post: + summary: Add new data collection parameters + tags: + - entities + requestBody: + description: Create one or multiple data collection parameters + required: true + content: + application/json: + schema: + type: object + responses: + '200': + description: The created data collection parameters + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollectionParameter' + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + patch: + summary: Update data collection parameters + tags: + - entities + requestBody: + description: Update one or multiple data collection parameters + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollectionParameter' + responses: + '200': + description: The updated entity + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollectionParameter' + '404': + description: When the entity to update could not be found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + /datacollections/count: + get: + summary: Return the count of the data collections + tags: + - entities + parameters: + - description: Apply a where filter to all entities. The filter can take the + form of {"field":{:"value"}, where the possible operators are + like, gte, lte, in and eq + in: query + required: false + name: where + schema: + type: object + example: + ID: + eq: 1 + - description: Return unique values for the fields requested + in: query + required: false + name: distinct + schema: + type: object + example: + - FIELD 1 + - FIELD 2 + responses: + '200': + description: The count of the data collections + '401': + description: When no credentials are provided + '403': + description: When bad credentials are given + /datacollections/{id}: + get: + summary: Find the data collections matching the ID + tags: + - entities + parameters: + - description: The id of an entity + in: path + required: true + name: id + schema: type: integer - type: object - User: - properties: - CREATE_ID: - type: string - CREATE_TIME: - type: string - EMAIL: - type: string - FULLNAME: - type: string - ID: + example: 4 + responses: + '200': + description: The matching data collections + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollection' + '404': + description: When no result is found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + delete: + summary: Delete the data collections matching the ID + tags: + - entities + parameters: + - description: The id of an entity + in: path + required: true + name: id + schema: type: integer - MOD_ID: - type: string - MOD_TIME: - type: string - NAME: - type: string - ORCIDID: - type: string - type: object - UserGroup: - properties: - CREATE_ID: - type: string - CREATE_TIME: + example: 4 + responses: + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + /datacollections: + get: + summary: Get data collections based on filters + tags: + - entities + parameters: + - description: Apply a where filter to all entities. The filter can take the + form of {"field":{:"value"}, where the possible operators are + like, gte, lte, in and eq + in: query + required: false + name: where + schema: + type: object + example: + ID: + eq: 1 + - description: Return unique values for the fields requested + in: query + required: false + name: distinct + schema: + type: object + example: + - FIELD 1 + - FIELD 2 + - description: Given the names of related entities, include them in the results. + Only one include parameter is allowed + in: query + required: false + name: include + schema: + type: object + example: + Relation 1: + - Relation A + - Relation B + - description: Limit the number of entities returned + in: query + required: false + name: limit + schema: + type: number + example: 4 + - description: Given a field and direction, order the returned entities + in: query + required: false + name: order + schema: type: string - GROUP_ID: + example: ID DESC + - description: Offset the returned entities by a given number + in: query + required: false + name: skip + schema: + type: number + example: 5 + responses: + '200': + description: The data collections found + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollection' + '404': + description: When no results are found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + post: + summary: Add new data collections + tags: + - entities + requestBody: + description: Create one or multiple data collections + required: true + content: + application/json: + schema: + type: object + responses: + '200': + description: The created data collections + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollection' + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + patch: + summary: Update data collections + tags: + - entities + requestBody: + description: Update one or multiple data collections + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollection' + responses: + '200': + description: The updated entity + content: + application/json: + schema: + $ref: '#/components/schemas/DataCollection' + '404': + description: When the entity to update could not be found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + /datafileformats/count: + get: + summary: Return the count of the datafile formats + tags: + - entities + parameters: + - description: Apply a where filter to all entities. The filter can take the + form of {"field":{:"value"}, where the possible operators are + like, gte, lte, in and eq + in: query + required: false + name: where + schema: + type: object + example: + ID: + eq: 1 + - description: Return unique values for the fields requested + in: query + required: false + name: distinct + schema: + type: object + example: + - FIELD 1 + - FIELD 2 + responses: + '200': + description: The count of the datafile formats + '401': + description: When no credentials are provided + '403': + description: When bad credentials are given + /datafileformats/{id}: + get: + summary: Find the datafile formats matching the ID + tags: + - entities + parameters: + - description: The id of an entity + in: path + required: true + name: id + schema: type: integer - ID: + example: 4 + responses: + '200': + description: The matching datafile formats + content: + application/json: + schema: + $ref: '#/components/schemas/DatafileFormat' + '404': + description: When no result is found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + delete: + summary: Delete the datafile formats matching the ID + tags: + - entities + parameters: + - description: The id of an entity + in: path + required: true + name: id + schema: type: integer - MOD_ID: - type: string - MOD_TIME: + example: 4 + responses: + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + /datafileformats: + get: + summary: Get datafile formats based on filters + tags: + - entities + parameters: + - description: Apply a where filter to all entities. The filter can take the + form of {"field":{:"value"}, where the possible operators are + like, gte, lte, in and eq + in: query + required: false + name: where + schema: + type: object + example: + ID: + eq: 1 + - description: Return unique values for the fields requested + in: query + required: false + name: distinct + schema: + type: object + example: + - FIELD 1 + - FIELD 2 + - description: Given the names of related entities, include them in the results. + Only one include parameter is allowed + in: query + required: false + name: include + schema: + type: object + example: + Relation 1: + - Relation A + - Relation B + - description: Limit the number of entities returned + in: query + required: false + name: limit + schema: + type: number + example: 4 + - description: Given a field and direction, order the returned entities + in: query + required: false + name: order + schema: type: string - USER_ID: - type: integer - type: object -info: - description: ICAT API to interface with the DataGateway - title: DataGateway API - version: '0' -openapi: 3.0.0 -paths: - /applications: + example: ID DESC + - description: Offset the returned entities by a given number + in: query + required: false + name: skip + schema: + type: number + example: 5 + responses: + '200': + description: The datafile formats found + content: + application/json: + schema: + $ref: '#/components/schemas/DatafileFormat' + '404': + description: When no results are found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + post: + summary: Add new datafile formats + tags: + - entities + requestBody: + description: Create one or multiple datafile formats + required: true + content: + application/json: + schema: + type: object + responses: + '200': + description: The created datafile formats + content: + application/json: + schema: + $ref: '#/components/schemas/DatafileFormat' + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + patch: + summary: Update datafile formats + tags: + - entities + requestBody: + description: Update one or multiple datafile formats + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DatafileFormat' + responses: + '200': + description: The updated entity + content: + application/json: + schema: + $ref: '#/components/schemas/DatafileFormat' + '404': + description: When the entity to update could not be found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + /datafileparameters/count: get: + summary: Return the count of the datafile parameters + tags: + - entities parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 + responses: + '200': + description: The count of the datafile parameters + '401': + description: When no credentials are provided + '403': + description: When bad credentials are given + /datafileparameters/{id}: + get: + summary: Find the datafile parameters matching the ID + tags: + - entities + parameters: + - description: The id of an entity + in: path + required: true + name: id + schema: + type: integer + example: 4 + responses: + '200': + description: The matching datafile parameters + content: + application/json: + schema: + $ref: '#/components/schemas/DatafileParameter' + '404': + description: When no result is found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + delete: + summary: Delete the datafile parameters matching the ID + tags: + - entities + parameters: + - description: The id of an entity + in: path + required: true + name: id + schema: + type: integer + example: 4 + responses: + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided + /datafileparameters: + get: + summary: Get datafile parameters based on filters + tags: + - entities + parameters: + - description: Apply a where filter to all entities. The filter can take the + form of {"field":{:"value"}, where the possible operators are + like, gte, lte, in and eq + in: query + required: false + name: where + schema: + type: object + example: + ID: + eq: 1 + - description: Return unique values for the fields requested + in: query + required: false + name: distinct + schema: type: object + example: + - FIELD 1 + - FIELD 2 - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The datafile parameters found content: application/json: schema: - $ref: '#/components/schemas/Application' - description: The applications found + $ref: '#/components/schemas/DatafileParameter' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get applications based on filters + post: + summary: Add new datafile parameters tags: - entities - patch: requestBody: + description: Create one or multiple datafile parameters + required: true content: application/json: schema: - $ref: '#/components/schemas/Application' - description: Update one or multiple applications - required: true + type: object responses: '200': + description: The created datafile parameters content: application/json: schema: - $ref: '#/components/schemas/Application' - description: The updated entity + $ref: '#/components/schemas/DatafileParameter' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update applications + patch: + summary: Update datafile parameters tags: - entities - post: requestBody: + description: Update one or multiple datafile parameters + required: true content: application/json: schema: - type: object - description: Create one or multiple applications - required: true + $ref: '#/components/schemas/DatafileParameter' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/Application' - description: The created applications + $ref: '#/components/schemas/DatafileParameter' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new applications + /datafiles/count: + get: + summary: Return the count of the datafiles tags: - entities - /applications/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the applications + description: The count of the datafiles '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the applications + /datafiles/{id}: + get: + summary: Find the datafiles matching the ID tags: - entities - /applications/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching datafiles + content: + application/json: + schema: + $ref: '#/components/schemas/Datafile' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the applications matching the ID + delete: + summary: Delete the datafiles matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Application' - description: The matching applications + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the applications matching the ID + /datafiles: + get: + summary: Get datafiles based on filters tags: - entities - /datacollectiondatafiles: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The datafiles found content: application/json: schema: - $ref: '#/components/schemas/DataCollectionDatafile' - description: The data collection datafiles found + $ref: '#/components/schemas/Datafile' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get data collection datafiles based on filters + post: + summary: Add new datafiles tags: - entities - patch: requestBody: + description: Create one or multiple datafiles + required: true content: application/json: schema: - $ref: '#/components/schemas/DataCollectionDatafile' - description: Update one or multiple data collection datafiles - required: true + type: object responses: '200': + description: The created datafiles content: application/json: schema: - $ref: '#/components/schemas/DataCollectionDatafile' - description: The updated entity + $ref: '#/components/schemas/Datafile' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update data collection datafiles + patch: + summary: Update datafiles tags: - entities - post: requestBody: + description: Update one or multiple datafiles + required: true content: application/json: schema: - type: object - description: Create one or multiple data collection datafiles - required: true + $ref: '#/components/schemas/Datafile' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/DataCollectionDatafile' - description: The created data collection datafiles + $ref: '#/components/schemas/Datafile' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new data collection datafiles + /datasettypes/count: + get: + summary: Return the count of the dataset types tags: - entities - /datacollectiondatafiles/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the data collection datafiles + description: The count of the dataset types '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the data collection datafiles + /datasettypes/{id}: + get: + summary: Find the dataset types matching the ID tags: - entities - /datacollectiondatafiles/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching dataset types + content: + application/json: + schema: + $ref: '#/components/schemas/DatasetType' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the data collection datafiles matching the ID + delete: + summary: Delete the dataset types matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DataCollectionDatafile' - description: The matching data collection datafiles + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the data collection datafiles matching the ID + /datasettypes: + get: + summary: Get dataset types based on filters tags: - entities - /datacollectiondatasets: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The dataset types found content: application/json: schema: - $ref: '#/components/schemas/DataCollectionDataset' - description: The data collection datasets found + $ref: '#/components/schemas/DatasetType' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get data collection datasets based on filters + post: + summary: Add new dataset types tags: - entities - patch: requestBody: + description: Create one or multiple dataset types + required: true content: application/json: schema: - $ref: '#/components/schemas/DataCollectionDataset' - description: Update one or multiple data collection datasets - required: true + type: object responses: '200': + description: The created dataset types content: application/json: schema: - $ref: '#/components/schemas/DataCollectionDataset' - description: The updated entity + $ref: '#/components/schemas/DatasetType' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update data collection datasets + patch: + summary: Update dataset types tags: - entities - post: requestBody: + description: Update one or multiple dataset types + required: true content: application/json: schema: - type: object - description: Create one or multiple data collection datasets - required: true + $ref: '#/components/schemas/DatasetType' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/DataCollectionDataset' - description: The created data collection datasets + $ref: '#/components/schemas/DatasetType' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new data collection datasets + /datasets/count: + get: + summary: Return the count of the datasets tags: - entities - /datacollectiondatasets/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the data collection datasets + description: The count of the datasets '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the data collection datasets + /datasets/{id}: + get: + summary: Find the datasets matching the ID tags: - entities - /datacollectiondatasets/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching datasets + content: + application/json: + schema: + $ref: '#/components/schemas/Dataset' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the data collection datasets matching the ID + delete: + summary: Delete the datasets matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DataCollectionDataset' - description: The matching data collection datasets + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the data collection datasets matching the ID + /datasets: + get: + summary: Get datasets based on filters tags: - entities - /datacollectionparameters: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The datasets found content: application/json: schema: - $ref: '#/components/schemas/DataCollectionParameter' - description: The data collection parameters found + $ref: '#/components/schemas/Dataset' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get data collection parameters based on filters + post: + summary: Add new datasets tags: - entities - patch: requestBody: + description: Create one or multiple datasets + required: true content: application/json: schema: - $ref: '#/components/schemas/DataCollectionParameter' - description: Update one or multiple data collection parameters - required: true + type: object responses: '200': + description: The created datasets content: application/json: schema: - $ref: '#/components/schemas/DataCollectionParameter' - description: The updated entity + $ref: '#/components/schemas/Dataset' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update data collection parameters + patch: + summary: Update datasets tags: - entities - post: requestBody: + description: Update one or multiple datasets + required: true content: application/json: schema: - type: object - description: Create one or multiple data collection parameters - required: true + $ref: '#/components/schemas/Dataset' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/DataCollectionParameter' - description: The created data collection parameters + $ref: '#/components/schemas/Dataset' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new data collection parameters + /facilities/count: + get: + summary: Return the count of the facilities tags: - entities - /datacollectionparameters/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the data collection parameters + description: The count of the facilities '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the data collection parameters + /facilities/{id}: + get: + summary: Find the facilities matching the ID tags: - entities - /datacollectionparameters/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching facilities + content: + application/json: + schema: + $ref: '#/components/schemas/Facility' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the data collection parameters matching the ID + delete: + summary: Delete the facilities matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DataCollectionParameter' - description: The matching data collection parameters + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the data collection parameters matching the ID + /facilities: + get: + summary: Get facilities based on filters tags: - entities - /datacollections: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The facilities found content: application/json: schema: - $ref: '#/components/schemas/DataCollection' - description: The data collections found + $ref: '#/components/schemas/Facility' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get data collections based on filters + post: + summary: Add new facilities tags: - entities - patch: requestBody: + description: Create one or multiple facilities + required: true content: application/json: schema: - $ref: '#/components/schemas/DataCollection' - description: Update one or multiple data collections - required: true + type: object responses: '200': + description: The created facilities content: application/json: schema: - $ref: '#/components/schemas/DataCollection' - description: The updated entity + $ref: '#/components/schemas/Facility' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update data collections + patch: + summary: Update facilities tags: - entities - post: requestBody: + description: Update one or multiple facilities + required: true content: application/json: schema: - type: object - description: Create one or multiple data collections - required: true + $ref: '#/components/schemas/Facility' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/DataCollection' - description: The created data collections + $ref: '#/components/schemas/Facility' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new data collections + /facilitycycles/count: + get: + summary: Return the count of the facility cycles tags: - entities - /datacollections/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the data collections + description: The count of the facility cycles '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the data collections + /facilitycycles/{id}: + get: + summary: Find the facility cycles matching the ID tags: - entities - /datacollections/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching facility cycles + content: + application/json: + schema: + $ref: '#/components/schemas/FacilityCycle' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the data collections matching the ID + delete: + summary: Delete the facility cycles matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DataCollection' - description: The matching data collections + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the data collections matching the ID + /facilitycycles: + get: + summary: Get facility cycles based on filters tags: - entities - /datafileformats: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The facility cycles found content: application/json: schema: - $ref: '#/components/schemas/DatafileFormat' - description: The datafile formats found + $ref: '#/components/schemas/FacilityCycle' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get datafile formats based on filters + post: + summary: Add new facility cycles tags: - entities - patch: requestBody: + description: Create one or multiple facility cycles + required: true content: application/json: schema: - $ref: '#/components/schemas/DatafileFormat' - description: Update one or multiple datafile formats - required: true + type: object responses: '200': + description: The created facility cycles content: application/json: schema: - $ref: '#/components/schemas/DatafileFormat' - description: The updated entity + $ref: '#/components/schemas/FacilityCycle' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update datafile formats + patch: + summary: Update facility cycles tags: - entities - post: requestBody: + description: Update one or multiple facility cycles + required: true content: application/json: schema: - type: object - description: Create one or multiple datafile formats - required: true + $ref: '#/components/schemas/FacilityCycle' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/DatafileFormat' - description: The created datafile formats + $ref: '#/components/schemas/FacilityCycle' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new datafile formats + /groupings/count: + get: + summary: Return the count of the groupings tags: - entities - /datafileformats/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the datafile formats + description: The count of the groupings '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the datafile formats + /groupings/{id}: + get: + summary: Find the groupings matching the ID tags: - entities - /datafileformats/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching groupings + content: + application/json: + schema: + $ref: '#/components/schemas/Grouping' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the datafile formats matching the ID + delete: + summary: Delete the groupings matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DatafileFormat' - description: The matching datafile formats + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the datafile formats matching the ID + /groupings: + get: + summary: Get groupings based on filters tags: - entities - /datafileparameters: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The groupings found content: application/json: schema: - $ref: '#/components/schemas/DatafileParameter' - description: The datafile parameters found + $ref: '#/components/schemas/Grouping' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get datafile parameters based on filters + post: + summary: Add new groupings tags: - entities - patch: requestBody: + description: Create one or multiple groupings + required: true content: application/json: schema: - $ref: '#/components/schemas/DatafileParameter' - description: Update one or multiple datafile parameters - required: true + type: object responses: '200': + description: The created groupings content: application/json: schema: - $ref: '#/components/schemas/DatafileParameter' - description: The updated entity + $ref: '#/components/schemas/Grouping' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update datafile parameters + patch: + summary: Update groupings tags: - entities - post: requestBody: + description: Update one or multiple groupings + required: true content: application/json: schema: - type: object - description: Create one or multiple datafile parameters - required: true + $ref: '#/components/schemas/Grouping' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/DatafileParameter' - description: The created datafile parameters + $ref: '#/components/schemas/Grouping' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new datafile parameters + /instrumentscientists/count: + get: + summary: Return the count of the instrument scientists tags: - entities - /datafileparameters/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the datafile parameters + description: The count of the instrument scientists '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the datafile parameters + /instrumentscientists/{id}: + get: + summary: Find the instrument scientists matching the ID tags: - entities - /datafileparameters/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching instrument scientists + content: + application/json: + schema: + $ref: '#/components/schemas/InstrumentScientist' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the datafile parameters matching the ID + delete: + summary: Delete the instrument scientists matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DatafileParameter' - description: The matching datafile parameters + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the datafile parameters matching the ID + /instrumentscientists: + get: + summary: Get instrument scientists based on filters tags: - entities - /datafiles: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The instrument scientists found content: application/json: schema: - $ref: '#/components/schemas/Datafile' - description: The datafiles found + $ref: '#/components/schemas/InstrumentScientist' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get datafiles based on filters + post: + summary: Add new instrument scientists tags: - entities - patch: requestBody: + description: Create one or multiple instrument scientists + required: true content: application/json: schema: - $ref: '#/components/schemas/Datafile' - description: Update one or multiple datafiles - required: true + type: object responses: '200': + description: The created instrument scientists content: application/json: schema: - $ref: '#/components/schemas/Datafile' - description: The updated entity + $ref: '#/components/schemas/InstrumentScientist' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update datafiles + patch: + summary: Update instrument scientists tags: - entities - post: requestBody: + description: Update one or multiple instrument scientists + required: true content: application/json: schema: - type: object - description: Create one or multiple datafiles - required: true + $ref: '#/components/schemas/InstrumentScientist' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/Datafile' - description: The created datafiles + $ref: '#/components/schemas/InstrumentScientist' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new datafiles + /instruments/count: + get: + summary: Return the count of the instruments tags: - entities - /datafiles/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the datafiles + description: The count of the instruments '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the datafiles + /instruments/{id}: + get: + summary: Find the instruments matching the ID tags: - entities - /datafiles/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching instruments + content: + application/json: + schema: + $ref: '#/components/schemas/Instrument' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the datafiles matching the ID + delete: + summary: Delete the instruments matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Datafile' - description: The matching datafiles + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the datafiles matching the ID + /instruments: + get: + summary: Get instruments based on filters tags: - entities - /datasets: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The instruments found content: application/json: schema: - $ref: '#/components/schemas/Dataset' - description: The datasets found + $ref: '#/components/schemas/Instrument' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get datasets based on filters + post: + summary: Add new instruments tags: - entities - patch: requestBody: + description: Create one or multiple instruments + required: true content: application/json: schema: - $ref: '#/components/schemas/Dataset' - description: Update one or multiple datasets - required: true + type: object responses: '200': + description: The created instruments content: application/json: schema: - $ref: '#/components/schemas/Dataset' - description: The updated entity + $ref: '#/components/schemas/Instrument' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update datasets + patch: + summary: Update instruments tags: - entities - post: requestBody: + description: Update one or multiple instruments + required: true content: application/json: schema: - type: object - description: Create one or multiple datasets - required: true + $ref: '#/components/schemas/Instrument' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/Dataset' - description: The created datasets + $ref: '#/components/schemas/Instrument' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new datasets + /investigationgroups/count: + get: + summary: Return the count of the investigation groups tags: - entities - /datasets/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the datasets + description: The count of the investigation groups '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the datasets + /investigationgroups/{id}: + get: + summary: Find the investigation groups matching the ID tags: - entities - /datasets/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching investigation groups + content: + application/json: + schema: + $ref: '#/components/schemas/InvestigationGroup' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the datasets matching the ID + delete: + summary: Delete the investigation groups matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Dataset' - description: The matching datasets + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the datasets matching the ID + /investigationgroups: + get: + summary: Get investigation groups based on filters tags: - entities - /datasettypes: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The investigation groups found content: application/json: schema: - $ref: '#/components/schemas/DatasetType' - description: The dataset types found + $ref: '#/components/schemas/InvestigationGroup' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get dataset types based on filters + post: + summary: Add new investigation groups tags: - entities - patch: requestBody: + description: Create one or multiple investigation groups + required: true content: application/json: schema: - $ref: '#/components/schemas/DatasetType' - description: Update one or multiple dataset types - required: true + type: object responses: '200': + description: The created investigation groups content: application/json: schema: - $ref: '#/components/schemas/DatasetType' - description: The updated entity + $ref: '#/components/schemas/InvestigationGroup' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update dataset types + patch: + summary: Update investigation groups tags: - entities - post: requestBody: + description: Update one or multiple investigation groups + required: true content: application/json: schema: - type: object - description: Create one or multiple dataset types - required: true + $ref: '#/components/schemas/InvestigationGroup' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/DatasetType' - description: The created dataset types + $ref: '#/components/schemas/InvestigationGroup' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new dataset types + /investigationinstruments/count: + get: + summary: Return the count of the investigation instruments tags: - entities - /datasettypes/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the dataset types + description: The count of the investigation instruments '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the dataset types + /investigationinstruments/{id}: + get: + summary: Find the investigation instruments matching the ID tags: - entities - /datasettypes/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching investigation instruments + content: + application/json: + schema: + $ref: '#/components/schemas/InvestigationInstrument' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the dataset types matching the ID + delete: + summary: Delete the investigation instruments matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DatasetType' - description: The matching dataset types + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the dataset types matching the ID + /investigationinstruments: + get: + summary: Get investigation instruments based on filters tags: - entities - /facilities: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The investigation instruments found content: application/json: schema: - $ref: '#/components/schemas/Facility' - description: The facilities found + $ref: '#/components/schemas/InvestigationInstrument' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get facilities based on filters + post: + summary: Add new investigation instruments tags: - entities - patch: requestBody: + description: Create one or multiple investigation instruments + required: true content: application/json: schema: - $ref: '#/components/schemas/Facility' - description: Update one or multiple facilities - required: true + type: object responses: '200': + description: The created investigation instruments content: application/json: schema: - $ref: '#/components/schemas/Facility' - description: The updated entity + $ref: '#/components/schemas/InvestigationInstrument' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update facilities + patch: + summary: Update investigation instruments tags: - entities - post: requestBody: + description: Update one or multiple investigation instruments + required: true content: application/json: schema: - type: object - description: Create one or multiple facilities - required: true + $ref: '#/components/schemas/InvestigationInstrument' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/Facility' - description: The created facilities + $ref: '#/components/schemas/InvestigationInstrument' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new facilities + /investigationparameters/count: + get: + summary: Return the count of the investigation parameters tags: - entities - /facilities/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the facilities + description: The count of the investigation parameters '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the facilities + /investigationparameters/{id}: + get: + summary: Find the investigation parameters matching the ID tags: - entities - /facilities/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching investigation parameters + content: + application/json: + schema: + $ref: '#/components/schemas/InvestigationParameter' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the facilities matching the ID + delete: + summary: Delete the investigation parameters matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Facility' - description: The matching facilities + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the facilities matching the ID + /investigationparameters: + get: + summary: Get investigation parameters based on filters tags: - entities - /facilitycycles: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The investigation parameters found content: application/json: schema: - $ref: '#/components/schemas/FacilityCycle' - description: The facility cycles found + $ref: '#/components/schemas/InvestigationParameter' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get facility cycles based on filters + post: + summary: Add new investigation parameters tags: - entities - patch: requestBody: + description: Create one or multiple investigation parameters + required: true content: application/json: schema: - $ref: '#/components/schemas/FacilityCycle' - description: Update one or multiple facility cycles - required: true + type: object responses: '200': + description: The created investigation parameters content: application/json: schema: - $ref: '#/components/schemas/FacilityCycle' - description: The updated entity + $ref: '#/components/schemas/InvestigationParameter' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update facility cycles + patch: + summary: Update investigation parameters tags: - entities - post: requestBody: + description: Update one or multiple investigation parameters + required: true content: application/json: schema: - type: object - description: Create one or multiple facility cycles - required: true + $ref: '#/components/schemas/InvestigationParameter' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/FacilityCycle' - description: The created facility cycles + $ref: '#/components/schemas/InvestigationParameter' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new facility cycles + /investigationtypes/count: + get: + summary: Return the count of the investigation types tags: - entities - /facilitycycles/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the facility cycles + description: The count of the investigation types '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the facility cycles + /investigationtypes/{id}: + get: + summary: Find the investigation types matching the ID tags: - entities - /facilitycycles/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching investigation types + content: + application/json: + schema: + $ref: '#/components/schemas/InvestigationType' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the facility cycles matching the ID + delete: + summary: Delete the investigation types matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/FacilityCycle' - description: The matching facility cycles + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the facility cycles matching the ID + /investigationtypes: + get: + summary: Get investigation types based on filters tags: - entities - /groupings: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The investigation types found content: application/json: schema: - $ref: '#/components/schemas/Grouping' - description: The groupings found + $ref: '#/components/schemas/InvestigationType' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get groupings based on filters + post: + summary: Add new investigation types tags: - entities - patch: requestBody: + description: Create one or multiple investigation types + required: true content: application/json: schema: - $ref: '#/components/schemas/Grouping' - description: Update one or multiple groupings - required: true + type: object responses: '200': + description: The created investigation types content: application/json: schema: - $ref: '#/components/schemas/Grouping' - description: The updated entity + $ref: '#/components/schemas/InvestigationType' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update groupings + patch: + summary: Update investigation types tags: - entities - post: requestBody: + description: Update one or multiple investigation types + required: true content: application/json: schema: - type: object - description: Create one or multiple groupings - required: true + $ref: '#/components/schemas/InvestigationType' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/Grouping' - description: The created groupings + $ref: '#/components/schemas/InvestigationType' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new groupings + /investigationusers/count: + get: + summary: Return the count of the investigation users tags: - entities - /groupings/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the groupings + description: The count of the investigation users '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the groupings + /investigationusers/{id}: + get: + summary: Find the investigation users matching the ID tags: - entities - /groupings/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching investigation users + content: + application/json: + schema: + $ref: '#/components/schemas/InvestigationUser' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the groupings matching the ID + delete: + summary: Delete the investigation users matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Grouping' - description: The matching groupings + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the groupings matching the ID + /investigationusers: + get: + summary: Get investigation users based on filters tags: - entities - /instruments: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The investigation users found content: application/json: schema: - $ref: '#/components/schemas/Instrument' - description: The instruments found + $ref: '#/components/schemas/InvestigationUser' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get instruments based on filters + post: + summary: Add new investigation users tags: - entities - patch: requestBody: + description: Create one or multiple investigation users + required: true content: application/json: schema: - $ref: '#/components/schemas/Instrument' - description: Update one or multiple instruments - required: true + type: object responses: '200': + description: The created investigation users content: application/json: schema: - $ref: '#/components/schemas/Instrument' - description: The updated entity + $ref: '#/components/schemas/InvestigationUser' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update instruments + patch: + summary: Update investigation users tags: - entities - post: requestBody: + description: Update one or multiple investigation users + required: true content: application/json: schema: - type: object - description: Create one or multiple instruments - required: true + $ref: '#/components/schemas/InvestigationUser' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/Instrument' - description: The created instruments + $ref: '#/components/schemas/InvestigationUser' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new instruments + /investigations/count: + get: + summary: Return the count of the investigations tags: - entities - /instruments/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the instruments + description: The count of the investigations '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the instruments + /investigations/{id}: + get: + summary: Find the investigations matching the ID tags: - entities - /instruments/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching investigations + content: + application/json: + schema: + $ref: '#/components/schemas/Investigation' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the instruments matching the ID + delete: + summary: Delete the investigations matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Instrument' - description: The matching instruments + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the instruments matching the ID + /investigations: + get: + summary: Get investigations based on filters tags: - entities - /instrumentscientists: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The investigations found content: application/json: schema: - $ref: '#/components/schemas/InstrumentScientist' - description: The instrument scientists found + $ref: '#/components/schemas/Investigation' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get instrument scientists based on filters + post: + summary: Add new investigations tags: - entities - patch: requestBody: + description: Create one or multiple investigations + required: true content: application/json: schema: - $ref: '#/components/schemas/InstrumentScientist' - description: Update one or multiple instrument scientists - required: true + type: object responses: '200': + description: The created investigations content: application/json: schema: - $ref: '#/components/schemas/InstrumentScientist' - description: The updated entity + $ref: '#/components/schemas/Investigation' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update instrument scientists + patch: + summary: Update investigations tags: - entities - post: requestBody: + description: Update one or multiple investigations + required: true content: application/json: schema: - type: object - description: Create one or multiple instrument scientists - required: true + $ref: '#/components/schemas/Investigation' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/InstrumentScientist' - description: The created instrument scientists + $ref: '#/components/schemas/Investigation' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new instrument scientists + /jobs/count: + get: + summary: Return the count of the jobs tags: - entities - /instrumentscientists/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the instrument scientists + description: The count of the jobs '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the instrument scientists + /jobs/{id}: + get: + summary: Find the jobs matching the ID tags: - entities - /instrumentscientists/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching jobs + content: + application/json: + schema: + $ref: '#/components/schemas/Job' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the instrument scientists matching the ID + delete: + summary: Delete the jobs matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/InstrumentScientist' - description: The matching instrument scientists + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the instrument scientists matching the ID + /jobs: + get: + summary: Get jobs based on filters tags: - entities - /investigationgroups: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The jobs found content: application/json: schema: - $ref: '#/components/schemas/InvestigationGroup' - description: The investigation groups found + $ref: '#/components/schemas/Job' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get investigation groups based on filters + post: + summary: Add new jobs tags: - entities - patch: requestBody: + description: Create one or multiple jobs + required: true content: application/json: schema: - $ref: '#/components/schemas/InvestigationGroup' - description: Update one or multiple investigation groups - required: true + type: object responses: '200': + description: The created jobs content: application/json: schema: - $ref: '#/components/schemas/InvestigationGroup' - description: The updated entity + $ref: '#/components/schemas/Job' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update investigation groups + patch: + summary: Update jobs tags: - entities - post: requestBody: + description: Update one or multiple jobs + required: true content: application/json: schema: - type: object - description: Create one or multiple investigation groups - required: true + $ref: '#/components/schemas/Job' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/InvestigationGroup' - description: The created investigation groups + $ref: '#/components/schemas/Job' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new investigation groups + /keywords/count: + get: + summary: Return the count of the keywords tags: - entities - /investigationgroups/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the investigation groups + description: The count of the keywords '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the investigation groups + /keywords/{id}: + get: + summary: Find the keywords matching the ID tags: - entities - /investigationgroups/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching keywords + content: + application/json: + schema: + $ref: '#/components/schemas/Keyword' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the investigation groups matching the ID + delete: + summary: Delete the keywords matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/InvestigationGroup' - description: The matching investigation groups + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the investigation groups matching the ID + /keywords: + get: + summary: Get keywords based on filters tags: - entities - /investigationinstruments: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The keywords found content: application/json: schema: - $ref: '#/components/schemas/InvestigationInstrument' - description: The investigation instruments found + $ref: '#/components/schemas/Keyword' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get investigation instruments based on filters + post: + summary: Add new keywords tags: - entities - patch: requestBody: + description: Create one or multiple keywords + required: true content: application/json: schema: - $ref: '#/components/schemas/InvestigationInstrument' - description: Update one or multiple investigation instruments - required: true + type: object responses: '200': + description: The created keywords content: application/json: schema: - $ref: '#/components/schemas/InvestigationInstrument' - description: The updated entity + $ref: '#/components/schemas/Keyword' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update investigation instruments + patch: + summary: Update keywords tags: - entities - post: requestBody: + description: Update one or multiple keywords + required: true content: application/json: schema: - type: object - description: Create one or multiple investigation instruments - required: true + $ref: '#/components/schemas/Keyword' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/InvestigationInstrument' - description: The created investigation instruments + $ref: '#/components/schemas/Keyword' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new investigation instruments + /parametertypes/count: + get: + summary: Return the count of the parameter types tags: - entities - /investigationinstruments/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the investigation instruments + description: The count of the parameter types '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the investigation instruments + /parametertypes/{id}: + get: + summary: Find the parameter types matching the ID tags: - entities - /investigationinstruments/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching parameter types + content: + application/json: + schema: + $ref: '#/components/schemas/ParameterType' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the investigation instruments matching the ID + delete: + summary: Delete the parameter types matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/InvestigationInstrument' - description: The matching investigation instruments + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the investigation instruments matching the ID + /parametertypes: + get: + summary: Get parameter types based on filters tags: - entities - /investigationparameters: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The parameter types found content: application/json: schema: - $ref: '#/components/schemas/InvestigationParameter' - description: The investigation parameters found + $ref: '#/components/schemas/ParameterType' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get investigation parameters based on filters + post: + summary: Add new parameter types tags: - entities - patch: requestBody: + description: Create one or multiple parameter types + required: true content: application/json: schema: - $ref: '#/components/schemas/InvestigationParameter' - description: Update one or multiple investigation parameters - required: true + type: object responses: '200': + description: The created parameter types content: application/json: schema: - $ref: '#/components/schemas/InvestigationParameter' - description: The updated entity + $ref: '#/components/schemas/ParameterType' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update investigation parameters + patch: + summary: Update parameter types tags: - entities - post: requestBody: + description: Update one or multiple parameter types + required: true content: application/json: schema: - type: object - description: Create one or multiple investigation parameters - required: true + $ref: '#/components/schemas/ParameterType' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/InvestigationParameter' - description: The created investigation parameters + $ref: '#/components/schemas/ParameterType' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new investigation parameters + /permissiblestringvalues/count: + get: + summary: Return the count of the permissible string values tags: - entities - /investigationparameters/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the investigation parameters + description: The count of the permissible string values '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the investigation parameters + /permissiblestringvalues/{id}: + get: + summary: Find the permissible string values matching the ID tags: - entities - /investigationparameters/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching permissible string values + content: + application/json: + schema: + $ref: '#/components/schemas/PermissibleStringValue' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the investigation parameters matching the ID + delete: + summary: Delete the permissible string values matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/InvestigationParameter' - description: The matching investigation parameters + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the investigation parameters matching the ID + /permissiblestringvalues: + get: + summary: Get permissible string values based on filters tags: - entities - /investigations: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The permissible string values found content: application/json: schema: - $ref: '#/components/schemas/Investigation' - description: The investigations found + $ref: '#/components/schemas/PermissibleStringValue' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get investigations based on filters + post: + summary: Add new permissible string values tags: - entities - patch: requestBody: + description: Create one or multiple permissible string values + required: true content: application/json: schema: - $ref: '#/components/schemas/Investigation' - description: Update one or multiple investigations - required: true + type: object responses: '200': + description: The created permissible string values content: application/json: schema: - $ref: '#/components/schemas/Investigation' - description: The updated entity + $ref: '#/components/schemas/PermissibleStringValue' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update investigations + patch: + summary: Update permissible string values tags: - entities - post: requestBody: + description: Update one or multiple permissible string values + required: true content: application/json: schema: - type: object - description: Create one or multiple investigations - required: true + $ref: '#/components/schemas/PermissibleStringValue' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/Investigation' - description: The created investigations + $ref: '#/components/schemas/PermissibleStringValue' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new investigations + /publicsteps/count: + get: + summary: Return the count of the public steps tags: - entities - /investigations/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the investigations + description: The count of the public steps '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the investigations + /publicsteps/{id}: + get: + summary: Find the public steps matching the ID tags: - entities - /investigations/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching public steps + content: + application/json: + schema: + $ref: '#/components/schemas/PublicStep' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the investigations matching the ID + delete: + summary: Delete the public steps matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Investigation' - description: The matching investigations + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the investigations matching the ID + /publicsteps: + get: + summary: Get public steps based on filters tags: - entities - /investigationtypes: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The public steps found content: application/json: schema: - $ref: '#/components/schemas/InvestigationType' - description: The investigation types found + $ref: '#/components/schemas/PublicStep' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get investigation types based on filters + post: + summary: Add new public steps tags: - entities - patch: requestBody: + description: Create one or multiple public steps + required: true content: application/json: schema: - $ref: '#/components/schemas/InvestigationType' - description: Update one or multiple investigation types - required: true + type: object responses: '200': + description: The created public steps content: application/json: schema: - $ref: '#/components/schemas/InvestigationType' - description: The updated entity + $ref: '#/components/schemas/PublicStep' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update investigation types + patch: + summary: Update public steps tags: - entities - post: requestBody: + description: Update one or multiple public steps + required: true content: application/json: schema: - type: object - description: Create one or multiple investigation types - required: true + $ref: '#/components/schemas/PublicStep' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/InvestigationType' - description: The created investigation types + $ref: '#/components/schemas/PublicStep' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new investigation types + /publications/count: + get: + summary: Return the count of the publications tags: - entities - /investigationtypes/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the investigation types + description: The count of the publications '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the investigation types + /publications/{id}: + get: + summary: Find the publications matching the ID tags: - entities - /investigationtypes/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching publications + content: + application/json: + schema: + $ref: '#/components/schemas/Publication' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the investigation types matching the ID + delete: + summary: Delete the publications matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/InvestigationType' - description: The matching investigation types + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the investigation types matching the ID + /publications: + get: + summary: Get publications based on filters tags: - entities - /investigationusers: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The publications found content: application/json: schema: - $ref: '#/components/schemas/InvestigationUser' - description: The investigation users found + $ref: '#/components/schemas/Publication' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get investigation users based on filters + post: + summary: Add new publications tags: - entities - patch: requestBody: + description: Create one or multiple publications + required: true content: application/json: schema: - $ref: '#/components/schemas/InvestigationUser' - description: Update one or multiple investigation users - required: true + type: object responses: '200': + description: The created publications content: application/json: schema: - $ref: '#/components/schemas/InvestigationUser' - description: The updated entity + $ref: '#/components/schemas/Publication' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update investigation users + patch: + summary: Update publications tags: - entities - post: requestBody: + description: Update one or multiple publications + required: true content: application/json: schema: - type: object - description: Create one or multiple investigation users - required: true + $ref: '#/components/schemas/Publication' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/InvestigationUser' - description: The created investigation users + $ref: '#/components/schemas/Publication' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new investigation users + /relateddatafiles/count: + get: + summary: Return the count of the related datafiles tags: - entities - /investigationusers/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the investigation users + description: The count of the related datafiles '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the investigation users + /relateddatafiles/{id}: + get: + summary: Find the related datafiles matching the ID tags: - entities - /investigationusers/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching related datafiles + content: + application/json: + schema: + $ref: '#/components/schemas/RelatedDatafile' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the investigation users matching the ID + delete: + summary: Delete the related datafiles matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/InvestigationUser' - description: The matching investigation users + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the investigation users matching the ID + /relateddatafiles: + get: + summary: Get related datafiles based on filters tags: - entities - /jobs: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The related datafiles found content: application/json: schema: - $ref: '#/components/schemas/Job' - description: The jobs found + $ref: '#/components/schemas/RelatedDatafile' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get jobs based on filters + post: + summary: Add new related datafiles tags: - entities - patch: requestBody: + description: Create one or multiple related datafiles + required: true content: application/json: schema: - $ref: '#/components/schemas/Job' - description: Update one or multiple jobs - required: true + type: object responses: '200': + description: The created related datafiles content: application/json: schema: - $ref: '#/components/schemas/Job' - description: The updated entity + $ref: '#/components/schemas/RelatedDatafile' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update jobs + patch: + summary: Update related datafiles tags: - entities - post: requestBody: + description: Update one or multiple related datafiles + required: true content: application/json: schema: - type: object - description: Create one or multiple jobs - required: true + $ref: '#/components/schemas/RelatedDatafile' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/Job' - description: The created jobs + $ref: '#/components/schemas/RelatedDatafile' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new jobs + /rules/count: + get: + summary: Return the count of the rules tags: - entities - /jobs/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the jobs + description: The count of the rules '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the jobs + /rules/{id}: + get: + summary: Find the rules matching the ID tags: - entities - /jobs/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching rules + content: + application/json: + schema: + $ref: '#/components/schemas/Rule' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the jobs matching the ID + delete: + summary: Delete the rules matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Job' - description: The matching jobs + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the jobs matching the ID + /rules: + get: + summary: Get rules based on filters tags: - entities - /keywords: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The rules found content: application/json: schema: - $ref: '#/components/schemas/Keyword' - description: The keywords found + $ref: '#/components/schemas/Rule' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get keywords based on filters + post: + summary: Add new rules tags: - entities - patch: requestBody: + description: Create one or multiple rules + required: true content: application/json: schema: - $ref: '#/components/schemas/Keyword' - description: Update one or multiple keywords - required: true + type: object responses: '200': + description: The created rules content: application/json: schema: - $ref: '#/components/schemas/Keyword' - description: The updated entity + $ref: '#/components/schemas/Rule' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update keywords + patch: + summary: Update rules tags: - entities - post: requestBody: + description: Update one or multiple rules + required: true content: application/json: schema: - type: object - description: Create one or multiple keywords - required: true + $ref: '#/components/schemas/Rule' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/Keyword' - description: The created keywords + $ref: '#/components/schemas/Rule' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new keywords + /sampleparameters/count: + get: + summary: Return the count of the sample parameters tags: - entities - /keywords/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the keywords + description: The count of the sample parameters '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the keywords + /sampleparameters/{id}: + get: + summary: Find the sample parameters matching the ID tags: - entities - /keywords/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching sample parameters + content: + application/json: + schema: + $ref: '#/components/schemas/SampleParameter' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the keywords matching the ID + delete: + summary: Delete the sample parameters matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Keyword' - description: The matching keywords + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the keywords matching the ID + /sampleparameters: + get: + summary: Get sample parameters based on filters tags: - entities - /parametertypes: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The sample parameters found content: application/json: schema: - $ref: '#/components/schemas/ParameterType' - description: The parameter types found + $ref: '#/components/schemas/SampleParameter' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get parameter types based on filters + post: + summary: Add new sample parameters tags: - entities - patch: requestBody: + description: Create one or multiple sample parameters + required: true content: application/json: schema: - $ref: '#/components/schemas/ParameterType' - description: Update one or multiple parameter types - required: true + type: object responses: '200': + description: The created sample parameters content: application/json: schema: - $ref: '#/components/schemas/ParameterType' - description: The updated entity + $ref: '#/components/schemas/SampleParameter' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update parameter types + patch: + summary: Update sample parameters tags: - entities - post: requestBody: + description: Update one or multiple sample parameters + required: true content: application/json: schema: - type: object - description: Create one or multiple parameter types - required: true + $ref: '#/components/schemas/SampleParameter' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/ParameterType' - description: The created parameter types + $ref: '#/components/schemas/SampleParameter' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new parameter types + /sampletypes/count: + get: + summary: Return the count of the sample types tags: - entities - /parametertypes/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the parameter types + description: The count of the sample types '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the parameter types + /sampletypes/{id}: + get: + summary: Find the sample types matching the ID tags: - entities - /parametertypes/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching sample types + content: + application/json: + schema: + $ref: '#/components/schemas/SampleType' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the parameter types matching the ID + delete: + summary: Delete the sample types matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ParameterType' - description: The matching parameter types + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the parameter types matching the ID + /sampletypes: + get: + summary: Get sample types based on filters tags: - entities - /permissiblestringvalues: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The sample types found content: application/json: schema: - $ref: '#/components/schemas/PermissibleStringValue' - description: The permissible string values found + $ref: '#/components/schemas/SampleType' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get permissible string values based on filters + post: + summary: Add new sample types tags: - entities - patch: requestBody: + description: Create one or multiple sample types + required: true content: application/json: schema: - $ref: '#/components/schemas/PermissibleStringValue' - description: Update one or multiple permissible string values - required: true + type: object responses: '200': + description: The created sample types content: application/json: schema: - $ref: '#/components/schemas/PermissibleStringValue' - description: The updated entity + $ref: '#/components/schemas/SampleType' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update permissible string values + patch: + summary: Update sample types tags: - entities - post: requestBody: + description: Update one or multiple sample types + required: true content: application/json: schema: - type: object - description: Create one or multiple permissible string values - required: true + $ref: '#/components/schemas/SampleType' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/PermissibleStringValue' - description: The created permissible string values + $ref: '#/components/schemas/SampleType' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new permissible string values + /samples/count: + get: + summary: Return the count of the samples tags: - entities - /permissiblestringvalues/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the permissible string values + description: The count of the samples '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the permissible string values + /samples/{id}: + get: + summary: Find the samples matching the ID tags: - entities - /permissiblestringvalues/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching samples + content: + application/json: + schema: + $ref: '#/components/schemas/Sample' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the permissible string values matching the ID + delete: + summary: Delete the samples matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PermissibleStringValue' - description: The matching permissible string values + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the permissible string values matching the ID + /samples: + get: + summary: Get samples based on filters tags: - entities - /publications: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The samples found content: application/json: schema: - $ref: '#/components/schemas/Publication' - description: The publications found + $ref: '#/components/schemas/Sample' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get publications based on filters + post: + summary: Add new samples tags: - entities - patch: requestBody: + description: Create one or multiple samples + required: true content: application/json: schema: - $ref: '#/components/schemas/Publication' - description: Update one or multiple publications - required: true + type: object responses: '200': + description: The created samples content: application/json: schema: - $ref: '#/components/schemas/Publication' - description: The updated entity + $ref: '#/components/schemas/Sample' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update publications + patch: + summary: Update samples tags: - entities - post: requestBody: + description: Update one or multiple samples + required: true content: application/json: schema: - type: object - description: Create one or multiple publications - required: true + $ref: '#/components/schemas/Sample' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/Publication' - description: The created publications + $ref: '#/components/schemas/Sample' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new publications + /shifts/count: + get: + summary: Return the count of the shifts tags: - entities - /publications/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the publications + description: The count of the shifts '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the publications + /shifts/{id}: + get: + summary: Find the shifts matching the ID tags: - entities - /publications/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching shifts + content: + application/json: + schema: + $ref: '#/components/schemas/Shift' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the publications matching the ID + delete: + summary: Delete the shifts matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Publication' - description: The matching publications + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the publications matching the ID + /shifts: + get: + summary: Get shifts based on filters tags: - entities - /publicsteps: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The shifts found content: application/json: schema: - $ref: '#/components/schemas/PublicStep' - description: The public steps found + $ref: '#/components/schemas/Shift' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get public steps based on filters + post: + summary: Add new shifts tags: - entities - patch: requestBody: + description: Create one or multiple shifts + required: true content: application/json: schema: - $ref: '#/components/schemas/PublicStep' - description: Update one or multiple public steps - required: true + type: object responses: '200': + description: The created shifts content: application/json: schema: - $ref: '#/components/schemas/PublicStep' - description: The updated entity + $ref: '#/components/schemas/Shift' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update public steps + patch: + summary: Update shifts tags: - entities - post: requestBody: + description: Update one or multiple shifts + required: true content: application/json: schema: - type: object - description: Create one or multiple public steps - required: true + $ref: '#/components/schemas/Shift' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/PublicStep' - description: The created public steps + $ref: '#/components/schemas/Shift' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new public steps + /studies/count: + get: + summary: Return the count of the studies tags: - entities - /publicsteps/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the public steps + description: The count of the studies '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the public steps + /studies/{id}: + get: + summary: Find the studies matching the ID tags: - entities - /publicsteps/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching studies + content: + application/json: + schema: + $ref: '#/components/schemas/Study' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the public steps matching the ID + delete: + summary: Delete the studies matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PublicStep' - description: The matching public steps + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the public steps matching the ID + /studies: + get: + summary: Get studies based on filters tags: - entities - /relateddatafiles: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The studies found content: application/json: schema: - $ref: '#/components/schemas/RelatedDatafile' - description: The related datafiles found + $ref: '#/components/schemas/Study' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get related datafiles based on filters + post: + summary: Add new studies tags: - entities - patch: requestBody: + description: Create one or multiple studies + required: true content: application/json: schema: - $ref: '#/components/schemas/RelatedDatafile' - description: Update one or multiple related datafiles - required: true + type: object responses: '200': + description: The created studies content: application/json: schema: - $ref: '#/components/schemas/RelatedDatafile' - description: The updated entity + $ref: '#/components/schemas/Study' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update related datafiles + patch: + summary: Update studies tags: - entities - post: requestBody: + description: Update one or multiple studies + required: true content: application/json: schema: - type: object - description: Create one or multiple related datafiles - required: true + $ref: '#/components/schemas/Study' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/RelatedDatafile' - description: The created related datafiles + $ref: '#/components/schemas/Study' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new related datafiles + /studyinvestigations/count: + get: + summary: Return the count of the study investigations tags: - entities - /relateddatafiles/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the related datafiles + description: The count of the study investigations '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the related datafiles + /studyinvestigations/{id}: + get: + summary: Find the study investigations matching the ID tags: - entities - /relateddatafiles/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching study investigations + content: + application/json: + schema: + $ref: '#/components/schemas/StudyInvestigation' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the related datafiles matching the ID + delete: + summary: Delete the study investigations matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/RelatedDatafile' - description: The matching related datafiles + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the related datafiles matching the ID + /studyinvestigations: + get: + summary: Get study investigations based on filters tags: - entities - /rules: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The study investigations found content: application/json: schema: - $ref: '#/components/schemas/Rule' - description: The rules found + $ref: '#/components/schemas/StudyInvestigation' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get rules based on filters + post: + summary: Add new study investigations tags: - entities - patch: requestBody: + description: Create one or multiple study investigations + required: true content: application/json: schema: - $ref: '#/components/schemas/Rule' - description: Update one or multiple rules - required: true + type: object responses: '200': + description: The created study investigations content: application/json: schema: - $ref: '#/components/schemas/Rule' - description: The updated entity + $ref: '#/components/schemas/StudyInvestigation' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update rules + patch: + summary: Update study investigations tags: - entities - post: requestBody: + description: Update one or multiple study investigations + required: true content: application/json: schema: - type: object - description: Create one or multiple rules - required: true + $ref: '#/components/schemas/StudyInvestigation' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/Rule' - description: The created rules + $ref: '#/components/schemas/StudyInvestigation' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new rules + /usergroups/count: + get: + summary: Return the count of the user groups tags: - entities - /rules/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the rules + description: The count of the user groups '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the rules + /usergroups/{id}: + get: + summary: Find the user groups matching the ID tags: - entities - /rules/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching user groups + content: + application/json: + schema: + $ref: '#/components/schemas/UserGroup' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the rules matching the ID + delete: + summary: Delete the user groups matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Rule' - description: The matching rules + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the rules matching the ID + /usergroups: + get: + summary: Get user groups based on filters tags: - entities - /sampleparameters: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The user groups found content: application/json: schema: - $ref: '#/components/schemas/SampleParameter' - description: The sample parameters found + $ref: '#/components/schemas/UserGroup' + '404': + description: When no results are found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no results are found - summary: Get sample parameters based on filters + post: + summary: Add new user groups tags: - entities - patch: requestBody: + description: Create one or multiple user groups + required: true content: application/json: schema: - $ref: '#/components/schemas/SampleParameter' - description: Update one or multiple sample parameters - required: true + type: object responses: '200': + description: The created user groups content: application/json: schema: - $ref: '#/components/schemas/SampleParameter' - description: The updated entity + $ref: '#/components/schemas/UserGroup' '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update sample parameters + patch: + summary: Update user groups tags: - entities - post: requestBody: + description: Update one or multiple user groups + required: true content: application/json: schema: - type: object - description: Create one or multiple sample parameters - required: true + $ref: '#/components/schemas/UserGroup' responses: '200': + description: The updated entity content: application/json: schema: - $ref: '#/components/schemas/SampleParameter' - description: The created sample parameters + $ref: '#/components/schemas/UserGroup' + '404': + description: When the entity to update could not be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - summary: Add new sample parameters + /users/count: + get: + summary: Return the count of the users tags: - entities - /sampleparameters/count: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object responses: '200': - description: The count of the sample parameters + description: The count of the users '401': description: When no credentials are provided '403': description: When bad credentials are given - summary: Return the count of the sample parameters + /users/{id}: + get: + summary: Find the users matching the ID tags: - entities - /sampleparameters/{id}: - delete: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '203': - description: Blank response when the entity is deleted + '200': + description: The matching users + content: + application/json: + schema: + $ref: '#/components/schemas/User' + '404': + description: When no result is found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the sample parameters matching the ID + delete: + summary: Delete the users matching the ID tags: - entities - get: parameters: - description: The id of an entity in: path - name: id required: true + name: id schema: - example: 4 type: integer + example: 4 responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SampleParameter' - description: The matching sample parameters + '203': + description: Blank response when the entity is deleted + '404': + description: When the entity can't be found '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the sample parameters matching the ID + /users: + get: + summary: Get users based on filters tags: - entities - /samples: - get: parameters: - description: Apply a where filter to all entities. The filter can take the form of {"field":{:"value"}, where the possible operators are like, gte, lte, in and eq in: query - name: where required: false + name: where schema: + type: object example: ID: eq: 1 - type: object - description: Return unique values for the fields requested in: query - name: distinct required: false + name: distinct schema: + type: object example: - FIELD 1 - FIELD 2 - type: object - description: Given the names of related entities, include them in the results. Only one include parameter is allowed in: query - name: include required: false + name: include schema: + type: object example: Relation 1: - Relation A - Relation B - type: object - description: Limit the number of entities returned in: query - name: limit required: false + name: limit schema: - example: 4 type: number + example: 4 - description: Given a field and direction, order the returned entities in: query - name: order required: false + name: order schema: - example: ID DESC type: string + example: ID DESC - description: Offset the returned entities by a given number in: query - name: skip required: false + name: skip schema: - example: 5 type: number + example: 5 responses: '200': + description: The users found content: application/json: schema: - $ref: '#/components/schemas/Sample' - description: The samples found - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided + $ref: '#/components/schemas/User' '404': description: When no results are found - summary: Get samples based on filters - tags: - - entities - patch: - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Sample' - description: Update one or multiple samples - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Sample' - description: The updated entity '401': description: When no credentials are provided '403': description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update samples + post: + summary: Add new users tags: - entities - post: requestBody: + description: Create one or multiple users + required: true content: application/json: schema: type: object - description: Create one or multiple samples - required: true responses: '200': + description: The created users content: application/json: schema: - $ref: '#/components/schemas/Sample' - description: The created samples - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - summary: Add new samples - tags: - - entities - /samples/count: - get: - parameters: - - description: Apply a where filter to all entities. The filter can take the - form of {"field":{:"value"}, where the possible operators are - like, gte, lte, in and eq - in: query - name: where - required: false - schema: - example: - ID: - eq: 1 - type: object - - description: Return unique values for the fields requested - in: query - name: distinct - required: false - schema: - example: - - FIELD 1 - - FIELD 2 - type: object - responses: - '200': - description: The count of the samples + $ref: '#/components/schemas/User' '401': description: When no credentials are provided '403': - description: When bad credentials are given - summary: Return the count of the samples + description: When bad credentials are provided + patch: + summary: Update users tags: - entities - /samples/{id}: - delete: - parameters: - - description: The id of an entity - in: path - name: id + requestBody: + description: Update one or multiple users required: true - schema: - example: 4 + content: + application/json: + schema: + $ref: '#/components/schemas/User' + responses: + '200': + description: The updated entity + content: + application/json: + schema: + $ref: '#/components/schemas/User' + '404': + description: When the entity to update could not be found + '401': + description: When no credentials are provided + '403': + description: When bad credentials are provided +components: + schemas: + Application: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + VERSION: + type: string + FACILITY_ID: + type: integer + DataCollectionDatafile: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + DATACOLLECTION_ID: + type: integer + DATAFILE_ID: + type: integer + DataCollectionDataset: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + DATACOLLECTION_ID: + type: integer + DATASET_ID: + type: integer + DataCollectionParameter: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + DATETIME_VALUE: + type: string + ERROR: + type: number + MOD_ID: + type: string + MOD_TIME: + type: string + NUMERIC_VALUE: + type: number + RANGEBOTTOM: + type: number + RANGETOP: + type: number + STRING_VALUE: + type: string + DATACOLLECTION_ID: + type: integer + PARAMETER_TYPE_ID: + type: integer + DataCollection: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + DOI: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + DatafileFormat: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + DESCRIPTION: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + TYPE: + type: string + VERSION: + type: string + FACILITY_ID: + type: integer + DatafileParameter: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + DATETIME_VALUE: + type: string + ERROR: + type: number + MOD_ID: + type: string + MOD_TIME: + type: string + NUMERIC_VALUE: + type: number + RANGEBOTTOM: + type: number + RANGETOP: + type: number + STRING_VALUE: + type: string + DATAFILE_ID: + type: integer + PARAMETER_TYPE_ID: + type: integer + Datafile: + type: object + properties: + ID: + type: integer + CHECKSUM: + type: string + CREATE_ID: + type: string + CREATE_TIME: + type: string + DATAFILECREATETIME: + type: string + DATAFILEMODTIME: + type: string + DESCRIPTION: + type: string + DOI: + type: string + FILESIZE: + type: integer + LOCATION: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + DATAFILEFORMAT_ID: + type: integer + DATASET_ID: + type: integer + DatasetType: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + DESCRIPTION: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + FACILITY_ID: + type: integer + Dataset: + type: object + properties: + ID: + type: integer + COMPLETE: + type: boolean + CREATE_ID: + type: string + CREATE_TIME: + type: string + DESCRIPTION: + type: string + DOI: + type: string + END_DATE: + type: string + LOCATION: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + STARTDATE: + type: string + INVESTIGATION_ID: type: integer - responses: - '203': - description: Blank response when the entity is deleted - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the samples matching the ID - tags: - - entities - get: - parameters: - - description: The id of an entity - in: path - name: id - required: true - schema: - example: 4 + SAMPLE_ID: type: integer - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Sample' - description: The matching samples - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the samples matching the ID - tags: - - entities - /sampletypes: - get: - parameters: - - description: Apply a where filter to all entities. The filter can take the - form of {"field":{:"value"}, where the possible operators are - like, gte, lte, in and eq - in: query - name: where - required: false - schema: - example: - ID: - eq: 1 - type: object - - description: Return unique values for the fields requested - in: query - name: distinct - required: false - schema: - example: - - FIELD 1 - - FIELD 2 - type: object - - description: Given the names of related entities, include them in the results. - Only one include parameter is allowed - in: query - name: include - required: false - schema: - example: - Relation 1: - - Relation A - - Relation B - type: object - - description: Limit the number of entities returned - in: query - name: limit - required: false - schema: - example: 4 - type: number - - description: Given a field and direction, order the returned entities - in: query - name: order - required: false - schema: - example: ID DESC + TYPE_ID: + type: integer + Facility: + type: object + properties: + ID: + type: integer + CREATE_ID: type: string - - description: Offset the returned entities by a given number - in: query - name: skip - required: false - schema: - example: 5 - type: number - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SampleType' - description: The sample types found - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When no results are found - summary: Get sample types based on filters - tags: - - entities - patch: - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SampleType' - description: Update one or multiple sample types - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SampleType' - description: The updated entity - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update sample types - tags: - - entities - post: - requestBody: - content: - application/json: - schema: - type: object - description: Create one or multiple sample types - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SampleType' - description: The created sample types - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - summary: Add new sample types - tags: - - entities - /sampletypes/count: - get: - parameters: - - description: Apply a where filter to all entities. The filter can take the - form of {"field":{:"value"}, where the possible operators are - like, gte, lte, in and eq - in: query - name: where - required: false - schema: - example: - ID: - eq: 1 - type: object - - description: Return unique values for the fields requested - in: query - name: distinct - required: false - schema: - example: - - FIELD 1 - - FIELD 2 - type: object - responses: - '200': - description: The count of the sample types - '401': - description: When no credentials are provided - '403': - description: When bad credentials are given - summary: Return the count of the sample types - tags: - - entities - /sampletypes/{id}: - delete: - parameters: - - description: The id of an entity - in: path - name: id - required: true - schema: - example: 4 + CREATE_TIME: + type: string + DAYSUNTILRELEASE: + type: integer + DESCRIPTION: + type: string + FULLNAME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + URL: + type: string + FacilityCycle: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + DESCRIPTION: + type: string + ENDDATE: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + STARTDATE: + type: string + FACILITY_ID: + type: integer + Grouping: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + InstrumentScientist: + type: object + properties: + ID: type: integer - responses: - '203': - description: Blank response when the entity is deleted - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the sample types matching the ID - tags: - - entities - get: - parameters: - - description: The id of an entity - in: path - name: id - required: true - schema: - example: 4 + CREATE_ID: + type: string + CREATE_TIME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + INSTRUMENT_ID: type: integer - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SampleType' - description: The matching sample types - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the sample types matching the ID - tags: - - entities - /shifts: - get: - parameters: - - description: Apply a where filter to all entities. The filter can take the - form of {"field":{:"value"}, where the possible operators are - like, gte, lte, in and eq - in: query - name: where - required: false - schema: - example: - ID: - eq: 1 - type: object - - description: Return unique values for the fields requested - in: query - name: distinct - required: false - schema: - example: - - FIELD 1 - - FIELD 2 - type: object - - description: Given the names of related entities, include them in the results. - Only one include parameter is allowed - in: query - name: include - required: false - schema: - example: - Relation 1: - - Relation A - - Relation B - type: object - - description: Limit the number of entities returned - in: query - name: limit - required: false - schema: - example: 4 - type: number - - description: Given a field and direction, order the returned entities - in: query - name: order - required: false - schema: - example: ID DESC + USER_ID: + type: integer + Instrument: + type: object + properties: + ID: + type: integer + CREATE_ID: type: string - - description: Offset the returned entities by a given number - in: query - name: skip - required: false - schema: - example: 5 - type: number - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Shift' - description: The shifts found - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When no results are found - summary: Get shifts based on filters - tags: - - entities - patch: - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Shift' - description: Update one or multiple shifts - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Shift' - description: The updated entity - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update shifts - tags: - - entities - post: - requestBody: - content: - application/json: - schema: - type: object - description: Create one or multiple shifts - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Shift' - description: The created shifts - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - summary: Add new shifts - tags: - - entities - /shifts/count: - get: - parameters: - - description: Apply a where filter to all entities. The filter can take the - form of {"field":{:"value"}, where the possible operators are - like, gte, lte, in and eq - in: query - name: where - required: false - schema: - example: - ID: - eq: 1 - type: object - - description: Return unique values for the fields requested - in: query - name: distinct - required: false - schema: - example: - - FIELD 1 - - FIELD 2 - type: object - responses: - '200': - description: The count of the shifts - '401': - description: When no credentials are provided - '403': - description: When bad credentials are given - summary: Return the count of the shifts - tags: - - entities - /shifts/{id}: - delete: - parameters: - - description: The id of an entity - in: path - name: id - required: true - schema: - example: 4 + CREATE_TIME: + type: string + DESCRIPTION: + type: string + FULLNAME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + TYPE: + type: string + URL: + type: string + FACILITY_ID: + type: integer + InvestigationGroup: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + ROLE: + type: string + GROUP_ID: type: integer - responses: - '203': - description: Blank response when the entity is deleted - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the shifts matching the ID - tags: - - entities - get: - parameters: - - description: The id of an entity - in: path - name: id - required: true - schema: - example: 4 + INVESTIGATION_ID: type: integer - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Shift' - description: The matching shifts - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the shifts matching the ID - tags: - - entities - /studies: - get: - parameters: - - description: Apply a where filter to all entities. The filter can take the - form of {"field":{:"value"}, where the possible operators are - like, gte, lte, in and eq - in: query - name: where - required: false - schema: - example: - ID: - eq: 1 - type: object - - description: Return unique values for the fields requested - in: query - name: distinct - required: false - schema: - example: - - FIELD 1 - - FIELD 2 - type: object - - description: Given the names of related entities, include them in the results. - Only one include parameter is allowed - in: query - name: include - required: false - schema: - example: - Relation 1: - - Relation A - - Relation B - type: object - - description: Limit the number of entities returned - in: query - name: limit - required: false - schema: - example: 4 + InvestigationInstrument: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + INSTRUMENT_ID: + type: integer + INVESTIGATION_ID: + type: integer + InvestigationParameter: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + DATETIME_VALUE: + type: string + ERROR: type: number - - description: Given a field and direction, order the returned entities - in: query - name: order - required: false - schema: - example: ID DESC + MOD_ID: + type: string + MOD_TIME: + type: string + NUMERIC_VALUE: + type: number + RANGEBOTTOM: + type: number + RANGETOP: + type: number + STRING_VALUE: + type: string + INVESTIGATION_ID: + type: integer + PARAMETER_TYPE_ID: + type: integer + InvestigationType: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + DESCRIPTION: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + FACILITY_ID: + type: integer + InvestigationUser: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + ROLE: + type: string + INVESTIGATION_ID: + type: integer + USER_ID: + type: integer + Investigation: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + DOI: + type: string + ENDDATE: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + RELEASEDATE: + type: string + STARTDATE: + type: string + SUMMARY: + type: string + TITLE: + type: string + VISIT_ID: + type: string + FACILITY_ID: + type: integer + TYPE_ID: + type: integer + Job: + type: object + properties: + ID: + type: integer + ARGUMENTS: + type: string + CREATE_ID: + type: string + CREATE_TIME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + APPLICATION_ID: + type: integer + INPUTDATACOLLECTION_ID: + type: integer + OUTPUTDATACOLLECTION_ID: + type: integer + Keyword: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + INVESTIGATION_ID: + type: integer + ParameterType: + type: object + properties: + ID: + type: integer + APPLICABLETODATACOLLECTION: + type: boolean + APPLICABLETODATAFILE: + type: boolean + APPLICABLETODATASET: + type: boolean + APPLICABLETOINVESTIGATION: + type: boolean + APPLICABLETOSAMPLE: + type: boolean + CREATE_ID: + type: string + CREATE_TIME: type: string - - description: Offset the returned entities by a given number - in: query - name: skip - required: false - schema: - example: 5 + DESCRIPTION: + type: string + ENFORCED: + type: boolean + MAXIMUMNUMERICVALUE: type: number - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Study' - description: The studies found - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When no results are found - summary: Get studies based on filters - tags: - - entities - patch: - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Study' - description: Update one or multiple studies - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Study' - description: The updated entity - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update studies - tags: - - entities - post: - requestBody: - content: - application/json: - schema: - type: object - description: Create one or multiple studies - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Study' - description: The created studies - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - summary: Add new studies - tags: - - entities - /studies/count: - get: - parameters: - - description: Apply a where filter to all entities. The filter can take the - form of {"field":{:"value"}, where the possible operators are - like, gte, lte, in and eq - in: query - name: where - required: false - schema: - example: - ID: - eq: 1 - type: object - - description: Return unique values for the fields requested - in: query - name: distinct - required: false - schema: - example: - - FIELD 1 - - FIELD 2 - type: object - responses: - '200': - description: The count of the studies - '401': - description: When no credentials are provided - '403': - description: When bad credentials are given - summary: Return the count of the studies - tags: - - entities - /studies/{id}: - delete: - parameters: - - description: The id of an entity - in: path - name: id - required: true - schema: - example: 4 + MINIMUMNUMERICVALUE: + type: number + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + UNITS: + type: string + UNITSFULLNAME: + type: string + VALUETYPE: type: integer - responses: - '203': - description: Blank response when the entity is deleted - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the studies matching the ID - tags: - - entities - get: - parameters: - - description: The id of an entity - in: path - name: id - required: true - schema: - example: 4 + VERIFIED: + type: boolean + FACILITY_ID: type: integer - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Study' - description: The matching studies - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the studies matching the ID - tags: - - entities - /studyinvestigations: - get: - parameters: - - description: Apply a where filter to all entities. The filter can take the - form of {"field":{:"value"}, where the possible operators are - like, gte, lte, in and eq - in: query - name: where - required: false - schema: - example: - ID: - eq: 1 - type: object - - description: Return unique values for the fields requested - in: query - name: distinct - required: false - schema: - example: - - FIELD 1 - - FIELD 2 - type: object - - description: Given the names of related entities, include them in the results. - Only one include parameter is allowed - in: query - name: include - required: false - schema: - example: - Relation 1: - - Relation A - - Relation B - type: object - - description: Limit the number of entities returned - in: query - name: limit - required: false - schema: - example: 4 - type: number - - description: Given a field and direction, order the returned entities - in: query - name: order - required: false - schema: - example: ID DESC + PermissibleStringValue: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + VALUE: + type: string + PARAMETERTYPE_ID: + type: integer + PublicStep: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + FIELD: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + ORIGIN: + type: string + Publication: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: type: string - - description: Offset the returned entities by a given number - in: query - name: skip - required: false - schema: - example: 5 - type: number - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/StudyInvestigation' - description: The study investigations found - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When no results are found - summary: Get study investigations based on filters - tags: - - entities - patch: - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StudyInvestigation' - description: Update one or multiple study investigations - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/StudyInvestigation' - description: The updated entity - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update study investigations - tags: - - entities - post: - requestBody: - content: - application/json: - schema: - type: object - description: Create one or multiple study investigations - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/StudyInvestigation' - description: The created study investigations - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - summary: Add new study investigations - tags: - - entities - /studyinvestigations/count: - get: - parameters: - - description: Apply a where filter to all entities. The filter can take the - form of {"field":{:"value"}, where the possible operators are - like, gte, lte, in and eq - in: query - name: where - required: false - schema: - example: - ID: - eq: 1 - type: object - - description: Return unique values for the fields requested - in: query - name: distinct - required: false - schema: - example: - - FIELD 1 - - FIELD 2 - type: object - responses: - '200': - description: The count of the study investigations - '401': - description: When no credentials are provided - '403': - description: When bad credentials are given - summary: Return the count of the study investigations - tags: - - entities - /studyinvestigations/{id}: - delete: - parameters: - - description: The id of an entity - in: path - name: id - required: true - schema: - example: 4 + DOI: + type: string + FULLREFERENCE: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + REPOSITORY: + type: string + REPOSITORYID: + type: string + URL: + type: string + INVESTIGATION_ID: type: integer - responses: - '203': - description: Blank response when the entity is deleted - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the study investigations matching the ID - tags: - - entities - get: - parameters: - - description: The id of an entity - in: path - name: id - required: true - schema: - example: 4 + RelatedDatafile: + type: object + properties: + ID: type: integer - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/StudyInvestigation' - description: The matching study investigations - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the study investigations matching the ID - tags: - - entities - /usergroups: - get: - parameters: - - description: Apply a where filter to all entities. The filter can take the - form of {"field":{:"value"}, where the possible operators are - like, gte, lte, in and eq - in: query - name: where - required: false - schema: - example: - ID: - eq: 1 - type: object - - description: Return unique values for the fields requested - in: query - name: distinct - required: false - schema: - example: - - FIELD 1 - - FIELD 2 - type: object - - description: Given the names of related entities, include them in the results. - Only one include parameter is allowed - in: query - name: include - required: false - schema: - example: - Relation 1: - - Relation A - - Relation B - type: object - - description: Limit the number of entities returned - in: query - name: limit - required: false - schema: - example: 4 + CREATE_ID: + type: string + CREATE_TIME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + RELATION: + type: string + DEST_DATAFILE_ID: + type: integer + SOURCE_DATAFILE_ID: + type: integer + Rule: + type: object + properties: + ID: + type: integer + ATTRIBUTE: + type: string + BEAN: + type: string + C: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + CRUDFLAGS: + type: string + CRUDJPQL: + type: string + D: + type: integer + INCLUDEJPQL: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + R: + type: integer + RESTRICTED: + type: integer + SEARCHJPQL: + type: string + U: + type: integer + WHAT: + type: string + GROUPING_ID: + type: integer + SampleParameter: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + DATETIME_VALUE: + type: string + ERROR: type: number - - description: Given a field and direction, order the returned entities - in: query - name: order - required: false - schema: - example: ID DESC + MOD_ID: type: string - - description: Offset the returned entities by a given number - in: query - name: skip - required: false - schema: - example: 5 + MOD_TIME: + type: string + NUMERIC_VALUE: type: number - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UserGroup' - description: The user groups found - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When no results are found - summary: Get user groups based on filters - tags: - - entities - patch: - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UserGroup' - description: Update one or multiple user groups - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UserGroup' - description: The updated entity - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update user groups - tags: - - entities - post: - requestBody: - content: - application/json: - schema: - type: object - description: Create one or multiple user groups - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UserGroup' - description: The created user groups - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - summary: Add new user groups - tags: - - entities - /usergroups/count: - get: - parameters: - - description: Apply a where filter to all entities. The filter can take the - form of {"field":{:"value"}, where the possible operators are - like, gte, lte, in and eq - in: query - name: where - required: false - schema: - example: - ID: - eq: 1 - type: object - - description: Return unique values for the fields requested - in: query - name: distinct - required: false - schema: - example: - - FIELD 1 - - FIELD 2 - type: object - responses: - '200': - description: The count of the user groups - '401': - description: When no credentials are provided - '403': - description: When bad credentials are given - summary: Return the count of the user groups - tags: - - entities - /usergroups/{id}: - delete: - parameters: - - description: The id of an entity - in: path - name: id - required: true - schema: - example: 4 + RANGEBOTTOM: + type: number + RANGETOP: + type: number + STRING_VALUE: + type: string + SAMPLE_ID: type: integer - responses: - '203': - description: Blank response when the entity is deleted - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the user groups matching the ID - tags: - - entities - get: - parameters: - - description: The id of an entity - in: path - name: id - required: true - schema: - example: 4 + PARAMETER_TYPE_ID: + type: integer + SampleType: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + MOLECULARFORMULA: + type: string + NAME: + type: string + SAFETYINFORMATION: + type: string + FACILITY_ID: + type: integer + Sample: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + INVESTIGATION_ID: + type: integer + SAMPLETYPE_ID: + type: integer + Shift: + type: object + properties: + ID: + type: integer + COMMENT: + type: string + CREATE_ID: + type: string + CREATE_TIME: + type: string + ENDDATE: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + STARTDATE: + type: string + INVESTIGATION_ID: + type: integer + Study: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + DESCRIPTION: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + STARTDATE: + type: string + STATUS: + type: integer + USER_ID: + type: integer + StudyInvestigation: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + INVESTIGATION_ID: type: integer - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UserGroup' - description: The matching user groups - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the user groups matching the ID - tags: - - entities - /users: - get: - parameters: - - description: Apply a where filter to all entities. The filter can take the - form of {"field":{:"value"}, where the possible operators are - like, gte, lte, in and eq - in: query - name: where - required: false - schema: - example: - ID: - eq: 1 - type: object - - description: Return unique values for the fields requested - in: query - name: distinct - required: false - schema: - example: - - FIELD 1 - - FIELD 2 - type: object - - description: Given the names of related entities, include them in the results. - Only one include parameter is allowed - in: query - name: include - required: false - schema: - example: - Relation 1: - - Relation A - - Relation B - type: object - - description: Limit the number of entities returned - in: query - name: limit - required: false - schema: - example: 4 - type: number - - description: Given a field and direction, order the returned entities - in: query - name: order - required: false - schema: - example: ID DESC + STUDY_ID: + type: integer + UserGroup: + type: object + properties: + ID: + type: integer + CREATE_ID: type: string - - description: Offset the returned entities by a given number - in: query - name: skip - required: false - schema: - example: 5 - type: number - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/User' - description: The users found - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When no results are found - summary: Get users based on filters - tags: - - entities - patch: - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/User' - description: Update one or multiple users - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/User' - description: The updated entity - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When the entity to update could not be found - summary: Update users - tags: - - entities - post: - requestBody: - content: - application/json: - schema: - type: object - description: Create one or multiple users - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/User' - description: The created users - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - summary: Add new users - tags: - - entities - /users/count: - get: - parameters: - - description: Apply a where filter to all entities. The filter can take the - form of {"field":{:"value"}, where the possible operators are - like, gte, lte, in and eq - in: query - name: where - required: false - schema: - example: - ID: - eq: 1 - type: object - - description: Return unique values for the fields requested - in: query - name: distinct - required: false - schema: - example: - - FIELD 1 - - FIELD 2 - type: object - responses: - '200': - description: The count of the users - '401': - description: When no credentials are provided - '403': - description: When bad credentials are given - summary: Return the count of the users - tags: - - entities - /users/{id}: - delete: - parameters: - - description: The id of an entity - in: path - name: id - required: true - schema: - example: 4 + CREATE_TIME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + GROUP_ID: type: integer - responses: - '203': - description: Blank response when the entity is deleted - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When the entity can't be found - summary: Delete the users matching the ID - tags: - - entities - get: - parameters: - - description: The id of an entity - in: path - name: id - required: true - schema: - example: 4 + USER_ID: type: integer - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/User' - description: The matching users - '401': - description: When no credentials are provided - '403': - description: When bad credentials are provided - '404': - description: When no result is found - summary: Find the users matching the ID - tags: - - entities -servers: -- url: http://localhost:5000 + User: + type: object + properties: + ID: + type: integer + CREATE_ID: + type: string + CREATE_TIME: + type: string + EMAIL: + type: string + FULLNAME: + type: string + MOD_ID: + type: string + MOD_TIME: + type: string + NAME: + type: string + ORCIDID: + type: string