From b7fdbe0027d86b152b80898d4ae2ad652b87b037 Mon Sep 17 00:00:00 2001 From: Reillyhewitson Date: Mon, 31 Oct 2022 16:28:53 +0000 Subject: [PATCH] generate openapi and fix model references --- .../src/datagateway_api/database/models.py | 41 +- .../src/swagger/datagateway_api/openapi.yaml | 6431 +++++++++++++---- 2 files changed, 5162 insertions(+), 1310 deletions(-) diff --git a/datagateway_api/src/datagateway_api/database/models.py b/datagateway_api/src/datagateway_api/database/models.py index aa1c6a0d..a314d119 100644 --- a/datagateway_api/src/datagateway_api/database/models.py +++ b/datagateway_api/src/datagateway_api/database/models.py @@ -227,10 +227,10 @@ class AFFILIATION(Base, EntityHelper, metaclass=EntityMeta): modId = Column("MOD_ID", String(255), nullable=False) modTime = Column("MOD_TIME", DateTime, nullable=False) name = Column("NAME", String(255), nullable=False) - fullReference = Column("FULL_REFERENCE", String(1023)) + fullReference = Column("FULLREFERENCE", String(1023)) pid = Column("PID", String(255)) dataPublicationUserId = Column( - "DATAPUBLICATIONUSER_ID", ForeignKey("DATAPUBLICATIONUSER.ID"), + "DATAPUBLICATIONUSER_ID", ForeignKey("DATAPUBLICATIONUSER.ID"), nullable=False ) DATAPUBLICATIONUSER = relationship( @@ -424,7 +424,7 @@ class DATAPUBLICATION(Base, EntityHelper, metaclass=EntityMeta): createTime = Column("CREATE_TIME", DateTime, nullable=False) modId = Column("MOD_ID", String(255), nullable=False) modTime = Column("MOD_TIME", DateTime, nullable=False) - publicationDate = Column("PUBLICATION_DATE", DateTime) + publicationDate = Column("PUBLICATIONDATE", DateTime) title = Column("TITLE", String(255), nullable=False) description = Column("DESCRIPTION", String(4000)) pid = Column("PID", String(255), nullable=False) @@ -467,7 +467,7 @@ class DATAPUBLICATIONDATE(Base, EntityHelper, metaclass=EntityMeta): createTime = Column("CREATE_TIME", DateTime, nullable=False) modId = Column("MOD_ID", String(255), nullable=False) modTime = Column("MOD_TIME", DateTime, nullable=False) - dateType = Column("DATE_TYPE", String(255), nullable=False) + dateType = Column("DATETYPE", String(255), nullable=False) date = Column("DATE", String(255), nullable=False) datapublicationId = Column( "DATAPUBLICATION_ID", ForeignKey("DATAPUBLICATION.ID"), nullable=False @@ -525,18 +525,9 @@ class DATAPUBLICATIONTYPE(Base, EntityHelper, metaclass=EntityMeta): modTime = Column("MOD_TIME", DateTime, nullable=False) name = Column("NAME", String(255), nullable=False) description = Column("DESCRIPTION", String(255)) - datapublicationId = Column( - "DATAPUBLICATION_ID", ForeignKey("DATAPUBLICATION.ID"), nullable=False - ) facilityId = Column("FACILITY_ID", ForeignKey("FACILITY.ID"), nullable=False) - DATAPUBLICATION = relationship( - "DATAPUBLICATION", - primaryjoin="DATAPUBLICATIONTYPE.datapublicationId == DATAPUBLICATION.id", - backref="type", - ) - FACILITY = relationship( "FACILITY", primaryjoin="DATAPUBLICATIONTYPE.facilityId == FACILITY.id", @@ -565,14 +556,14 @@ class DATAPUBLICATIONUSER(Base, EntityHelper, metaclass=EntityMeta): orderKey = Column("ORDERKEY", String(255)) givenName = Column("GIVENNAME", String(255)) fullName = Column("FULLNAME", String(255)) + familyName = Column("FAMILYNAME", String(255)) email = Column("EMAIL", String(255)) contributorType = Column("CONTRIBUTORTYPE", String(255), nullable=False) publicationId = Column( "DATAPUBLICATION_ID", ForeignKey("DATAPUBLICATION.ID"), nullable=False, ) - userID = Column("USER_ID", ForeignKey("USER_.ID"), nullable=False) - affiliationId = Column("AFFILIATION_ID", ForeignKey("AFFILIATION.ID")) + userId = Column("USER_ID", ForeignKey("USER_.ID"), nullable=False) USER = relationship( "USER", @@ -586,12 +577,6 @@ class DATAPUBLICATIONUSER(Base, EntityHelper, metaclass=EntityMeta): backref="users", ) - AFFILIATION = relationship( - "AFFILIATION", - primaryjoin="DATAPUBLICATIONUSER.affiliationId == AFFILIATION.id", - backref="user", - ) - class DATAFILE(Base, EntityHelper, metaclass=EntityMeta): __tablename__ = "DATAFILE" @@ -877,10 +862,10 @@ class FUNDINGREFERENCE(Base, EntityHelper, metaclass=EntityMeta): description = Column("DESCRIPTION", String(255)) modId = Column("MOD_ID", String(255), nullable=False) modTime = Column("MOD_TIME", DateTime, nullable=False) - funderIdentifier = Column("FUNDER_IDENTIFIER", String(255)) - funderName = Column("FUNDER_NAME", String(255), nullable=False) - awardNumber = Column("AWARD_NUMBER", String(255), nullable=False) - awardTitle = Column("AWARD_TITLE", String(255)) + funderIdentifier = Column("FUNDERIDENTIFIER", String(255)) + funderName = Column("FUNDERNAME", String(255), nullable=False) + awardNumber = Column("AWARDNUMBER", String(255), nullable=False) + awardTitle = Column("AWARDTITLE", String(255)) class GROUPING(Base, EntityHelper, metaclass=EntityMeta): @@ -1418,9 +1403,9 @@ class RELATEDITEM(Base, EntityHelper, metaclass=EntityMeta): modId = Column("MOD_ID", String(255), nullable=False) modTime = Column("MOD_TIME", DateTime, nullable=False) identifier = Column("IDENTIFIER", String(255), nullable=False) - relationType = Column("RELATION_TYPE", String(255), nullable=False) - fullReference = Column("FULL_REFERENCE", String(1023)) - relatedItemType = Column("RELATED_ITEM_TYPE", String(255)) + relationType = Column("RELATIONTYPE", String(255), nullable=False) + fullReference = Column("FULLREFERENCE", String(1023)) + relatedItemType = Column("RELATEDITEMTYPE", String(255)) title = Column("TITLE", String(255)) datapublicationId = Column( "DATAPUBLICATION_ID", ForeignKey("DATAPUBLICATION.ID"), nullable=False, diff --git a/datagateway_api/src/swagger/datagateway_api/openapi.yaml b/datagateway_api/src/swagger/datagateway_api/openapi.yaml index 207fda63..8b7f5a1e 100644 --- a/datagateway_api/src/swagger/datagateway_api/openapi.yaml +++ b/datagateway_api/src/swagger/datagateway_api/openapi.yaml @@ -201,6 +201,39 @@ components: type: object type: array schemas: + AFFILIATION: + properties: + DATAPUBLICATIONUSER: + $ref: '#/components/schemas/DATAPUBLICATIONUSER' + createId: + type: string + createTime: + format: datetime + type: string + dataPublicationUserId: + type: integer + fullReference: + type: string + id: + readOnly: true + type: integer + modId: + type: string + modTime: + format: datetime + type: string + name: + type: string + pid: + type: string + required: + - id + - createId + - createTime + - modId + - modTime + - name + - dataPublicationUserId APPLICATION: properties: FACILITY: @@ -252,10 +285,18 @@ components: items: $ref: '#/components/schemas/DATACOLLECTIONDATASET' type: array + dataCollectionInvestigations: + items: + $ref: '#/components/schemas/DATACOLLECTIONINVESTIGATION' + type: array dataCollectionParameters: items: $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' type: array + dataPublications: + items: + $ref: '#/components/schemas/DATAPUBLICATION' + type: array doi: type: string id: @@ -338,6 +379,37 @@ components: - modTime - dataCollectionID - datasetID + DATACOLLECTIONINVESTIGATION: + properties: + DATACOLLECTION: + $ref: '#/components/schemas/DATACOLLECTION' + INVESTIGATION: + $ref: '#/components/schemas/INVESTIGATION' + createId: + type: string + createTime: + format: datetime + type: string + datacollectionId: + type: integer + id: + readOnly: true + type: integer + investigationId: + type: integer + modId: + type: string + modTime: + format: datetime + type: string + required: + - id + - createId + - createTime + - modId + - modTime + - datacollectionId + - investigationId DATACOLLECTIONPARAMETER: properties: DATACOLLECTION: @@ -527,88 +599,85 @@ components: - modTime - datafileID - parameterTypeID - DATASET: + DATAPUBLICATION: properties: - DATASETTYPE: - $ref: '#/components/schemas/DATASETTYPE' - INVESTIGATION: - $ref: '#/components/schemas/INVESTIGATION' - SAMPLE: - $ref: '#/components/schemas/SAMPLE' - complete: - type: boolean + DATACOLLECTION: + $ref: '#/components/schemas/DATACOLLECTION' + DATAPUBLICATIONTYPE: + $ref: '#/components/schemas/DATAPUBLICATIONTYPE' + FACILITY: + $ref: '#/components/schemas/FACILITY' createId: type: string createTime: format: datetime type: string - dataCollectionDatasets: - items: - $ref: '#/components/schemas/DATACOLLECTIONDATASET' - type: array - datafiles: - items: - $ref: '#/components/schemas/DATAFILE' - type: array - datasetParameters: + dataPublicationDates: items: - $ref: '#/components/schemas/DATASETPARAMETER' + $ref: '#/components/schemas/DATAPUBLICATIONDATE' type: array + datacollectionId: + type: integer + datapublicationtypeId: + type: integer description: type: string - doi: - type: string - endDate: - format: datetime - type: string + facilityId: + type: integer + fundingReferences: + items: + $ref: '#/components/schemas/FUNDINGREFERENCE' + type: array id: readOnly: true type: integer - investigationID: - type: integer - location: - type: string modId: type: string modTime: format: datetime type: string - name: + pid: type: string - sampleID: - type: integer - startDate: + publicationDate: format: datetime type: string - typeID: - type: integer + relatedItems: + items: + $ref: '#/components/schemas/RELATEDITEM' + type: array + subject: + type: string + title: + type: string + users: + items: + $ref: '#/components/schemas/USER' + type: array required: - id - - complete - createId - createTime - modId - modTime - - name - - investigationID - - typeID - DATASETPARAMETER: + - title + - pid + - datacollectionId + - facilityId + - datapublicationtypeId + DATAPUBLICATIONDATE: properties: - DATASET: - $ref: '#/components/schemas/DATASET' - PARAMETERTYPE: - $ref: '#/components/schemas/PARAMETERTYPE' + DATAPUBLICATION: + $ref: '#/components/schemas/DATAPUBLICATION' createId: type: string createTime: format: datetime type: string - datasetID: + datapublicationId: type: integer - dateTimeValue: - format: datetime + date: type: string - error: + dateType: type: string id: readOnly: true @@ -618,15 +687,37 @@ components: modTime: format: datetime type: string - numericValue: + required: + - id + - createId + - createTime + - modId + - modTime + - dateType + - date + - datapublicationId + DATAPUBLICATIONFUNDING: + properties: + DATAPUBLICATION: + $ref: '#/components/schemas/DATAPUBLICATION' + FUNDINGREFERENCE: + $ref: '#/components/schemas/FUNDINGREFERENCE' + createId: type: string - parameterTypeID: - type: integer - rangeBottom: + createTime: + format: datetime type: string - rangeTop: + datapublicationId: + type: integer + fundingId: + type: integer + id: + readOnly: true + type: integer + modId: type: string - stringValue: + modTime: + format: datetime type: string required: - id @@ -634,9 +725,9 @@ components: - createTime - modId - modTime - - datasetID - - parameterTypeID - DATASETTYPE: + - datapublicationId + - fundingId + DATAPUBLICATIONTYPE: properties: FACILITY: $ref: '#/components/schemas/FACILITY' @@ -645,13 +736,13 @@ components: createTime: format: datetime type: string - datasets: + dataPublications: items: - $ref: '#/components/schemas/DATASET' + $ref: '#/components/schemas/DATAPUBLICATION' type: array description: type: string - facilityID: + facilityId: type: integer id: readOnly: true @@ -665,99 +756,105 @@ components: type: string required: - id - - createId - - createTime - modId - modTime - name - - facilityID - FACILITY: + - facilityId + DATAPUBLICATIONUSER: properties: - applications: + DATAPUBLICATION: + $ref: '#/components/schemas/DATAPUBLICATION' + USER: + $ref: '#/components/schemas/USER' + affiliations: items: - $ref: '#/components/schemas/APPLICATION' + $ref: '#/components/schemas/AFFILIATION' type: array + contributorType: + type: string createId: type: string createTime: format: datetime type: string - datafileFormats: - items: - $ref: '#/components/schemas/DATAFILEFORMAT' - type: array - datasetTypes: - items: - $ref: '#/components/schemas/DATASETTYPE' - type: array - daysUntilRelease: - type: integer - description: + email: type: string - facilityCycles: - items: - $ref: '#/components/schemas/FACILITYCYCLE' - type: array fullName: type: string + givenName: + type: string id: readOnly: true type: integer - instruments: - items: - $ref: '#/components/schemas/INSTRUMENT' - type: array - investigationTypes: - items: - $ref: '#/components/schemas/INVESTIGATIONTYPE' - type: array - investigations: - items: - $ref: '#/components/schemas/INVESTIGATION' - type: array modId: type: string modTime: format: datetime type: string - name: - type: string - parameterTypes: - items: - $ref: '#/components/schemas/PARAMETERTYPE' - type: array - sampleTypes: - items: - $ref: '#/components/schemas/SAMPLETYPE' - type: array - url: + orderKey: type: string + publicationId: + type: integer + userID: + type: integer required: - id - createId - createTime - modId - modTime - - name - FACILITYCYCLE: + - contributorType + - publicationId + - userID + DATASET: properties: - FACILITY: - $ref: '#/components/schemas/FACILITY' + DATASETTYPE: + $ref: '#/components/schemas/DATASETTYPE' + INVESTIGATION: + $ref: '#/components/schemas/INVESTIGATION' + SAMPLE: + $ref: '#/components/schemas/SAMPLE' + complete: + type: boolean createId: type: string createTime: format: datetime type: string + dataCollectionDatasets: + items: + $ref: '#/components/schemas/DATACOLLECTIONDATASET' + type: array + datafiles: + items: + $ref: '#/components/schemas/DATAFILE' + type: array + datasetInstruments: + items: + $ref: '#/components/schemas/DATASETINSTRUMENT' + type: array + datasetParameters: + items: + $ref: '#/components/schemas/DATASETPARAMETER' + type: array + datasetTechniques: + items: + $ref: '#/components/schemas/DATASETTECHNIQUE' + type: array description: type: string + doi: + type: string endDate: format: datetime type: string - facilityID: - type: integer id: readOnly: true type: integer + investigationID: + type: integer + location: + type: string modId: type: string modTime: @@ -765,89 +862,89 @@ components: type: string name: type: string + sampleID: + type: integer startDate: format: datetime type: string + typeID: + type: integer required: - id + - complete - createId - createTime - modId - modTime - name - - facilityID - GROUPING: + - investigationID + - typeID + DATASETINSTRUMENT: properties: + DATASET: + $ref: '#/components/schemas/DATASET' + INSTRUMENT: + $ref: '#/components/schemas/INSTRUMENT' createId: type: string createTime: format: datetime type: string - grouping: - items: - $ref: '#/components/schemas/GROUPING' - type: array + datasetId: + type: integer id: readOnly: true type: integer - investigationGroups: - items: - $ref: '#/components/schemas/INVESTIGATIONGROUP' - type: array + instrumentId: + type: integer modId: type: string modTime: format: datetime type: string - name: - type: string - rules: - items: - $ref: '#/components/schemas/RULE' - type: array required: - id - createId - createTime - modId - modTime - - name - INSTRUMENT: + - datasetId + - instrumentId + DATASETPARAMETER: properties: - FACILITY: - $ref: '#/components/schemas/FACILITY' + DATASET: + $ref: '#/components/schemas/DATASET' + PARAMETERTYPE: + $ref: '#/components/schemas/PARAMETERTYPE' createId: type: string createTime: format: datetime type: string - description: - type: string - facilityID: + datasetID: type: integer - fullName: + dateTimeValue: + format: datetime + type: string + error: type: string id: readOnly: true type: integer - instrumentScientists: - items: - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' - type: array - investigationInstruments: - items: - $ref: '#/components/schemas/INVESTIGATIONINSTRUMENT' - type: array modId: type: string modTime: format: datetime type: string - name: + numericValue: type: string - type: + parameterTypeID: + type: integer + rangeBottom: type: string - url: + rangeTop: + type: string + stringValue: type: string required: - id @@ -855,30 +952,32 @@ components: - createTime - modId - modTime - - name - - facilityID - INSTRUMENTSCIENTIST: + - datasetID + - parameterTypeID + DATASETTECHNIQUE: properties: - INSTRUMENT: - $ref: '#/components/schemas/INSTRUMENT' - USER: - $ref: '#/components/schemas/USER' + DATASET: + $ref: '#/components/schemas/DATASET' + TECHNIQUE: + $ref: '#/components/schemas/TECHNIQUE' createId: type: string createTime: format: datetime type: string + datasetId: + type: integer + description: + type: string id: readOnly: true type: integer - instrumentID: - type: integer modId: type: string modTime: format: datetime type: string - userID: + techniqueId: type: integer required: - id @@ -886,14 +985,12 @@ components: - createTime - modId - modTime - - instrumentID - - userID - INVESTIGATION: + - datasetId + - techniqueId + DATASETTYPE: properties: FACILITY: $ref: '#/components/schemas/FACILITY' - INVESTIGATIONTYPE: - $ref: '#/components/schemas/INVESTIGATIONTYPE' createId: type: string createTime: @@ -903,72 +1000,96 @@ components: items: $ref: '#/components/schemas/DATASET' type: array - doi: - type: string - endDate: - format: datetime + description: type: string facilityID: type: integer id: readOnly: true type: integer - investigationGroups: + modId: + type: string + modTime: + format: datetime + type: string + name: + type: string + required: + - id + - createId + - createTime + - modId + - modTime + - name + - facilityID + FACILITY: + properties: + applications: items: - $ref: '#/components/schemas/INVESTIGATIONGROUP' + $ref: '#/components/schemas/APPLICATION' type: array - investigationInstruments: + createId: + type: string + createTime: + format: datetime + type: string + dataPublicationTypes: items: - $ref: '#/components/schemas/INVESTIGATIONINSTRUMENT' + $ref: '#/components/schemas/DATAPUBLICATIONTYPE' type: array - investigationParameters: + dataPublications: items: - $ref: '#/components/schemas/INVESTIGATIONPARAMETER' + $ref: '#/components/schemas/DATAPUBLICATION' type: array - investigationUsers: + datafileFormats: items: - $ref: '#/components/schemas/INVESTIGATIONUSER' + $ref: '#/components/schemas/DATAFILEFORMAT' type: array - keywords: + datasetTypes: items: - $ref: '#/components/schemas/KEYWORD' + $ref: '#/components/schemas/DATASETTYPE' type: array - modId: - type: string - modTime: - format: datetime - type: string - name: + daysUntilRelease: + type: integer + description: type: string - publications: + facilityCycles: items: - $ref: '#/components/schemas/PUBLICATION' + $ref: '#/components/schemas/FACILITYCYCLE' type: array - releaseDate: - format: datetime + fullName: type: string - samples: + id: + readOnly: true + type: integer + instruments: items: - $ref: '#/components/schemas/SAMPLE' + $ref: '#/components/schemas/INSTRUMENT' type: array - shifts: + investigationTypes: items: - $ref: '#/components/schemas/SHIFT' + $ref: '#/components/schemas/INVESTIGATIONTYPE' type: array - startDate: - format: datetime - type: string - studyInvestigations: + investigations: items: - $ref: '#/components/schemas/STUDYINVESTIGATION' + $ref: '#/components/schemas/INVESTIGATION' type: array - summary: + modId: type: string - title: + modTime: + format: datetime type: string - typeID: - type: integer - visitId: + name: + type: string + parameterTypes: + items: + $ref: '#/components/schemas/PARAMETERTYPE' + type: array + sampleTypes: + items: + $ref: '#/components/schemas/SAMPLETYPE' + type: array + url: type: string required: - id @@ -977,34 +1098,38 @@ components: - modId - modTime - name - - title - - visitId - - facilityID - - typeID - INVESTIGATIONGROUP: + FACILITYCYCLE: properties: - GROUPING: - $ref: '#/components/schemas/GROUPING' - INVESTIGATION: - $ref: '#/components/schemas/INVESTIGATION' + FACILITY: + $ref: '#/components/schemas/FACILITY' createId: type: string createTime: format: datetime type: string - groupID: + description: + type: string + endDate: + format: datetime + type: string + facilityID: type: integer id: readOnly: true type: integer - investigationID: - type: integer + investigationFacilityCycles: + items: + $ref: '#/components/schemas/INVESTIGATIONFACILITYCYCLE' + type: array modId: type: string modTime: format: datetime type: string - role: + name: + type: string + startDate: + format: datetime type: string required: - id @@ -1012,85 +1137,86 @@ components: - createTime - modId - modTime - - role - - groupID - - investigationID - INVESTIGATIONINSTRUMENT: + - name + - facilityID + FUNDINGREFERENCE: properties: - INSTRUMENT: - $ref: '#/components/schemas/INSTRUMENT' - INVESTIGATION: - $ref: '#/components/schemas/INVESTIGATION' + awardNumber: + type: string + awardTitle: + type: string createId: type: string createTime: format: datetime type: string + description: + type: string + funderIdentifier: + type: string + funderName: + type: string id: readOnly: true type: integer - instrumentID: - type: integer - investigationID: - type: integer + investigations: + items: + $ref: '#/components/schemas/INVESTIGATION' + type: array modId: type: string modTime: format: datetime type: string + publications: + items: + $ref: '#/components/schemas/PUBLICATION' + type: array required: - id - createId - createTime - modId - modTime - - instrumentID - - investigationID - INVESTIGATIONPARAMETER: + - funderName + - awardNumber + GROUPING: properties: - INVESTIGATION: - $ref: '#/components/schemas/INVESTIGATION' - PARAMETERTYPE: - $ref: '#/components/schemas/PARAMETERTYPE' createId: type: string createTime: format: datetime type: string - dateTimeValue: - format: datetime - type: string - error: - type: string + grouping: + items: + $ref: '#/components/schemas/GROUPING' + type: array id: readOnly: true type: integer - investigationID: - type: integer + investigationGroups: + items: + $ref: '#/components/schemas/INVESTIGATIONGROUP' + type: array modId: type: string modTime: format: datetime type: string - numericValue: - type: string - parameterTypeID: - type: integer - rangeBottom: - type: string - rangeTop: - type: string - stringValue: + name: type: string + rules: + items: + $ref: '#/components/schemas/RULE' + type: array required: - id - createId - createTime - modId - modTime - - investigationID - - parameterTypeID - INVESTIGATIONTYPE: + - name + INSTRUMENT: properties: FACILITY: $ref: '#/components/schemas/FACILITY' @@ -1099,16 +1225,26 @@ components: createTime: format: datetime type: string + datasetInstruments: + items: + $ref: '#/components/schemas/DATASETINSTRUMENT' + type: array description: type: string facilityID: type: integer + fullName: + type: string id: readOnly: true type: integer - investigations: + instrumentScientists: items: - $ref: '#/components/schemas/INVESTIGATION' + $ref: '#/components/schemas/INSTRUMENTSCIENTIST' + type: array + investigationInstruments: + items: + $ref: '#/components/schemas/INVESTIGATIONINSTRUMENT' type: array modId: type: string @@ -1117,6 +1253,10 @@ components: type: string name: type: string + type: + type: string + url: + type: string required: - id - createId @@ -1125,10 +1265,10 @@ components: - modTime - name - facilityID - INVESTIGATIONUSER: + INSTRUMENTSCIENTIST: properties: - INVESTIGATION: - $ref: '#/components/schemas/INVESTIGATION' + INSTRUMENT: + $ref: '#/components/schemas/INSTRUMENT' USER: $ref: '#/components/schemas/USER' createId: @@ -1139,15 +1279,13 @@ components: id: readOnly: true type: integer - investigationID: + instrumentID: type: integer modId: type: string modTime: format: datetime type: string - role: - type: string userID: type: integer required: @@ -1156,45 +1294,121 @@ components: - createTime - modId - modTime - - role - - investigationID + - instrumentID - userID - JOB: + INVESTIGATION: properties: - APPLICATION: - $ref: '#/components/schemas/APPLICATION' - DATACOLLECTION: - $ref: '#/components/schemas/DATACOLLECTION' - applicationID: - type: integer - arguments: - type: string + FACILITY: + $ref: '#/components/schemas/FACILITY' + INVESTIGATIONTYPE: + $ref: '#/components/schemas/INVESTIGATIONTYPE' createId: type: string createTime: format: datetime type: string + dataCollectionInvestigations: + items: + $ref: '#/components/schemas/DATACOLLECTIONINVESTIGATION' + type: array + datasets: + items: + $ref: '#/components/schemas/DATASET' + type: array + doi: + type: string + endDate: + format: datetime + type: string + facilityID: + type: integer + fileCount: + type: integer + fileSize: + type: integer + fundingReferences: + items: + $ref: '#/components/schemas/FUNDINGREFERENCE' + type: array id: readOnly: true type: integer - inputDataCollectionID: - type: integer + investigationFacilityCycles: + items: + $ref: '#/components/schemas/INVESTIGATIONFACILITYCYCLE' + type: array + investigationGroups: + items: + $ref: '#/components/schemas/INVESTIGATIONGROUP' + type: array + investigationInstruments: + items: + $ref: '#/components/schemas/INVESTIGATIONINSTRUMENT' + type: array + investigationParameters: + items: + $ref: '#/components/schemas/INVESTIGATIONPARAMETER' + type: array + investigationUsers: + items: + $ref: '#/components/schemas/INVESTIGATIONUSER' + type: array + keywords: + items: + $ref: '#/components/schemas/KEYWORD' + type: array modId: type: string modTime: format: datetime type: string - outputDataCollectionID: + name: + type: string + publications: + items: + $ref: '#/components/schemas/PUBLICATION' + type: array + releaseDate: + format: datetime + type: string + samples: + items: + $ref: '#/components/schemas/SAMPLE' + type: array + shifts: + items: + $ref: '#/components/schemas/SHIFT' + type: array + startDate: + format: datetime + type: string + studyInvestigations: + items: + $ref: '#/components/schemas/STUDYINVESTIGATION' + type: array + summary: + type: string + title: + type: string + typeID: type: integer + visitId: + type: string required: - id - createId - createTime - modId - modTime - - applicationID - KEYWORD: + - name + - title + - visitId + - facilityID + - typeID + INVESTIGATIONFACILITYCYCLE: properties: + FACILITYCYCLE: + $ref: '#/components/schemas/FACILITYCYCLE' INVESTIGATION: $ref: '#/components/schemas/INVESTIGATION' createId: @@ -1202,6 +1416,8 @@ components: createTime: format: datetime type: string + facilityCycleId: + type: integer id: readOnly: true type: integer @@ -1212,117 +1428,69 @@ components: modTime: format: datetime type: string - name: - type: string required: - id - createId - createTime - modId - modTime - - name + - facilityCycleId - investigationID - PARAMETERTYPE: + INVESTIGATIONFUNDING: properties: - FACILITY: - $ref: '#/components/schemas/FACILITY' - applicableToDataCollection: - type: boolean - applicableToDatafile: - type: boolean - applicableToDataset: - type: boolean - applicableToInvestigation: - type: boolean - applicableToSample: - type: boolean + FUNDINGREFERENCE: + $ref: '#/components/schemas/FUNDINGREFERENCE' + INVESTIGATION: + $ref: '#/components/schemas/INVESTIGATION' createId: type: string createTime: format: datetime type: string - dataCollectionParameters: - items: - $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' - type: array - datafileParameters: - items: - $ref: '#/components/schemas/DATAFILEPARAMETER' - type: array - datasetParameters: - items: - $ref: '#/components/schemas/DATASETPARAMETER' - type: array - description: - type: string - enforced: - type: boolean - facilityID: + fundingId: type: integer id: readOnly: true type: integer - investigationParameters: - items: - $ref: '#/components/schemas/INVESTIGATIONPARAMETER' - type: array - maximumNumericValue: - type: string - minimumNumericValue: - type: string + investigationID: + type: integer modId: type: string modTime: format: datetime type: string - name: - type: string - permissibleStringValues: - items: - $ref: '#/components/schemas/PERMISSIBLESTRINGVALUE' - type: array - sampleParameters: - items: - $ref: '#/components/schemas/SAMPLEPARAMETER' - type: array - units: - type: string - unitsFullName: - type: string - valueType: - type: integer - verified: - type: boolean required: - id - createId - createTime - modId - modTime - - name - - units - - valueType - - facilityID - PERMISSIBLESTRINGVALUE: + - fundingId + - investigationID + INVESTIGATIONGROUP: properties: - PARAMETERTYPE: - $ref: '#/components/schemas/PARAMETERTYPE' + GROUPING: + $ref: '#/components/schemas/GROUPING' + INVESTIGATION: + $ref: '#/components/schemas/INVESTIGATION' createId: type: string createTime: format: datetime type: string + groupID: + type: integer id: readOnly: true type: integer + investigationID: + type: integer modId: type: string modTime: format: datetime type: string - parameterTypeID: - type: integer - value: + role: type: string required: - id @@ -1330,10 +1498,13 @@ components: - createTime - modId - modTime - - value - - parameterTypeID - PUBLICATION: + - role + - groupID + - investigationID + INVESTIGATIONINSTRUMENT: properties: + INSTRUMENT: + $ref: '#/components/schemas/INSTRUMENT' INVESTIGATION: $ref: '#/components/schemas/INVESTIGATION' createId: @@ -1341,13 +1512,11 @@ components: createTime: format: datetime type: string - doi: - type: string - fullReference: - type: string id: readOnly: true type: integer + instrumentID: + type: integer investigationID: type: integer modId: @@ -1355,145 +1524,170 @@ components: modTime: format: datetime type: string - repository: - type: string - repositoryId: - type: string - url: - type: string required: - id - createId - createTime - - fullReference - modId - modTime + - instrumentID - investigationID - PUBLICSTEP: + INVESTIGATIONPARAMETER: properties: + INVESTIGATION: + $ref: '#/components/schemas/INVESTIGATION' + PARAMETERTYPE: + $ref: '#/components/schemas/PARAMETERTYPE' createId: type: string createTime: format: datetime type: string - field: + dateTimeValue: + format: datetime + type: string + error: type: string id: readOnly: true type: integer + investigationID: + type: integer modId: type: string modTime: format: datetime type: string - origin: + numericValue: + type: string + parameterTypeID: + type: integer + rangeBottom: + type: string + rangeTop: + type: string + stringValue: type: string required: - id - createId - createTime - - field - modId - modTime - - origin - RELATEDDATAFILE: + - investigationID + - parameterTypeID + INVESTIGATIONTYPE: properties: - DATAFILE: - $ref: '#/components/schemas/DATAFILE' + FACILITY: + $ref: '#/components/schemas/FACILITY' createId: type: string createTime: format: datetime type: string - destDatafileID: + description: + type: string + facilityID: type: integer id: readOnly: true type: integer + investigations: + items: + $ref: '#/components/schemas/INVESTIGATION' + type: array modId: type: string modTime: format: datetime type: string - relation: + name: type: string - sourceDatafileID: - type: integer required: - id - createId - createTime - modId - modTime - - relation - - destDatafileID - - sourceDatafileID - RULE: + - name + - facilityID + INVESTIGATIONUSER: properties: - GROUPING: - $ref: '#/components/schemas/GROUPING' - attribute: - type: string - bean: - type: string - c: - type: integer + INVESTIGATION: + $ref: '#/components/schemas/INVESTIGATION' + USER: + $ref: '#/components/schemas/USER' createId: type: string createTime: format: datetime type: string - crudFlags: - type: string - crudJPQL: - type: string - d: - type: integer - groupingID: - type: integer id: readOnly: true type: integer - includeJPQL: - type: string + investigationID: + type: integer modId: type: string modTime: format: datetime type: string - r: + role: + type: string + userID: type: integer - restricted: + required: + - id + - createId + - createTime + - modId + - modTime + - role + - investigationID + - userID + JOB: + properties: + APPLICATION: + $ref: '#/components/schemas/APPLICATION' + DATACOLLECTION: + $ref: '#/components/schemas/DATACOLLECTION' + applicationID: type: integer - searchJPQL: + arguments: type: string - u: + createId: + type: string + createTime: + format: datetime + type: string + id: + readOnly: true type: integer - what: + inputDataCollectionID: + type: integer + modId: type: string + modTime: + format: datetime + type: string + outputDataCollectionID: + type: integer required: - id - createId - createTime - - crudFlags - modId - modTime - - what - SAMPLE: + - applicationID + KEYWORD: properties: INVESTIGATION: $ref: '#/components/schemas/INVESTIGATION' - SAMPLETYPE: - $ref: '#/components/schemas/SAMPLETYPE' createId: type: string createTime: format: datetime type: string - datasets: - items: - $ref: '#/components/schemas/DATASET' - type: array id: readOnly: true type: integer @@ -1506,12 +1700,6 @@ components: type: string name: type: string - sampleParameters: - items: - $ref: '#/components/schemas/SAMPLEPARAMETER' - type: array - sampleTypeID: - type: integer required: - id - createId @@ -1520,61 +1708,96 @@ components: - modTime - name - investigationID - SAMPLEPARAMETER: + PARAMETERTYPE: properties: - PARAMETERTYPE: - $ref: '#/components/schemas/PARAMETERTYPE' - SAMPLE: - $ref: '#/components/schemas/SAMPLE' + FACILITY: + $ref: '#/components/schemas/FACILITY' + applicableToDataCollection: + type: boolean + applicableToDatafile: + type: boolean + applicableToDataset: + type: boolean + applicableToInvestigation: + type: boolean + applicableToSample: + type: boolean createId: type: string createTime: format: datetime type: string - dateTimeValue: - format: datetime - type: string - error: + dataCollectionParameters: + items: + $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + type: array + datafileParameters: + items: + $ref: '#/components/schemas/DATAFILEPARAMETER' + type: array + datasetParameters: + items: + $ref: '#/components/schemas/DATASETPARAMETER' + type: array + description: type: string + enforced: + type: boolean + facilityID: + type: integer id: readOnly: true type: integer + investigationParameters: + items: + $ref: '#/components/schemas/INVESTIGATIONPARAMETER' + type: array + maximumNumericValue: + type: string + minimumNumericValue: + type: string modId: type: string modTime: format: datetime type: string - numericValue: + name: type: string - parameterTypeID: - type: integer - rangeBottom: + permissibleStringValues: + items: + $ref: '#/components/schemas/PERMISSIBLESTRINGVALUE' + type: array + sampleParameters: + items: + $ref: '#/components/schemas/SAMPLEPARAMETER' + type: array + units: type: string - rangeTop: + unitsFullName: type: string - sampleID: + valueType: type: integer - stringValue: - type: string + verified: + type: boolean required: - id - createId - createTime - modId - modTime - - sampleID - - parameterTypeID - SAMPLETYPE: + - name + - units + - valueType + - facilityID + PERMISSIBLESTRINGVALUE: properties: - FACILITY: - $ref: '#/components/schemas/FACILITY' + PARAMETERTYPE: + $ref: '#/components/schemas/PARAMETERTYPE' createId: type: string createTime: format: datetime type: string - facilityID: - type: integer id: readOnly: true type: integer @@ -1583,38 +1806,30 @@ components: modTime: format: datetime type: string - molecularFormula: - type: string - name: - type: string - safetyInformation: + parameterTypeID: + type: integer + value: type: string - samples: - items: - $ref: '#/components/schemas/SAMPLE' - type: array required: - id - createId - createTime - modId - modTime - - molecularFormula - - name - - facilityID - SHIFT: + - value + - parameterTypeID + PUBLICATION: properties: INVESTIGATION: $ref: '#/components/schemas/INVESTIGATION' - comment: - type: string createId: type: string createTime: format: datetime type: string - endDate: - format: datetime + doi: + type: string + fullReference: type: string id: readOnly: true @@ -1626,28 +1841,28 @@ components: modTime: format: datetime type: string - startDate: - format: datetime + repository: + type: string + repositoryId: + type: string + url: type: string required: - id - createId - createTime - - endDate + - fullReference - modId - modTime - - startDate - investigationID - STUDY: + PUBLICSTEP: properties: - USER: - $ref: '#/components/schemas/USER' createId: type: string createTime: format: datetime type: string - description: + field: type: string id: readOnly: true @@ -1657,20 +1872,38 @@ components: modTime: format: datetime type: string - name: - type: string - pid: - type: string - startDate: - format: datetime + origin: type: string - status: - type: integer - studyInvestigations: - items: - $ref: '#/components/schemas/STUDYINVESTIGATION' - type: array - userID: + required: + - id + - createId + - createTime + - field + - modId + - modTime + - origin + RELATEDDATAFILE: + properties: + DATAFILE: + $ref: '#/components/schemas/DATAFILE' + createId: + type: string + createTime: + format: datetime + type: string + destDatafileID: + type: integer + id: + readOnly: true + type: integer + modId: + type: string + modTime: + format: datetime + type: string + relation: + type: string + sourceDatafileID: type: integer required: - id @@ -1678,18 +1911,113 @@ components: - createTime - modId - modTime - - name - STUDYINVESTIGATION: + - relation + - destDatafileID + - sourceDatafileID + RELATEDITEM: + properties: + PUBLICATION: + $ref: '#/components/schemas/PUBLICATION' + createId: + type: string + createTime: + format: datetime + type: string + datapublicationId: + type: integer + fullReference: + type: string + id: + readOnly: true + type: integer + identifier: + type: string + modId: + type: string + modTime: + format: datetime + type: string + relatedItemType: + type: string + relationType: + type: string + title: + type: string + required: + - id + - createId + - createTime + - modId + - modTime + - identifier + - relationType + - datapublicationId + RULE: + properties: + GROUPING: + $ref: '#/components/schemas/GROUPING' + attribute: + type: string + bean: + type: string + c: + type: integer + createId: + type: string + createTime: + format: datetime + type: string + crudFlags: + type: string + crudJPQL: + type: string + d: + type: integer + groupingID: + type: integer + id: + readOnly: true + type: integer + includeJPQL: + type: string + modId: + type: string + modTime: + format: datetime + type: string + r: + type: integer + restricted: + type: integer + searchJPQL: + type: string + u: + type: integer + what: + type: string + required: + - id + - createId + - createTime + - crudFlags + - modId + - modTime + - what + SAMPLE: properties: INVESTIGATION: $ref: '#/components/schemas/INVESTIGATION' - STUDY: - $ref: '#/components/schemas/STUDY' + SAMPLETYPE: + $ref: '#/components/schemas/SAMPLETYPE' createId: type: string createTime: format: datetime type: string + datasets: + items: + $ref: '#/components/schemas/DATASET' + type: array id: readOnly: true type: integer @@ -1700,7 +2028,13 @@ components: modTime: format: datetime type: string - studyID: + name: + type: string + sampleParameters: + items: + $ref: '#/components/schemas/SAMPLEPARAMETER' + type: array + sampleTypeID: type: integer required: - id @@ -1708,46 +2042,80 @@ components: - createTime - modId - modTime + - name - investigationID - - studyID - USER: + SAMPLEPARAMETER: properties: + PARAMETERTYPE: + $ref: '#/components/schemas/PARAMETERTYPE' + SAMPLE: + $ref: '#/components/schemas/SAMPLE' createId: type: string createTime: format: datetime type: string - email: + dateTimeValue: + format: datetime type: string - fullName: + error: type: string id: readOnly: true type: integer - instrumentScientists: - items: - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' - type: array - investigationUsers: - items: - $ref: '#/components/schemas/INVESTIGATIONUSER' - type: array modId: type: string modTime: format: datetime type: string + numericValue: + type: string + parameterTypeID: + type: integer + rangeBottom: + type: string + rangeTop: + type: string + sampleID: + type: integer + stringValue: + type: string + required: + - id + - createId + - createTime + - modId + - modTime + - sampleID + - parameterTypeID + SAMPLETYPE: + properties: + FACILITY: + $ref: '#/components/schemas/FACILITY' + createId: + type: string + createTime: + format: datetime + type: string + facilityID: + type: integer + id: + readOnly: true + type: integer + modId: + type: string + modTime: + format: datetime + type: string + molecularFormula: + type: string name: type: string - orcidId: + safetyInformation: type: string - studies: - items: - $ref: '#/components/schemas/STUDY' - type: array - userGroups: + samples: items: - $ref: '#/components/schemas/USERGROUP' + $ref: '#/components/schemas/SAMPLE' type: array required: - id @@ -1755,51 +2123,3079 @@ components: - createTime - modId - modTime + - molecularFormula - name - USERGROUP: + - facilityID + SHIFT: properties: - GROUPING: - $ref: '#/components/schemas/GROUPING' - USER: - $ref: '#/components/schemas/USER' + INVESTIGATION: + $ref: '#/components/schemas/INVESTIGATION' + comment: + type: string createId: type: string createTime: format: datetime type: string - groupID: - type: integer + endDate: + format: datetime + type: string id: readOnly: true type: integer + investigationID: + type: integer modId: type: string modTime: format: datetime type: string - userID: - type: integer + startDate: + format: datetime + type: string required: - id - createId - createTime + - endDate - modId - modTime - - groupID - - userID - securitySchemes: - session_id: - bearerFormat: uuid - scheme: bearer - type: http -info: - title: DataGateway API - version: '1.0' -openapi: 3.0.3 -paths: - /datagateway-api/applications: + - startDate + - investigationID + STUDY: + properties: + USER: + $ref: '#/components/schemas/USER' + createId: + type: string + createTime: + format: datetime + type: string + description: + type: string + id: + readOnly: true + type: integer + modId: + type: string + modTime: + format: datetime + type: string + name: + type: string + pid: + type: string + startDate: + format: datetime + type: string + status: + type: integer + studyInvestigations: + items: + $ref: '#/components/schemas/STUDYINVESTIGATION' + type: array + userID: + type: integer + required: + - id + - createId + - createTime + - modId + - modTime + - name + STUDYINVESTIGATION: + properties: + INVESTIGATION: + $ref: '#/components/schemas/INVESTIGATION' + STUDY: + $ref: '#/components/schemas/STUDY' + createId: + type: string + createTime: + format: datetime + type: string + id: + readOnly: true + type: integer + investigationID: + type: integer + modId: + type: string + modTime: + format: datetime + type: string + studyID: + type: integer + required: + - id + - createId + - createTime + - modId + - modTime + - investigationID + - studyID + TECHNIQUE: + properties: + createId: + type: string + createTime: + format: datetime + type: string + datasetTechniques: + items: + $ref: '#/components/schemas/DATASETTECHNIQUE' + type: array + description: + type: string + id: + readOnly: true + type: integer + modId: + type: string + modTime: + format: datetime + type: string + name: + type: string + pid: + type: string + required: + - id + - createId + - createTime + - modId + - modTime + - name + USER: + properties: + createId: + type: string + createTime: + format: datetime + type: string + dataPublicationUsers: + items: + $ref: '#/components/schemas/DATAPUBLICATIONUSER' + type: array + email: + type: string + fullName: + type: string + id: + readOnly: true + type: integer + instrumentScientists: + items: + $ref: '#/components/schemas/INSTRUMENTSCIENTIST' + type: array + investigationUsers: + items: + $ref: '#/components/schemas/INVESTIGATIONUSER' + type: array + modId: + type: string + modTime: + format: datetime + type: string + name: + type: string + orcidId: + type: string + studies: + items: + $ref: '#/components/schemas/STUDY' + type: array + userGroups: + items: + $ref: '#/components/schemas/USERGROUP' + type: array + required: + - id + - createId + - createTime + - modId + - modTime + - name + USERGROUP: + properties: + GROUPING: + $ref: '#/components/schemas/GROUPING' + USER: + $ref: '#/components/schemas/USER' + createId: + type: string + createTime: + format: datetime + type: string + groupID: + type: integer + id: + readOnly: true + type: integer + modId: + type: string + modTime: + format: datetime + type: string + userID: + type: integer + required: + - id + - createId + - createTime + - modId + - modTime + - groupID + - userID + securitySchemes: + session_id: + bearerFormat: uuid + scheme: bearer + type: http +info: + title: DataGateway API + version: '1.0' +openapi: 3.0.3 +paths: + /datagateway-api/applications: + get: + description: Retrieves a list of Application objects + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/APPLICATION' + type: array + description: Success - returns Application that satisfy the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get Applications + tags: + - Applications + patch: + description: Updates Application object(s) with details provided in the request + body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/APPLICATION' + type: array + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/APPLICATION' + type: array + description: Success - returns the updated object(s) + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update Applications + tags: + - Applications + post: + description: Creates new Application object(s) with details provided in the + request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/APPLICATION' + type: array + description: The values to use to create the new object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/APPLICATION' + type: array + description: Success - returns the created object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Create new Applications + tags: + - Applications + /datagateway-api/applications/{id_}: + delete: + description: Updates Application with the specified ID with details provided + in the request body + parameters: + - description: The id of the entity to delete + in: path + name: id_ + required: true + schema: + type: integer + responses: + '204': + description: No Content - Object was successfully deleted + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Delete Applications by id + tags: + - Applications + get: + description: Retrieves a list of Application objects + parameters: + - description: The id of the entity to retrieve + in: path + name: id_ + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/APPLICATION' + description: Success - the matching Application + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Find the Application matching the given ID + tags: + - Applications + patch: + description: Updates Application with the specified ID with details provided + in the request body + parameters: + - description: The id of the entity to update + in: path + name: id_ + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/APPLICATION' + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/APPLICATION' + description: Success - returns the updated object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update Applications by id + tags: + - Applications + /datagateway-api/applications/count: + get: + description: Return the count of the Application objects that would be retrieved + given the filters provided + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + type: integer + description: Success - The count of the Application objects + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Count Applications + tags: + - Applications + /datagateway-api/applications/findone: + get: + description: Retrieves the first Application objects that satisfies the filters. + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/APPLICATION' + description: Success - a Application object that satisfies the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get single Application + tags: + - Applications + /datagateway-api/affiliations: + get: + description: Retrieves a list of Affiliation objects + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/AFFILIATION' + type: array + description: Success - returns Affiliation that satisfy the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get Affiliations + tags: + - Affiliations + patch: + description: Updates Affiliation object(s) with details provided in the request + body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/AFFILIATION' + type: array + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/AFFILIATION' + type: array + description: Success - returns the updated object(s) + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update Affiliations + tags: + - Affiliations + post: + description: Creates new Affiliation object(s) with details provided in the + request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/AFFILIATION' + type: array + description: The values to use to create the new object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/AFFILIATION' + type: array + description: Success - returns the created object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Create new Affiliations + tags: + - Affiliations + /datagateway-api/affiliations/{id_}: + delete: + description: Updates Affiliation with the specified ID with details provided + in the request body + parameters: + - description: The id of the entity to delete + in: path + name: id_ + required: true + schema: + type: integer + responses: + '204': + description: No Content - Object was successfully deleted + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Delete Affiliations by id + tags: + - Affiliations + get: + description: Retrieves a list of Affiliation objects + parameters: + - description: The id of the entity to retrieve + in: path + name: id_ + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AFFILIATION' + description: Success - the matching Affiliation + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Find the Affiliation matching the given ID + tags: + - Affiliations + patch: + description: Updates Affiliation with the specified ID with details provided + in the request body + parameters: + - description: The id of the entity to update + in: path + name: id_ + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AFFILIATION' + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AFFILIATION' + description: Success - returns the updated object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update Affiliations by id + tags: + - Affiliations + /datagateway-api/affiliations/count: + get: + description: Return the count of the Affiliation objects that would be retrieved + given the filters provided + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + type: integer + description: Success - The count of the Affiliation objects + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Count Affiliations + tags: + - Affiliations + /datagateway-api/affiliations/findone: + get: + description: Retrieves the first Affiliation objects that satisfies the filters. + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AFFILIATION' + description: Success - a Affiliation object that satisfies the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get single Affiliation + tags: + - Affiliations + /datagateway-api/datacollectioninvestigations: + get: + description: Retrieves a list of DataCollectionInvestigation objects + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONINVESTIGATION' + type: array + description: Success - returns DataCollectionInvestigation that satisfy + the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get DataCollectionInvestigations + tags: + - DataCollectionInvestigations + patch: + description: Updates DataCollectionInvestigation object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONINVESTIGATION' + type: array + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONINVESTIGATION' + type: array + description: Success - returns the updated object(s) + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataCollectionInvestigations + tags: + - DataCollectionInvestigations + post: + description: Creates new DataCollectionInvestigation object(s) with details + provided in the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONINVESTIGATION' + type: array + description: The values to use to create the new object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONINVESTIGATION' + type: array + description: Success - returns the created object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Create new DataCollectionInvestigations + tags: + - DataCollectionInvestigations + /datagateway-api/datacollectioninvestigations/{id_}: + delete: + description: Updates DataCollectionInvestigation with the specified ID with + details provided in the request body + parameters: + - description: The id of the entity to delete + in: path + name: id_ + required: true + schema: + type: integer + responses: + '204': + description: No Content - Object was successfully deleted + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Delete DataCollectionInvestigations by id + tags: + - DataCollectionInvestigations + get: + description: Retrieves a list of DataCollectionInvestigation objects + parameters: + - description: The id of the entity to retrieve + in: path + name: id_ + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTIONINVESTIGATION' + description: Success - the matching DataCollectionInvestigation + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Find the DataCollectionInvestigation matching the given ID + tags: + - DataCollectionInvestigations + patch: + description: Updates DataCollectionInvestigation with the specified ID with + details provided in the request body + parameters: + - description: The id of the entity to update + in: path + name: id_ + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTIONINVESTIGATION' + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTIONINVESTIGATION' + description: Success - returns the updated object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataCollectionInvestigations by id + tags: + - DataCollectionInvestigations + /datagateway-api/datacollectioninvestigations/count: + get: + description: Return the count of the DataCollectionInvestigation objects that + would be retrieved given the filters provided + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + type: integer + description: Success - The count of the DataCollectionInvestigation objects + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Count DataCollectionInvestigations + tags: + - DataCollectionInvestigations + /datagateway-api/datacollectioninvestigations/findone: + get: + description: Retrieves the first DataCollectionInvestigation objects that satisfies + the filters. + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTIONINVESTIGATION' + description: Success - a DataCollectionInvestigation object that satisfies + the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get single DataCollectionInvestigation + tags: + - DataCollectionInvestigations + /datagateway-api/datacollectiondatafiles: + get: + description: Retrieves a list of DataCollectionDatafile objects + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + type: array + description: Success - returns DataCollectionDatafile that satisfy the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get DataCollectionDatafiles + tags: + - DataCollectionDatafiles + patch: + description: Updates DataCollectionDatafile object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + type: array + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + type: array + description: Success - returns the updated object(s) + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataCollectionDatafiles + tags: + - DataCollectionDatafiles + post: + description: Creates new DataCollectionDatafile object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + type: array + description: The values to use to create the new object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + type: array + description: Success - returns the created object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Create new DataCollectionDatafiles + tags: + - DataCollectionDatafiles + /datagateway-api/datacollectiondatafiles/{id_}: + delete: + description: Updates DataCollectionDatafile with the specified ID with details + provided in the request body + parameters: + - description: The id of the entity to delete + in: path + name: id_ + required: true + schema: + type: integer + responses: + '204': + description: No Content - Object was successfully deleted + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Delete DataCollectionDatafiles by id + tags: + - DataCollectionDatafiles + get: + description: Retrieves a list of DataCollectionDatafile objects + parameters: + - description: The id of the entity to retrieve + in: path + name: id_ + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + description: Success - the matching DataCollectionDatafile + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Find the DataCollectionDatafile matching the given ID + tags: + - DataCollectionDatafiles + patch: + description: Updates DataCollectionDatafile with the specified ID with details + provided in the request body + parameters: + - description: The id of the entity to update + in: path + name: id_ + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + description: Success - returns the updated object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataCollectionDatafiles by id + tags: + - DataCollectionDatafiles + /datagateway-api/datacollectiondatafiles/count: + get: + description: Return the count of the DataCollectionDatafile objects that would + be retrieved given the filters provided + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + type: integer + description: Success - The count of the DataCollectionDatafile objects + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Count DataCollectionDatafiles + tags: + - DataCollectionDatafiles + /datagateway-api/datacollectiondatafiles/findone: + get: + description: Retrieves the first DataCollectionDatafile objects that satisfies + the filters. + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + description: Success - a DataCollectionDatafile object that satisfies the + filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get single DataCollectionDatafile + tags: + - DataCollectionDatafiles + /datagateway-api/datacollectiondatasets: + get: + description: Retrieves a list of DataCollectionDataset objects + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONDATASET' + type: array + description: Success - returns DataCollectionDataset that satisfy the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get DataCollectionDatasets + tags: + - DataCollectionDatasets + patch: + description: Updates DataCollectionDataset object(s) with details provided in + the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONDATASET' + type: array + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONDATASET' + type: array + description: Success - returns the updated object(s) + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataCollectionDatasets + tags: + - DataCollectionDatasets + post: + description: Creates new DataCollectionDataset object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONDATASET' + type: array + description: The values to use to create the new object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONDATASET' + type: array + description: Success - returns the created object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Create new DataCollectionDatasets + tags: + - DataCollectionDatasets + /datagateway-api/datacollectiondatasets/{id_}: + delete: + description: Updates DataCollectionDataset with the specified ID with details + provided in the request body + parameters: + - description: The id of the entity to delete + in: path + name: id_ + required: true + schema: + type: integer + responses: + '204': + description: No Content - Object was successfully deleted + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Delete DataCollectionDatasets by id + tags: + - DataCollectionDatasets + get: + description: Retrieves a list of DataCollectionDataset objects + parameters: + - description: The id of the entity to retrieve + in: path + name: id_ + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTIONDATASET' + description: Success - the matching DataCollectionDataset + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Find the DataCollectionDataset matching the given ID + tags: + - DataCollectionDatasets + patch: + description: Updates DataCollectionDataset with the specified ID with details + provided in the request body + parameters: + - description: The id of the entity to update + in: path + name: id_ + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTIONDATASET' + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTIONDATASET' + description: Success - returns the updated object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataCollectionDatasets by id + tags: + - DataCollectionDatasets + /datagateway-api/datacollectiondatasets/count: + get: + description: Return the count of the DataCollectionDataset objects that would + be retrieved given the filters provided + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + type: integer + description: Success - The count of the DataCollectionDataset objects + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Count DataCollectionDatasets + tags: + - DataCollectionDatasets + /datagateway-api/datacollectiondatasets/findone: + get: + description: Retrieves the first DataCollectionDataset objects that satisfies + the filters. + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTIONDATASET' + description: Success - a DataCollectionDataset object that satisfies the + filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get single DataCollectionDataset + tags: + - DataCollectionDatasets + /datagateway-api/datacollectionparameters: + get: + description: Retrieves a list of DataCollectionParameter objects + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + type: array + description: Success - returns DataCollectionParameter that satisfy the + filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get DataCollectionParameters + tags: + - DataCollectionParameters + patch: + description: Updates DataCollectionParameter object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + type: array + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + type: array + description: Success - returns the updated object(s) + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataCollectionParameters + tags: + - DataCollectionParameters + post: + description: Creates new DataCollectionParameter object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + type: array + description: The values to use to create the new object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + type: array + description: Success - returns the created object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Create new DataCollectionParameters + tags: + - DataCollectionParameters + /datagateway-api/datacollectionparameters/{id_}: + delete: + description: Updates DataCollectionParameter with the specified ID with details + provided in the request body + parameters: + - description: The id of the entity to delete + in: path + name: id_ + required: true + schema: + type: integer + responses: + '204': + description: No Content - Object was successfully deleted + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Delete DataCollectionParameters by id + tags: + - DataCollectionParameters + get: + description: Retrieves a list of DataCollectionParameter objects + parameters: + - description: The id of the entity to retrieve + in: path + name: id_ + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + description: Success - the matching DataCollectionParameter + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Find the DataCollectionParameter matching the given ID + tags: + - DataCollectionParameters + patch: + description: Updates DataCollectionParameter with the specified ID with details + provided in the request body + parameters: + - description: The id of the entity to update + in: path + name: id_ + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + description: Success - returns the updated object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataCollectionParameters by id + tags: + - DataCollectionParameters + /datagateway-api/datacollectionparameters/count: + get: + description: Return the count of the DataCollectionParameter objects that would + be retrieved given the filters provided + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + type: integer + description: Success - The count of the DataCollectionParameter objects + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Count DataCollectionParameters + tags: + - DataCollectionParameters + /datagateway-api/datacollectionparameters/findone: + get: + description: Retrieves the first DataCollectionParameter objects that satisfies + the filters. + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + description: Success - a DataCollectionParameter object that satisfies the + filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get single DataCollectionParameter + tags: + - DataCollectionParameters + /datagateway-api/datacollections: + get: + description: Retrieves a list of DataCollection objects + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTION' + type: array + description: Success - returns DataCollection that satisfy the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get DataCollections + tags: + - DataCollections + patch: + description: Updates DataCollection object(s) with details provided in the request + body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTION' + type: array + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTION' + type: array + description: Success - returns the updated object(s) + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataCollections + tags: + - DataCollections + post: + description: Creates new DataCollection object(s) with details provided in the + request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTION' + type: array + description: The values to use to create the new object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATACOLLECTION' + type: array + description: Success - returns the created object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Create new DataCollections + tags: + - DataCollections + /datagateway-api/datacollections/{id_}: + delete: + description: Updates DataCollection with the specified ID with details provided + in the request body + parameters: + - description: The id of the entity to delete + in: path + name: id_ + required: true + schema: + type: integer + responses: + '204': + description: No Content - Object was successfully deleted + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Delete DataCollections by id + tags: + - DataCollections + get: + description: Retrieves a list of DataCollection objects + parameters: + - description: The id of the entity to retrieve + in: path + name: id_ + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTION' + description: Success - the matching DataCollection + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Find the DataCollection matching the given ID + tags: + - DataCollections + patch: + description: Updates DataCollection with the specified ID with details provided + in the request body + parameters: + - description: The id of the entity to update + in: path + name: id_ + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTION' + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTION' + description: Success - returns the updated object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataCollections by id + tags: + - DataCollections + /datagateway-api/datacollections/count: + get: + description: Return the count of the DataCollection objects that would be retrieved + given the filters provided + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + type: integer + description: Success - The count of the DataCollection objects + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Count DataCollections + tags: + - DataCollections + /datagateway-api/datacollections/findone: + get: + description: Retrieves the first DataCollection objects that satisfies the filters. + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATACOLLECTION' + description: Success - a DataCollection object that satisfies the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get single DataCollection + tags: + - DataCollections + /datagateway-api/datapublications: + get: + description: Retrieves a list of DataPublication objects + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATION' + type: array + description: Success - returns DataPublication that satisfy the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get DataPublications + tags: + - DataPublications + patch: + description: Updates DataPublication object(s) with details provided in the + request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATION' + type: array + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATION' + type: array + description: Success - returns the updated object(s) + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataPublications + tags: + - DataPublications + post: + description: Creates new DataPublication object(s) with details provided in + the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATION' + type: array + description: The values to use to create the new object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATION' + type: array + description: Success - returns the created object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Create new DataPublications + tags: + - DataPublications + /datagateway-api/datapublications/{id_}: + delete: + description: Updates DataPublication with the specified ID with details provided + in the request body + parameters: + - description: The id of the entity to delete + in: path + name: id_ + required: true + schema: + type: integer + responses: + '204': + description: No Content - Object was successfully deleted + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Delete DataPublications by id + tags: + - DataPublications + get: + description: Retrieves a list of DataPublication objects + parameters: + - description: The id of the entity to retrieve + in: path + name: id_ + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATION' + description: Success - the matching DataPublication + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Find the DataPublication matching the given ID + tags: + - DataPublications + patch: + description: Updates DataPublication with the specified ID with details provided + in the request body + parameters: + - description: The id of the entity to update + in: path + name: id_ + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATION' + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATION' + description: Success - returns the updated object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataPublications by id + tags: + - DataPublications + /datagateway-api/datapublications/count: + get: + description: Return the count of the DataPublication objects that would be retrieved + given the filters provided + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + type: integer + description: Success - The count of the DataPublication objects + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Count DataPublications + tags: + - DataPublications + /datagateway-api/datapublications/findone: + get: + description: Retrieves the first DataPublication objects that satisfies the + filters. + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATION' + description: Success - a DataPublication object that satisfies the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get single DataPublication + tags: + - DataPublications + /datagateway-api/datapublicationdates: + get: + description: Retrieves a list of DataPublicationDate objects + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONDATE' + type: array + description: Success - returns DataPublicationDate that satisfy the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get DataPublicationDates + tags: + - DataPublicationDates + patch: + description: Updates DataPublicationDate object(s) with details provided in + the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONDATE' + type: array + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONDATE' + type: array + description: Success - returns the updated object(s) + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataPublicationDates + tags: + - DataPublicationDates + post: + description: Creates new DataPublicationDate object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONDATE' + type: array + description: The values to use to create the new object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONDATE' + type: array + description: Success - returns the created object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Create new DataPublicationDates + tags: + - DataPublicationDates + /datagateway-api/datapublicationdates/{id_}: + delete: + description: Updates DataPublicationDate with the specified ID with details + provided in the request body + parameters: + - description: The id of the entity to delete + in: path + name: id_ + required: true + schema: + type: integer + responses: + '204': + description: No Content - Object was successfully deleted + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Delete DataPublicationDates by id + tags: + - DataPublicationDates + get: + description: Retrieves a list of DataPublicationDate objects + parameters: + - description: The id of the entity to retrieve + in: path + name: id_ + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATIONDATE' + description: Success - the matching DataPublicationDate + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Find the DataPublicationDate matching the given ID + tags: + - DataPublicationDates + patch: + description: Updates DataPublicationDate with the specified ID with details + provided in the request body + parameters: + - description: The id of the entity to update + in: path + name: id_ + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATIONDATE' + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATIONDATE' + description: Success - returns the updated object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataPublicationDates by id + tags: + - DataPublicationDates + /datagateway-api/datapublicationdates/count: + get: + description: Return the count of the DataPublicationDate objects that would + be retrieved given the filters provided + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + type: integer + description: Success - The count of the DataPublicationDate objects + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Count DataPublicationDates + tags: + - DataPublicationDates + /datagateway-api/datapublicationdates/findone: + get: + description: Retrieves the first DataPublicationDate objects that satisfies + the filters. + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATIONDATE' + description: Success - a DataPublicationDate object that satisfies the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get single DataPublicationDate + tags: + - DataPublicationDates + /datagateway-api/datapublicationfundings: + get: + description: Retrieves a list of DataPublicationFunding objects + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONFUNDING' + type: array + description: Success - returns DataPublicationFunding that satisfy the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get DataPublicationFundings + tags: + - DataPublicationFundings + patch: + description: Updates DataPublicationFunding object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONFUNDING' + type: array + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONFUNDING' + type: array + description: Success - returns the updated object(s) + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataPublicationFundings + tags: + - DataPublicationFundings + post: + description: Creates new DataPublicationFunding object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONFUNDING' + type: array + description: The values to use to create the new object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONFUNDING' + type: array + description: Success - returns the created object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Create new DataPublicationFundings + tags: + - DataPublicationFundings + /datagateway-api/datapublicationfundings/{id_}: + delete: + description: Updates DataPublicationFunding with the specified ID with details + provided in the request body + parameters: + - description: The id of the entity to delete + in: path + name: id_ + required: true + schema: + type: integer + responses: + '204': + description: No Content - Object was successfully deleted + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Delete DataPublicationFundings by id + tags: + - DataPublicationFundings + get: + description: Retrieves a list of DataPublicationFunding objects + parameters: + - description: The id of the entity to retrieve + in: path + name: id_ + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATIONFUNDING' + description: Success - the matching DataPublicationFunding + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Find the DataPublicationFunding matching the given ID + tags: + - DataPublicationFundings + patch: + description: Updates DataPublicationFunding with the specified ID with details + provided in the request body + parameters: + - description: The id of the entity to update + in: path + name: id_ + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATIONFUNDING' + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATIONFUNDING' + description: Success - returns the updated object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataPublicationFundings by id + tags: + - DataPublicationFundings + /datagateway-api/datapublicationfundings/count: + get: + description: Return the count of the DataPublicationFunding objects that would + be retrieved given the filters provided + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + type: integer + description: Success - The count of the DataPublicationFunding objects + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Count DataPublicationFundings + tags: + - DataPublicationFundings + /datagateway-api/datapublicationfundings/findone: + get: + description: Retrieves the first DataPublicationFunding objects that satisfies + the filters. + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATIONFUNDING' + description: Success - a DataPublicationFunding object that satisfies the + filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get single DataPublicationFunding + tags: + - DataPublicationFundings + /datagateway-api/datapublicationtypes: + get: + description: Retrieves a list of DataPublicationType objects + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONTYPE' + type: array + description: Success - returns DataPublicationType that satisfy the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get DataPublicationTypes + tags: + - DataPublicationTypes + patch: + description: Updates DataPublicationType object(s) with details provided in + the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONTYPE' + type: array + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONTYPE' + type: array + description: Success - returns the updated object(s) + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataPublicationTypes + tags: + - DataPublicationTypes + post: + description: Creates new DataPublicationType object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONTYPE' + type: array + description: The values to use to create the new object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONTYPE' + type: array + description: Success - returns the created object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Create new DataPublicationTypes + tags: + - DataPublicationTypes + /datagateway-api/datapublicationtypes/{id_}: + delete: + description: Updates DataPublicationType with the specified ID with details + provided in the request body + parameters: + - description: The id of the entity to delete + in: path + name: id_ + required: true + schema: + type: integer + responses: + '204': + description: No Content - Object was successfully deleted + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Delete DataPublicationTypes by id + tags: + - DataPublicationTypes + get: + description: Retrieves a list of DataPublicationType objects + parameters: + - description: The id of the entity to retrieve + in: path + name: id_ + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATIONTYPE' + description: Success - the matching DataPublicationType + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Find the DataPublicationType matching the given ID + tags: + - DataPublicationTypes + patch: + description: Updates DataPublicationType with the specified ID with details + provided in the request body + parameters: + - description: The id of the entity to update + in: path + name: id_ + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATIONTYPE' + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATIONTYPE' + description: Success - returns the updated object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataPublicationTypes by id + tags: + - DataPublicationTypes + /datagateway-api/datapublicationtypes/count: + get: + description: Return the count of the DataPublicationType objects that would + be retrieved given the filters provided + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + type: integer + description: Success - The count of the DataPublicationType objects + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Count DataPublicationTypes + tags: + - DataPublicationTypes + /datagateway-api/datapublicationtypes/findone: + get: + description: Retrieves the first DataPublicationType objects that satisfies + the filters. + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATIONTYPE' + description: Success - a DataPublicationType object that satisfies the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get single DataPublicationType + tags: + - DataPublicationTypes + /datagateway-api/datapublicationusers: + get: + description: Retrieves a list of DataPublicationUser objects + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONUSER' + type: array + description: Success - returns DataPublicationUser that satisfy the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get DataPublicationUsers + tags: + - DataPublicationUsers + patch: + description: Updates DataPublicationUser object(s) with details provided in + the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONUSER' + type: array + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONUSER' + type: array + description: Success - returns the updated object(s) + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataPublicationUsers + tags: + - DataPublicationUsers + post: + description: Creates new DataPublicationUser object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONUSER' + type: array + description: The values to use to create the new object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DATAPUBLICATIONUSER' + type: array + description: Success - returns the created object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Create new DataPublicationUsers + tags: + - DataPublicationUsers + /datagateway-api/datapublicationusers/{id_}: + delete: + description: Updates DataPublicationUser with the specified ID with details + provided in the request body + parameters: + - description: The id of the entity to delete + in: path + name: id_ + required: true + schema: + type: integer + responses: + '204': + description: No Content - Object was successfully deleted + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Delete DataPublicationUsers by id + tags: + - DataPublicationUsers + get: + description: Retrieves a list of DataPublicationUser objects + parameters: + - description: The id of the entity to retrieve + in: path + name: id_ + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATIONUSER' + description: Success - the matching DataPublicationUser + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Find the DataPublicationUser matching the given ID + tags: + - DataPublicationUsers + patch: + description: Updates DataPublicationUser with the specified ID with details + provided in the request body + parameters: + - description: The id of the entity to update + in: path + name: id_ + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATIONUSER' + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATIONUSER' + description: Success - returns the updated object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update DataPublicationUsers by id + tags: + - DataPublicationUsers + /datagateway-api/datapublicationusers/count: get: - description: Retrieves a list of Application objects + description: Return the count of the DataPublicationUser objects that would + be retrieved given the filters provided + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + type: integer + description: Success - The count of the DataPublicationUser objects + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Count DataPublicationUsers + tags: + - DataPublicationUsers + /datagateway-api/datapublicationusers/findone: + get: + description: Retrieves the first DataPublicationUser objects that satisfies + the filters. + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DATAPUBLICATIONUSER' + description: Success - a DataPublicationUser object that satisfies the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get single DataPublicationUser + tags: + - DataPublicationUsers + /datagateway-api/datafileformats: + get: + description: Retrieves a list of DatafileFormat objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -1813,9 +5209,9 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/APPLICATION' + $ref: '#/components/schemas/DATAFILEFORMAT' type: array - description: Success - returns Application that satisfy the filters + description: Success - returns DatafileFormat that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -1824,18 +5220,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get Applications + summary: Get DatafileFormats tags: - - Applications + - DatafileFormats patch: - description: Updates Application object(s) with details provided in the request + description: Updates DatafileFormat object(s) with details provided in the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/APPLICATION' + $ref: '#/components/schemas/DATAFILEFORMAT' type: array description: The values to use to update the object(s) with required: true @@ -1845,7 +5241,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/APPLICATION' + $ref: '#/components/schemas/DATAFILEFORMAT' type: array description: Success - returns the updated object(s) '400': @@ -1856,18 +5252,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update Applications + summary: Update DatafileFormats tags: - - Applications + - DatafileFormats post: - description: Creates new Application object(s) with details provided in the + description: Creates new DatafileFormat object(s) with details provided in the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/APPLICATION' + $ref: '#/components/schemas/DATAFILEFORMAT' type: array description: The values to use to create the new object(s) with required: true @@ -1877,7 +5273,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/APPLICATION' + $ref: '#/components/schemas/DATAFILEFORMAT' type: array description: Success - returns the created object '400': @@ -1888,12 +5284,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Create new Applications + summary: Create new DatafileFormats tags: - - Applications - /datagateway-api/applications/{id_}: + - DatafileFormats + /datagateway-api/datafileformats/{id_}: delete: - description: Updates Application with the specified ID with details provided + description: Updates DatafileFormat with the specified ID with details provided in the request body parameters: - description: The id of the entity to delete @@ -1913,11 +5309,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Delete Applications by id + summary: Delete DatafileFormats by id tags: - - Applications + - DatafileFormats get: - description: Retrieves a list of Application objects + description: Retrieves a list of DatafileFormat objects parameters: - description: The id of the entity to retrieve in: path @@ -1930,8 +5326,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/APPLICATION' - description: Success - the matching Application + $ref: '#/components/schemas/DATAFILEFORMAT' + description: Success - the matching DatafileFormat '400': description: Bad request - Something was wrong with the request '401': @@ -1940,11 +5336,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Find the Application matching the given ID + summary: Find the DatafileFormat matching the given ID tags: - - Applications + - DatafileFormats patch: - description: Updates Application with the specified ID with details provided + description: Updates DatafileFormat with the specified ID with details provided in the request body parameters: - description: The id of the entity to update @@ -1957,7 +5353,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/APPLICATION' + $ref: '#/components/schemas/DATAFILEFORMAT' description: The values to use to update the object(s) with required: true responses: @@ -1965,7 +5361,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/APPLICATION' + $ref: '#/components/schemas/DATAFILEFORMAT' description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request @@ -1975,12 +5371,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update Applications by id + summary: Update DatafileFormats by id tags: - - Applications - /datagateway-api/applications/count: + - DatafileFormats + /datagateway-api/datafileformats/count: get: - description: Return the count of the Application objects that would be retrieved + description: Return the count of the DatafileFormat objects that would be retrieved given the filters provided parameters: - $ref: '#/components/parameters/WHERE_FILTER' @@ -1992,7 +5388,7 @@ paths: application/json: schema: type: integer - description: Success - The count of the Application objects + description: Success - The count of the DatafileFormat objects '400': description: Bad request - Something was wrong with the request '401': @@ -2001,12 +5397,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Count Applications + summary: Count DatafileFormats tags: - - Applications - /datagateway-api/applications/findone: + - DatafileFormats + /datagateway-api/datafileformats/findone: get: - description: Retrieves the first Application objects that satisfies the filters. + description: Retrieves the first DatafileFormat objects that satisfies the filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -2019,8 +5415,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/APPLICATION' - description: Success - a Application object that satisfies the filters + $ref: '#/components/schemas/DATAFILEFORMAT' + description: Success - a DatafileFormat object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -2029,12 +5425,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single Application + summary: Get single DatafileFormat tags: - - Applications - /datagateway-api/datacollectiondatafiles: + - DatafileFormats + /datagateway-api/datafileparameters: get: - description: Retrieves a list of DataCollectionDatafile objects + description: Retrieves a list of DatafileParameter objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -2048,9 +5444,9 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + $ref: '#/components/schemas/DATAFILEPARAMETER' type: array - description: Success - returns DataCollectionDatafile that satisfy the filters + description: Success - returns DatafileParameter that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -2059,18 +5455,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get DataCollectionDatafiles + summary: Get DatafileParameters tags: - - DataCollectionDatafiles + - DatafileParameters patch: - description: Updates DataCollectionDatafile object(s) with details provided - in the request body + description: Updates DatafileParameter object(s) with details provided in the + request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + $ref: '#/components/schemas/DATAFILEPARAMETER' type: array description: The values to use to update the object(s) with required: true @@ -2080,7 +5476,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + $ref: '#/components/schemas/DATAFILEPARAMETER' type: array description: Success - returns the updated object(s) '400': @@ -2091,18 +5487,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update DataCollectionDatafiles + summary: Update DatafileParameters tags: - - DataCollectionDatafiles + - DatafileParameters post: - description: Creates new DataCollectionDatafile object(s) with details provided - in the request body + description: Creates new DatafileParameter object(s) with details provided in + the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + $ref: '#/components/schemas/DATAFILEPARAMETER' type: array description: The values to use to create the new object(s) with required: true @@ -2112,7 +5508,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + $ref: '#/components/schemas/DATAFILEPARAMETER' type: array description: Success - returns the created object '400': @@ -2123,13 +5519,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Create new DataCollectionDatafiles + summary: Create new DatafileParameters tags: - - DataCollectionDatafiles - /datagateway-api/datacollectiondatafiles/{id_}: + - DatafileParameters + /datagateway-api/datafileparameters/{id_}: delete: - description: Updates DataCollectionDatafile with the specified ID with details - provided in the request body + description: Updates DatafileParameter with the specified ID with details provided + in the request body parameters: - description: The id of the entity to delete in: path @@ -2148,11 +5544,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Delete DataCollectionDatafiles by id + summary: Delete DatafileParameters by id tags: - - DataCollectionDatafiles + - DatafileParameters get: - description: Retrieves a list of DataCollectionDatafile objects + description: Retrieves a list of DatafileParameter objects parameters: - description: The id of the entity to retrieve in: path @@ -2165,8 +5561,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' - description: Success - the matching DataCollectionDatafile + $ref: '#/components/schemas/DATAFILEPARAMETER' + description: Success - the matching DatafileParameter '400': description: Bad request - Something was wrong with the request '401': @@ -2175,12 +5571,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Find the DataCollectionDatafile matching the given ID + summary: Find the DatafileParameter matching the given ID tags: - - DataCollectionDatafiles + - DatafileParameters patch: - description: Updates DataCollectionDatafile with the specified ID with details - provided in the request body + description: Updates DatafileParameter with the specified ID with details provided + in the request body parameters: - description: The id of the entity to update in: path @@ -2192,7 +5588,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + $ref: '#/components/schemas/DATAFILEPARAMETER' description: The values to use to update the object(s) with required: true responses: @@ -2200,7 +5596,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + $ref: '#/components/schemas/DATAFILEPARAMETER' description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request @@ -2210,13 +5606,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update DataCollectionDatafiles by id + summary: Update DatafileParameters by id tags: - - DataCollectionDatafiles - /datagateway-api/datacollectiondatafiles/count: + - DatafileParameters + /datagateway-api/datafileparameters/count: get: - description: Return the count of the DataCollectionDatafile objects that would - be retrieved given the filters provided + description: Return the count of the DatafileParameter objects that would be + retrieved given the filters provided parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/DISTINCT_FILTER' @@ -2227,7 +5623,7 @@ paths: application/json: schema: type: integer - description: Success - The count of the DataCollectionDatafile objects + description: Success - The count of the DatafileParameter objects '400': description: Bad request - Something was wrong with the request '401': @@ -2236,13 +5632,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Count DataCollectionDatafiles + summary: Count DatafileParameters tags: - - DataCollectionDatafiles - /datagateway-api/datacollectiondatafiles/findone: + - DatafileParameters + /datagateway-api/datafileparameters/findone: get: - description: Retrieves the first DataCollectionDatafile objects that satisfies - the filters. + description: Retrieves the first DatafileParameter objects that satisfies the + filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -2255,9 +5651,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' - description: Success - a DataCollectionDatafile object that satisfies the - filters + $ref: '#/components/schemas/DATAFILEPARAMETER' + description: Success - a DatafileParameter object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -2266,12 +5661,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single DataCollectionDatafile - tags: - - DataCollectionDatafiles - /datagateway-api/datacollectiondatasets: + summary: Get single DatafileParameter + tags: + - DatafileParameters + /datagateway-api/datafiles: get: - description: Retrieves a list of DataCollectionDataset objects + description: Retrieves a list of Datafile objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -2285,9 +5680,9 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTIONDATASET' + $ref: '#/components/schemas/DATAFILE' type: array - description: Success - returns DataCollectionDataset that satisfy the filters + description: Success - returns Datafile that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -2296,18 +5691,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get DataCollectionDatasets + summary: Get Datafiles tags: - - DataCollectionDatasets + - Datafiles patch: - description: Updates DataCollectionDataset object(s) with details provided in - the request body + description: Updates Datafile object(s) with details provided in the request + body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTIONDATASET' + $ref: '#/components/schemas/DATAFILE' type: array description: The values to use to update the object(s) with required: true @@ -2317,7 +5712,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTIONDATASET' + $ref: '#/components/schemas/DATAFILE' type: array description: Success - returns the updated object(s) '400': @@ -2328,18 +5723,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update DataCollectionDatasets + summary: Update Datafiles tags: - - DataCollectionDatasets + - Datafiles post: - description: Creates new DataCollectionDataset object(s) with details provided - in the request body + description: Creates new Datafile object(s) with details provided in the request + body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTIONDATASET' + $ref: '#/components/schemas/DATAFILE' type: array description: The values to use to create the new object(s) with required: true @@ -2349,7 +5744,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTIONDATASET' + $ref: '#/components/schemas/DATAFILE' type: array description: Success - returns the created object '400': @@ -2360,13 +5755,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Create new DataCollectionDatasets + summary: Create new Datafiles tags: - - DataCollectionDatasets - /datagateway-api/datacollectiondatasets/{id_}: + - Datafiles + /datagateway-api/datafiles/{id_}: delete: - description: Updates DataCollectionDataset with the specified ID with details - provided in the request body + description: Updates Datafile with the specified ID with details provided in + the request body parameters: - description: The id of the entity to delete in: path @@ -2385,11 +5780,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Delete DataCollectionDatasets by id + summary: Delete Datafiles by id tags: - - DataCollectionDatasets + - Datafiles get: - description: Retrieves a list of DataCollectionDataset objects + description: Retrieves a list of Datafile objects parameters: - description: The id of the entity to retrieve in: path @@ -2402,8 +5797,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATACOLLECTIONDATASET' - description: Success - the matching DataCollectionDataset + $ref: '#/components/schemas/DATAFILE' + description: Success - the matching Datafile '400': description: Bad request - Something was wrong with the request '401': @@ -2412,12 +5807,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Find the DataCollectionDataset matching the given ID + summary: Find the Datafile matching the given ID tags: - - DataCollectionDatasets + - Datafiles patch: - description: Updates DataCollectionDataset with the specified ID with details - provided in the request body + description: Updates Datafile with the specified ID with details provided in + the request body parameters: - description: The id of the entity to update in: path @@ -2429,7 +5824,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATACOLLECTIONDATASET' + $ref: '#/components/schemas/DATAFILE' description: The values to use to update the object(s) with required: true responses: @@ -2437,7 +5832,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATACOLLECTIONDATASET' + $ref: '#/components/schemas/DATAFILE' description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request @@ -2447,13 +5842,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update DataCollectionDatasets by id + summary: Update Datafiles by id tags: - - DataCollectionDatasets - /datagateway-api/datacollectiondatasets/count: + - Datafiles + /datagateway-api/datafiles/count: get: - description: Return the count of the DataCollectionDataset objects that would - be retrieved given the filters provided + description: Return the count of the Datafile objects that would be retrieved + given the filters provided parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/DISTINCT_FILTER' @@ -2464,7 +5859,7 @@ paths: application/json: schema: type: integer - description: Success - The count of the DataCollectionDataset objects + description: Success - The count of the Datafile objects '400': description: Bad request - Something was wrong with the request '401': @@ -2473,13 +5868,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Count DataCollectionDatasets + summary: Count Datafiles tags: - - DataCollectionDatasets - /datagateway-api/datacollectiondatasets/findone: + - Datafiles + /datagateway-api/datafiles/findone: get: - description: Retrieves the first DataCollectionDataset objects that satisfies - the filters. + description: Retrieves the first Datafile objects that satisfies the filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -2492,9 +5886,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATACOLLECTIONDATASET' - description: Success - a DataCollectionDataset object that satisfies the - filters + $ref: '#/components/schemas/DATAFILE' + description: Success - a Datafile object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -2503,12 +5896,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single DataCollectionDataset + summary: Get single Datafile tags: - - DataCollectionDatasets - /datagateway-api/datacollectionparameters: + - Datafiles + /datagateway-api/datasetparameters: get: - description: Retrieves a list of DataCollectionParameter objects + description: Retrieves a list of DatasetParameter objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -2522,10 +5915,9 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + $ref: '#/components/schemas/DATASETPARAMETER' type: array - description: Success - returns DataCollectionParameter that satisfy the - filters + description: Success - returns DatasetParameter that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -2534,18 +5926,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get DataCollectionParameters + summary: Get DatasetParameters tags: - - DataCollectionParameters + - DatasetParameters patch: - description: Updates DataCollectionParameter object(s) with details provided - in the request body + description: Updates DatasetParameter object(s) with details provided in the + request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + $ref: '#/components/schemas/DATASETPARAMETER' type: array description: The values to use to update the object(s) with required: true @@ -2555,7 +5947,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + $ref: '#/components/schemas/DATASETPARAMETER' type: array description: Success - returns the updated object(s) '400': @@ -2566,18 +5958,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update DataCollectionParameters + summary: Update DatasetParameters tags: - - DataCollectionParameters + - DatasetParameters post: - description: Creates new DataCollectionParameter object(s) with details provided - in the request body + description: Creates new DatasetParameter object(s) with details provided in + the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + $ref: '#/components/schemas/DATASETPARAMETER' type: array description: The values to use to create the new object(s) with required: true @@ -2587,7 +5979,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + $ref: '#/components/schemas/DATASETPARAMETER' type: array description: Success - returns the created object '400': @@ -2598,13 +5990,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Create new DataCollectionParameters + summary: Create new DatasetParameters tags: - - DataCollectionParameters - /datagateway-api/datacollectionparameters/{id_}: + - DatasetParameters + /datagateway-api/datasetparameters/{id_}: delete: - description: Updates DataCollectionParameter with the specified ID with details - provided in the request body + description: Updates DatasetParameter with the specified ID with details provided + in the request body parameters: - description: The id of the entity to delete in: path @@ -2623,11 +6015,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Delete DataCollectionParameters by id + summary: Delete DatasetParameters by id tags: - - DataCollectionParameters + - DatasetParameters get: - description: Retrieves a list of DataCollectionParameter objects + description: Retrieves a list of DatasetParameter objects parameters: - description: The id of the entity to retrieve in: path @@ -2640,8 +6032,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' - description: Success - the matching DataCollectionParameter + $ref: '#/components/schemas/DATASETPARAMETER' + description: Success - the matching DatasetParameter '400': description: Bad request - Something was wrong with the request '401': @@ -2650,12 +6042,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Find the DataCollectionParameter matching the given ID + summary: Find the DatasetParameter matching the given ID tags: - - DataCollectionParameters + - DatasetParameters patch: - description: Updates DataCollectionParameter with the specified ID with details - provided in the request body + description: Updates DatasetParameter with the specified ID with details provided + in the request body parameters: - description: The id of the entity to update in: path @@ -2667,7 +6059,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + $ref: '#/components/schemas/DATASETPARAMETER' description: The values to use to update the object(s) with required: true responses: @@ -2675,7 +6067,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + $ref: '#/components/schemas/DATASETPARAMETER' description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request @@ -2685,13 +6077,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update DataCollectionParameters by id + summary: Update DatasetParameters by id tags: - - DataCollectionParameters - /datagateway-api/datacollectionparameters/count: + - DatasetParameters + /datagateway-api/datasetparameters/count: get: - description: Return the count of the DataCollectionParameter objects that would - be retrieved given the filters provided + description: Return the count of the DatasetParameter objects that would be + retrieved given the filters provided parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/DISTINCT_FILTER' @@ -2702,7 +6094,7 @@ paths: application/json: schema: type: integer - description: Success - The count of the DataCollectionParameter objects + description: Success - The count of the DatasetParameter objects '400': description: Bad request - Something was wrong with the request '401': @@ -2711,13 +6103,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Count DataCollectionParameters + summary: Count DatasetParameters tags: - - DataCollectionParameters - /datagateway-api/datacollectionparameters/findone: + - DatasetParameters + /datagateway-api/datasetparameters/findone: get: - description: Retrieves the first DataCollectionParameter objects that satisfies - the filters. + description: Retrieves the first DatasetParameter objects that satisfies the + filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -2730,9 +6122,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' - description: Success - a DataCollectionParameter object that satisfies the - filters + $ref: '#/components/schemas/DATASETPARAMETER' + description: Success - a DatasetParameter object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -2741,12 +6132,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single DataCollectionParameter + summary: Get single DatasetParameter tags: - - DataCollectionParameters - /datagateway-api/datacollections: + - DatasetParameters + /datagateway-api/datasetinstruments: get: - description: Retrieves a list of DataCollection objects + description: Retrieves a list of DatasetInstrument objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -2760,9 +6151,9 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTION' + $ref: '#/components/schemas/DATASETINSTRUMENT' type: array - description: Success - returns DataCollection that satisfy the filters + description: Success - returns DatasetInstrument that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -2771,18 +6162,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get DataCollections + summary: Get DatasetInstruments tags: - - DataCollections + - DatasetInstruments patch: - description: Updates DataCollection object(s) with details provided in the request - body + description: Updates DatasetInstrument object(s) with details provided in the + request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTION' + $ref: '#/components/schemas/DATASETINSTRUMENT' type: array description: The values to use to update the object(s) with required: true @@ -2792,7 +6183,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTION' + $ref: '#/components/schemas/DATASETINSTRUMENT' type: array description: Success - returns the updated object(s) '400': @@ -2803,18 +6194,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update DataCollections + summary: Update DatasetInstruments tags: - - DataCollections + - DatasetInstruments post: - description: Creates new DataCollection object(s) with details provided in the - request body + description: Creates new DatasetInstrument object(s) with details provided in + the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTION' + $ref: '#/components/schemas/DATASETINSTRUMENT' type: array description: The values to use to create the new object(s) with required: true @@ -2824,7 +6215,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATACOLLECTION' + $ref: '#/components/schemas/DATASETINSTRUMENT' type: array description: Success - returns the created object '400': @@ -2835,12 +6226,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Create new DataCollections + summary: Create new DatasetInstruments tags: - - DataCollections - /datagateway-api/datacollections/{id_}: + - DatasetInstruments + /datagateway-api/datasetinstruments/{id_}: delete: - description: Updates DataCollection with the specified ID with details provided + description: Updates DatasetInstrument with the specified ID with details provided in the request body parameters: - description: The id of the entity to delete @@ -2860,11 +6251,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Delete DataCollections by id + summary: Delete DatasetInstruments by id tags: - - DataCollections + - DatasetInstruments get: - description: Retrieves a list of DataCollection objects + description: Retrieves a list of DatasetInstrument objects parameters: - description: The id of the entity to retrieve in: path @@ -2877,8 +6268,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATACOLLECTION' - description: Success - the matching DataCollection + $ref: '#/components/schemas/DATASETINSTRUMENT' + description: Success - the matching DatasetInstrument '400': description: Bad request - Something was wrong with the request '401': @@ -2887,11 +6278,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Find the DataCollection matching the given ID + summary: Find the DatasetInstrument matching the given ID tags: - - DataCollections + - DatasetInstruments patch: - description: Updates DataCollection with the specified ID with details provided + description: Updates DatasetInstrument with the specified ID with details provided in the request body parameters: - description: The id of the entity to update @@ -2904,7 +6295,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATACOLLECTION' + $ref: '#/components/schemas/DATASETINSTRUMENT' description: The values to use to update the object(s) with required: true responses: @@ -2912,7 +6303,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATACOLLECTION' + $ref: '#/components/schemas/DATASETINSTRUMENT' description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request @@ -2922,13 +6313,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update DataCollections by id + summary: Update DatasetInstruments by id tags: - - DataCollections - /datagateway-api/datacollections/count: + - DatasetInstruments + /datagateway-api/datasetinstruments/count: get: - description: Return the count of the DataCollection objects that would be retrieved - given the filters provided + description: Return the count of the DatasetInstrument objects that would be + retrieved given the filters provided parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/DISTINCT_FILTER' @@ -2939,7 +6330,7 @@ paths: application/json: schema: type: integer - description: Success - The count of the DataCollection objects + description: Success - The count of the DatasetInstrument objects '400': description: Bad request - Something was wrong with the request '401': @@ -2948,12 +6339,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Count DataCollections + summary: Count DatasetInstruments tags: - - DataCollections - /datagateway-api/datacollections/findone: + - DatasetInstruments + /datagateway-api/datasetinstruments/findone: get: - description: Retrieves the first DataCollection objects that satisfies the filters. + description: Retrieves the first DatasetInstrument objects that satisfies the + filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -2966,8 +6358,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATACOLLECTION' - description: Success - a DataCollection object that satisfies the filters + $ref: '#/components/schemas/DATASETINSTRUMENT' + description: Success - a DatasetInstrument object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -2976,12 +6368,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single DataCollection + summary: Get single DatasetInstrument tags: - - DataCollections - /datagateway-api/datafileformats: + - DatasetInstruments + /datagateway-api/datasettechniques: get: - description: Retrieves a list of DatafileFormat objects + description: Retrieves a list of DatasetTechnique objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -2995,9 +6387,9 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATAFILEFORMAT' + $ref: '#/components/schemas/DATASETTECHNIQUE' type: array - description: Success - returns DatafileFormat that satisfy the filters + description: Success - returns DatasetTechnique that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -3006,18 +6398,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get DatafileFormats + summary: Get DatasetTechniques tags: - - DatafileFormats + - DatasetTechniques patch: - description: Updates DatafileFormat object(s) with details provided in the request - body + description: Updates DatasetTechnique object(s) with details provided in the + request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATAFILEFORMAT' + $ref: '#/components/schemas/DATASETTECHNIQUE' type: array description: The values to use to update the object(s) with required: true @@ -3027,7 +6419,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATAFILEFORMAT' + $ref: '#/components/schemas/DATASETTECHNIQUE' type: array description: Success - returns the updated object(s) '400': @@ -3038,18 +6430,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update DatafileFormats + summary: Update DatasetTechniques tags: - - DatafileFormats + - DatasetTechniques post: - description: Creates new DatafileFormat object(s) with details provided in the - request body + description: Creates new DatasetTechnique object(s) with details provided in + the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATAFILEFORMAT' + $ref: '#/components/schemas/DATASETTECHNIQUE' type: array description: The values to use to create the new object(s) with required: true @@ -3059,7 +6451,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATAFILEFORMAT' + $ref: '#/components/schemas/DATASETTECHNIQUE' type: array description: Success - returns the created object '400': @@ -3070,12 +6462,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Create new DatafileFormats + summary: Create new DatasetTechniques tags: - - DatafileFormats - /datagateway-api/datafileformats/{id_}: + - DatasetTechniques + /datagateway-api/datasettechniques/{id_}: delete: - description: Updates DatafileFormat with the specified ID with details provided + description: Updates DatasetTechnique with the specified ID with details provided in the request body parameters: - description: The id of the entity to delete @@ -3095,11 +6487,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Delete DatafileFormats by id + summary: Delete DatasetTechniques by id tags: - - DatafileFormats + - DatasetTechniques get: - description: Retrieves a list of DatafileFormat objects + description: Retrieves a list of DatasetTechnique objects parameters: - description: The id of the entity to retrieve in: path @@ -3112,8 +6504,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATAFILEFORMAT' - description: Success - the matching DatafileFormat + $ref: '#/components/schemas/DATASETTECHNIQUE' + description: Success - the matching DatasetTechnique '400': description: Bad request - Something was wrong with the request '401': @@ -3122,11 +6514,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Find the DatafileFormat matching the given ID + summary: Find the DatasetTechnique matching the given ID tags: - - DatafileFormats + - DatasetTechniques patch: - description: Updates DatafileFormat with the specified ID with details provided + description: Updates DatasetTechnique with the specified ID with details provided in the request body parameters: - description: The id of the entity to update @@ -3139,7 +6531,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATAFILEFORMAT' + $ref: '#/components/schemas/DATASETTECHNIQUE' description: The values to use to update the object(s) with required: true responses: @@ -3147,7 +6539,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATAFILEFORMAT' + $ref: '#/components/schemas/DATASETTECHNIQUE' description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request @@ -3157,13 +6549,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update DatafileFormats by id + summary: Update DatasetTechniques by id tags: - - DatafileFormats - /datagateway-api/datafileformats/count: + - DatasetTechniques + /datagateway-api/datasettechniques/count: get: - description: Return the count of the DatafileFormat objects that would be retrieved - given the filters provided + description: Return the count of the DatasetTechnique objects that would be + retrieved given the filters provided parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/DISTINCT_FILTER' @@ -3174,7 +6566,7 @@ paths: application/json: schema: type: integer - description: Success - The count of the DatafileFormat objects + description: Success - The count of the DatasetTechnique objects '400': description: Bad request - Something was wrong with the request '401': @@ -3183,12 +6575,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Count DatafileFormats + summary: Count DatasetTechniques tags: - - DatafileFormats - /datagateway-api/datafileformats/findone: + - DatasetTechniques + /datagateway-api/datasettechniques/findone: get: - description: Retrieves the first DatafileFormat objects that satisfies the filters. + description: Retrieves the first DatasetTechnique objects that satisfies the + filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -3201,8 +6594,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATAFILEFORMAT' - description: Success - a DatafileFormat object that satisfies the filters + $ref: '#/components/schemas/DATASETTECHNIQUE' + description: Success - a DatasetTechnique object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -3211,12 +6604,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single DatafileFormat + summary: Get single DatasetTechnique tags: - - DatafileFormats - /datagateway-api/datafileparameters: + - DatasetTechniques + /datagateway-api/datasettypes: get: - description: Retrieves a list of DatafileParameter objects + description: Retrieves a list of DatasetType objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -3230,9 +6623,9 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATAFILEPARAMETER' + $ref: '#/components/schemas/DATASETTYPE' type: array - description: Success - returns DatafileParameter that satisfy the filters + description: Success - returns DatasetType that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -3241,18 +6634,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get DatafileParameters + summary: Get DatasetTypes tags: - - DatafileParameters + - DatasetTypes patch: - description: Updates DatafileParameter object(s) with details provided in the - request body + description: Updates DatasetType object(s) with details provided in the request + body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATAFILEPARAMETER' + $ref: '#/components/schemas/DATASETTYPE' type: array description: The values to use to update the object(s) with required: true @@ -3262,7 +6655,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATAFILEPARAMETER' + $ref: '#/components/schemas/DATASETTYPE' type: array description: Success - returns the updated object(s) '400': @@ -3273,18 +6666,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update DatafileParameters + summary: Update DatasetTypes tags: - - DatafileParameters + - DatasetTypes post: - description: Creates new DatafileParameter object(s) with details provided in - the request body + description: Creates new DatasetType object(s) with details provided in the + request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATAFILEPARAMETER' + $ref: '#/components/schemas/DATASETTYPE' type: array description: The values to use to create the new object(s) with required: true @@ -3294,7 +6687,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATAFILEPARAMETER' + $ref: '#/components/schemas/DATASETTYPE' type: array description: Success - returns the created object '400': @@ -3305,12 +6698,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Create new DatafileParameters + summary: Create new DatasetTypes tags: - - DatafileParameters - /datagateway-api/datafileparameters/{id_}: + - DatasetTypes + /datagateway-api/datasettypes/{id_}: delete: - description: Updates DatafileParameter with the specified ID with details provided + description: Updates DatasetType with the specified ID with details provided in the request body parameters: - description: The id of the entity to delete @@ -3330,11 +6723,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Delete DatafileParameters by id + summary: Delete DatasetTypes by id tags: - - DatafileParameters + - DatasetTypes get: - description: Retrieves a list of DatafileParameter objects + description: Retrieves a list of DatasetType objects parameters: - description: The id of the entity to retrieve in: path @@ -3347,8 +6740,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATAFILEPARAMETER' - description: Success - the matching DatafileParameter + $ref: '#/components/schemas/DATASETTYPE' + description: Success - the matching DatasetType '400': description: Bad request - Something was wrong with the request '401': @@ -3357,11 +6750,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Find the DatafileParameter matching the given ID + summary: Find the DatasetType matching the given ID tags: - - DatafileParameters + - DatasetTypes patch: - description: Updates DatafileParameter with the specified ID with details provided + description: Updates DatasetType with the specified ID with details provided in the request body parameters: - description: The id of the entity to update @@ -3374,7 +6767,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATAFILEPARAMETER' + $ref: '#/components/schemas/DATASETTYPE' description: The values to use to update the object(s) with required: true responses: @@ -3382,7 +6775,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATAFILEPARAMETER' + $ref: '#/components/schemas/DATASETTYPE' description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request @@ -3392,13 +6785,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update DatafileParameters by id + summary: Update DatasetTypes by id tags: - - DatafileParameters - /datagateway-api/datafileparameters/count: + - DatasetTypes + /datagateway-api/datasettypes/count: get: - description: Return the count of the DatafileParameter objects that would be - retrieved given the filters provided + description: Return the count of the DatasetType objects that would be retrieved + given the filters provided parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/DISTINCT_FILTER' @@ -3409,7 +6802,7 @@ paths: application/json: schema: type: integer - description: Success - The count of the DatafileParameter objects + description: Success - The count of the DatasetType objects '400': description: Bad request - Something was wrong with the request '401': @@ -3418,13 +6811,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Count DatafileParameters + summary: Count DatasetTypes tags: - - DatafileParameters - /datagateway-api/datafileparameters/findone: + - DatasetTypes + /datagateway-api/datasettypes/findone: get: - description: Retrieves the first DatafileParameter objects that satisfies the - filters. + description: Retrieves the first DatasetType objects that satisfies the filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -3437,8 +6829,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATAFILEPARAMETER' - description: Success - a DatafileParameter object that satisfies the filters + $ref: '#/components/schemas/DATASETTYPE' + description: Success - a DatasetType object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -3447,12 +6839,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single DatafileParameter + summary: Get single DatasetType tags: - - DatafileParameters - /datagateway-api/datafiles: + - DatasetTypes + /datagateway-api/datasets: get: - description: Retrieves a list of Datafile objects + description: Retrieves a list of Dataset objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -3466,9 +6858,9 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATAFILE' + $ref: '#/components/schemas/DATASET' type: array - description: Success - returns Datafile that satisfy the filters + description: Success - returns Dataset that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -3477,18 +6869,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get Datafiles + summary: Get Datasets tags: - - Datafiles + - Datasets patch: - description: Updates Datafile object(s) with details provided in the request + description: Updates Dataset object(s) with details provided in the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATAFILE' + $ref: '#/components/schemas/DATASET' type: array description: The values to use to update the object(s) with required: true @@ -3498,7 +6890,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATAFILE' + $ref: '#/components/schemas/DATASET' type: array description: Success - returns the updated object(s) '400': @@ -3509,18 +6901,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update Datafiles + summary: Update Datasets tags: - - Datafiles + - Datasets post: - description: Creates new Datafile object(s) with details provided in the request + description: Creates new Dataset object(s) with details provided in the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATAFILE' + $ref: '#/components/schemas/DATASET' type: array description: The values to use to create the new object(s) with required: true @@ -3530,7 +6922,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATAFILE' + $ref: '#/components/schemas/DATASET' type: array description: Success - returns the created object '400': @@ -3541,12 +6933,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Create new Datafiles + summary: Create new Datasets tags: - - Datafiles - /datagateway-api/datafiles/{id_}: + - Datasets + /datagateway-api/datasets/{id_}: delete: - description: Updates Datafile with the specified ID with details provided in + description: Updates Dataset with the specified ID with details provided in the request body parameters: - description: The id of the entity to delete @@ -3566,11 +6958,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Delete Datafiles by id + summary: Delete Datasets by id tags: - - Datafiles + - Datasets get: - description: Retrieves a list of Datafile objects + description: Retrieves a list of Dataset objects parameters: - description: The id of the entity to retrieve in: path @@ -3583,8 +6975,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATAFILE' - description: Success - the matching Datafile + $ref: '#/components/schemas/DATASET' + description: Success - the matching Dataset '400': description: Bad request - Something was wrong with the request '401': @@ -3593,11 +6985,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Find the Datafile matching the given ID + summary: Find the Dataset matching the given ID tags: - - Datafiles + - Datasets patch: - description: Updates Datafile with the specified ID with details provided in + description: Updates Dataset with the specified ID with details provided in the request body parameters: - description: The id of the entity to update @@ -3610,7 +7002,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATAFILE' + $ref: '#/components/schemas/DATASET' description: The values to use to update the object(s) with required: true responses: @@ -3618,7 +7010,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATAFILE' + $ref: '#/components/schemas/DATASET' description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request @@ -3628,12 +7020,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update Datafiles by id + summary: Update Datasets by id tags: - - Datafiles - /datagateway-api/datafiles/count: + - Datasets + /datagateway-api/datasets/count: get: - description: Return the count of the Datafile objects that would be retrieved + description: Return the count of the Dataset objects that would be retrieved given the filters provided parameters: - $ref: '#/components/parameters/WHERE_FILTER' @@ -3645,7 +7037,7 @@ paths: application/json: schema: type: integer - description: Success - The count of the Datafile objects + description: Success - The count of the Dataset objects '400': description: Bad request - Something was wrong with the request '401': @@ -3654,12 +7046,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Count Datafiles + summary: Count Datasets tags: - - Datafiles - /datagateway-api/datafiles/findone: + - Datasets + /datagateway-api/datasets/findone: get: - description: Retrieves the first Datafile objects that satisfies the filters. + description: Retrieves the first Dataset objects that satisfies the filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -3672,8 +7064,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATAFILE' - description: Success - a Datafile object that satisfies the filters + $ref: '#/components/schemas/DATASET' + description: Success - a Dataset object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -3682,12 +7074,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single Datafile + summary: Get single Dataset tags: - - Datafiles - /datagateway-api/datasetparameters: + - Datasets + /datagateway-api/facilities: get: - description: Retrieves a list of DatasetParameter objects + description: Retrieves a list of Facility objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -3701,9 +7093,9 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATASETPARAMETER' + $ref: '#/components/schemas/FACILITY' type: array - description: Success - returns DatasetParameter that satisfy the filters + description: Success - returns Facility that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -3712,18 +7104,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get DatasetParameters + summary: Get Facilities tags: - - DatasetParameters + - Facilities patch: - description: Updates DatasetParameter object(s) with details provided in the - request body + description: Updates Facility object(s) with details provided in the request + body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATASETPARAMETER' + $ref: '#/components/schemas/FACILITY' type: array description: The values to use to update the object(s) with required: true @@ -3733,7 +7125,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATASETPARAMETER' + $ref: '#/components/schemas/FACILITY' type: array description: Success - returns the updated object(s) '400': @@ -3744,18 +7136,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update DatasetParameters + summary: Update Facilities tags: - - DatasetParameters + - Facilities post: - description: Creates new DatasetParameter object(s) with details provided in - the request body + description: Creates new Facility object(s) with details provided in the request + body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATASETPARAMETER' + $ref: '#/components/schemas/FACILITY' type: array description: The values to use to create the new object(s) with required: true @@ -3765,7 +7157,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATASETPARAMETER' + $ref: '#/components/schemas/FACILITY' type: array description: Success - returns the created object '400': @@ -3776,13 +7168,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Create new DatasetParameters + summary: Create new Facilities tags: - - DatasetParameters - /datagateway-api/datasetparameters/{id_}: + - Facilities + /datagateway-api/facilities/{id_}: delete: - description: Updates DatasetParameter with the specified ID with details provided - in the request body + description: Updates Facility with the specified ID with details provided in + the request body parameters: - description: The id of the entity to delete in: path @@ -3801,11 +7193,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Delete DatasetParameters by id + summary: Delete Facilities by id tags: - - DatasetParameters + - Facilities get: - description: Retrieves a list of DatasetParameter objects + description: Retrieves a list of Facility objects parameters: - description: The id of the entity to retrieve in: path @@ -3818,8 +7210,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATASETPARAMETER' - description: Success - the matching DatasetParameter + $ref: '#/components/schemas/FACILITY' + description: Success - the matching Facility '400': description: Bad request - Something was wrong with the request '401': @@ -3828,12 +7220,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Find the DatasetParameter matching the given ID + summary: Find the Facility matching the given ID tags: - - DatasetParameters + - Facilities patch: - description: Updates DatasetParameter with the specified ID with details provided - in the request body + description: Updates Facility with the specified ID with details provided in + the request body parameters: - description: The id of the entity to update in: path @@ -3845,7 +7237,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATASETPARAMETER' + $ref: '#/components/schemas/FACILITY' description: The values to use to update the object(s) with required: true responses: @@ -3853,7 +7245,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATASETPARAMETER' + $ref: '#/components/schemas/FACILITY' description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request @@ -3863,13 +7255,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update DatasetParameters by id + summary: Update Facilities by id tags: - - DatasetParameters - /datagateway-api/datasetparameters/count: + - Facilities + /datagateway-api/facilities/count: get: - description: Return the count of the DatasetParameter objects that would be - retrieved given the filters provided + description: Return the count of the Facility objects that would be retrieved + given the filters provided parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/DISTINCT_FILTER' @@ -3880,7 +7272,7 @@ paths: application/json: schema: type: integer - description: Success - The count of the DatasetParameter objects + description: Success - The count of the Facility objects '400': description: Bad request - Something was wrong with the request '401': @@ -3889,13 +7281,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Count DatasetParameters + summary: Count Facilities tags: - - DatasetParameters - /datagateway-api/datasetparameters/findone: + - Facilities + /datagateway-api/facilities/findone: get: - description: Retrieves the first DatasetParameter objects that satisfies the - filters. + description: Retrieves the first Facility objects that satisfies the filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -3908,8 +7299,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATASETPARAMETER' - description: Success - a DatasetParameter object that satisfies the filters + $ref: '#/components/schemas/FACILITY' + description: Success - a Facility object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -3918,12 +7309,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single DatasetParameter + summary: Get single Facility tags: - - DatasetParameters - /datagateway-api/datasettypes: + - Facilities + /datagateway-api/facilitycycles: get: - description: Retrieves a list of DatasetType objects + description: Retrieves a list of FacilityCycle objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -3937,9 +7328,9 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATASETTYPE' + $ref: '#/components/schemas/FACILITYCYCLE' type: array - description: Success - returns DatasetType that satisfy the filters + description: Success - returns FacilityCycle that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -3948,18 +7339,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get DatasetTypes + summary: Get FacilityCycles tags: - - DatasetTypes + - FacilityCycles patch: - description: Updates DatasetType object(s) with details provided in the request + description: Updates FacilityCycle object(s) with details provided in the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATASETTYPE' + $ref: '#/components/schemas/FACILITYCYCLE' type: array description: The values to use to update the object(s) with required: true @@ -3969,7 +7360,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATASETTYPE' + $ref: '#/components/schemas/FACILITYCYCLE' type: array description: Success - returns the updated object(s) '400': @@ -3980,18 +7371,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update DatasetTypes + summary: Update FacilityCycles tags: - - DatasetTypes + - FacilityCycles post: - description: Creates new DatasetType object(s) with details provided in the + description: Creates new FacilityCycle object(s) with details provided in the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATASETTYPE' + $ref: '#/components/schemas/FACILITYCYCLE' type: array description: The values to use to create the new object(s) with required: true @@ -4001,7 +7392,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATASETTYPE' + $ref: '#/components/schemas/FACILITYCYCLE' type: array description: Success - returns the created object '400': @@ -4012,12 +7403,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Create new DatasetTypes + summary: Create new FacilityCycles tags: - - DatasetTypes - /datagateway-api/datasettypes/{id_}: + - FacilityCycles + /datagateway-api/facilitycycles/{id_}: delete: - description: Updates DatasetType with the specified ID with details provided + description: Updates FacilityCycle with the specified ID with details provided in the request body parameters: - description: The id of the entity to delete @@ -4037,11 +7428,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Delete DatasetTypes by id + summary: Delete FacilityCycles by id tags: - - DatasetTypes + - FacilityCycles get: - description: Retrieves a list of DatasetType objects + description: Retrieves a list of FacilityCycle objects parameters: - description: The id of the entity to retrieve in: path @@ -4054,8 +7445,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATASETTYPE' - description: Success - the matching DatasetType + $ref: '#/components/schemas/FACILITYCYCLE' + description: Success - the matching FacilityCycle '400': description: Bad request - Something was wrong with the request '401': @@ -4064,11 +7455,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Find the DatasetType matching the given ID + summary: Find the FacilityCycle matching the given ID tags: - - DatasetTypes + - FacilityCycles patch: - description: Updates DatasetType with the specified ID with details provided + description: Updates FacilityCycle with the specified ID with details provided in the request body parameters: - description: The id of the entity to update @@ -4081,7 +7472,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATASETTYPE' + $ref: '#/components/schemas/FACILITYCYCLE' description: The values to use to update the object(s) with required: true responses: @@ -4089,7 +7480,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATASETTYPE' + $ref: '#/components/schemas/FACILITYCYCLE' description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request @@ -4099,12 +7490,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update DatasetTypes by id + summary: Update FacilityCycles by id tags: - - DatasetTypes - /datagateway-api/datasettypes/count: + - FacilityCycles + /datagateway-api/facilitycycles/count: get: - description: Return the count of the DatasetType objects that would be retrieved + description: Return the count of the FacilityCycle objects that would be retrieved given the filters provided parameters: - $ref: '#/components/parameters/WHERE_FILTER' @@ -4116,7 +7507,7 @@ paths: application/json: schema: type: integer - description: Success - The count of the DatasetType objects + description: Success - The count of the FacilityCycle objects '400': description: Bad request - Something was wrong with the request '401': @@ -4125,12 +7516,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Count DatasetTypes + summary: Count FacilityCycles tags: - - DatasetTypes - /datagateway-api/datasettypes/findone: + - FacilityCycles + /datagateway-api/facilitycycles/findone: get: - description: Retrieves the first DatasetType objects that satisfies the filters. + description: Retrieves the first FacilityCycle objects that satisfies the filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -4143,8 +7534,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATASETTYPE' - description: Success - a DatasetType object that satisfies the filters + $ref: '#/components/schemas/FACILITYCYCLE' + description: Success - a FacilityCycle object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -4153,12 +7544,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single DatasetType + summary: Get single FacilityCycle tags: - - DatasetTypes - /datagateway-api/datasets: + - FacilityCycles + /datagateway-api/fundingreferences: get: - description: Retrieves a list of Dataset objects + description: Retrieves a list of FundingReference objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -4172,9 +7563,9 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATASET' + $ref: '#/components/schemas/FUNDINGREFERENCE' type: array - description: Success - returns Dataset that satisfy the filters + description: Success - returns FundingReference that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -4183,18 +7574,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get Datasets + summary: Get FundingReferences tags: - - Datasets + - FundingReferences patch: - description: Updates Dataset object(s) with details provided in the request - body + description: Updates FundingReference object(s) with details provided in the + request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATASET' + $ref: '#/components/schemas/FUNDINGREFERENCE' type: array description: The values to use to update the object(s) with required: true @@ -4204,7 +7595,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATASET' + $ref: '#/components/schemas/FUNDINGREFERENCE' type: array description: Success - returns the updated object(s) '400': @@ -4215,18 +7606,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update Datasets + summary: Update FundingReferences tags: - - Datasets + - FundingReferences post: - description: Creates new Dataset object(s) with details provided in the request - body + description: Creates new FundingReference object(s) with details provided in + the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/DATASET' + $ref: '#/components/schemas/FUNDINGREFERENCE' type: array description: The values to use to create the new object(s) with required: true @@ -4236,7 +7627,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/DATASET' + $ref: '#/components/schemas/FUNDINGREFERENCE' type: array description: Success - returns the created object '400': @@ -4247,13 +7638,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Create new Datasets + summary: Create new FundingReferences tags: - - Datasets - /datagateway-api/datasets/{id_}: + - FundingReferences + /datagateway-api/fundingreferences/{id_}: delete: - description: Updates Dataset with the specified ID with details provided in - the request body + description: Updates FundingReference with the specified ID with details provided + in the request body parameters: - description: The id of the entity to delete in: path @@ -4272,11 +7663,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Delete Datasets by id + summary: Delete FundingReferences by id tags: - - Datasets + - FundingReferences get: - description: Retrieves a list of Dataset objects + description: Retrieves a list of FundingReference objects parameters: - description: The id of the entity to retrieve in: path @@ -4289,8 +7680,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATASET' - description: Success - the matching Dataset + $ref: '#/components/schemas/FUNDINGREFERENCE' + description: Success - the matching FundingReference '400': description: Bad request - Something was wrong with the request '401': @@ -4299,12 +7690,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Find the Dataset matching the given ID + summary: Find the FundingReference matching the given ID tags: - - Datasets + - FundingReferences patch: - description: Updates Dataset with the specified ID with details provided in - the request body + description: Updates FundingReference with the specified ID with details provided + in the request body parameters: - description: The id of the entity to update in: path @@ -4316,7 +7707,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATASET' + $ref: '#/components/schemas/FUNDINGREFERENCE' description: The values to use to update the object(s) with required: true responses: @@ -4324,7 +7715,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATASET' + $ref: '#/components/schemas/FUNDINGREFERENCE' description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request @@ -4334,13 +7725,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update Datasets by id + summary: Update FundingReferences by id tags: - - Datasets - /datagateway-api/datasets/count: + - FundingReferences + /datagateway-api/fundingreferences/count: get: - description: Return the count of the Dataset objects that would be retrieved - given the filters provided + description: Return the count of the FundingReference objects that would be + retrieved given the filters provided parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/DISTINCT_FILTER' @@ -4351,7 +7742,7 @@ paths: application/json: schema: type: integer - description: Success - The count of the Dataset objects + description: Success - The count of the FundingReference objects '400': description: Bad request - Something was wrong with the request '401': @@ -4360,12 +7751,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Count Datasets + summary: Count FundingReferences tags: - - Datasets - /datagateway-api/datasets/findone: + - FundingReferences + /datagateway-api/fundingreferences/findone: get: - description: Retrieves the first Dataset objects that satisfies the filters. + description: Retrieves the first FundingReference objects that satisfies the + filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -4378,8 +7770,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DATASET' - description: Success - a Dataset object that satisfies the filters + $ref: '#/components/schemas/FUNDINGREFERENCE' + description: Success - a FundingReference object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -4388,12 +7780,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single Dataset + summary: Get single FundingReference tags: - - Datasets - /datagateway-api/facilities: + - FundingReferences + /datagateway-api/groupings: get: - description: Retrieves a list of Facility objects + description: Retrieves a list of Grouping objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -4407,9 +7799,9 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/FACILITY' + $ref: '#/components/schemas/GROUPING' type: array - description: Success - returns Facility that satisfy the filters + description: Success - returns Grouping that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -4418,18 +7810,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get Facilities + summary: Get Groupings tags: - - Facilities + - Groupings patch: - description: Updates Facility object(s) with details provided in the request + description: Updates Grouping object(s) with details provided in the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/FACILITY' + $ref: '#/components/schemas/GROUPING' type: array description: The values to use to update the object(s) with required: true @@ -4439,7 +7831,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/FACILITY' + $ref: '#/components/schemas/GROUPING' type: array description: Success - returns the updated object(s) '400': @@ -4450,18 +7842,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update Facilities + summary: Update Groupings tags: - - Facilities + - Groupings post: - description: Creates new Facility object(s) with details provided in the request + description: Creates new Grouping object(s) with details provided in the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/FACILITY' + $ref: '#/components/schemas/GROUPING' type: array description: The values to use to create the new object(s) with required: true @@ -4471,7 +7863,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/FACILITY' + $ref: '#/components/schemas/GROUPING' type: array description: Success - returns the created object '400': @@ -4482,12 +7874,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Create new Facilities + summary: Create new Groupings tags: - - Facilities - /datagateway-api/facilities/{id_}: + - Groupings + /datagateway-api/groupings/{id_}: delete: - description: Updates Facility with the specified ID with details provided in + description: Updates Grouping with the specified ID with details provided in the request body parameters: - description: The id of the entity to delete @@ -4507,11 +7899,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Delete Facilities by id + summary: Delete Groupings by id tags: - - Facilities + - Groupings get: - description: Retrieves a list of Facility objects + description: Retrieves a list of Grouping objects parameters: - description: The id of the entity to retrieve in: path @@ -4524,8 +7916,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FACILITY' - description: Success - the matching Facility + $ref: '#/components/schemas/GROUPING' + description: Success - the matching Grouping '400': description: Bad request - Something was wrong with the request '401': @@ -4534,11 +7926,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Find the Facility matching the given ID + summary: Find the Grouping matching the given ID tags: - - Facilities + - Groupings patch: - description: Updates Facility with the specified ID with details provided in + description: Updates Grouping with the specified ID with details provided in the request body parameters: - description: The id of the entity to update @@ -4551,7 +7943,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FACILITY' + $ref: '#/components/schemas/GROUPING' description: The values to use to update the object(s) with required: true responses: @@ -4559,7 +7951,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FACILITY' + $ref: '#/components/schemas/GROUPING' description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request @@ -4569,12 +7961,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update Facilities by id + summary: Update Groupings by id tags: - - Facilities - /datagateway-api/facilities/count: + - Groupings + /datagateway-api/groupings/count: get: - description: Return the count of the Facility objects that would be retrieved + description: Return the count of the Grouping objects that would be retrieved given the filters provided parameters: - $ref: '#/components/parameters/WHERE_FILTER' @@ -4586,7 +7978,7 @@ paths: application/json: schema: type: integer - description: Success - The count of the Facility objects + description: Success - The count of the Grouping objects '400': description: Bad request - Something was wrong with the request '401': @@ -4595,12 +7987,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Count Facilities + summary: Count Groupings tags: - - Facilities - /datagateway-api/facilities/findone: + - Groupings + /datagateway-api/groupings/findone: get: - description: Retrieves the first Facility objects that satisfies the filters. + description: Retrieves the first Grouping objects that satisfies the filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -4613,8 +8005,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FACILITY' - description: Success - a Facility object that satisfies the filters + $ref: '#/components/schemas/GROUPING' + description: Success - a Grouping object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -4623,12 +8015,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single Facility - tags: - - Facilities - /datagateway-api/facilitycycles: + summary: Get single Grouping + tags: + - Groupings + /datagateway-api/instrumentscientists: get: - description: Retrieves a list of FacilityCycle objects + description: Retrieves a list of InstrumentScientist objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -4642,9 +8034,9 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/FACILITYCYCLE' + $ref: '#/components/schemas/INSTRUMENTSCIENTIST' type: array - description: Success - returns FacilityCycle that satisfy the filters + description: Success - returns InstrumentScientist that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -4653,18 +8045,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get FacilityCycles + summary: Get InstrumentScientists tags: - - FacilityCycles + - InstrumentScientists patch: - description: Updates FacilityCycle object(s) with details provided in the request - body + description: Updates InstrumentScientist object(s) with details provided in + the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/FACILITYCYCLE' + $ref: '#/components/schemas/INSTRUMENTSCIENTIST' type: array description: The values to use to update the object(s) with required: true @@ -4674,7 +8066,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/FACILITYCYCLE' + $ref: '#/components/schemas/INSTRUMENTSCIENTIST' type: array description: Success - returns the updated object(s) '400': @@ -4685,18 +8077,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update FacilityCycles + summary: Update InstrumentScientists tags: - - FacilityCycles + - InstrumentScientists post: - description: Creates new FacilityCycle object(s) with details provided in the - request body + description: Creates new InstrumentScientist object(s) with details provided + in the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/FACILITYCYCLE' + $ref: '#/components/schemas/INSTRUMENTSCIENTIST' type: array description: The values to use to create the new object(s) with required: true @@ -4706,7 +8098,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/FACILITYCYCLE' + $ref: '#/components/schemas/INSTRUMENTSCIENTIST' type: array description: Success - returns the created object '400': @@ -4717,13 +8109,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Create new FacilityCycles + summary: Create new InstrumentScientists tags: - - FacilityCycles - /datagateway-api/facilitycycles/{id_}: + - InstrumentScientists + /datagateway-api/instrumentscientists/{id_}: delete: - description: Updates FacilityCycle with the specified ID with details provided - in the request body + description: Updates InstrumentScientist with the specified ID with details + provided in the request body parameters: - description: The id of the entity to delete in: path @@ -4742,11 +8134,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Delete FacilityCycles by id + summary: Delete InstrumentScientists by id tags: - - FacilityCycles + - InstrumentScientists get: - description: Retrieves a list of FacilityCycle objects + description: Retrieves a list of InstrumentScientist objects parameters: - description: The id of the entity to retrieve in: path @@ -4759,8 +8151,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FACILITYCYCLE' - description: Success - the matching FacilityCycle + $ref: '#/components/schemas/INSTRUMENTSCIENTIST' + description: Success - the matching InstrumentScientist '400': description: Bad request - Something was wrong with the request '401': @@ -4769,12 +8161,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Find the FacilityCycle matching the given ID + summary: Find the InstrumentScientist matching the given ID tags: - - FacilityCycles + - InstrumentScientists patch: - description: Updates FacilityCycle with the specified ID with details provided - in the request body + description: Updates InstrumentScientist with the specified ID with details + provided in the request body parameters: - description: The id of the entity to update in: path @@ -4786,7 +8178,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FACILITYCYCLE' + $ref: '#/components/schemas/INSTRUMENTSCIENTIST' description: The values to use to update the object(s) with required: true responses: @@ -4794,7 +8186,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FACILITYCYCLE' + $ref: '#/components/schemas/INSTRUMENTSCIENTIST' description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request @@ -4804,13 +8196,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update FacilityCycles by id + summary: Update InstrumentScientists by id tags: - - FacilityCycles - /datagateway-api/facilitycycles/count: + - InstrumentScientists + /datagateway-api/instrumentscientists/count: get: - description: Return the count of the FacilityCycle objects that would be retrieved - given the filters provided + description: Return the count of the InstrumentScientist objects that would + be retrieved given the filters provided parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/DISTINCT_FILTER' @@ -4821,7 +8213,7 @@ paths: application/json: schema: type: integer - description: Success - The count of the FacilityCycle objects + description: Success - The count of the InstrumentScientist objects '400': description: Bad request - Something was wrong with the request '401': @@ -4830,12 +8222,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Count FacilityCycles + summary: Count InstrumentScientists tags: - - FacilityCycles - /datagateway-api/facilitycycles/findone: + - InstrumentScientists + /datagateway-api/instrumentscientists/findone: get: - description: Retrieves the first FacilityCycle objects that satisfies the filters. + description: Retrieves the first InstrumentScientist objects that satisfies + the filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -4848,8 +8241,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FACILITYCYCLE' - description: Success - a FacilityCycle object that satisfies the filters + $ref: '#/components/schemas/INSTRUMENTSCIENTIST' + description: Success - a InstrumentScientist object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -4858,12 +8251,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single FacilityCycle + summary: Get single InstrumentScientist tags: - - FacilityCycles - /datagateway-api/groupings: + - InstrumentScientists + /datagateway-api/instruments: get: - description: Retrieves a list of Grouping objects + description: Retrieves a list of Instrument objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -4877,9 +8270,9 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/GROUPING' + $ref: '#/components/schemas/INSTRUMENT' type: array - description: Success - returns Grouping that satisfy the filters + description: Success - returns Instrument that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -4888,18 +8281,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get Groupings + summary: Get Instruments tags: - - Groupings + - Instruments patch: - description: Updates Grouping object(s) with details provided in the request + description: Updates Instrument object(s) with details provided in the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/GROUPING' + $ref: '#/components/schemas/INSTRUMENT' type: array description: The values to use to update the object(s) with required: true @@ -4909,7 +8302,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/GROUPING' + $ref: '#/components/schemas/INSTRUMENT' type: array description: Success - returns the updated object(s) '400': @@ -4920,18 +8313,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update Groupings + summary: Update Instruments tags: - - Groupings + - Instruments post: - description: Creates new Grouping object(s) with details provided in the request + description: Creates new Instrument object(s) with details provided in the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/GROUPING' + $ref: '#/components/schemas/INSTRUMENT' type: array description: The values to use to create the new object(s) with required: true @@ -4941,7 +8334,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/GROUPING' + $ref: '#/components/schemas/INSTRUMENT' type: array description: Success - returns the created object '400': @@ -4952,13 +8345,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Create new Groupings + summary: Create new Instruments tags: - - Groupings - /datagateway-api/groupings/{id_}: + - Instruments + /datagateway-api/instruments/{id_}: delete: - description: Updates Grouping with the specified ID with details provided in - the request body + description: Updates Instrument with the specified ID with details provided + in the request body parameters: - description: The id of the entity to delete in: path @@ -4977,11 +8370,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Delete Groupings by id + summary: Delete Instruments by id tags: - - Groupings + - Instruments get: - description: Retrieves a list of Grouping objects + description: Retrieves a list of Instrument objects parameters: - description: The id of the entity to retrieve in: path @@ -4994,8 +8387,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GROUPING' - description: Success - the matching Grouping + $ref: '#/components/schemas/INSTRUMENT' + description: Success - the matching Instrument '400': description: Bad request - Something was wrong with the request '401': @@ -5004,12 +8397,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Find the Grouping matching the given ID + summary: Find the Instrument matching the given ID tags: - - Groupings + - Instruments patch: - description: Updates Grouping with the specified ID with details provided in - the request body + description: Updates Instrument with the specified ID with details provided + in the request body parameters: - description: The id of the entity to update in: path @@ -5021,7 +8414,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GROUPING' + $ref: '#/components/schemas/INSTRUMENT' description: The values to use to update the object(s) with required: true responses: @@ -5029,7 +8422,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GROUPING' + $ref: '#/components/schemas/INSTRUMENT' description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request @@ -5039,12 +8432,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update Groupings by id + summary: Update Instruments by id tags: - - Groupings - /datagateway-api/groupings/count: + - Instruments + /datagateway-api/instruments/count: get: - description: Return the count of the Grouping objects that would be retrieved + description: Return the count of the Instrument objects that would be retrieved given the filters provided parameters: - $ref: '#/components/parameters/WHERE_FILTER' @@ -5056,7 +8449,7 @@ paths: application/json: schema: type: integer - description: Success - The count of the Grouping objects + description: Success - The count of the Instrument objects '400': description: Bad request - Something was wrong with the request '401': @@ -5065,12 +8458,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Count Groupings + summary: Count Instruments tags: - - Groupings - /datagateway-api/groupings/findone: + - Instruments + /datagateway-api/instruments/findone: get: - description: Retrieves the first Grouping objects that satisfies the filters. + description: Retrieves the first Instrument objects that satisfies the filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -5083,8 +8476,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GROUPING' - description: Success - a Grouping object that satisfies the filters + $ref: '#/components/schemas/INSTRUMENT' + description: Success - a Instrument object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -5093,12 +8486,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single Grouping + summary: Get single Instrument tags: - - Groupings - /datagateway-api/instrumentscientists: + - Instruments + /datagateway-api/investigationfacilitycycles: get: - description: Retrieves a list of InstrumentScientist objects + description: Retrieves a list of InvestigationFacilityCycle objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -5112,9 +8505,10 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' + $ref: '#/components/schemas/INVESTIGATIONFACILITYCYCLE' type: array - description: Success - returns InstrumentScientist that satisfy the filters + description: Success - returns InvestigationFacilityCycle that satisfy the + filters '400': description: Bad request - Something was wrong with the request '401': @@ -5123,18 +8517,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get InstrumentScientists + summary: Get InvestigationFacilityCycles tags: - - InstrumentScientists + - InvestigationFacilityCycles patch: - description: Updates InstrumentScientist object(s) with details provided in - the request body + description: Updates InvestigationFacilityCycle object(s) with details provided + in the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' + $ref: '#/components/schemas/INVESTIGATIONFACILITYCYCLE' type: array description: The values to use to update the object(s) with required: true @@ -5144,7 +8538,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' + $ref: '#/components/schemas/INVESTIGATIONFACILITYCYCLE' type: array description: Success - returns the updated object(s) '400': @@ -5155,18 +8549,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update InstrumentScientists + summary: Update InvestigationFacilityCycles tags: - - InstrumentScientists + - InvestigationFacilityCycles post: - description: Creates new InstrumentScientist object(s) with details provided + description: Creates new InvestigationFacilityCycle object(s) with details provided in the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' + $ref: '#/components/schemas/INVESTIGATIONFACILITYCYCLE' type: array description: The values to use to create the new object(s) with required: true @@ -5176,7 +8570,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' + $ref: '#/components/schemas/INVESTIGATIONFACILITYCYCLE' type: array description: Success - returns the created object '400': @@ -5187,12 +8581,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Create new InstrumentScientists + summary: Create new InvestigationFacilityCycles tags: - - InstrumentScientists - /datagateway-api/instrumentscientists/{id_}: + - InvestigationFacilityCycles + /datagateway-api/investigationfacilitycycles/{id_}: delete: - description: Updates InstrumentScientist with the specified ID with details + description: Updates InvestigationFacilityCycle with the specified ID with details provided in the request body parameters: - description: The id of the entity to delete @@ -5212,11 +8606,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Delete InstrumentScientists by id + summary: Delete InvestigationFacilityCycles by id tags: - - InstrumentScientists + - InvestigationFacilityCycles get: - description: Retrieves a list of InstrumentScientist objects + description: Retrieves a list of InvestigationFacilityCycle objects parameters: - description: The id of the entity to retrieve in: path @@ -5229,8 +8623,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' - description: Success - the matching InstrumentScientist + $ref: '#/components/schemas/INVESTIGATIONFACILITYCYCLE' + description: Success - the matching InvestigationFacilityCycle '400': description: Bad request - Something was wrong with the request '401': @@ -5239,11 +8633,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Find the InstrumentScientist matching the given ID + summary: Find the InvestigationFacilityCycle matching the given ID tags: - - InstrumentScientists + - InvestigationFacilityCycles patch: - description: Updates InstrumentScientist with the specified ID with details + description: Updates InvestigationFacilityCycle with the specified ID with details provided in the request body parameters: - description: The id of the entity to update @@ -5256,7 +8650,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' + $ref: '#/components/schemas/INVESTIGATIONFACILITYCYCLE' description: The values to use to update the object(s) with required: true responses: @@ -5264,7 +8658,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' + $ref: '#/components/schemas/INVESTIGATIONFACILITYCYCLE' description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request @@ -5274,13 +8668,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update InstrumentScientists by id + summary: Update InvestigationFacilityCycles by id tags: - - InstrumentScientists - /datagateway-api/instrumentscientists/count: + - InvestigationFacilityCycles + /datagateway-api/investigationfacilitycycles/count: get: - description: Return the count of the InstrumentScientist objects that would - be retrieved given the filters provided + description: Return the count of the InvestigationFacilityCycle objects that + would be retrieved given the filters provided parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/DISTINCT_FILTER' @@ -5291,7 +8685,7 @@ paths: application/json: schema: type: integer - description: Success - The count of the InstrumentScientist objects + description: Success - The count of the InvestigationFacilityCycle objects '400': description: Bad request - Something was wrong with the request '401': @@ -5300,12 +8694,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Count InstrumentScientists + summary: Count InvestigationFacilityCycles tags: - - InstrumentScientists - /datagateway-api/instrumentscientists/findone: + - InvestigationFacilityCycles + /datagateway-api/investigationfacilitycycles/findone: get: - description: Retrieves the first InstrumentScientist objects that satisfies + description: Retrieves the first InvestigationFacilityCycle objects that satisfies the filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' @@ -5319,8 +8713,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' - description: Success - a InstrumentScientist object that satisfies the filters + $ref: '#/components/schemas/INVESTIGATIONFACILITYCYCLE' + description: Success - a InvestigationFacilityCycle object that satisfies + the filters '400': description: Bad request - Something was wrong with the request '401': @@ -5329,12 +8724,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single InstrumentScientist + summary: Get single InvestigationFacilityCycle tags: - - InstrumentScientists - /datagateway-api/instruments: + - InvestigationFacilityCycles + /datagateway-api/investigationfundings: get: - description: Retrieves a list of Instrument objects + description: Retrieves a list of InvestigationFunding objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -5348,9 +8743,9 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/INSTRUMENT' + $ref: '#/components/schemas/INVESTIGATIONFUNDING' type: array - description: Success - returns Instrument that satisfy the filters + description: Success - returns InvestigationFunding that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -5359,18 +8754,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get Instruments + summary: Get InvestigationFundings tags: - - Instruments + - InvestigationFundings patch: - description: Updates Instrument object(s) with details provided in the request - body + description: Updates InvestigationFunding object(s) with details provided in + the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/INSTRUMENT' + $ref: '#/components/schemas/INVESTIGATIONFUNDING' type: array description: The values to use to update the object(s) with required: true @@ -5380,7 +8775,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/INSTRUMENT' + $ref: '#/components/schemas/INVESTIGATIONFUNDING' type: array description: Success - returns the updated object(s) '400': @@ -5391,18 +8786,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update Instruments + summary: Update InvestigationFundings tags: - - Instruments + - InvestigationFundings post: - description: Creates new Instrument object(s) with details provided in the request - body + description: Creates new InvestigationFunding object(s) with details provided + in the request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/INSTRUMENT' + $ref: '#/components/schemas/INVESTIGATIONFUNDING' type: array description: The values to use to create the new object(s) with required: true @@ -5412,7 +8807,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/INSTRUMENT' + $ref: '#/components/schemas/INVESTIGATIONFUNDING' type: array description: Success - returns the created object '400': @@ -5423,13 +8818,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Create new Instruments + summary: Create new InvestigationFundings tags: - - Instruments - /datagateway-api/instruments/{id_}: + - InvestigationFundings + /datagateway-api/investigationfundings/{id_}: delete: - description: Updates Instrument with the specified ID with details provided - in the request body + description: Updates InvestigationFunding with the specified ID with details + provided in the request body parameters: - description: The id of the entity to delete in: path @@ -5448,11 +8843,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Delete Instruments by id + summary: Delete InvestigationFundings by id tags: - - Instruments + - InvestigationFundings get: - description: Retrieves a list of Instrument objects + description: Retrieves a list of InvestigationFunding objects parameters: - description: The id of the entity to retrieve in: path @@ -5465,8 +8860,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/INSTRUMENT' - description: Success - the matching Instrument + $ref: '#/components/schemas/INVESTIGATIONFUNDING' + description: Success - the matching InvestigationFunding '400': description: Bad request - Something was wrong with the request '401': @@ -5475,12 +8870,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Find the Instrument matching the given ID + summary: Find the InvestigationFunding matching the given ID tags: - - Instruments + - InvestigationFundings patch: - description: Updates Instrument with the specified ID with details provided - in the request body + description: Updates InvestigationFunding with the specified ID with details + provided in the request body parameters: - description: The id of the entity to update in: path @@ -5492,7 +8887,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/INSTRUMENT' + $ref: '#/components/schemas/INVESTIGATIONFUNDING' description: The values to use to update the object(s) with required: true responses: @@ -5500,7 +8895,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/INSTRUMENT' + $ref: '#/components/schemas/INVESTIGATIONFUNDING' description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request @@ -5510,13 +8905,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update Instruments by id + summary: Update InvestigationFundings by id tags: - - Instruments - /datagateway-api/instruments/count: + - InvestigationFundings + /datagateway-api/investigationfundings/count: get: - description: Return the count of the Instrument objects that would be retrieved - given the filters provided + description: Return the count of the InvestigationFunding objects that would + be retrieved given the filters provided parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/DISTINCT_FILTER' @@ -5527,7 +8922,7 @@ paths: application/json: schema: type: integer - description: Success - The count of the Instrument objects + description: Success - The count of the InvestigationFunding objects '400': description: Bad request - Something was wrong with the request '401': @@ -5536,12 +8931,13 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Count Instruments + summary: Count InvestigationFundings tags: - - Instruments - /datagateway-api/instruments/findone: + - InvestigationFundings + /datagateway-api/investigationfundings/findone: get: - description: Retrieves the first Instrument objects that satisfies the filters. + description: Retrieves the first InvestigationFunding objects that satisfies + the filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -5554,8 +8950,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/INSTRUMENT' - description: Success - a Instrument object that satisfies the filters + $ref: '#/components/schemas/INVESTIGATIONFUNDING' + description: Success - a InvestigationFunding object that satisfies the + filters '400': description: Bad request - Something was wrong with the request '401': @@ -5564,9 +8961,9 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single Instrument + summary: Get single InvestigationFunding tags: - - Instruments + - InvestigationFundings /datagateway-api/investigationgroups: get: description: Retrieves a list of InvestigationGroup objects @@ -8367,10 +11764,246 @@ paths: description: No such record - Unable to find a record in ICAT summary: Count Publications tags: - - Publications - /datagateway-api/publications/findone: + - Publications + /datagateway-api/publications/findone: + get: + description: Retrieves the first Publication objects that satisfies the filters. + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PUBLICATION' + description: Success - a Publication object that satisfies the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get single Publication + tags: + - Publications + /datagateway-api/relateddatafiles: + get: + description: Retrieves a list of RelatedDatafile objects + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/RELATEDDATAFILE' + type: array + description: Success - returns RelatedDatafile that satisfy the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get RelatedDatafiles + tags: + - RelatedDatafiles + patch: + description: Updates RelatedDatafile object(s) with details provided in the + request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/RELATEDDATAFILE' + type: array + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/RELATEDDATAFILE' + type: array + description: Success - returns the updated object(s) + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update RelatedDatafiles + tags: + - RelatedDatafiles + post: + description: Creates new RelatedDatafile object(s) with details provided in + the request body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/RELATEDDATAFILE' + type: array + description: The values to use to create the new object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/RELATEDDATAFILE' + type: array + description: Success - returns the created object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Create new RelatedDatafiles + tags: + - RelatedDatafiles + /datagateway-api/relateddatafiles/{id_}: + delete: + description: Updates RelatedDatafile with the specified ID with details provided + in the request body + parameters: + - description: The id of the entity to delete + in: path + name: id_ + required: true + schema: + type: integer + responses: + '204': + description: No Content - Object was successfully deleted + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Delete RelatedDatafiles by id + tags: + - RelatedDatafiles + get: + description: Retrieves a list of RelatedDatafile objects + parameters: + - description: The id of the entity to retrieve + in: path + name: id_ + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RELATEDDATAFILE' + description: Success - the matching RelatedDatafile + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Find the RelatedDatafile matching the given ID + tags: + - RelatedDatafiles + patch: + description: Updates RelatedDatafile with the specified ID with details provided + in the request body + parameters: + - description: The id of the entity to update + in: path + name: id_ + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RELATEDDATAFILE' + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RELATEDDATAFILE' + description: Success - returns the updated object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update RelatedDatafiles by id + tags: + - RelatedDatafiles + /datagateway-api/relateddatafiles/count: + get: + description: Return the count of the RelatedDatafile objects that would be retrieved + given the filters provided + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + type: integer + description: Success - The count of the RelatedDatafile objects + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Count RelatedDatafiles + tags: + - RelatedDatafiles + /datagateway-api/relateddatafiles/findone: get: - description: Retrieves the first Publication objects that satisfies the filters. + description: Retrieves the first RelatedDatafile objects that satisfies the + filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -8383,8 +12016,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PUBLICATION' - description: Success - a Publication object that satisfies the filters + $ref: '#/components/schemas/RELATEDDATAFILE' + description: Success - a RelatedDatafile object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -8393,12 +12026,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single Publication + summary: Get single RelatedDatafile tags: - - Publications - /datagateway-api/relateddatafiles: + - RelatedDatafiles + /datagateway-api/relateditems: get: - description: Retrieves a list of RelatedDatafile objects + description: Retrieves a list of RelatedItem objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -8412,9 +12045,9 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/RELATEDDATAFILE' + $ref: '#/components/schemas/RELATEDITEM' type: array - description: Success - returns RelatedDatafile that satisfy the filters + description: Success - returns RelatedItem that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -8423,18 +12056,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get RelatedDatafiles + summary: Get RelatedItems tags: - - RelatedDatafiles + - RelatedItems patch: - description: Updates RelatedDatafile object(s) with details provided in the - request body + description: Updates RelatedItem object(s) with details provided in the request + body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/RELATEDDATAFILE' + $ref: '#/components/schemas/RELATEDITEM' type: array description: The values to use to update the object(s) with required: true @@ -8444,7 +12077,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/RELATEDDATAFILE' + $ref: '#/components/schemas/RELATEDITEM' type: array description: Success - returns the updated object(s) '400': @@ -8455,18 +12088,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update RelatedDatafiles + summary: Update RelatedItems tags: - - RelatedDatafiles + - RelatedItems post: - description: Creates new RelatedDatafile object(s) with details provided in - the request body + description: Creates new RelatedItem object(s) with details provided in the + request body requestBody: content: application/json: schema: items: - $ref: '#/components/schemas/RELATEDDATAFILE' + $ref: '#/components/schemas/RELATEDITEM' type: array description: The values to use to create the new object(s) with required: true @@ -8476,7 +12109,7 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/RELATEDDATAFILE' + $ref: '#/components/schemas/RELATEDITEM' type: array description: Success - returns the created object '400': @@ -8487,12 +12120,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Create new RelatedDatafiles + summary: Create new RelatedItems tags: - - RelatedDatafiles - /datagateway-api/relateddatafiles/{id_}: + - RelatedItems + /datagateway-api/relateditems/{id_}: delete: - description: Updates RelatedDatafile with the specified ID with details provided + description: Updates RelatedItem with the specified ID with details provided in the request body parameters: - description: The id of the entity to delete @@ -8512,11 +12145,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Delete RelatedDatafiles by id + summary: Delete RelatedItems by id tags: - - RelatedDatafiles + - RelatedItems get: - description: Retrieves a list of RelatedDatafile objects + description: Retrieves a list of RelatedItem objects parameters: - description: The id of the entity to retrieve in: path @@ -8529,8 +12162,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RELATEDDATAFILE' - description: Success - the matching RelatedDatafile + $ref: '#/components/schemas/RELATEDITEM' + description: Success - the matching RelatedItem '400': description: Bad request - Something was wrong with the request '401': @@ -8539,11 +12172,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Find the RelatedDatafile matching the given ID + summary: Find the RelatedItem matching the given ID tags: - - RelatedDatafiles + - RelatedItems patch: - description: Updates RelatedDatafile with the specified ID with details provided + description: Updates RelatedItem with the specified ID with details provided in the request body parameters: - description: The id of the entity to update @@ -8556,7 +12189,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RELATEDDATAFILE' + $ref: '#/components/schemas/RELATEDITEM' description: The values to use to update the object(s) with required: true responses: @@ -8564,7 +12197,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RELATEDDATAFILE' + $ref: '#/components/schemas/RELATEDITEM' description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request @@ -8574,12 +12207,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Update RelatedDatafiles by id + summary: Update RelatedItems by id tags: - - RelatedDatafiles - /datagateway-api/relateddatafiles/count: + - RelatedItems + /datagateway-api/relateditems/count: get: - description: Return the count of the RelatedDatafile objects that would be retrieved + description: Return the count of the RelatedItem objects that would be retrieved given the filters provided parameters: - $ref: '#/components/parameters/WHERE_FILTER' @@ -8591,7 +12224,7 @@ paths: application/json: schema: type: integer - description: Success - The count of the RelatedDatafile objects + description: Success - The count of the RelatedItem objects '400': description: Bad request - Something was wrong with the request '401': @@ -8600,13 +12233,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Count RelatedDatafiles + summary: Count RelatedItems tags: - - RelatedDatafiles - /datagateway-api/relateddatafiles/findone: + - RelatedItems + /datagateway-api/relateditems/findone: get: - description: Retrieves the first RelatedDatafile objects that satisfies the - filters. + description: Retrieves the first RelatedItem objects that satisfies the filters. parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -8619,8 +12251,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RELATEDDATAFILE' - description: Success - a RelatedDatafile object that satisfies the filters + $ref: '#/components/schemas/RELATEDITEM' + description: Success - a RelatedItem object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -8629,9 +12261,9 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in ICAT - summary: Get single RelatedDatafile + summary: Get single RelatedItem tags: - - RelatedDatafiles + - RelatedItems /datagateway-api/rules: get: description: Retrieves a list of Rule objects @@ -10275,6 +13907,241 @@ paths: summary: Get single StudyInvestigation tags: - StudyInvestigations + /datagateway-api/techniques: + get: + description: Retrieves a list of Technique objects + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/TECHNIQUE' + type: array + description: Success - returns Technique that satisfy the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get Techniques + tags: + - Techniques + patch: + description: Updates Technique object(s) with details provided in the request + body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/TECHNIQUE' + type: array + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/TECHNIQUE' + type: array + description: Success - returns the updated object(s) + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update Techniques + tags: + - Techniques + post: + description: Creates new Technique object(s) with details provided in the request + body + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/TECHNIQUE' + type: array + description: The values to use to create the new object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/TECHNIQUE' + type: array + description: Success - returns the created object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Create new Techniques + tags: + - Techniques + /datagateway-api/techniques/{id_}: + delete: + description: Updates Technique with the specified ID with details provided in + the request body + parameters: + - description: The id of the entity to delete + in: path + name: id_ + required: true + schema: + type: integer + responses: + '204': + description: No Content - Object was successfully deleted + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Delete Techniques by id + tags: + - Techniques + get: + description: Retrieves a list of Technique objects + parameters: + - description: The id of the entity to retrieve + in: path + name: id_ + required: true + schema: + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TECHNIQUE' + description: Success - the matching Technique + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Find the Technique matching the given ID + tags: + - Techniques + patch: + description: Updates Technique with the specified ID with details provided in + the request body + parameters: + - description: The id of the entity to update + in: path + name: id_ + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TECHNIQUE' + description: The values to use to update the object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TECHNIQUE' + description: Success - returns the updated object + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Update Techniques by id + tags: + - Techniques + /datagateway-api/techniques/count: + get: + description: Return the count of the Technique objects that would be retrieved + given the filters provided + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + type: integer + description: Success - The count of the Technique objects + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Count Techniques + tags: + - Techniques + /datagateway-api/techniques/findone: + get: + description: Retrieves the first Technique objects that satisfies the filters. + parameters: + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/ORDER_FILTER' + - $ref: '#/components/parameters/LIMIT_FILTER' + - $ref: '#/components/parameters/SKIP_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TECHNIQUE' + description: Success - a Technique object that satisfies the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID found in HTTP Auth. header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in ICAT + summary: Get single Technique + tags: + - Techniques /datagateway-api/usergroups: get: description: Retrieves a list of UserGroup objects