diff --git a/common/backend.py b/common/backend.py index 89fe0bd1..84b8e8e8 100644 --- a/common/backend.py +++ b/common/backend.py @@ -142,7 +142,7 @@ def update_with_id(self, session_id, entity_type, id_, data): pass @abstractmethod - def get_instrument_facilitycycles_with_filters( + def get_facility_cycles_for_instrument_with_filters( self, session_id, instrument_id, filters ): """ @@ -157,7 +157,7 @@ def get_instrument_facilitycycles_with_filters( pass @abstractmethod - def count_instrument_facilitycycles_with_filters( + def get_facility_cycles_for_instrument_count_with_filters( self, session_id, instrument_id, filters ): """ @@ -172,7 +172,7 @@ def count_instrument_facilitycycles_with_filters( pass @abstractmethod - def get_instrument_facilitycycle_investigations_with_filters( + def get_investigations_for_instrument_in_facility_cycle_with_filters( self, session_id, instrument_id, facilitycycle_id, filters ): """ @@ -188,7 +188,7 @@ def get_instrument_facilitycycle_investigations_with_filters( pass @abstractmethod - def count_instrument_facilitycycles_investigations_with_filters( + def get_investigations_for_instrument_in_facility_cycle_count_with_filters( self, session_id, instrument_id, facilitycycle_id, filters ): """ diff --git a/common/constants.py b/common/constants.py index 8dbdb7c3..e5d5fb63 100644 --- a/common/constants.py +++ b/common/constants.py @@ -3,6 +3,5 @@ class Constants: DATABASE_URL = config.get_db_url() - ACCEPTED_DATE_FORMAT = "%Y-%m-%d %H:%M:%S" PYTHON_ICAT_DISTNCT_CONDITION = "!= null" ICAT_PROPERTIES = config.get_icat_properties() diff --git a/common/database/backend.py b/common/database/backend.py index 60e52eb8..7fdaa699 100644 --- a/common/database/backend.py +++ b/common/database/backend.py @@ -101,21 +101,21 @@ def update_with_id(self, session_id, table, id_, data): @requires_session_id @queries_records - def get_instrument_facilitycycles_with_filters( + def get_facility_cycles_for_instrument_with_filters( self, session_id, instrument_id, filters ): return get_facility_cycles_for_instrument(instrument_id, filters) @requires_session_id @queries_records - def count_instrument_facilitycycles_with_filters( + def get_facility_cycles_for_instrument_count_with_filters( self, session_id, instrument_id, filters ): return get_facility_cycles_for_instrument_count(instrument_id, filters) @requires_session_id @queries_records - def get_instrument_facilitycycle_investigations_with_filters( + def get_investigations_for_instrument_in_facility_cycle_with_filters( self, session_id, instrument_id, facilitycycle_id, filters ): return get_investigations_for_instrument_in_facility_cycle( @@ -124,7 +124,7 @@ def get_instrument_facilitycycle_investigations_with_filters( @requires_session_id @queries_records - def count_instrument_facilitycycles_investigations_with_filters( + def get_investigations_for_instrument_in_facility_cycle_count_with_filters( self, session_id, instrument_id, facilitycycle_id, filters ): return get_investigations_for_instrument_in_facility_cycle_count( diff --git a/common/database/helpers.py b/common/database/helpers.py index f4e0d217..e5a5aae6 100644 --- a/common/database/helpers.py +++ b/common/database/helpers.py @@ -233,7 +233,7 @@ def get_query_filter(filter): elif filter_name == "limit": return LimitFilter(filter["limit"]) elif filter_name == "include": - return IncludeFilter(filter) + return IncludeFilter(filter["include"]) elif filter_name == "distinct": return DistinctFieldFilter(filter["distinct"]) else: @@ -426,14 +426,14 @@ def patch_entities(table, json_list): if key.upper() == "ID": update_row_from_id(table, json_list[key], json_list) result = get_row_by_id(table, json_list[key]) - results.append(result) + results.append(result.to_dict()) else: for entity in json_list: for key in entity: if key.upper() == "ID": update_row_from_id(table, entity[key], entity) result = get_row_by_id(table, entity[key]) - results.append(result) + results.append(result.to_dict()) if len(results) == 0: raise BadRequestError(f" Bad request made, request: {json_list}") diff --git a/common/date_handler.py b/common/date_handler.py new file mode 100644 index 00000000..cf5b5710 --- /dev/null +++ b/common/date_handler.py @@ -0,0 +1,70 @@ +from dateutil.parser import parse +from icat import helper + +from common.exceptions import BadRequestError + + +class DateHandler: + """ + Utility class to deal with dates. Currently, this class converts dates between + strings and `datetime.datetime` objects as well as detecting whether a string is + likely to be a date. + """ + + @staticmethod + def is_str_a_date(potential_date): + """ + This function identifies if a string contains a date. This function doesn't + detect which format the date is, just if there's a date or not. + + :param potential_date: String data that could contain a date of any format + :type potential_date: :class:`str` + :return: Boolean to signify whether `potential_date` is a date or not + """ + + try: + # Disabled fuzzy to avoid picking up dates in things like descriptions etc. + parse(potential_date, fuzzy=False) + return True + except ValueError: + return False + + @staticmethod + def str_to_datetime_object(data): + """ + Convert a string to a `datetime.datetime` object. This is commonly used when + storing user input in ICAT (using the Python ICAT backend). + + Python 3.7+ has support for `datetime.fromisoformat()` which would be a more + elegant solution to this conversion operation since dates are converted into ISO + format within this file, however, the production instance of this API is + typically built on Python 3.6, and it doesn't seem of enough value to mandate + 3.7 for a single line of code. Instead, a helper function from `python-icat` is + used which does the conversion using `suds`. This will convert inputs in the ISO + format (i.e. the format which Python ICAT, and therefore DataGateway API outputs + data) but also allows for conversion of other "sensible" formats. + + :param data: Single data value from the request body + :type data: Data type of the data as per user's request body, :class:`str` is + assumed + :return: Date converted into a :class:`datetime` object + :raises BadRequestError: If there is an issue with the date format + """ + + try: + datetime_obj = helper.parse_attr_string(data, "Date") + except ValueError as e: + raise BadRequestError(e) + + return datetime_obj + + @staticmethod + def datetime_object_to_str(datetime_obj): + """ + Convert a datetime object to a string so it can be outputted in JSON + + :param datetime_obj: Datetime object from data from an ICAT entity + :type datetime_obj: :class:`datetime.datetime` + :return: Datetime (of type string) in the agreed format + """ + return datetime_obj.isoformat(" ") diff --git a/common/filter_order_handler.py b/common/filter_order_handler.py index c190e314..857fce91 100644 --- a/common/filter_order_handler.py +++ b/common/filter_order_handler.py @@ -1,3 +1,14 @@ +import logging + +from common.icat.filters import ( + PythonICATLimitFilter, + PythonICATSkipFilter, + PythonICATOrderFilter, +) + +log = logging.getLogger() + + class FilterOrderHandler(object): """ The FilterOrderHandler takes in filters, sorts them according to the order of @@ -32,3 +43,65 @@ def apply_filters(self, query): for filter in self.filters: filter.apply_filter(query) + + def merge_python_icat_limit_skip_filters(self): + """ + When there are both limit and skip filters in a request, merge them into the + limit filter and remove the skip filter from the instance + """ + + if any( + isinstance(icat_filter, PythonICATSkipFilter) + for icat_filter in self.filters + ) and any( + isinstance(icat_filter, PythonICATLimitFilter) + for icat_filter in self.filters + ): + # Merge skip and limit filter into a single limit filter + for icat_filter in self.filters: + if isinstance(icat_filter, PythonICATSkipFilter): + skip_filter = icat_filter + request_skip_value = icat_filter.skip_value + + if isinstance(icat_filter, PythonICATLimitFilter): + limit_filter = icat_filter + + if skip_filter and limit_filter: + log.info("Merging skip filter with limit filter") + limit_filter.skip_value = skip_filter.skip_value + log.info("Removing skip filter from list of filters") + self.remove_filter(skip_filter) + log.debug("Filters: %s", self.filters) + + def clear_python_icat_order_filters(self): + """ + Checks if any order filters have been added to the request and resets the + variable used to manage which attribute(s) to use for sorting results. + + A reset is required because Python ICAT overwrites (as opposed to appending to + it) the query's order list every time one is added to the query. + """ + + if any( + isinstance(icat_filter, PythonICATOrderFilter) + for icat_filter in self.filters + ): + PythonICATOrderFilter.result_order = [] + + def manage_icat_filters(self, filters, query): + """ + Utility function to call other functions in this class, used to manage filters + when using the Python ICAT backend. These steps are the same with the different + types of requests that utilise filters, therefore this function helps to reduce + code duplication + + :param filters: The list of filters that will be applied to the query + :type filters: List of specific implementations :class:`QueryFilter` + :param query: ICAT query which will fetch the data at a later stage + :type query: :class:`icat.query.Query` + """ + + self.add_filters(filters) + self.merge_python_icat_limit_skip_filters() + self.clear_python_icat_order_filters() + self.apply_filters(query) diff --git a/common/filters.py b/common/filters.py index 50732e4c..07de77fa 100644 --- a/common/filters.py +++ b/common/filters.py @@ -69,4 +69,4 @@ class IncludeFilter(QueryFilter): precedence = 5 def __init__(self, included_filters): - self.included_filters = included_filters["include"] + self.included_filters = included_filters diff --git a/common/icat/backend.py b/common/icat/backend.py index eacc8297..9699c73c 100644 --- a/common/icat/backend.py +++ b/common/icat/backend.py @@ -15,6 +15,14 @@ update_entity_by_id, delete_entity_by_id, get_entity_with_filters, + get_count_with_filters, + get_first_result_with_filters, + update_entities, + create_entities, + get_facility_cycles_for_instrument, + get_facility_cycles_for_instrument_count, + get_investigations_for_instrument_in_facility_cycle, + get_investigations_for_instrument_in_facility_cycle_count, ) from common.config import config @@ -72,21 +80,25 @@ def get_with_filters(self, session_id, table, filters, **kwargs): @queries_records def create(self, session_id, table, data, **kwargs): client = kwargs["client"] if kwargs["client"] else create_client() + return create_entities(client, table.__name__, data) @requires_session_id @queries_records def update(self, session_id, table, data, **kwargs): client = kwargs["client"] if kwargs["client"] else create_client() + return update_entities(client, table.__name__, data) @requires_session_id @queries_records def get_one_with_filters(self, session_id, table, filters, **kwargs): client = kwargs["client"] if kwargs["client"] else create_client() + return get_first_result_with_filters(client, table.__name__, filters) @requires_session_id @queries_records def count_with_filters(self, session_id, table, filters, **kwargs): client = kwargs["client"] if kwargs["client"] else create_client() + return get_count_with_filters(client, table.__name__, filters) @requires_session_id @queries_records @@ -108,31 +120,36 @@ def update_with_id(self, session_id, table, id_, data, **kwargs): @requires_session_id @queries_records - def get_instrument_facilitycycles_with_filters( - self, session_id, instrument_id, filters, **kwargs + def get_facility_cycles_for_instrument_with_filters( + self, session_id, instrument_id, filters, **kwargs, ): client = kwargs["client"] if kwargs["client"] else create_client() + return get_facility_cycles_for_instrument(client, instrument_id, filters) @requires_session_id @queries_records - def count_instrument_facilitycycles_with_filters( - self, session_id, instrument_id, filters, **kwargs + def get_facility_cycles_for_instrument_count_with_filters( + self, session_id, instrument_id, filters, **kwargs, ): client = kwargs["client"] if kwargs["client"] else create_client() - # return get_facility_cycles_for_instrument_count(instrument_id, filters) + return get_facility_cycles_for_instrument_count(client, instrument_id, filters) @requires_session_id @queries_records - def get_instrument_facilitycycle_investigations_with_filters( - self, session_id, instrument_id, facilitycycle_id, filters, **kwargs + def get_investigations_for_instrument_in_facility_cycle_with_filters( + self, session_id, instrument_id, facilitycycle_id, filters, **kwargs, ): client = kwargs["client"] if kwargs["client"] else create_client() - # return get_investigations_for_instrument_in_facility_cycle(instrument_id, facilitycycle_id, filters) + return get_investigations_for_instrument_in_facility_cycle( + client, instrument_id, facilitycycle_id, filters + ) @requires_session_id @queries_records - def count_instrument_facilitycycles_investigations_with_filters( - self, session_id, instrument_id, facilitycycle_id, filters, **kwargs + def get_investigations_for_instrument_in_facility_cycle_count_with_filters( + self, session_id, instrument_id, facilitycycle_id, filters, **kwargs, ): client = kwargs["client"] if kwargs["client"] else create_client() - # return get_investigations_for_instrument_in_facility_cycle_count(instrument_id, facilitycycle_id, filters) + return get_investigations_for_instrument_in_facility_cycle_count( + client, instrument_id, facilitycycle_id, filters + ) diff --git a/common/icat/filters.py b/common/icat/filters.py index 10bd4d28..e2037c86 100644 --- a/common/icat/filters.py +++ b/common/icat/filters.py @@ -74,8 +74,11 @@ def create_condition(attribute_name, operator, value): # Removing quote marks when doing conditions with IN expressions or when a # distinct filter is used in a request jpql_value = ( - f"{value}" if operator == "in" or operator == "!=" else f"'{value}'" + f"{value}" + if operator == "in" or operator == "!=" or "o." in str(value) + else f"'{value}'" ) + conditions[attribute_name] = f"{operator} {jpql_value}" log.debug("Conditions in ICAT where filter, %s", conditions) return conditions @@ -88,7 +91,15 @@ def __init__(self, fields): def apply_filter(self, query): try: log.info("Adding ICAT distinct filter to ICAT query") - query.setAggregate("DISTINCT") + if ( + query.aggregate == "COUNT" + or query.aggregate == "AVG" + or query.aggregate == "SUM" + ): + # Distinct can be combined with other aggregate functions + query.setAggregate(f"{query.aggregate}:DISTINCT") + else: + query.setAggregate("DISTINCT") # Using where filters to identify which fields to apply distinct too for field in self.fields: @@ -163,7 +174,7 @@ class PythonICATIncludeFilter(IncludeFilter): def __init__(self, included_filters): self.included_filters = [] log.info("Extracting fields for include filter") - self._extract_filter_fields(included_filters["include"]) + self._extract_filter_fields(included_filters) def _extract_filter_fields(self, field): """ diff --git a/common/icat/helpers.py b/common/icat/helpers.py index 721d8003..81fa68e2 100644 --- a/common/icat/helpers.py +++ b/common/icat/helpers.py @@ -2,7 +2,16 @@ import logging from datetime import datetime, timedelta -from icat.exception import ICATSessionError, ICATValidationError +from icat.entities import getTypeMap +from icat.exception import ( + ICATSessionError, + ICATValidationError, + ICATInternalError, + ICATObjectExistsError, + ICATNoObjectError, + ICATParameterError, +) +from icat.sslcontext import create_ssl_context from common.exceptions import ( AuthenticationError, BadRequestError, @@ -10,13 +19,9 @@ PythonICATError, ) from common.filter_order_handler import FilterOrderHandler +from common.date_handler import DateHandler from common.constants import Constants -from common.icat.filters import ( - PythonICATLimitFilter, - PythonICATWhereFilter, - PythonICATSkipFilter, - PythonICATOrderFilter, -) +from common.icat.filters import PythonICATLimitFilter, PythonICATWhereFilter from common.icat.query import ICATQuery import icat.client @@ -81,16 +86,16 @@ def get_session_details_helper(client): :return: Details of the user's session, ready to be converted into a JSON response body """ - # Remove rounding session_time_remaining = client.getRemainingMinutes() - session_expiry_time = datetime.now() + timedelta(minutes=session_time_remaining) - + session_expiry_time = ( + datetime.now() + timedelta(minutes=session_time_remaining) + ).replace(microsecond=0) username = client.getUserName() return { - "ID": client.sessionId, - "EXPIREDATETIME": str(session_expiry_time), - "USERNAME": username, + "id": client.sessionId, + "expireDateTime": DateHandler.datetime_object_to_str(session_expiry_time), + "username": username, } @@ -115,7 +120,7 @@ def refresh_client_session(client): client.refresh() -def get_python_icat_entity_name(client, database_table_name): +def get_python_icat_entity_name(client, database_table_name, camel_case_output=False): """ From the database table name, this function returns the correctly cased entity name relating to the table name @@ -128,14 +133,23 @@ def get_python_icat_entity_name(client, database_table_name): :type client: :class:`icat.client.Client` :param database_table_name: Table name (from icatdb) to be interacted with :type database_table_name: :class:`str` + :param camel_case_output: Flag to signify if the entity name should be returned in + camel case format. Enabling this flag gets the entity names from a different + place in Python ICAT. + :type camel_case_output: :class:`bool` :return: Entity name (of type string) in the correct casing ready to be passed into Python ICAT :raises BadRequestError: If the entity cannot be found """ + if camel_case_output: + entity_names = getTypeMap(client).keys() + else: + entity_names = client.getEntityNames() + lowercase_table_name = database_table_name.lower() - entity_names = client.getEntityNames() python_icat_entity_name = None + for entity_name in entity_names: lowercase_name = entity_name.lower() @@ -152,38 +166,6 @@ def get_python_icat_entity_name(client, database_table_name): return python_icat_entity_name -def str_to_datetime_object(icat_attribute, data): - """ - Where data is stored as dates in ICAT (which this function determines), convert - strings (i.e. user data from PATCH/POST requests) into datetime objects so they can - be stored in ICAT - - Python 3.7+ has support for `datetime.fromisoformat()` which would be a more elegant - solution to this conversion operation since dates are converted into ISO format - within this file, however, the production instance of this API is typically built on - Python 3.6, and it doesn't seem of enough value to mandate 3.7 for a single line of - code - - :param icat_attribute: Attribute that will be updated with new data - :type icat_attribute: Any valid data type that can be stored in Python ICAT - :param data: Single data value from the request body - :type data: Data type of the data as per user's request body - :return: Date converted into a :class:`datetime` object - :raises BadRequestError: If the date is entered in the incorrect format, as per - `Constants.ACCEPTED_DATE_FORMAT` - """ - - try: - data = datetime.strptime(data, Constants.ACCEPTED_DATE_FORMAT) - except ValueError: - raise BadRequestError( - "Bad request made, the date entered is not in the correct format. Use the" - f" {Constants.ACCEPTED_DATE_FORMAT} format to submit dates to the API" - ) - - return data - - def update_attributes(old_entity, new_entity): """ Updates the attribute(s) of a given object which is a record of an entity from @@ -202,13 +184,11 @@ def update_attributes(old_entity, new_entity): try: original_data_attribute = getattr(old_entity, key) if isinstance(original_data_attribute, datetime): - new_entity[key] = str_to_datetime_object( - original_data_attribute, new_entity[key] - ) + new_entity[key] = DateHandler.str_to_datetime_object(new_entity[key]) except AttributeError: raise BadRequestError( f"Bad request made, cannot find attribute '{key}' within the" - f"{old_entity.BeanName} entity" + f" {old_entity.BeanName} entity" ) try: @@ -219,13 +199,19 @@ def update_attributes(old_entity, new_entity): f" {old_entity.BeanName} entity" ) + return old_entity + + +def push_data_updates_to_icat(entity): try: - old_entity.update() - except ICATValidationError as e: + entity.update() + except (ICATValidationError, ICATInternalError) as e: raise PythonICATError(e) -def get_entity_by_id(client, table_name, id_, return_json_formattable_data): +def get_entity_by_id( + client, table_name, id_, return_json_formattable_data, return_related_entities=False +): """ Gets a record of a given ID from the specified entity @@ -240,6 +226,11 @@ def get_entity_by_id(client, table_name, id_, return_json_formattable_data): data will be used as a response for an API call) or whether to leave the data in a Python ICAT format :type return_json_formattable_data: :class:`bool` + :param return_related_entities: Flag to determine whether related entities should + automatically be returned or not. Returning related entities used as a bug fix + for an `IcatException` where ICAT attempts to set a field to null because said + field hasn't been included in the updated data + :type return_related_entities: :class:`bool` :return: The record of the specified ID from the given entity :raises: MissingRecordError: If Python ICAT cannot find a record of the specified ID """ @@ -248,8 +239,9 @@ def get_entity_by_id(client, table_name, id_, return_json_formattable_data): # Set query condition for the selected ID id_condition = PythonICATWhereFilter.create_condition("id", "=", id_) + includes_value = "1" if return_related_entities == True else None id_query = ICATQuery( - client, selected_entity_name, conditions=id_condition, includes="1" + client, selected_entity_name, conditions=id_condition, includes=includes_value ) entity_by_id_data = id_query.execute_query(client, return_json_formattable_data) @@ -291,11 +283,14 @@ def update_entity_by_id(client, table_name, id_, new_data): :return: The updated record of the specified ID from the given entity """ - entity_id_data = get_entity_by_id(client, table_name, id_, False) + entity_id_data = get_entity_by_id( + client, table_name, id_, False, return_related_entities=True + ) # There will only ever be one record associated with a single ID - if a record with # the specified ID cannot be found, it'll be picked up by the MissingRecordError in # get_entity_by_id() - update_attributes(entity_id_data, new_data) + updated_icat_entity = update_attributes(entity_id_data, new_data) + push_data_updates_to_icat(updated_icat_entity) # The record is re-obtained from Python ICAT (rather than using entity_id_data) to # show to the user whether the change has actually been applied @@ -315,15 +310,13 @@ def get_entity_with_filters(client, table_name, filters): :return: The list of records of the given entity, using the filters to restrict the result of the query """ + log.info("Getting entity using request's filters") selected_entity_name = get_python_icat_entity_name(client, table_name) query = ICATQuery(client, selected_entity_name) filter_handler = FilterOrderHandler() - filter_handler.add_filters(filters) - merge_limit_skip_filters(filter_handler) - clear_order_filters(filter_handler.filters) - filter_handler.apply_filters(query.query) + filter_handler.manage_icat_filters(filters, query.query) data = query.execute_query(client, True) @@ -333,48 +326,386 @@ def get_entity_with_filters(client, table_name, filters): return data -def merge_limit_skip_filters(filter_handler): +def get_count_with_filters(client, table_name, filters): + """ + Get the number of results of a given entity, based on the filters provided in the + request. This acts very much like `get_entity_with_filters()` but returns the number + of results, as opposed to a JSON object of data. + + :param client: ICAT client containing an authenticated user + :type client: :class:`icat.client.Client` + :param table_name: Table name to extract which entity to use + :type table_name: :class:`str` + :param filters: The list of filters to be applied to the request + :type filters: List of specific implementations :class:`QueryFilter` + :return: The number of records of the given entity (of type integer), using the + filters to restrict the result of the query + """ + log.info( + "Getting the number of results of %s, also using the request's filters", + table_name, + ) + + selected_entity_name = get_python_icat_entity_name(client, table_name) + query = ICATQuery(client, selected_entity_name, aggregate="COUNT") + + filter_handler = FilterOrderHandler() + filter_handler.manage_icat_filters(filters, query.query) + + data = query.execute_query(client, True) + + if not data: + raise MissingRecordError("No results found") + else: + # Only ever 1 element in a count query result + return data[0] + + +def get_first_result_with_filters(client, table_name, filters): + """ + Using filters in the request, get results of the given entity, but only show the + first one to the user + + Since only one result will be outputted, inserting a `PythonICATLimitFilter` in the + query will make Python ICAT's data fetching more snappy and prevent a 500 being + caused by trying to fetch over the number of records limited by ICAT (currently + 10000). + + :param client: ICAT client containing an authenticated user + :type client: :class:`icat.client.Client` + :param table_name: Table name to extract which entity to use + :type table_name: :class:`str` + :param filters: The list of filters to be applied to the request + :type filters: List of specific implementations :class:`QueryFilter` + :return: The first record of the given entity, using the filters to restrict the + result of the query + """ + log.info( + "Getting only first result of %s, making use of filters in request", table_name + ) + + limit_filter = PythonICATLimitFilter(1) + filters.append(limit_filter) + + entity_data = get_entity_with_filters(client, table_name, filters) + + if not entity_data: + raise MissingRecordError("No results found") + else: + return entity_data[0] + + +def update_entities(client, table_name, data_to_update): + """ + Update one or more results for the given entity using the JSON provided in + `data_to_update` + + If an exception occurs while sending data to icatdb, an attempt will be made to + restore a backup of the data made before making the update. + + :param client: ICAT client containing an authenticated user + :type client: :class:`icat.client.Client` + :param table_name: Table name to extract which entity to use + :type table_name: :class:`str` + :param data_to_update: The data that to be updated in ICAT + :type data_to_update: :class:`list` or :class:`dict` + :return: The updated record(s) of the given entity + """ + log.info("Updating certain results in %s", table_name) + + updated_data = [] + + if not isinstance(data_to_update, list): + data_to_update = [data_to_update] + + icat_data_backup = [] + updated_icat_data = [] + + for entity_request in data_to_update: + try: + entity_data = get_entity_by_id( + client, + table_name, + entity_request["id"], + False, + return_related_entities=True, + ) + icat_data_backup.append(entity_data.copy()) + + updated_entity_data = update_attributes(entity_data, entity_request) + updated_icat_data.append(updated_entity_data) + except KeyError: + raise BadRequestError( + "The new data in the request body must contain the ID (using the key:" + " 'id') of the entity you wish to update" + ) + + # This separates the local data updates from pushing these updates to icatdb + for updated_icat_entity in updated_icat_data: + try: + updated_icat_entity.update() + except (ICATValidationError, ICATInternalError) as e: + # Use `icat_data_backup` to restore data trying to updated to the state + # before this request + for icat_entity_backup in icat_data_backup: + try: + icat_entity_backup.update() + except (ICATValidationError, ICATInternalError) as e: + # If an error occurs while trying to restore backup data, just throw + # a 500 immediately + raise PythonICATError(e) + + raise PythonICATError(e) + + updated_data.append( + get_entity_by_id(client, table_name, updated_icat_entity.id, True) + ) + + return updated_data + + +def create_entities(client, table_name, data): """ - When there are both limit and skip filters in a request, merge them into the limit - filter and remove the skip filter from `filter_handler` + Add one or more results for the given entity using the JSON provided in `data` + + `created_icat_data` is data of `icat.entity.Entity` type that is collated to be + pushed to ICAT at the end of the function - this avoids confusion over which data + has/hasn't been created if the request returns an error. When pushing the data to + ICAT, there is still risk an exception might be caught, so any entities already + pushed to ICAT will be deleted. Python ICAT doesn't support a database rollback (or + the concept of transactions) so this is a good alternative. - :param filter_handler: The filter handler to apply the filters - :param filters: The filters to be applied + :param client: ICAT client containing an authenticated user + :type client: :class:`icat.client.Client` + :param table_name: Table name to extract which entity to use + :type table_name: :class:`str` + :param data: The data that needs to be created in ICAT + :type data_to_update: :class:`list` or :class:`dict` + :return: The created record(s) of the given entity """ + log.info("Creating ICAT data for %s", table_name) - if any( - isinstance(filter, PythonICATSkipFilter) for filter in filter_handler.filters - ) and any( - isinstance(filter, PythonICATLimitFilter) for filter in filter_handler.filters - ): - # Merge skip and limit filter into a single limit filter - for filter in filter_handler.filters: - if isinstance(filter, PythonICATSkipFilter): - skip_filter = filter - request_skip_value = filter.skip_value + created_data = [] + created_icat_data = [] - if isinstance(filter, PythonICATLimitFilter): - limit_filter = filter + if not isinstance(data, list): + data = [data] - if skip_filter and limit_filter: - log.info("Merging skip filter with limit filter") - limit_filter.skip_value = skip_filter.skip_value - log.info("Removing skip filter from list of filters") - filter_handler.remove_filter(skip_filter) - log.debug("Filters: %s", filter_handler.filters) + for result in data: + new_entity = client.new( + get_python_icat_entity_name(client, table_name, camel_case_output=True) + ) + for attribute_name, value in result.items(): + try: + entity_info = new_entity.getAttrInfo(client, attribute_name) + if entity_info.relType.lower() == "attribute": + if isinstance(value, str): + if DateHandler.is_str_a_date(value): + value = DateHandler.str_to_datetime_object(value) + + setattr(new_entity, attribute_name, value) + else: + # This means the attribute has a relationship with another object + try: + related_object = client.get(entity_info.type, value) + except ICATNoObjectError as e: + raise BadRequestError(e) + if entity_info.relType.lower() == "many": + related_object = [related_object] + setattr(new_entity, attribute_name, related_object) + + except ValueError as e: + raise BadRequestError(e) + + created_icat_data.append(new_entity) + + for entity in created_icat_data: + try: + entity.create() + except (ICATValidationError, ICATInternalError) as e: + for entity_json in created_data: + # Delete any data that has been pushed to ICAT before the exception + delete_entity_by_id(client, table_name, entity_json["id"]) + + raise PythonICATError(e) + except (ICATObjectExistsError, ICATParameterError) as e: + for entity_json in created_data: + delete_entity_by_id(client, table_name, entity_json["id"]) + + raise BadRequestError(e) + + created_data.append(get_entity_by_id(client, table_name, entity.id, True)) + + return created_data -def clear_order_filters(filters): + +def get_facility_cycles_for_instrument( + client, instrument_id, filters, count_query=False +): """ - Checks if any order filters have been added to the request and resets the variable - used to manage which attribute(s) to use for sorting results. - - A reset is required because Python ICAT overwrites (as opposed to appending to it) - the query's order list every time one is added to the query. + Given an Instrument ID, get the Facility Cycles where there are Instruments that + have investigations occurring within that cycle + :param client: ICAT client containing an authenticated user + :type client: :class:`icat.client.Client` + :param instrument_id: ID of the instrument from the request + :type instrument_id: :class:`int` :param filters: The list of filters to be applied to the request :type filters: List of specific implementations :class:`QueryFilter` + :param count_query: Flag to determine if the query in this function should be used + as a count query. Used for `get_facility_cycles_for_instrument_count()` + :type count_query: :class:`bool` + :return: A list of Facility Cycles that match the query """ + log.info("Getting a list of facility cycles from the specified instrument for ISIS") + + query_aggregate = "COUNT:DISTINCT" if count_query else "DISTINCT" + query = ICATQuery( + client, "FacilityCycle", aggregate=query_aggregate, isis_endpoint=True + ) - if any(isinstance(filter, PythonICATOrderFilter) for filter in filters): - PythonICATOrderFilter.result_order = [] + instrument_id_check = PythonICATWhereFilter( + "facility.instruments.id", instrument_id, "eq" + ) + investigation_instrument_id_check = PythonICATWhereFilter( + "facility.investigations.investigationInstruments.instrument.id", + instrument_id, + "eq", + ) + investigation_start_date_check = PythonICATWhereFilter( + "facility.investigations.startDate", "o.startDate", "gte" + ) + investigation_end_date_check = PythonICATWhereFilter( + "facility.investigations.startDate", "o.endDate", "lte" + ) + + facility_cycle_filters = [ + instrument_id_check, + investigation_instrument_id_check, + investigation_start_date_check, + investigation_end_date_check, + ] + filters.extend(facility_cycle_filters) + filter_handler = FilterOrderHandler() + filter_handler.manage_icat_filters(filters, query.query) + + data = query.execute_query(client, True) + + if not data: + raise MissingRecordError("No results found") + else: + return data + + +def get_facility_cycles_for_instrument_count(client, instrument_id, filters): + """ + Given an Instrument ID, get the number of Facility Cycles where there's Instruments + that have investigations occurring within that cycle + + :param client: ICAT client containing an authenticated user + :type client: :class:`icat.client.Client` + :param instrument_id: ID of the instrument from the request + :type instrument_id: :class:`int` + :param filters: The list of filters to be applied to the request + :type filters: List of specific implementations :class:`QueryFilter` + :return: The number of Facility Cycles that match the query + """ + log.info( + "Getting the number of facility cycles from the specified instrument for ISIS" + ) + return get_facility_cycles_for_instrument( + client, instrument_id, filters, count_query=True + )[0] + + +def get_investigations_for_instrument_in_facility_cycle( + client, instrument_id, facilitycycle_id, filters, count_query=False +): + """ + Given Instrument and Facility Cycle IDs, get investigations that use the given + instrument in the given cycle + + :param client: ICAT client containing an authenticated user + :type client: :class:`icat.client.Client` + :param instrument_id: ID of the instrument from the request + :type instrument_id: :class:`int` + :param facilitycycle_id: ID of the facilityCycle from the request + :type facilitycycle_id: :class:`int` + :param filters: The list of filters to be applied to the request + :type filters: List of specific implementations :class:`QueryFilter` + :param count_query: Flag to determine if the query in this function should be used + as a count query. Used for + `get_investigations_for_instrument_in_facility_cycle_count()` + :type count_query: :class:`bool` + :return: A list of Investigations that match the query + """ + log.info( + "Getting a list of investigations from the specified instrument and facility" + " cycle, for ISIS" + ) + + query_aggregate = "COUNT:DISTINCT" if count_query else "DISTINCT" + query = ICATQuery( + client, "Investigation", aggregate=query_aggregate, isis_endpoint=True + ) + + instrument_id_check = PythonICATWhereFilter( + "facility.instruments.id", instrument_id, "eq" + ) + investigation_instrument_id_check = PythonICATWhereFilter( + "investigationInstruments.instrument.id", instrument_id, "eq", + ) + facility_cycle_id_check = PythonICATWhereFilter( + "facility.facilityCycles.id", facilitycycle_id, "eq" + ) + facility_cycle_start_date_check = PythonICATWhereFilter( + "facility.facilityCycles.startDate", "o.startDate", "lte" + ) + facility_cycle_end_date_check = PythonICATWhereFilter( + "facility.facilityCycles.endDate", "o.startDate", "gte" + ) + + required_filters = [ + instrument_id_check, + investigation_instrument_id_check, + facility_cycle_id_check, + facility_cycle_start_date_check, + facility_cycle_end_date_check, + ] + filters.extend(required_filters) + filter_handler = FilterOrderHandler() + filter_handler.manage_icat_filters(filters, query.query) + + data = query.execute_query(client, True) + + if not data: + raise MissingRecordError("No results found") + else: + return data + + +def get_investigations_for_instrument_in_facility_cycle_count( + client, instrument_id, facilitycycle_id, filters +): + """ + Given Instrument and Facility Cycle IDs, get the number of investigations that use + the given instrument in the given cycle + + :param client: ICAT client containing an authenticated user + :type client: :class:`icat.client.Client` + :param instrument_id: ID of the instrument from the request + :type instrument_id: :class:`int` + :param facilitycycle_id: ID of the facilityCycle from the request + :type facilitycycle_id: :class:`int` + :param filters: The list of filters to be applied to the request + :type filters: List of specific implementations :class:`QueryFilter` + :return: The number of Investigations that match the query + """ + log.info( + "Getting the number of investigations from the specified instrument and" + " facility cycle, for ISIS" + ) + return get_investigations_for_instrument_in_facility_cycle( + client, instrument_id, facilitycycle_id, filters, count_query=True + )[0] diff --git a/common/icat/query.py b/common/icat/query.py index 8779dd7f..5a465de8 100644 --- a/common/icat/query.py +++ b/common/icat/query.py @@ -2,10 +2,12 @@ from datetime import datetime from icat.entity import Entity, EntityList +from icat.entities import getTypeMap from icat.query import Query -from icat.exception import ICATValidationError +from icat.exception import ICATValidationError, ICATInternalError from common.exceptions import PythonICATError, FilterError +from common.date_handler import DateHandler from common.constants import Constants log = logging.getLogger() @@ -13,7 +15,13 @@ class ICATQuery: def __init__( - self, client, entity_name, conditions=None, aggregate=None, includes=None + self, + client, + entity_name, + conditions=None, + aggregate=None, + includes=None, + isis_endpoint=False, ): """ Create a Query object within Python ICAT @@ -31,6 +39,12 @@ def __init__( :param includes: List of related entity names to add to the query so related entities (and their data) can be returned with the query result :type includes: :class:`str` or iterable of :class:`str` + :param isis_endpoint: Flag to determine if the instance will be used for an ISIS + specific endpoint. These endpoints require the use of the DISTINCT aggregate + which is different to the distinct field filter implemented in this API, so + this flag prevents code related to the filter from executing (because it + doesn't need to be on a DISTINCT aggregate) + :type isis_endpoint: :class:`bool` :return: Query object from Python ICAT :raises PythonICATError: If a ValueError is raised when creating a Query(), 500 will be returned as a response @@ -51,10 +65,12 @@ def __init__( " suggesting an invalid argument" ) + self.isis_endpoint = isis_endpoint + def execute_query(self, client, return_json_formattable=False): """ - Execute a previously created ICAT Query object and return in the format - specified by the return_json_formattable flag + Execute the ICAT Query object and return in the format specified by the + return_json_formattable flag :param client: ICAT client containing an authenticated user :type client: :class:`icat.client.Client` @@ -69,15 +85,26 @@ def execute_query(self, client, return_json_formattable=False): """ try: - log.debug("Executing ICAT query") + log.debug("Executing ICAT query: %s", self.query) query_result = client.search(self.query) - except ICATValidationError as e: + except (ICATValidationError, ICATInternalError) as e: raise PythonICATError(e) flat_query_includes = self.flatten_query_included_fields(self.query.includes) mapped_distinct_fields = None - if self.query.aggregate == "DISTINCT": + # If the query has a COUNT function applied to it, some of these steps can be + # skipped + count_query = False + if self.query.aggregate is not None: + if "COUNT" in self.query.aggregate: + count_query = True + + if ( + self.query.aggregate == "DISTINCT" + and not count_query + and not self.isis_endpoint + ): log.info("Extracting the distinct fields from query's conditions") # Check query's conditions for the ones created by the distinct filter distinct_attributes = self.iterate_query_conditions_for_distinctiveness() @@ -95,10 +122,14 @@ def execute_query(self, client, return_json_formattable=False): data = [] for result in query_result: - dict_result = self.entity_to_dict( - result, flat_query_includes, mapped_distinct_fields - ) - data.append(dict_result) + if not count_query: + dict_result = self.entity_to_dict( + result, flat_query_includes, mapped_distinct_fields + ) + data.append(dict_result) + else: + data.append(result) + return data else: log.info("Query results will be returned as ICAT entities") @@ -134,19 +165,6 @@ def check_attribute_name_for_distinct(self, attribute_list, key, value): if value == Constants.PYTHON_ICAT_DISTNCT_CONDITION: attribute_list.append(key) - def datetime_object_to_str(self, date_obj): - """ - Convert a datetime object to a string so it can be outputted in JSON - - There's currently no reason to make this function static, but it could be useful - in the future if a use case required this functionality. - - :param date_obj: Datetime object from data from an ICAT entity - :type date_obj: :class:`datetime.datetime` - :return: Datetime (of type string) in the agreed format - """ - return date_obj.replace(tzinfo=None).strftime(Constants.ACCEPTED_DATE_FORMAT) - def entity_to_dict(self, entity, includes, distinct_fields=None): """ This expands on Python ICAT's implementation of `icat.entity.Entity.as_dict()` @@ -185,9 +203,13 @@ def entity_to_dict(self, entity, includes, distinct_fields=None): " cause an issue further on in the request" ) if isinstance(target, Entity): - distinct_fields_copy = self.prepare_distinct_fields_for_recursion( - key, distinct_fields - ) + if distinct_fields is not None: + distinct_fields_copy = self.prepare_distinct_fields_for_recursion( + key, distinct_fields + ) + else: + distinct_fields_copy = None + d[key] = self.entity_to_dict( target, includes_copy, distinct_fields_copy ) @@ -196,9 +218,13 @@ def entity_to_dict(self, entity, includes, distinct_fields=None): elif isinstance(target, EntityList): d[key] = [] for e in target: - distinct_fields_copy = self.prepare_distinct_fields_for_recursion( - key, distinct_fields - ) + if distinct_fields is not None: + distinct_fields_copy = self.prepare_distinct_fields_for_recursion( + key, distinct_fields + ) + else: + distinct_fields_copy = None + d[key].append( self.entity_to_dict(e, includes_copy, distinct_fields_copy) ) @@ -211,7 +237,7 @@ def entity_to_dict(self, entity, includes, distinct_fields=None): # Convert datetime objects to strings ready to be outputted as JSON if isinstance(entity_data, datetime): # Remove timezone data which isn't utilised in ICAT - entity_data = self.datetime_object_to_str(entity_data) + entity_data = DateHandler.datetime_object_to_str(entity_data) d[key] = entity_data return d diff --git a/src/main.py b/src/main.py index a19c2b94..e3939582 100644 --- a/src/main.py +++ b/src/main.py @@ -102,6 +102,12 @@ def handle_error(e): ) spec.path(resource=InstrumentsFacilityCyclesInvestigationsCount, api=api) +# Reorder paths (e.g. get, patch, post) so openapi.yaml only changes when there's a +# change to the Swagger docs, rather than changing on each startup +for entity_data in spec._paths.values(): + for endpoint_name in sorted(entity_data.keys()): + entity_data.move_to_end(endpoint_name) + openapi_spec_path = Path(__file__).parent / "swagger/openapi.yaml" with open(openapi_spec_path, "w") as f: f.write(spec.to_yaml()) diff --git a/src/resources/entities/entity_endpoint.py b/src/resources/entities/entity_endpoint.py index cd742d49..0addd080 100644 --- a/src/resources/entities/entity_endpoint.py +++ b/src/resources/entities/entity_endpoint.py @@ -108,14 +108,7 @@ def post(self): def patch(self): return ( - list( - map( - lambda x: x.to_dict(), - backend.update( - get_session_id_from_auth_header(), table, request.json - ), - ) - ), + backend.update(get_session_id_from_auth_header(), table, request.json), 200, ) diff --git a/src/resources/table_endpoints/table_endpoints.py b/src/resources/table_endpoints/table_endpoints.py index 4de8a945..d2584c89 100644 --- a/src/resources/table_endpoints/table_endpoints.py +++ b/src/resources/table_endpoints/table_endpoints.py @@ -53,7 +53,7 @@ def get(self, id_): description: No such record - Unable to find a record in the database """ return ( - backend.get_facility_cycles_for_instrument( + backend.get_facility_cycles_for_instrument_with_filters( get_session_id_from_auth_header(), id_, get_filters_from_query_string() ), 200, @@ -94,7 +94,7 @@ def get(self, id_): description: No such record - Unable to find a record in the database """ return ( - backend.get_facility_cycles_for_instrument_count( + backend.get_facility_cycles_for_instrument_count_with_filters( get_session_id_from_auth_header(), id_, get_filters_from_query_string() ), 200, @@ -147,7 +147,7 @@ def get(self, instrument_id, cycle_id): description: No such record - Unable to find a record in the database """ return ( - backend.get_investigations_for_instrument_in_facility_cycle( + backend.get_investigations_for_instrument_in_facility_cycle_with_filters( get_session_id_from_auth_header(), instrument_id, cycle_id, @@ -197,7 +197,7 @@ def get(self, instrument_id, cycle_id): description: No such record - Unable to find a record in the database """ return ( - backend.get_investigations_for_instrument_in_facility_cycle_count( + backend.get_investigations_for_instrument_in_facility_cycle_count_with_filters( get_session_id_from_auth_header(), instrument_id, cycle_id, diff --git a/src/swagger/openapi.yaml b/src/swagger/openapi.yaml index 3a187654..db6fbe18 100644 --- a/src/swagger/openapi.yaml +++ b/src/swagger/openapi.yaml @@ -1760,31 +1760,24 @@ info: openapi: 3.0.3 paths: /applications: - post: - description: Creates new APPLICATION object(s) with details provided in the - request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/APPLICATION' - - items: - $ref: '#/components/schemas/APPLICATION' - type: array - description: The values to use to create the new object(s) with - required: true + 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: - oneOf: - - $ref: '#/components/schemas/APPLICATION' - - items: - $ref: '#/components/schemas/APPLICATION' - type: array - description: Success - returns the created object + 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': @@ -1794,7 +1787,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new Applications + summary: Get Applications tags: - Applications patch: @@ -1834,24 +1827,31 @@ paths: summary: Update Applications tags: - 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' + post: + description: Creates new APPLICATION object(s) with details provided in the + request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/APPLICATION' + - 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 APPLICATION that satisfy the filters + oneOf: + - $ref: '#/components/schemas/APPLICATION' + - items: + $ref: '#/components/schemas/APPLICATION' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -1861,7 +1861,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get Applications + summary: Create new Applications tags: - Applications /applications/{id_}: @@ -1890,30 +1890,22 @@ paths: summary: Delete Applications by id tags: - Applications - patch: - description: Updates APPLICATION with the specified ID with details provided - in the request body + get: + description: Retrieves a list of APPLICATION objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve 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 + description: Success - the matching APPLICATION '400': description: Bad request - Something was wrong with the request '401': @@ -1923,25 +1915,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update Applications by id + summary: Find the APPLICATION matching the given ID tags: - Applications - get: - description: Retrieves a list of APPLICATION objects + patch: + description: Updates APPLICATION with the specified ID with details provided + in the request body parameters: - - description: The id of the entity to retrieve + - 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 - the matching APPLICATION + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -1951,7 +1951,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the APPLICATION matching the given ID + summary: Update Applications by id tags: - Applications /applications/count: @@ -2011,31 +2011,24 @@ paths: tags: - Applications /datacollectiondatafiles: - post: - description: Creates new DATACOLLECTIONDATAFILE object(s) with details provided - in the request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' - - items: - $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' - type: array - description: The values to use to create the new object(s) with - required: true + 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: - oneOf: - - $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' - - items: - $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' - type: array - description: Success - returns the created object + 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': @@ -2045,7 +2038,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new DataCollectionDatafiles + summary: Get DataCollectionDatafiles tags: - DataCollectionDatafiles patch: @@ -2085,24 +2078,31 @@ paths: summary: Update DataCollectionDatafiles tags: - 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' + post: + description: Creates new DATACOLLECTIONDATAFILE object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + - 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 DATACOLLECTIONDATAFILE that satisfy the filters + oneOf: + - $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + - items: + $ref: '#/components/schemas/DATACOLLECTIONDATAFILE' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -2112,7 +2112,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get DataCollectionDatafiles + summary: Create new DataCollectionDatafiles tags: - DataCollectionDatafiles /datacollectiondatafiles/{id_}: @@ -2141,30 +2141,22 @@ paths: summary: Delete DataCollectionDatafiles by id tags: - DataCollectionDatafiles - patch: - description: Updates DATACOLLECTIONDATAFILE with the specified ID with details - provided in the request body + get: + description: Retrieves a list of DATACOLLECTIONDATAFILE objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve 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 + description: Success - the matching DATACOLLECTIONDATAFILE '400': description: Bad request - Something was wrong with the request '401': @@ -2174,25 +2166,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update DataCollectionDatafiles by id + summary: Find the DATACOLLECTIONDATAFILE matching the given ID tags: - DataCollectionDatafiles - get: - description: Retrieves a list of DATACOLLECTIONDATAFILE objects + patch: + description: Updates DATACOLLECTIONDATAFILE with the specified ID with details + provided in the request body parameters: - - description: The id of the entity to retrieve + - 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 - the matching DATACOLLECTIONDATAFILE + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -2202,7 +2202,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the DATACOLLECTIONDATAFILE matching the given ID + summary: Update DataCollectionDatafiles by id tags: - DataCollectionDatafiles /datacollectiondatafiles/count: @@ -2264,31 +2264,24 @@ paths: tags: - DataCollectionDatafiles /datacollectiondatasets: - post: - description: Creates new DATACOLLECTIONDATASET object(s) with details provided - in the request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/DATACOLLECTIONDATASET' - - items: - $ref: '#/components/schemas/DATACOLLECTIONDATASET' - type: array - description: The values to use to create the new object(s) with - required: true + 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: - oneOf: - - $ref: '#/components/schemas/DATACOLLECTIONDATASET' - - items: - $ref: '#/components/schemas/DATACOLLECTIONDATASET' - type: array - description: Success - returns the created object + 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': @@ -2298,7 +2291,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new DataCollectionDatasets + summary: Get DataCollectionDatasets tags: - DataCollectionDatasets patch: @@ -2338,24 +2331,31 @@ paths: summary: Update DataCollectionDatasets tags: - 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' + post: + description: Creates new DATACOLLECTIONDATASET object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/DATACOLLECTIONDATASET' + - 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 DATACOLLECTIONDATASET that satisfy the filters + oneOf: + - $ref: '#/components/schemas/DATACOLLECTIONDATASET' + - items: + $ref: '#/components/schemas/DATACOLLECTIONDATASET' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -2365,7 +2365,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get DataCollectionDatasets + summary: Create new DataCollectionDatasets tags: - DataCollectionDatasets /datacollectiondatasets/{id_}: @@ -2394,30 +2394,22 @@ paths: summary: Delete DataCollectionDatasets by id tags: - DataCollectionDatasets - patch: - description: Updates DATACOLLECTIONDATASET with the specified ID with details - provided in the request body + get: + description: Retrieves a list of DATACOLLECTIONDATASET objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve 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 + description: Success - the matching DATACOLLECTIONDATASET '400': description: Bad request - Something was wrong with the request '401': @@ -2427,25 +2419,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update DataCollectionDatasets by id + summary: Find the DATACOLLECTIONDATASET matching the given ID tags: - DataCollectionDatasets - get: - description: Retrieves a list of DATACOLLECTIONDATASET objects + patch: + description: Updates DATACOLLECTIONDATASET with the specified ID with details + provided in the request body parameters: - - description: The id of the entity to retrieve + - 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 - the matching DATACOLLECTIONDATASET + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -2455,7 +2455,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the DATACOLLECTIONDATASET matching the given ID + summary: Update DataCollectionDatasets by id tags: - DataCollectionDatasets /datacollectiondatasets/count: @@ -2517,31 +2517,25 @@ paths: tags: - DataCollectionDatasets /datacollectionparameters: - post: - description: Creates new DATACOLLECTIONPARAMETER object(s) with details provided - in the request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' - - items: - $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' - type: array - description: The values to use to create the new object(s) with - required: true + 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: - oneOf: - - $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' - - items: - $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' - type: array - description: Success - returns the created object + 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': @@ -2551,7 +2545,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new DataCollectionParameters + summary: Get DataCollectionParameters tags: - DataCollectionParameters patch: @@ -2591,25 +2585,31 @@ paths: summary: Update DataCollectionParameters tags: - 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' + post: + description: Creates new DATACOLLECTIONPARAMETER object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + - 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 DATACOLLECTIONPARAMETER that satisfy the - filters + oneOf: + - $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + - items: + $ref: '#/components/schemas/DATACOLLECTIONPARAMETER' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -2619,7 +2619,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get DataCollectionParameters + summary: Create new DataCollectionParameters tags: - DataCollectionParameters /datacollectionparameters/{id_}: @@ -2648,30 +2648,22 @@ paths: summary: Delete DataCollectionParameters by id tags: - DataCollectionParameters - patch: - description: Updates DATACOLLECTIONPARAMETER with the specified ID with details - provided in the request body + get: + description: Retrieves a list of DATACOLLECTIONPARAMETER objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve 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 + description: Success - the matching DATACOLLECTIONPARAMETER '400': description: Bad request - Something was wrong with the request '401': @@ -2681,25 +2673,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update DataCollectionParameters by id + summary: Find the DATACOLLECTIONPARAMETER matching the given ID tags: - DataCollectionParameters - get: - description: Retrieves a list of DATACOLLECTIONPARAMETER objects + patch: + description: Updates DATACOLLECTIONPARAMETER with the specified ID with details + provided in the request body parameters: - - description: The id of the entity to retrieve + - 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 - the matching DATACOLLECTIONPARAMETER + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -2709,7 +2709,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the DATACOLLECTIONPARAMETER matching the given ID + summary: Update DataCollectionParameters by id tags: - DataCollectionParameters /datacollectionparameters/count: @@ -2771,31 +2771,24 @@ paths: tags: - DataCollectionParameters /datacollections: - post: - description: Creates new DATACOLLECTION object(s) with details provided in the - request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/DATACOLLECTION' - - items: - $ref: '#/components/schemas/DATACOLLECTION' - type: array - description: The values to use to create the new object(s) with - required: true + 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: - oneOf: - - $ref: '#/components/schemas/DATACOLLECTION' - - items: - $ref: '#/components/schemas/DATACOLLECTION' - type: array - description: Success - returns the created object + 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': @@ -2805,7 +2798,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new DataCollections + summary: Get DataCollections tags: - DataCollections patch: @@ -2845,24 +2838,31 @@ paths: summary: Update DataCollections tags: - 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' + post: + description: Creates new DATACOLLECTION object(s) with details provided in the + request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/DATACOLLECTION' + - 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 DATACOLLECTION that satisfy the filters + oneOf: + - $ref: '#/components/schemas/DATACOLLECTION' + - items: + $ref: '#/components/schemas/DATACOLLECTION' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -2872,7 +2872,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get DataCollections + summary: Create new DataCollections tags: - DataCollections /datacollections/{id_}: @@ -2901,30 +2901,22 @@ paths: summary: Delete DataCollections by id tags: - DataCollections - patch: - description: Updates DATACOLLECTION with the specified ID with details provided - in the request body + get: + description: Retrieves a list of DATACOLLECTION objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve 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 + description: Success - the matching DATACOLLECTION '400': description: Bad request - Something was wrong with the request '401': @@ -2934,25 +2926,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update DataCollections by id + summary: Find the DATACOLLECTION matching the given ID tags: - DataCollections - get: - description: Retrieves a list of DATACOLLECTION objects + patch: + description: Updates DATACOLLECTION with the specified ID with details provided + in the request body parameters: - - description: The id of the entity to retrieve + - 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 - the matching DATACOLLECTION + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -2962,7 +2962,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the DATACOLLECTION matching the given ID + summary: Update DataCollections by id tags: - DataCollections /datacollections/count: @@ -3022,31 +3022,24 @@ paths: tags: - DataCollections /datafileformats: - post: - description: Creates new DATAFILEFORMAT object(s) with details provided in the - request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/DATAFILEFORMAT' - - items: - $ref: '#/components/schemas/DATAFILEFORMAT' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of DATAFILEFORMAT 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: - oneOf: - - $ref: '#/components/schemas/DATAFILEFORMAT' - - items: - $ref: '#/components/schemas/DATAFILEFORMAT' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/DATAFILEFORMAT' + type: array + description: Success - returns DATAFILEFORMAT that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -3056,7 +3049,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new DatafileFormats + summary: Get DatafileFormats tags: - DatafileFormats patch: @@ -3096,24 +3089,31 @@ paths: summary: Update DatafileFormats tags: - DatafileFormats - get: - description: Retrieves a list of DATAFILEFORMAT 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' + post: + description: Creates new DATAFILEFORMAT object(s) with details provided in the + request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/DATAFILEFORMAT' + - items: + $ref: '#/components/schemas/DATAFILEFORMAT' + 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/DATAFILEFORMAT' - type: array - description: Success - returns DATAFILEFORMAT that satisfy the filters + oneOf: + - $ref: '#/components/schemas/DATAFILEFORMAT' + - items: + $ref: '#/components/schemas/DATAFILEFORMAT' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -3123,7 +3123,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get DatafileFormats + summary: Create new DatafileFormats tags: - DatafileFormats /datafileformats/{id_}: @@ -3152,30 +3152,22 @@ paths: summary: Delete DatafileFormats by id tags: - DatafileFormats - patch: - description: Updates DATAFILEFORMAT with the specified ID with details provided - in the request body + get: + description: Retrieves a list of DATAFILEFORMAT objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DATAFILEFORMAT' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DATAFILEFORMAT' - description: Success - returns the updated object + description: Success - the matching DATAFILEFORMAT '400': description: Bad request - Something was wrong with the request '401': @@ -3185,25 +3177,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update DatafileFormats by id + summary: Find the DATAFILEFORMAT matching the given ID tags: - DatafileFormats - get: - description: Retrieves a list of DATAFILEFORMAT objects + patch: + description: Updates DATAFILEFORMAT with the specified ID with details provided + in the request body parameters: - - description: The id of the entity to retrieve + - 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/DATAFILEFORMAT' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DATAFILEFORMAT' - description: Success - the matching DATAFILEFORMAT + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -3213,7 +3213,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the DATAFILEFORMAT matching the given ID + summary: Update DatafileFormats by id tags: - DatafileFormats /datafileformats/count: @@ -3273,31 +3273,24 @@ paths: tags: - DatafileFormats /datafileparameters: - post: - description: Creates new DATAFILEPARAMETER object(s) with details provided in - the request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/DATAFILEPARAMETER' - - items: - $ref: '#/components/schemas/DATAFILEPARAMETER' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of DATAFILEPARAMETER 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: - oneOf: - - $ref: '#/components/schemas/DATAFILEPARAMETER' - - items: - $ref: '#/components/schemas/DATAFILEPARAMETER' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/DATAFILEPARAMETER' + type: array + description: Success - returns DATAFILEPARAMETER that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -3307,7 +3300,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new DatafileParameters + summary: Get DatafileParameters tags: - DatafileParameters patch: @@ -3347,24 +3340,31 @@ paths: summary: Update DatafileParameters tags: - DatafileParameters - get: - description: Retrieves a list of DATAFILEPARAMETER 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' + post: + description: Creates new DATAFILEPARAMETER object(s) with details provided in + the request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/DATAFILEPARAMETER' + - items: + $ref: '#/components/schemas/DATAFILEPARAMETER' + 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/DATAFILEPARAMETER' - type: array - description: Success - returns DATAFILEPARAMETER that satisfy the filters + oneOf: + - $ref: '#/components/schemas/DATAFILEPARAMETER' + - items: + $ref: '#/components/schemas/DATAFILEPARAMETER' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -3374,7 +3374,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get DatafileParameters + summary: Create new DatafileParameters tags: - DatafileParameters /datafileparameters/{id_}: @@ -3403,30 +3403,22 @@ paths: summary: Delete DatafileParameters by id tags: - DatafileParameters - patch: - description: Updates DATAFILEPARAMETER with the specified ID with details provided - in the request body + get: + description: Retrieves a list of DATAFILEPARAMETER objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DATAFILEPARAMETER' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DATAFILEPARAMETER' - description: Success - returns the updated object + description: Success - the matching DATAFILEPARAMETER '400': description: Bad request - Something was wrong with the request '401': @@ -3436,25 +3428,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update DatafileParameters by id + summary: Find the DATAFILEPARAMETER matching the given ID tags: - DatafileParameters - get: - description: Retrieves a list of DATAFILEPARAMETER objects + patch: + description: Updates DATAFILEPARAMETER with the specified ID with details provided + in the request body parameters: - - description: The id of the entity to retrieve + - 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/DATAFILEPARAMETER' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DATAFILEPARAMETER' - description: Success - the matching DATAFILEPARAMETER + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -3464,7 +3464,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the DATAFILEPARAMETER matching the given ID + summary: Update DatafileParameters by id tags: - DatafileParameters /datafileparameters/count: @@ -3525,31 +3525,24 @@ paths: tags: - DatafileParameters /datafiles: - post: - description: Creates new DATAFILE object(s) with details provided in the request - body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/DATAFILE' - - items: - $ref: '#/components/schemas/DATAFILE' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of DATAFILE 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: - oneOf: - - $ref: '#/components/schemas/DATAFILE' - - items: - $ref: '#/components/schemas/DATAFILE' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/DATAFILE' + type: array + description: Success - returns DATAFILE that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -3559,7 +3552,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new Datafiles + summary: Get Datafiles tags: - Datafiles patch: @@ -3599,24 +3592,31 @@ paths: summary: Update Datafiles tags: - Datafiles - get: - description: Retrieves a list of DATAFILE 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' + post: + description: Creates new DATAFILE object(s) with details provided in the request + body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/DATAFILE' + - items: + $ref: '#/components/schemas/DATAFILE' + 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/DATAFILE' - type: array - description: Success - returns DATAFILE that satisfy the filters + oneOf: + - $ref: '#/components/schemas/DATAFILE' + - items: + $ref: '#/components/schemas/DATAFILE' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -3626,7 +3626,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get Datafiles + summary: Create new Datafiles tags: - Datafiles /datafiles/{id_}: @@ -3655,30 +3655,22 @@ paths: summary: Delete Datafiles by id tags: - Datafiles - patch: - description: Updates DATAFILE with the specified ID with details provided in - the request body + get: + description: Retrieves a list of DATAFILE objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DATAFILE' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DATAFILE' - description: Success - returns the updated object + description: Success - the matching DATAFILE '400': description: Bad request - Something was wrong with the request '401': @@ -3688,25 +3680,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update Datafiles by id + summary: Find the DATAFILE matching the given ID tags: - Datafiles - get: - description: Retrieves a list of DATAFILE objects + patch: + description: Updates DATAFILE with the specified ID with details provided in + the request body parameters: - - description: The id of the entity to retrieve + - 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/DATAFILE' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DATAFILE' - description: Success - the matching DATAFILE + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -3716,7 +3716,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the DATAFILE matching the given ID + summary: Update Datafiles by id tags: - Datafiles /datafiles/count: @@ -3776,31 +3776,24 @@ paths: tags: - Datafiles /datasetparameters: - post: - description: Creates new DATASETPARAMETER object(s) with details provided in - the request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/DATASETPARAMETER' - - items: - $ref: '#/components/schemas/DATASETPARAMETER' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of DATASETPARAMETER 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: - oneOf: - - $ref: '#/components/schemas/DATASETPARAMETER' - - items: - $ref: '#/components/schemas/DATASETPARAMETER' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/DATASETPARAMETER' + type: array + description: Success - returns DATASETPARAMETER that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -3810,7 +3803,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new DatasetParameters + summary: Get DatasetParameters tags: - DatasetParameters patch: @@ -3850,24 +3843,31 @@ paths: summary: Update DatasetParameters tags: - DatasetParameters - get: - description: Retrieves a list of DATASETPARAMETER 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' + post: + description: Creates new DATASETPARAMETER object(s) with details provided in + the request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/DATASETPARAMETER' + - items: + $ref: '#/components/schemas/DATASETPARAMETER' + 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/DATASETPARAMETER' - type: array - description: Success - returns DATASETPARAMETER that satisfy the filters + oneOf: + - $ref: '#/components/schemas/DATASETPARAMETER' + - items: + $ref: '#/components/schemas/DATASETPARAMETER' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -3877,7 +3877,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get DatasetParameters + summary: Create new DatasetParameters tags: - DatasetParameters /datasetparameters/{id_}: @@ -3906,30 +3906,22 @@ paths: summary: Delete DatasetParameters by id tags: - DatasetParameters - patch: - description: Updates DATASETPARAMETER with the specified ID with details provided - in the request body + get: + description: Retrieves a list of DATASETPARAMETER objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DATASETPARAMETER' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DATASETPARAMETER' - description: Success - returns the updated object + description: Success - the matching DATASETPARAMETER '400': description: Bad request - Something was wrong with the request '401': @@ -3939,25 +3931,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update DatasetParameters by id + summary: Find the DATASETPARAMETER matching the given ID tags: - DatasetParameters - get: - description: Retrieves a list of DATASETPARAMETER objects + patch: + description: Updates DATASETPARAMETER with the specified ID with details provided + in the request body parameters: - - description: The id of the entity to retrieve + - 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/DATASETPARAMETER' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DATASETPARAMETER' - description: Success - the matching DATASETPARAMETER + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -3967,7 +3967,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the DATASETPARAMETER matching the given ID + summary: Update DatasetParameters by id tags: - DatasetParameters /datasetparameters/count: @@ -4028,31 +4028,24 @@ paths: tags: - DatasetParameters /datasettypes: - post: - description: Creates new DATASETTYPE object(s) with details provided in the - request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/DATASETTYPE' - - items: - $ref: '#/components/schemas/DATASETTYPE' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of DATASETTYPE 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: - oneOf: - - $ref: '#/components/schemas/DATASETTYPE' - - items: - $ref: '#/components/schemas/DATASETTYPE' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/DATASETTYPE' + type: array + description: Success - returns DATASETTYPE that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -4062,7 +4055,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new DatasetTypes + summary: Get DatasetTypes tags: - DatasetTypes patch: @@ -4102,24 +4095,31 @@ paths: summary: Update DatasetTypes tags: - DatasetTypes - get: - description: Retrieves a list of DATASETTYPE 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' + post: + description: Creates new DATASETTYPE object(s) with details provided in the + request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/DATASETTYPE' + - items: + $ref: '#/components/schemas/DATASETTYPE' + 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/DATASETTYPE' - type: array - description: Success - returns DATASETTYPE that satisfy the filters + oneOf: + - $ref: '#/components/schemas/DATASETTYPE' + - items: + $ref: '#/components/schemas/DATASETTYPE' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -4129,7 +4129,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get DatasetTypes + summary: Create new DatasetTypes tags: - DatasetTypes /datasettypes/{id_}: @@ -4158,30 +4158,22 @@ paths: summary: Delete DatasetTypes by id tags: - DatasetTypes - patch: - description: Updates DATASETTYPE with the specified ID with details provided - in the request body + get: + description: Retrieves a list of DATASETTYPE objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DATASETTYPE' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DATASETTYPE' - description: Success - returns the updated object + description: Success - the matching DATASETTYPE '400': description: Bad request - Something was wrong with the request '401': @@ -4191,25 +4183,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update DatasetTypes by id + summary: Find the DATASETTYPE matching the given ID tags: - DatasetTypes - get: - description: Retrieves a list of DATASETTYPE objects + patch: + description: Updates DATASETTYPE with the specified ID with details provided + in the request body parameters: - - description: The id of the entity to retrieve + - 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/DATASETTYPE' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DATASETTYPE' - description: Success - the matching DATASETTYPE + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -4219,7 +4219,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the DATASETTYPE matching the given ID + summary: Update DatasetTypes by id tags: - DatasetTypes /datasettypes/count: @@ -4279,31 +4279,24 @@ paths: tags: - DatasetTypes /datasets: - post: - description: Creates new DATASET object(s) with details provided in the request - body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/DATASET' - - items: - $ref: '#/components/schemas/DATASET' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of DATASET 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: - oneOf: - - $ref: '#/components/schemas/DATASET' - - items: - $ref: '#/components/schemas/DATASET' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/DATASET' + type: array + description: Success - returns DATASET that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -4313,7 +4306,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new Datasets + summary: Get Datasets tags: - Datasets patch: @@ -4353,24 +4346,31 @@ paths: summary: Update Datasets tags: - Datasets - get: - description: Retrieves a list of DATASET 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' + post: + description: Creates new DATASET object(s) with details provided in the request + body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/DATASET' + - items: + $ref: '#/components/schemas/DATASET' + 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/DATASET' - type: array - description: Success - returns DATASET that satisfy the filters + oneOf: + - $ref: '#/components/schemas/DATASET' + - items: + $ref: '#/components/schemas/DATASET' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -4380,7 +4380,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get Datasets + summary: Create new Datasets tags: - Datasets /datasets/{id_}: @@ -4409,30 +4409,22 @@ paths: summary: Delete Datasets by id tags: - Datasets - patch: - description: Updates DATASET with the specified ID with details provided in - the request body + get: + description: Retrieves a list of DATASET objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DATASET' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DATASET' - description: Success - returns the updated object + description: Success - the matching DATASET '400': description: Bad request - Something was wrong with the request '401': @@ -4442,25 +4434,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update Datasets by id + summary: Find the DATASET matching the given ID tags: - Datasets - get: - description: Retrieves a list of DATASET objects + patch: + description: Updates DATASET with the specified ID with details provided in + the request body parameters: - - description: The id of the entity to retrieve + - 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/DATASET' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DATASET' - description: Success - the matching DATASET + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -4470,7 +4470,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the DATASET matching the given ID + summary: Update Datasets by id tags: - Datasets /datasets/count: @@ -4530,31 +4530,24 @@ paths: tags: - Datasets /facilities: - post: - description: Creates new FACILITY object(s) with details provided in the request - body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/FACILITY' - - items: - $ref: '#/components/schemas/FACILITY' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of FACILITY 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: - oneOf: - - $ref: '#/components/schemas/FACILITY' - - items: - $ref: '#/components/schemas/FACILITY' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/FACILITY' + type: array + description: Success - returns FACILITY that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -4564,7 +4557,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new Facilities + summary: Get Facilities tags: - Facilities patch: @@ -4604,24 +4597,31 @@ paths: summary: Update Facilities tags: - Facilities - get: - description: Retrieves a list of FACILITY 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' + post: + description: Creates new FACILITY object(s) with details provided in the request + body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/FACILITY' + - items: + $ref: '#/components/schemas/FACILITY' + 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/FACILITY' - type: array - description: Success - returns FACILITY that satisfy the filters + oneOf: + - $ref: '#/components/schemas/FACILITY' + - items: + $ref: '#/components/schemas/FACILITY' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -4631,7 +4631,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get Facilities + summary: Create new Facilities tags: - Facilities /facilities/{id_}: @@ -4660,30 +4660,22 @@ paths: summary: Delete Facilities by id tags: - Facilities - patch: - description: Updates FACILITY with the specified ID with details provided in - the request body + get: + description: Retrieves a list of FACILITY objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FACILITY' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FACILITY' - description: Success - returns the updated object + description: Success - the matching FACILITY '400': description: Bad request - Something was wrong with the request '401': @@ -4693,25 +4685,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update Facilities by id + summary: Find the FACILITY matching the given ID tags: - Facilities - get: - description: Retrieves a list of FACILITY objects + patch: + description: Updates FACILITY with the specified ID with details provided in + the request body parameters: - - description: The id of the entity to retrieve + - 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/FACILITY' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FACILITY' - description: Success - the matching FACILITY + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -4721,7 +4721,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the FACILITY matching the given ID + summary: Update Facilities by id tags: - Facilities /facilities/count: @@ -4781,31 +4781,24 @@ paths: tags: - Facilities /facilitycycles: - post: - description: Creates new FACILITYCYCLE object(s) with details provided in the - request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/FACILITYCYCLE' - - items: - $ref: '#/components/schemas/FACILITYCYCLE' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of FACILITYCYCLE 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: - oneOf: - - $ref: '#/components/schemas/FACILITYCYCLE' - - items: - $ref: '#/components/schemas/FACILITYCYCLE' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/FACILITYCYCLE' + type: array + description: Success - returns FACILITYCYCLE that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -4815,7 +4808,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new FacilityCycles + summary: Get FacilityCycles tags: - FacilityCycles patch: @@ -4855,24 +4848,31 @@ paths: summary: Update FacilityCycles tags: - FacilityCycles - get: - description: Retrieves a list of FACILITYCYCLE 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' + post: + description: Creates new FACILITYCYCLE object(s) with details provided in the + request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/FACILITYCYCLE' + - items: + $ref: '#/components/schemas/FACILITYCYCLE' + 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/FACILITYCYCLE' - type: array - description: Success - returns FACILITYCYCLE that satisfy the filters + oneOf: + - $ref: '#/components/schemas/FACILITYCYCLE' + - items: + $ref: '#/components/schemas/FACILITYCYCLE' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -4882,7 +4882,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get FacilityCycles + summary: Create new FacilityCycles tags: - FacilityCycles /facilitycycles/{id_}: @@ -4911,30 +4911,22 @@ paths: summary: Delete FacilityCycles by id tags: - FacilityCycles - patch: - description: Updates FACILITYCYCLE with the specified ID with details provided - in the request body + get: + description: Retrieves a list of FACILITYCYCLE objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FACILITYCYCLE' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FACILITYCYCLE' - description: Success - returns the updated object + description: Success - the matching FACILITYCYCLE '400': description: Bad request - Something was wrong with the request '401': @@ -4944,25 +4936,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update FacilityCycles by id + summary: Find the FACILITYCYCLE matching the given ID tags: - FacilityCycles - get: - description: Retrieves a list of FACILITYCYCLE objects + patch: + description: Updates FACILITYCYCLE with the specified ID with details provided + in the request body parameters: - - description: The id of the entity to retrieve + - 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/FACILITYCYCLE' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FACILITYCYCLE' - description: Success - the matching FACILITYCYCLE + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -4972,7 +4972,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the FACILITYCYCLE matching the given ID + summary: Update FacilityCycles by id tags: - FacilityCycles /facilitycycles/count: @@ -5032,31 +5032,24 @@ paths: tags: - FacilityCycles /groupings: - post: - description: Creates new GROUPING object(s) with details provided in the request - body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/GROUPING' - - items: - $ref: '#/components/schemas/GROUPING' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of GROUPING 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: - oneOf: - - $ref: '#/components/schemas/GROUPING' - - items: - $ref: '#/components/schemas/GROUPING' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/GROUPING' + type: array + description: Success - returns GROUPING that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -5066,7 +5059,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new Groupings + summary: Get Groupings tags: - Groupings patch: @@ -5106,24 +5099,31 @@ paths: summary: Update Groupings tags: - Groupings - get: - description: Retrieves a list of GROUPING 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' + post: + description: Creates new GROUPING object(s) with details provided in the request + body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/GROUPING' + - items: + $ref: '#/components/schemas/GROUPING' + 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/GROUPING' - type: array - description: Success - returns GROUPING that satisfy the filters + oneOf: + - $ref: '#/components/schemas/GROUPING' + - items: + $ref: '#/components/schemas/GROUPING' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -5133,7 +5133,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get Groupings + summary: Create new Groupings tags: - Groupings /groupings/{id_}: @@ -5162,30 +5162,22 @@ paths: summary: Delete Groupings by id tags: - Groupings - patch: - description: Updates GROUPING with the specified ID with details provided in - the request body + get: + description: Retrieves a list of GROUPING objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GROUPING' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GROUPING' - description: Success - returns the updated object + description: Success - the matching GROUPING '400': description: Bad request - Something was wrong with the request '401': @@ -5195,25 +5187,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update Groupings by id + summary: Find the GROUPING matching the given ID tags: - Groupings - get: - description: Retrieves a list of GROUPING objects + patch: + description: Updates GROUPING with the specified ID with details provided in + the request body parameters: - - description: The id of the entity to retrieve + - 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/GROUPING' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GROUPING' - description: Success - the matching GROUPING + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -5223,7 +5223,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the GROUPING matching the given ID + summary: Update Groupings by id tags: - Groupings /groupings/count: @@ -5283,31 +5283,24 @@ paths: tags: - Groupings /instrumentscientists: - post: - description: Creates new INSTRUMENTSCIENTIST object(s) with details provided - in the request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' - - items: - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of INSTRUMENTSCIENTIST 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: - oneOf: - - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' - - items: - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/INSTRUMENTSCIENTIST' + type: array + description: Success - returns INSTRUMENTSCIENTIST that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -5317,7 +5310,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new InstrumentScientists + summary: Get InstrumentScientists tags: - InstrumentScientists patch: @@ -5357,24 +5350,31 @@ paths: summary: Update InstrumentScientists tags: - InstrumentScientists - get: - description: Retrieves a list of INSTRUMENTSCIENTIST 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: + post: + description: Creates new INSTRUMENTSCIENTIST object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' + - items: $ref: '#/components/schemas/INSTRUMENTSCIENTIST' type: array - description: Success - returns INSTRUMENTSCIENTIST that satisfy the filters + description: The values to use to create the new object(s) with + required: true + responses: + '200': + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' + - items: + $ref: '#/components/schemas/INSTRUMENTSCIENTIST' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -5384,7 +5384,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get InstrumentScientists + summary: Create new InstrumentScientists tags: - InstrumentScientists /instrumentscientists/{id_}: @@ -5413,30 +5413,22 @@ paths: summary: Delete InstrumentScientists by id tags: - InstrumentScientists - patch: - description: Updates INSTRUMENTSCIENTIST with the specified ID with details - provided in the request body + get: + description: Retrieves a list of INSTRUMENTSCIENTIST objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/INSTRUMENTSCIENTIST' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/INSTRUMENTSCIENTIST' - description: Success - returns the updated object + description: Success - the matching INSTRUMENTSCIENTIST '400': description: Bad request - Something was wrong with the request '401': @@ -5446,25 +5438,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update InstrumentScientists by id + summary: Find the INSTRUMENTSCIENTIST matching the given ID tags: - InstrumentScientists - get: - description: Retrieves a list of INSTRUMENTSCIENTIST objects + patch: + description: Updates INSTRUMENTSCIENTIST with the specified ID with details + provided in the request body parameters: - - description: The id of the entity to retrieve + - 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/INSTRUMENTSCIENTIST' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/INSTRUMENTSCIENTIST' - description: Success - the matching INSTRUMENTSCIENTIST + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -5474,7 +5474,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the INSTRUMENTSCIENTIST matching the given ID + summary: Update InstrumentScientists by id tags: - InstrumentScientists /instrumentscientists/count: @@ -5535,31 +5535,24 @@ paths: tags: - InstrumentScientists /instruments: - post: - description: Creates new INSTRUMENT object(s) with details provided in the request - body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/INSTRUMENT' - - items: - $ref: '#/components/schemas/INSTRUMENT' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of INSTRUMENT 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: - oneOf: - - $ref: '#/components/schemas/INSTRUMENT' - - items: - $ref: '#/components/schemas/INSTRUMENT' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/INSTRUMENT' + type: array + description: Success - returns INSTRUMENT that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -5569,7 +5562,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new Instruments + summary: Get Instruments tags: - Instruments patch: @@ -5609,24 +5602,31 @@ paths: summary: Update Instruments tags: - Instruments - get: - description: Retrieves a list of INSTRUMENT 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' + post: + description: Creates new INSTRUMENT object(s) with details provided in the request + body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/INSTRUMENT' + - items: + $ref: '#/components/schemas/INSTRUMENT' + 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/INSTRUMENT' - type: array - description: Success - returns INSTRUMENT that satisfy the filters + oneOf: + - $ref: '#/components/schemas/INSTRUMENT' + - items: + $ref: '#/components/schemas/INSTRUMENT' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -5636,7 +5636,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get Instruments + summary: Create new Instruments tags: - Instruments /instruments/{id_}: @@ -5665,30 +5665,22 @@ paths: summary: Delete Instruments by id tags: - Instruments - patch: - description: Updates INSTRUMENT with the specified ID with details provided - in the request body + get: + description: Retrieves a list of INSTRUMENT objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/INSTRUMENT' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/INSTRUMENT' - description: Success - returns the updated object + description: Success - the matching INSTRUMENT '400': description: Bad request - Something was wrong with the request '401': @@ -5698,25 +5690,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update Instruments by id + summary: Find the INSTRUMENT matching the given ID tags: - Instruments - get: - description: Retrieves a list of INSTRUMENT objects + patch: + description: Updates INSTRUMENT with the specified ID with details provided + in the request body parameters: - - description: The id of the entity to retrieve + - 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/INSTRUMENT' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/INSTRUMENT' - description: Success - the matching INSTRUMENT + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -5726,7 +5726,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the INSTRUMENT matching the given ID + summary: Update Instruments by id tags: - Instruments /instruments/count: @@ -5786,31 +5786,24 @@ paths: tags: - Instruments /investigationgroups: - post: - description: Creates new INVESTIGATIONGROUP object(s) with details provided - in the request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/INVESTIGATIONGROUP' - - items: - $ref: '#/components/schemas/INVESTIGATIONGROUP' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of INVESTIGATIONGROUP 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: - oneOf: - - $ref: '#/components/schemas/INVESTIGATIONGROUP' - - items: - $ref: '#/components/schemas/INVESTIGATIONGROUP' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/INVESTIGATIONGROUP' + type: array + description: Success - returns INVESTIGATIONGROUP that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -5820,7 +5813,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new InvestigationGroups + summary: Get InvestigationGroups tags: - InvestigationGroups patch: @@ -5860,24 +5853,31 @@ paths: summary: Update InvestigationGroups tags: - InvestigationGroups - get: - description: Retrieves a list of INVESTIGATIONGROUP 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' + post: + description: Creates new INVESTIGATIONGROUP object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/INVESTIGATIONGROUP' + - items: + $ref: '#/components/schemas/INVESTIGATIONGROUP' + 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/INVESTIGATIONGROUP' - type: array - description: Success - returns INVESTIGATIONGROUP that satisfy the filters + oneOf: + - $ref: '#/components/schemas/INVESTIGATIONGROUP' + - items: + $ref: '#/components/schemas/INVESTIGATIONGROUP' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -5887,7 +5887,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get InvestigationGroups + summary: Create new InvestigationGroups tags: - InvestigationGroups /investigationgroups/{id_}: @@ -5916,30 +5916,22 @@ paths: summary: Delete InvestigationGroups by id tags: - InvestigationGroups - patch: - description: Updates INVESTIGATIONGROUP with the specified ID with details provided - in the request body + get: + description: Retrieves a list of INVESTIGATIONGROUP objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/INVESTIGATIONGROUP' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/INVESTIGATIONGROUP' - description: Success - returns the updated object + description: Success - the matching INVESTIGATIONGROUP '400': description: Bad request - Something was wrong with the request '401': @@ -5949,25 +5941,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update InvestigationGroups by id + summary: Find the INVESTIGATIONGROUP matching the given ID tags: - InvestigationGroups - get: - description: Retrieves a list of INVESTIGATIONGROUP objects + patch: + description: Updates INVESTIGATIONGROUP with the specified ID with details provided + in the request body parameters: - - description: The id of the entity to retrieve + - 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/INVESTIGATIONGROUP' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/INVESTIGATIONGROUP' - description: Success - the matching INVESTIGATIONGROUP + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -5977,7 +5977,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the INVESTIGATIONGROUP matching the given ID + summary: Update InvestigationGroups by id tags: - InvestigationGroups /investigationgroups/count: @@ -6038,31 +6038,25 @@ paths: tags: - InvestigationGroups /investigationinstruments: - post: - description: Creates new INVESTIGATIONINSTRUMENT object(s) with details provided - in the request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/INVESTIGATIONINSTRUMENT' - - items: - $ref: '#/components/schemas/INVESTIGATIONINSTRUMENT' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of INVESTIGATIONINSTRUMENT 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: - oneOf: - - $ref: '#/components/schemas/INVESTIGATIONINSTRUMENT' - - items: - $ref: '#/components/schemas/INVESTIGATIONINSTRUMENT' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/INVESTIGATIONINSTRUMENT' + type: array + description: Success - returns INVESTIGATIONINSTRUMENT that satisfy the + filters '400': description: Bad request - Something was wrong with the request '401': @@ -6072,7 +6066,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new InvestigationInstruments + summary: Get InvestigationInstruments tags: - InvestigationInstruments patch: @@ -6112,25 +6106,31 @@ paths: summary: Update InvestigationInstruments tags: - InvestigationInstruments - get: - description: Retrieves a list of INVESTIGATIONINSTRUMENT 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' + post: + description: Creates new INVESTIGATIONINSTRUMENT object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/INVESTIGATIONINSTRUMENT' + - items: + $ref: '#/components/schemas/INVESTIGATIONINSTRUMENT' + 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/INVESTIGATIONINSTRUMENT' - type: array - description: Success - returns INVESTIGATIONINSTRUMENT that satisfy the - filters + oneOf: + - $ref: '#/components/schemas/INVESTIGATIONINSTRUMENT' + - items: + $ref: '#/components/schemas/INVESTIGATIONINSTRUMENT' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -6140,7 +6140,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get InvestigationInstruments + summary: Create new InvestigationInstruments tags: - InvestigationInstruments /investigationinstruments/{id_}: @@ -6169,30 +6169,22 @@ paths: summary: Delete InvestigationInstruments by id tags: - InvestigationInstruments - patch: - description: Updates INVESTIGATIONINSTRUMENT with the specified ID with details - provided in the request body + get: + description: Retrieves a list of INVESTIGATIONINSTRUMENT objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/INVESTIGATIONINSTRUMENT' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/INVESTIGATIONINSTRUMENT' - description: Success - returns the updated object + description: Success - the matching INVESTIGATIONINSTRUMENT '400': description: Bad request - Something was wrong with the request '401': @@ -6202,25 +6194,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update InvestigationInstruments by id + summary: Find the INVESTIGATIONINSTRUMENT matching the given ID tags: - InvestigationInstruments - get: - description: Retrieves a list of INVESTIGATIONINSTRUMENT objects + patch: + description: Updates INVESTIGATIONINSTRUMENT with the specified ID with details + provided in the request body parameters: - - description: The id of the entity to retrieve + - 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/INVESTIGATIONINSTRUMENT' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/INVESTIGATIONINSTRUMENT' - description: Success - the matching INVESTIGATIONINSTRUMENT + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -6230,7 +6230,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the INVESTIGATIONINSTRUMENT matching the given ID + summary: Update InvestigationInstruments by id tags: - InvestigationInstruments /investigationinstruments/count: @@ -6292,31 +6292,24 @@ paths: tags: - InvestigationInstruments /investigationparameters: - post: - description: Creates new INVESTIGATIONPARAMETER object(s) with details provided - in the request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/INVESTIGATIONPARAMETER' - - items: - $ref: '#/components/schemas/INVESTIGATIONPARAMETER' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of INVESTIGATIONPARAMETER 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: - oneOf: - - $ref: '#/components/schemas/INVESTIGATIONPARAMETER' - - items: - $ref: '#/components/schemas/INVESTIGATIONPARAMETER' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/INVESTIGATIONPARAMETER' + type: array + description: Success - returns INVESTIGATIONPARAMETER that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -6326,7 +6319,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new InvestigationParameters + summary: Get InvestigationParameters tags: - InvestigationParameters patch: @@ -6366,24 +6359,31 @@ paths: summary: Update InvestigationParameters tags: - InvestigationParameters - get: - description: Retrieves a list of INVESTIGATIONPARAMETER 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' + post: + description: Creates new INVESTIGATIONPARAMETER object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/INVESTIGATIONPARAMETER' + - items: + $ref: '#/components/schemas/INVESTIGATIONPARAMETER' + 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/INVESTIGATIONPARAMETER' - type: array - description: Success - returns INVESTIGATIONPARAMETER that satisfy the filters + oneOf: + - $ref: '#/components/schemas/INVESTIGATIONPARAMETER' + - items: + $ref: '#/components/schemas/INVESTIGATIONPARAMETER' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -6393,7 +6393,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get InvestigationParameters + summary: Create new InvestigationParameters tags: - InvestigationParameters /investigationparameters/{id_}: @@ -6422,30 +6422,22 @@ paths: summary: Delete InvestigationParameters by id tags: - InvestigationParameters - patch: - description: Updates INVESTIGATIONPARAMETER with the specified ID with details - provided in the request body + get: + description: Retrieves a list of INVESTIGATIONPARAMETER objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/INVESTIGATIONPARAMETER' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/INVESTIGATIONPARAMETER' - description: Success - returns the updated object + description: Success - the matching INVESTIGATIONPARAMETER '400': description: Bad request - Something was wrong with the request '401': @@ -6455,25 +6447,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update InvestigationParameters by id + summary: Find the INVESTIGATIONPARAMETER matching the given ID tags: - InvestigationParameters - get: - description: Retrieves a list of INVESTIGATIONPARAMETER objects + patch: + description: Updates INVESTIGATIONPARAMETER with the specified ID with details + provided in the request body parameters: - - description: The id of the entity to retrieve + - 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/INVESTIGATIONPARAMETER' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/INVESTIGATIONPARAMETER' - description: Success - the matching INVESTIGATIONPARAMETER + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -6483,7 +6483,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the INVESTIGATIONPARAMETER matching the given ID + summary: Update InvestigationParameters by id tags: - InvestigationParameters /investigationparameters/count: @@ -6545,31 +6545,24 @@ paths: tags: - InvestigationParameters /investigationtypes: - post: - description: Creates new INVESTIGATIONTYPE object(s) with details provided in - the request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/INVESTIGATIONTYPE' - - items: - $ref: '#/components/schemas/INVESTIGATIONTYPE' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of INVESTIGATIONTYPE 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: - oneOf: - - $ref: '#/components/schemas/INVESTIGATIONTYPE' - - items: - $ref: '#/components/schemas/INVESTIGATIONTYPE' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/INVESTIGATIONTYPE' + type: array + description: Success - returns INVESTIGATIONTYPE that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -6579,7 +6572,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new InvestigationTypes + summary: Get InvestigationTypes tags: - InvestigationTypes patch: @@ -6619,24 +6612,31 @@ paths: summary: Update InvestigationTypes tags: - InvestigationTypes - get: - description: Retrieves a list of INVESTIGATIONTYPE 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' + post: + description: Creates new INVESTIGATIONTYPE object(s) with details provided in + the request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/INVESTIGATIONTYPE' + - items: + $ref: '#/components/schemas/INVESTIGATIONTYPE' + 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/INVESTIGATIONTYPE' - type: array - description: Success - returns INVESTIGATIONTYPE that satisfy the filters + oneOf: + - $ref: '#/components/schemas/INVESTIGATIONTYPE' + - items: + $ref: '#/components/schemas/INVESTIGATIONTYPE' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -6646,7 +6646,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get InvestigationTypes + summary: Create new InvestigationTypes tags: - InvestigationTypes /investigationtypes/{id_}: @@ -6675,30 +6675,22 @@ paths: summary: Delete InvestigationTypes by id tags: - InvestigationTypes - patch: - description: Updates INVESTIGATIONTYPE with the specified ID with details provided - in the request body + get: + description: Retrieves a list of INVESTIGATIONTYPE objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/INVESTIGATIONTYPE' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/INVESTIGATIONTYPE' - description: Success - returns the updated object + description: Success - the matching INVESTIGATIONTYPE '400': description: Bad request - Something was wrong with the request '401': @@ -6708,25 +6700,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update InvestigationTypes by id + summary: Find the INVESTIGATIONTYPE matching the given ID tags: - InvestigationTypes - get: - description: Retrieves a list of INVESTIGATIONTYPE objects + patch: + description: Updates INVESTIGATIONTYPE with the specified ID with details provided + in the request body parameters: - - description: The id of the entity to retrieve + - 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/INVESTIGATIONTYPE' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/INVESTIGATIONTYPE' - description: Success - the matching INVESTIGATIONTYPE + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -6736,7 +6736,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the INVESTIGATIONTYPE matching the given ID + summary: Update InvestigationTypes by id tags: - InvestigationTypes /investigationtypes/count: @@ -6797,31 +6797,24 @@ paths: tags: - InvestigationTypes /investigationusers: - post: - description: Creates new INVESTIGATIONUSER object(s) with details provided in - the request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/INVESTIGATIONUSER' - - items: - $ref: '#/components/schemas/INVESTIGATIONUSER' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of INVESTIGATIONUSER 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: - oneOf: - - $ref: '#/components/schemas/INVESTIGATIONUSER' - - items: - $ref: '#/components/schemas/INVESTIGATIONUSER' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/INVESTIGATIONUSER' + type: array + description: Success - returns INVESTIGATIONUSER that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -6831,7 +6824,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new InvestigationUsers + summary: Get InvestigationUsers tags: - InvestigationUsers patch: @@ -6871,24 +6864,31 @@ paths: summary: Update InvestigationUsers tags: - InvestigationUsers - get: - description: Retrieves a list of INVESTIGATIONUSER 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' + post: + description: Creates new INVESTIGATIONUSER object(s) with details provided in + the request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/INVESTIGATIONUSER' + - items: + $ref: '#/components/schemas/INVESTIGATIONUSER' + 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/INVESTIGATIONUSER' - type: array - description: Success - returns INVESTIGATIONUSER that satisfy the filters + oneOf: + - $ref: '#/components/schemas/INVESTIGATIONUSER' + - items: + $ref: '#/components/schemas/INVESTIGATIONUSER' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -6898,7 +6898,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get InvestigationUsers + summary: Create new InvestigationUsers tags: - InvestigationUsers /investigationusers/{id_}: @@ -6927,30 +6927,22 @@ paths: summary: Delete InvestigationUsers by id tags: - InvestigationUsers - patch: - description: Updates INVESTIGATIONUSER with the specified ID with details provided - in the request body + get: + description: Retrieves a list of INVESTIGATIONUSER objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/INVESTIGATIONUSER' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/INVESTIGATIONUSER' - description: Success - returns the updated object + description: Success - the matching INVESTIGATIONUSER '400': description: Bad request - Something was wrong with the request '401': @@ -6960,25 +6952,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update InvestigationUsers by id + summary: Find the INVESTIGATIONUSER matching the given ID tags: - InvestigationUsers - get: - description: Retrieves a list of INVESTIGATIONUSER objects + patch: + description: Updates INVESTIGATIONUSER with the specified ID with details provided + in the request body parameters: - - description: The id of the entity to retrieve + - 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/INVESTIGATIONUSER' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/INVESTIGATIONUSER' - description: Success - the matching INVESTIGATIONUSER + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -6988,7 +6988,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the INVESTIGATIONUSER matching the given ID + summary: Update InvestigationUsers by id tags: - InvestigationUsers /investigationusers/count: @@ -7049,31 +7049,24 @@ paths: tags: - InvestigationUsers /investigations: - post: - description: Creates new INVESTIGATION object(s) with details provided in the - request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/INVESTIGATION' - - items: - $ref: '#/components/schemas/INVESTIGATION' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of INVESTIGATION 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: - oneOf: - - $ref: '#/components/schemas/INVESTIGATION' - - items: - $ref: '#/components/schemas/INVESTIGATION' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/INVESTIGATION' + type: array + description: Success - returns INVESTIGATION that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -7083,7 +7076,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new Investigations + summary: Get Investigations tags: - Investigations patch: @@ -7123,24 +7116,31 @@ paths: summary: Update Investigations tags: - Investigations - get: - description: Retrieves a list of INVESTIGATION 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' + post: + description: Creates new INVESTIGATION object(s) with details provided in the + request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/INVESTIGATION' + - items: + $ref: '#/components/schemas/INVESTIGATION' + 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/INVESTIGATION' - type: array - description: Success - returns INVESTIGATION that satisfy the filters + oneOf: + - $ref: '#/components/schemas/INVESTIGATION' + - items: + $ref: '#/components/schemas/INVESTIGATION' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -7150,7 +7150,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get Investigations + summary: Create new Investigations tags: - Investigations /investigations/{id_}: @@ -7179,30 +7179,22 @@ paths: summary: Delete Investigations by id tags: - Investigations - patch: - description: Updates INVESTIGATION with the specified ID with details provided - in the request body + get: + description: Retrieves a list of INVESTIGATION objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/INVESTIGATION' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/INVESTIGATION' - description: Success - returns the updated object + description: Success - the matching INVESTIGATION '400': description: Bad request - Something was wrong with the request '401': @@ -7212,25 +7204,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update Investigations by id + summary: Find the INVESTIGATION matching the given ID tags: - Investigations - get: - description: Retrieves a list of INVESTIGATION objects + patch: + description: Updates INVESTIGATION with the specified ID with details provided + in the request body parameters: - - description: The id of the entity to retrieve + - 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/INVESTIGATION' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/INVESTIGATION' - description: Success - the matching INVESTIGATION + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -7240,7 +7240,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the INVESTIGATION matching the given ID + summary: Update Investigations by id tags: - Investigations /investigations/count: @@ -7300,31 +7300,24 @@ paths: tags: - Investigations /jobs: - post: - description: Creates new JOB object(s) with details provided in the request - body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/JOB' - - items: - $ref: '#/components/schemas/JOB' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of JOB 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: - oneOf: - - $ref: '#/components/schemas/JOB' - - items: - $ref: '#/components/schemas/JOB' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/JOB' + type: array + description: Success - returns JOB that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -7334,7 +7327,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new Jobs + summary: Get Jobs tags: - Jobs patch: @@ -7373,24 +7366,31 @@ paths: summary: Update Jobs tags: - Jobs - get: - description: Retrieves a list of JOB 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' + post: + description: Creates new JOB object(s) with details provided in the request + body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/JOB' + - items: + $ref: '#/components/schemas/JOB' + 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/JOB' - type: array - description: Success - returns JOB that satisfy the filters + oneOf: + - $ref: '#/components/schemas/JOB' + - items: + $ref: '#/components/schemas/JOB' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -7400,7 +7400,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get Jobs + summary: Create new Jobs tags: - Jobs /jobs/{id_}: @@ -7429,30 +7429,22 @@ paths: summary: Delete Jobs by id tags: - Jobs - patch: - description: Updates JOB with the specified ID with details provided in the - request body + get: + description: Retrieves a list of JOB objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/JOB' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/JOB' - description: Success - returns the updated object + description: Success - the matching JOB '400': description: Bad request - Something was wrong with the request '401': @@ -7462,25 +7454,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update Jobs by id + summary: Find the JOB matching the given ID tags: - Jobs - get: - description: Retrieves a list of JOB objects + patch: + description: Updates JOB with the specified ID with details provided in the + request body parameters: - - description: The id of the entity to retrieve + - 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/JOB' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/JOB' - description: Success - the matching JOB + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -7490,7 +7490,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the JOB matching the given ID + summary: Update Jobs by id tags: - Jobs /jobs/count: @@ -7550,31 +7550,24 @@ paths: tags: - Jobs /keywords: - post: - description: Creates new KEYWORD object(s) with details provided in the request - body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/KEYWORD' - - items: - $ref: '#/components/schemas/KEYWORD' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of KEYWORD 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: - oneOf: - - $ref: '#/components/schemas/KEYWORD' - - items: - $ref: '#/components/schemas/KEYWORD' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/KEYWORD' + type: array + description: Success - returns KEYWORD that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -7584,7 +7577,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new Keywords + summary: Get Keywords tags: - Keywords patch: @@ -7624,24 +7617,31 @@ paths: summary: Update Keywords tags: - Keywords - get: - description: Retrieves a list of KEYWORD 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' + post: + description: Creates new KEYWORD object(s) with details provided in the request + body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/KEYWORD' + - items: + $ref: '#/components/schemas/KEYWORD' + 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/KEYWORD' - type: array - description: Success - returns KEYWORD that satisfy the filters + oneOf: + - $ref: '#/components/schemas/KEYWORD' + - items: + $ref: '#/components/schemas/KEYWORD' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -7651,7 +7651,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get Keywords + summary: Create new Keywords tags: - Keywords /keywords/{id_}: @@ -7680,30 +7680,22 @@ paths: summary: Delete Keywords by id tags: - Keywords - patch: - description: Updates KEYWORD with the specified ID with details provided in - the request body + get: + description: Retrieves a list of KEYWORD objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/KEYWORD' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/KEYWORD' - description: Success - returns the updated object + description: Success - the matching KEYWORD '400': description: Bad request - Something was wrong with the request '401': @@ -7713,25 +7705,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update Keywords by id + summary: Find the KEYWORD matching the given ID tags: - Keywords - get: - description: Retrieves a list of KEYWORD objects + patch: + description: Updates KEYWORD with the specified ID with details provided in + the request body parameters: - - description: The id of the entity to retrieve + - 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/KEYWORD' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/KEYWORD' - description: Success - the matching KEYWORD + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -7741,7 +7741,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the KEYWORD matching the given ID + summary: Update Keywords by id tags: - Keywords /keywords/count: @@ -7801,31 +7801,24 @@ paths: tags: - Keywords /parametertypes: - post: - description: Creates new PARAMETERTYPE object(s) with details provided in the - request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/PARAMETERTYPE' - - items: - $ref: '#/components/schemas/PARAMETERTYPE' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of PARAMETERTYPE 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: - oneOf: - - $ref: '#/components/schemas/PARAMETERTYPE' - - items: - $ref: '#/components/schemas/PARAMETERTYPE' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/PARAMETERTYPE' + type: array + description: Success - returns PARAMETERTYPE that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -7835,7 +7828,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new ParameterTypes + summary: Get ParameterTypes tags: - ParameterTypes patch: @@ -7875,24 +7868,31 @@ paths: summary: Update ParameterTypes tags: - ParameterTypes - get: - description: Retrieves a list of PARAMETERTYPE 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' + post: + description: Creates new PARAMETERTYPE object(s) with details provided in the + request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/PARAMETERTYPE' + - items: + $ref: '#/components/schemas/PARAMETERTYPE' + 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/PARAMETERTYPE' - type: array - description: Success - returns PARAMETERTYPE that satisfy the filters + oneOf: + - $ref: '#/components/schemas/PARAMETERTYPE' + - items: + $ref: '#/components/schemas/PARAMETERTYPE' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -7902,7 +7902,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get ParameterTypes + summary: Create new ParameterTypes tags: - ParameterTypes /parametertypes/{id_}: @@ -7931,30 +7931,22 @@ paths: summary: Delete ParameterTypes by id tags: - ParameterTypes - patch: - description: Updates PARAMETERTYPE with the specified ID with details provided - in the request body + get: + description: Retrieves a list of PARAMETERTYPE objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PARAMETERTYPE' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PARAMETERTYPE' - description: Success - returns the updated object + description: Success - the matching PARAMETERTYPE '400': description: Bad request - Something was wrong with the request '401': @@ -7964,25 +7956,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update ParameterTypes by id + summary: Find the PARAMETERTYPE matching the given ID tags: - ParameterTypes - get: - description: Retrieves a list of PARAMETERTYPE objects + patch: + description: Updates PARAMETERTYPE with the specified ID with details provided + in the request body parameters: - - description: The id of the entity to retrieve + - 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/PARAMETERTYPE' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PARAMETERTYPE' - description: Success - the matching PARAMETERTYPE + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -7992,7 +7992,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the PARAMETERTYPE matching the given ID + summary: Update ParameterTypes by id tags: - ParameterTypes /parametertypes/count: @@ -8052,31 +8052,24 @@ paths: tags: - ParameterTypes /permissiblestringvalues: - post: - description: Creates new PERMISSIBLESTRINGVALUE object(s) with details provided - in the request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/PERMISSIBLESTRINGVALUE' - - items: - $ref: '#/components/schemas/PERMISSIBLESTRINGVALUE' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of PERMISSIBLESTRINGVALUE 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: - oneOf: - - $ref: '#/components/schemas/PERMISSIBLESTRINGVALUE' - - items: - $ref: '#/components/schemas/PERMISSIBLESTRINGVALUE' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/PERMISSIBLESTRINGVALUE' + type: array + description: Success - returns PERMISSIBLESTRINGVALUE that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -8086,7 +8079,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new PermissibleStringValues + summary: Get PermissibleStringValues tags: - PermissibleStringValues patch: @@ -8126,24 +8119,31 @@ paths: summary: Update PermissibleStringValues tags: - PermissibleStringValues - get: - description: Retrieves a list of PERMISSIBLESTRINGVALUE 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' + post: + description: Creates new PERMISSIBLESTRINGVALUE object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/PERMISSIBLESTRINGVALUE' + - items: + $ref: '#/components/schemas/PERMISSIBLESTRINGVALUE' + 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/PERMISSIBLESTRINGVALUE' - type: array - description: Success - returns PERMISSIBLESTRINGVALUE that satisfy the filters + oneOf: + - $ref: '#/components/schemas/PERMISSIBLESTRINGVALUE' + - items: + $ref: '#/components/schemas/PERMISSIBLESTRINGVALUE' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -8153,7 +8153,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get PermissibleStringValues + summary: Create new PermissibleStringValues tags: - PermissibleStringValues /permissiblestringvalues/{id_}: @@ -8182,30 +8182,22 @@ paths: summary: Delete PermissibleStringValues by id tags: - PermissibleStringValues - patch: - description: Updates PERMISSIBLESTRINGVALUE with the specified ID with details - provided in the request body + get: + description: Retrieves a list of PERMISSIBLESTRINGVALUE objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PERMISSIBLESTRINGVALUE' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PERMISSIBLESTRINGVALUE' - description: Success - returns the updated object + description: Success - the matching PERMISSIBLESTRINGVALUE '400': description: Bad request - Something was wrong with the request '401': @@ -8215,25 +8207,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update PermissibleStringValues by id + summary: Find the PERMISSIBLESTRINGVALUE matching the given ID tags: - PermissibleStringValues - get: - description: Retrieves a list of PERMISSIBLESTRINGVALUE objects + patch: + description: Updates PERMISSIBLESTRINGVALUE with the specified ID with details + provided in the request body parameters: - - description: The id of the entity to retrieve + - 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/PERMISSIBLESTRINGVALUE' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PERMISSIBLESTRINGVALUE' - description: Success - the matching PERMISSIBLESTRINGVALUE + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -8243,7 +8243,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the PERMISSIBLESTRINGVALUE matching the given ID + summary: Update PermissibleStringValues by id tags: - PermissibleStringValues /permissiblestringvalues/count: @@ -8305,8 +8305,38 @@ paths: tags: - PermissibleStringValues /publicsteps: - post: - description: Creates new PUBLICSTEP object(s) with details provided in the request + get: + description: Retrieves a list of PUBLICSTEP 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/PUBLICSTEP' + type: array + description: Success - returns PUBLICSTEP that satisfy the filters + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID was found in the HTTP Authorization + header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in the database + summary: Get PublicSteps + tags: + - PublicSteps + patch: + description: Updates PUBLICSTEP object(s) with details provided in the request body requestBody: content: @@ -8317,7 +8347,7 @@ paths: - items: $ref: '#/components/schemas/PUBLICSTEP' type: array - description: The values to use to create the new object(s) with + description: The values to use to update the object(s) with required: true responses: '200': @@ -8329,7 +8359,7 @@ paths: - items: $ref: '#/components/schemas/PUBLICSTEP' type: array - description: Success - returns the created object + description: Success - returns the updated object(s) '400': description: Bad request - Something was wrong with the request '401': @@ -8339,11 +8369,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new PublicSteps + summary: Update PublicSteps tags: - PublicSteps - patch: - description: Updates PUBLICSTEP object(s) with details provided in the request + post: + description: Creates new PUBLICSTEP object(s) with details provided in the request body requestBody: content: @@ -8354,7 +8384,7 @@ paths: - items: $ref: '#/components/schemas/PUBLICSTEP' type: array - description: The values to use to update the object(s) with + description: The values to use to create the new object(s) with required: true responses: '200': @@ -8366,7 +8396,7 @@ paths: - items: $ref: '#/components/schemas/PUBLICSTEP' type: array - description: Success - returns the updated object(s) + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -8376,37 +8406,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update PublicSteps - tags: - - PublicSteps - get: - description: Retrieves a list of PUBLICSTEP 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/PUBLICSTEP' - type: array - description: Success - returns PUBLICSTEP that satisfy the filters - '400': - description: Bad request - Something was wrong with the request - '401': - description: Unauthorized - No session ID was found in the HTTP Authorization - header - '403': - description: Forbidden - The session ID provided is invalid - '404': - description: No such record - Unable to find a record in the database - summary: Get PublicSteps + summary: Create new PublicSteps tags: - PublicSteps /publicsteps/{id_}: @@ -8435,30 +8435,22 @@ paths: summary: Delete PublicSteps by id tags: - PublicSteps - patch: - description: Updates PUBLICSTEP with the specified ID with details provided - in the request body + get: + description: Retrieves a list of PUBLICSTEP objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PUBLICSTEP' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PUBLICSTEP' - description: Success - returns the updated object + description: Success - the matching PUBLICSTEP '400': description: Bad request - Something was wrong with the request '401': @@ -8468,25 +8460,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update PublicSteps by id + summary: Find the PUBLICSTEP matching the given ID tags: - PublicSteps - get: - description: Retrieves a list of PUBLICSTEP objects + patch: + description: Updates PUBLICSTEP with the specified ID with details provided + in the request body parameters: - - description: The id of the entity to retrieve + - 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/PUBLICSTEP' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PUBLICSTEP' - description: Success - the matching PUBLICSTEP + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -8496,7 +8496,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the PUBLICSTEP matching the given ID + summary: Update PublicSteps by id tags: - PublicSteps /publicsteps/count: @@ -8556,31 +8556,24 @@ paths: tags: - PublicSteps /publications: - post: - description: Creates new PUBLICATION object(s) with details provided in the - request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/PUBLICATION' - - items: - $ref: '#/components/schemas/PUBLICATION' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of PUBLICATION 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: - oneOf: - - $ref: '#/components/schemas/PUBLICATION' - - items: - $ref: '#/components/schemas/PUBLICATION' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/PUBLICATION' + type: array + description: Success - returns PUBLICATION that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -8590,7 +8583,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new Publications + summary: Get Publications tags: - Publications patch: @@ -8630,24 +8623,31 @@ paths: summary: Update Publications tags: - Publications - get: - description: Retrieves a list of PUBLICATION 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' + post: + description: Creates new PUBLICATION object(s) with details provided in the + request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/PUBLICATION' + - items: + $ref: '#/components/schemas/PUBLICATION' + 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/PUBLICATION' - type: array - description: Success - returns PUBLICATION that satisfy the filters + oneOf: + - $ref: '#/components/schemas/PUBLICATION' + - items: + $ref: '#/components/schemas/PUBLICATION' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -8657,7 +8657,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get Publications + summary: Create new Publications tags: - Publications /publications/{id_}: @@ -8686,30 +8686,22 @@ paths: summary: Delete Publications by id tags: - Publications - patch: - description: Updates PUBLICATION with the specified ID with details provided - in the request body + get: + description: Retrieves a list of PUBLICATION objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PUBLICATION' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PUBLICATION' - description: Success - returns the updated object + description: Success - the matching PUBLICATION '400': description: Bad request - Something was wrong with the request '401': @@ -8719,25 +8711,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update Publications by id + summary: Find the PUBLICATION matching the given ID tags: - Publications - get: - description: Retrieves a list of PUBLICATION objects + patch: + description: Updates PUBLICATION with the specified ID with details provided + in the request body parameters: - - description: The id of the entity to retrieve + - 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/PUBLICATION' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PUBLICATION' - description: Success - the matching PUBLICATION + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -8747,7 +8747,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the PUBLICATION matching the given ID + summary: Update Publications by id tags: - Publications /publications/count: @@ -8807,31 +8807,24 @@ paths: tags: - Publications /relateddatafiles: - post: - description: Creates new RELATEDDATAFILE object(s) with details provided in - the request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/RELATEDDATAFILE' - - items: - $ref: '#/components/schemas/RELATEDDATAFILE' - type: array - description: The values to use to create the new object(s) with - required: true + 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: - oneOf: - - $ref: '#/components/schemas/RELATEDDATAFILE' - - items: - $ref: '#/components/schemas/RELATEDDATAFILE' - type: array - description: Success - returns the created object + 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': @@ -8841,7 +8834,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new RelatedDatafiles + summary: Get RelatedDatafiles tags: - RelatedDatafiles patch: @@ -8881,24 +8874,31 @@ paths: summary: Update RelatedDatafiles tags: - 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' + post: + description: Creates new RELATEDDATAFILE object(s) with details provided in + the request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/RELATEDDATAFILE' + - 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 RELATEDDATAFILE that satisfy the filters + oneOf: + - $ref: '#/components/schemas/RELATEDDATAFILE' + - items: + $ref: '#/components/schemas/RELATEDDATAFILE' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -8908,7 +8908,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get RelatedDatafiles + summary: Create new RelatedDatafiles tags: - RelatedDatafiles /relateddatafiles/{id_}: @@ -8937,6 +8937,34 @@ paths: 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 was found in the HTTP Authorization + header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in the database + 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 @@ -8973,22 +9001,21 @@ paths: summary: Update RelatedDatafiles by id tags: - RelatedDatafiles + /relateddatafiles/count: get: - description: Retrieves a list of RELATEDDATAFILE objects + description: Return the count of the RELATEDDATAFILE objects that would be retrieved + given the filters provided parameters: - - description: The id of the entity to retrieve - in: path - name: id - required: true - schema: - type: integer + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RELATEDDATAFILE' - description: Success - the matching RELATEDDATAFILE + type: integer + description: Success - The count of the RELATEDDATAFILE objects '400': description: Bad request - Something was wrong with the request '401': @@ -8998,15 +9025,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the RELATEDDATAFILE matching the given ID + summary: Count RelatedDatafiles tags: - RelatedDatafiles - /relateddatafiles/count: + /relateddatafiles/findone: get: - description: Return the count of the RELATEDDATAFILE objects that would be retrieved - given the filters provided + description: Retrieves the first RELATEDDATAFILE 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: @@ -9014,8 +9044,8 @@ paths: content: application/json: schema: - type: integer - description: Success - The count of the RELATEDDATAFILE objects + $ref: '#/components/schemas/RELATEDDATAFILE' + description: Success - a RELATEDDATAFILE object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -9025,13 +9055,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Count RelatedDatafiles + summary: Get single RELATEDDATAFILE tags: - RelatedDatafiles - /relateddatafiles/findone: + /rules: get: - description: Retrieves the first RELATEDDATAFILE objects that satisfies the - filters. + description: Retrieves a list of RULE objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -9044,8 +9073,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RELATEDDATAFILE' - description: Success - a RELATEDDATAFILE object that satisfies the filters + items: + $ref: '#/components/schemas/RULE' + type: array + description: Success - returns RULE that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -9055,13 +9086,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get single RELATEDDATAFILE + summary: Get Rules tags: - - RelatedDatafiles - /rules: - post: - description: Creates new RULE object(s) with details provided in the request - body + - Rules + patch: + description: Updates RULE object(s) with details provided in the request body requestBody: content: application/json: @@ -9071,7 +9100,7 @@ paths: - items: $ref: '#/components/schemas/RULE' type: array - description: The values to use to create the new object(s) with + description: The values to use to update the object(s) with required: true responses: '200': @@ -9083,7 +9112,7 @@ paths: - items: $ref: '#/components/schemas/RULE' type: array - description: Success - returns the created object + description: Success - returns the updated object(s) '400': description: Bad request - Something was wrong with the request '401': @@ -9093,11 +9122,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new Rules + summary: Update Rules tags: - Rules - patch: - description: Updates RULE object(s) with details provided in the request body + post: + description: Creates new RULE object(s) with details provided in the request + body requestBody: content: application/json: @@ -9107,7 +9137,7 @@ paths: - items: $ref: '#/components/schemas/RULE' type: array - description: The values to use to update the object(s) with + description: The values to use to create the new object(s) with required: true responses: '200': @@ -9119,37 +9149,7 @@ paths: - items: $ref: '#/components/schemas/RULE' 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 was found in the HTTP Authorization - header - '403': - description: Forbidden - The session ID provided is invalid - '404': - description: No such record - Unable to find a record in the database - summary: Update Rules - tags: - - Rules - get: - description: Retrieves a list of RULE 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/RULE' - type: array - description: Success - returns RULE that satisfy the filters + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -9159,7 +9159,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get Rules + summary: Create new Rules tags: - Rules /rules/{id_}: @@ -9188,30 +9188,22 @@ paths: summary: Delete Rules by id tags: - Rules - patch: - description: Updates RULE with the specified ID with details provided in the - request body + get: + description: Retrieves a list of RULE objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RULE' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RULE' - description: Success - returns the updated object + description: Success - the matching RULE '400': description: Bad request - Something was wrong with the request '401': @@ -9221,25 +9213,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update Rules by id + summary: Find the RULE matching the given ID tags: - Rules - get: - description: Retrieves a list of RULE objects + patch: + description: Updates RULE with the specified ID with details provided in the + request body parameters: - - description: The id of the entity to retrieve + - 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/RULE' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RULE' - description: Success - the matching RULE + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -9249,7 +9249,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the RULE matching the given ID + summary: Update Rules by id tags: - Rules /rules/count: @@ -9309,31 +9309,24 @@ paths: tags: - Rules /sampleparameters: - post: - description: Creates new SAMPLEPARAMETER object(s) with details provided in - the request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/SAMPLEPARAMETER' - - items: - $ref: '#/components/schemas/SAMPLEPARAMETER' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of SAMPLEPARAMETER 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: - oneOf: - - $ref: '#/components/schemas/SAMPLEPARAMETER' - - items: - $ref: '#/components/schemas/SAMPLEPARAMETER' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/SAMPLEPARAMETER' + type: array + description: Success - returns SAMPLEPARAMETER that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -9343,7 +9336,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new SampleParameters + summary: Get SampleParameters tags: - SampleParameters patch: @@ -9383,24 +9376,31 @@ paths: summary: Update SampleParameters tags: - SampleParameters - get: - description: Retrieves a list of SAMPLEPARAMETER 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' + post: + description: Creates new SAMPLEPARAMETER object(s) with details provided in + the request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SAMPLEPARAMETER' + - items: + $ref: '#/components/schemas/SAMPLEPARAMETER' + 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/SAMPLEPARAMETER' - type: array - description: Success - returns SAMPLEPARAMETER that satisfy the filters + oneOf: + - $ref: '#/components/schemas/SAMPLEPARAMETER' + - items: + $ref: '#/components/schemas/SAMPLEPARAMETER' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -9410,7 +9410,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get SampleParameters + summary: Create new SampleParameters tags: - SampleParameters /sampleparameters/{id_}: @@ -9439,30 +9439,22 @@ paths: summary: Delete SampleParameters by id tags: - SampleParameters - patch: - description: Updates SAMPLEPARAMETER with the specified ID with details provided - in the request body + get: + description: Retrieves a list of SAMPLEPARAMETER objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SAMPLEPARAMETER' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SAMPLEPARAMETER' - description: Success - returns the updated object + description: Success - the matching SAMPLEPARAMETER '400': description: Bad request - Something was wrong with the request '401': @@ -9472,25 +9464,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update SampleParameters by id + summary: Find the SAMPLEPARAMETER matching the given ID tags: - SampleParameters - get: - description: Retrieves a list of SAMPLEPARAMETER objects + patch: + description: Updates SAMPLEPARAMETER with the specified ID with details provided + in the request body parameters: - - description: The id of the entity to retrieve + - 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/SAMPLEPARAMETER' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SAMPLEPARAMETER' - description: Success - the matching SAMPLEPARAMETER + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -9500,7 +9500,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the SAMPLEPARAMETER matching the given ID + summary: Update SampleParameters by id tags: - SampleParameters /sampleparameters/count: @@ -9561,31 +9561,24 @@ paths: tags: - SampleParameters /sampletypes: - post: - description: Creates new SAMPLETYPE object(s) with details provided in the request - body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/SAMPLETYPE' - - items: - $ref: '#/components/schemas/SAMPLETYPE' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of SAMPLETYPE 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: - oneOf: - - $ref: '#/components/schemas/SAMPLETYPE' - - items: - $ref: '#/components/schemas/SAMPLETYPE' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/SAMPLETYPE' + type: array + description: Success - returns SAMPLETYPE that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -9595,7 +9588,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new SampleTypes + summary: Get SampleTypes tags: - SampleTypes patch: @@ -9635,24 +9628,31 @@ paths: summary: Update SampleTypes tags: - SampleTypes - get: - description: Retrieves a list of SAMPLETYPE 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' + post: + description: Creates new SAMPLETYPE object(s) with details provided in the request + body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SAMPLETYPE' + - items: + $ref: '#/components/schemas/SAMPLETYPE' + 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/SAMPLETYPE' - type: array - description: Success - returns SAMPLETYPE that satisfy the filters + oneOf: + - $ref: '#/components/schemas/SAMPLETYPE' + - items: + $ref: '#/components/schemas/SAMPLETYPE' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -9662,7 +9662,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get SampleTypes + summary: Create new SampleTypes tags: - SampleTypes /sampletypes/{id_}: @@ -9691,30 +9691,22 @@ paths: summary: Delete SampleTypes by id tags: - SampleTypes - patch: - description: Updates SAMPLETYPE with the specified ID with details provided - in the request body + get: + description: Retrieves a list of SAMPLETYPE objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SAMPLETYPE' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SAMPLETYPE' - description: Success - returns the updated object + description: Success - the matching SAMPLETYPE '400': description: Bad request - Something was wrong with the request '401': @@ -9724,25 +9716,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update SampleTypes by id + summary: Find the SAMPLETYPE matching the given ID tags: - SampleTypes - get: - description: Retrieves a list of SAMPLETYPE objects + patch: + description: Updates SAMPLETYPE with the specified ID with details provided + in the request body parameters: - - description: The id of the entity to retrieve + - 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/SAMPLETYPE' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SAMPLETYPE' - description: Success - the matching SAMPLETYPE + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -9752,7 +9752,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the SAMPLETYPE matching the given ID + summary: Update SampleTypes by id tags: - SampleTypes /sampletypes/count: @@ -9812,31 +9812,24 @@ paths: tags: - SampleTypes /samples: - post: - description: Creates new SAMPLE object(s) with details provided in the request - body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/SAMPLE' - - items: - $ref: '#/components/schemas/SAMPLE' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of SAMPLE 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: - oneOf: - - $ref: '#/components/schemas/SAMPLE' - - items: - $ref: '#/components/schemas/SAMPLE' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/SAMPLE' + type: array + description: Success - returns SAMPLE that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -9846,7 +9839,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new Samples + summary: Get Samples tags: - Samples patch: @@ -9885,24 +9878,31 @@ paths: summary: Update Samples tags: - Samples - get: - description: Retrieves a list of SAMPLE 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' + post: + description: Creates new SAMPLE object(s) with details provided in the request + body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SAMPLE' + - items: + $ref: '#/components/schemas/SAMPLE' + 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/SAMPLE' - type: array - description: Success - returns SAMPLE that satisfy the filters + oneOf: + - $ref: '#/components/schemas/SAMPLE' + - items: + $ref: '#/components/schemas/SAMPLE' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -9912,7 +9912,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get Samples + summary: Create new Samples tags: - Samples /samples/{id_}: @@ -9941,30 +9941,22 @@ paths: summary: Delete Samples by id tags: - Samples - patch: - description: Updates SAMPLE with the specified ID with details provided in the - request body + get: + description: Retrieves a list of SAMPLE objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SAMPLE' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SAMPLE' - description: Success - returns the updated object + description: Success - the matching SAMPLE '400': description: Bad request - Something was wrong with the request '401': @@ -9974,25 +9966,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update Samples by id + summary: Find the SAMPLE matching the given ID tags: - Samples - get: - description: Retrieves a list of SAMPLE objects + patch: + description: Updates SAMPLE with the specified ID with details provided in the + request body parameters: - - description: The id of the entity to retrieve + - 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/SAMPLE' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SAMPLE' - description: Success - the matching SAMPLE + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -10002,7 +10002,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the SAMPLE matching the given ID + summary: Update Samples by id tags: - Samples /samples/count: @@ -10062,31 +10062,24 @@ paths: tags: - Samples /shifts: - post: - description: Creates new SHIFT object(s) with details provided in the request - body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/SHIFT' - - items: - $ref: '#/components/schemas/SHIFT' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of SHIFT 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: - oneOf: - - $ref: '#/components/schemas/SHIFT' - - items: - $ref: '#/components/schemas/SHIFT' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/SHIFT' + type: array + description: Success - returns SHIFT that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -10096,7 +10089,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new Shifts + summary: Get Shifts tags: - Shifts patch: @@ -10135,24 +10128,31 @@ paths: summary: Update Shifts tags: - Shifts - get: - description: Retrieves a list of SHIFT 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' + post: + description: Creates new SHIFT object(s) with details provided in the request + body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SHIFT' + - items: + $ref: '#/components/schemas/SHIFT' + 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/SHIFT' - type: array - description: Success - returns SHIFT that satisfy the filters + oneOf: + - $ref: '#/components/schemas/SHIFT' + - items: + $ref: '#/components/schemas/SHIFT' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -10162,7 +10162,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get Shifts + summary: Create new Shifts tags: - Shifts /shifts/{id_}: @@ -10191,30 +10191,22 @@ paths: summary: Delete Shifts by id tags: - Shifts - patch: - description: Updates SHIFT with the specified ID with details provided in the - request body + get: + description: Retrieves a list of SHIFT objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SHIFT' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SHIFT' - description: Success - returns the updated object + description: Success - the matching SHIFT '400': description: Bad request - Something was wrong with the request '401': @@ -10224,25 +10216,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update Shifts by id + summary: Find the SHIFT matching the given ID tags: - Shifts - get: - description: Retrieves a list of SHIFT objects + patch: + description: Updates SHIFT with the specified ID with details provided in the + request body parameters: - - description: The id of the entity to retrieve + - 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/SHIFT' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SHIFT' - description: Success - the matching SHIFT + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -10252,7 +10252,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the SHIFT matching the given ID + summary: Update Shifts by id tags: - Shifts /shifts/count: @@ -10312,31 +10312,24 @@ paths: tags: - Shifts /studies: - post: - description: Creates new STUDY object(s) with details provided in the request - body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/STUDY' - - items: - $ref: '#/components/schemas/STUDY' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of STUDY 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: - oneOf: - - $ref: '#/components/schemas/STUDY' - - items: - $ref: '#/components/schemas/STUDY' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/STUDY' + type: array + description: Success - returns STUDY that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -10346,7 +10339,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new Studies + summary: Get Studies tags: - Studies patch: @@ -10385,24 +10378,31 @@ paths: summary: Update Studies tags: - Studies - get: - description: Retrieves a list of STUDY 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' + post: + description: Creates new STUDY object(s) with details provided in the request + body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/STUDY' + - items: + $ref: '#/components/schemas/STUDY' + 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/STUDY' - type: array - description: Success - returns STUDY that satisfy the filters + oneOf: + - $ref: '#/components/schemas/STUDY' + - items: + $ref: '#/components/schemas/STUDY' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -10412,7 +10412,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get Studies + summary: Create new Studies tags: - Studies /studies/{id_}: @@ -10441,30 +10441,22 @@ paths: summary: Delete Studies by id tags: - Studies - patch: - description: Updates STUDY with the specified ID with details provided in the - request body + get: + description: Retrieves a list of STUDY objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/STUDY' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/STUDY' - description: Success - returns the updated object + description: Success - the matching STUDY '400': description: Bad request - Something was wrong with the request '401': @@ -10474,25 +10466,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update Studies by id + summary: Find the STUDY matching the given ID tags: - Studies - get: - description: Retrieves a list of STUDY objects + patch: + description: Updates STUDY with the specified ID with details provided in the + request body parameters: - - description: The id of the entity to retrieve + - 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/STUDY' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/STUDY' - description: Success - the matching STUDY + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -10502,7 +10502,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the STUDY matching the given ID + summary: Update Studies by id tags: - Studies /studies/count: @@ -10562,31 +10562,24 @@ paths: tags: - Studies /studyinvestigations: - post: - description: Creates new STUDYINVESTIGATION object(s) with details provided - in the request body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/STUDYINVESTIGATION' - - items: - $ref: '#/components/schemas/STUDYINVESTIGATION' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of STUDYINVESTIGATION 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: - oneOf: - - $ref: '#/components/schemas/STUDYINVESTIGATION' - - items: - $ref: '#/components/schemas/STUDYINVESTIGATION' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/STUDYINVESTIGATION' + type: array + description: Success - returns STUDYINVESTIGATION that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -10596,7 +10589,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new StudyInvestigations + summary: Get StudyInvestigations tags: - StudyInvestigations patch: @@ -10636,24 +10629,31 @@ paths: summary: Update StudyInvestigations tags: - StudyInvestigations - get: - description: Retrieves a list of STUDYINVESTIGATION 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' + post: + description: Creates new STUDYINVESTIGATION object(s) with details provided + in the request body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/STUDYINVESTIGATION' + - items: + $ref: '#/components/schemas/STUDYINVESTIGATION' + 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/STUDYINVESTIGATION' - type: array - description: Success - returns STUDYINVESTIGATION that satisfy the filters + oneOf: + - $ref: '#/components/schemas/STUDYINVESTIGATION' + - items: + $ref: '#/components/schemas/STUDYINVESTIGATION' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -10663,7 +10663,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get StudyInvestigations + summary: Create new StudyInvestigations tags: - StudyInvestigations /studyinvestigations/{id_}: @@ -10692,6 +10692,34 @@ paths: summary: Delete StudyInvestigations by id tags: - StudyInvestigations + get: + description: Retrieves a list of STUDYINVESTIGATION 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/STUDYINVESTIGATION' + description: Success - the matching STUDYINVESTIGATION + '400': + description: Bad request - Something was wrong with the request + '401': + description: Unauthorized - No session ID was found in the HTTP Authorization + header + '403': + description: Forbidden - The session ID provided is invalid + '404': + description: No such record - Unable to find a record in the database + summary: Find the STUDYINVESTIGATION matching the given ID + tags: + - StudyInvestigations patch: description: Updates STUDYINVESTIGATION with the specified ID with details provided in the request body @@ -10728,22 +10756,21 @@ paths: summary: Update StudyInvestigations by id tags: - StudyInvestigations + /studyinvestigations/count: get: - description: Retrieves a list of STUDYINVESTIGATION objects + description: Return the count of the STUDYINVESTIGATION objects that would be + retrieved given the filters provided parameters: - - description: The id of the entity to retrieve - in: path - name: id - required: true - schema: - type: integer + - $ref: '#/components/parameters/WHERE_FILTER' + - $ref: '#/components/parameters/DISTINCT_FILTER' + - $ref: '#/components/parameters/INCLUDE_FILTER' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/STUDYINVESTIGATION' - description: Success - the matching STUDYINVESTIGATION + type: integer + description: Success - The count of the STUDYINVESTIGATION objects '400': description: Bad request - Something was wrong with the request '401': @@ -10753,15 +10780,18 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the STUDYINVESTIGATION matching the given ID + summary: Count StudyInvestigations tags: - StudyInvestigations - /studyinvestigations/count: + /studyinvestigations/findone: get: - description: Return the count of the STUDYINVESTIGATION objects that would be - retrieved given the filters provided + description: Retrieves the first STUDYINVESTIGATION 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: @@ -10769,8 +10799,8 @@ paths: content: application/json: schema: - type: integer - description: Success - The count of the STUDYINVESTIGATION objects + $ref: '#/components/schemas/STUDYINVESTIGATION' + description: Success - a STUDYINVESTIGATION object that satisfies the filters '400': description: Bad request - Something was wrong with the request '401': @@ -10780,13 +10810,12 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Count StudyInvestigations + summary: Get single STUDYINVESTIGATION tags: - StudyInvestigations - /studyinvestigations/findone: + /usergroups: get: - description: Retrieves the first STUDYINVESTIGATION objects that satisfies the - filters. + description: Retrieves a list of USERGROUP objects parameters: - $ref: '#/components/parameters/WHERE_FILTER' - $ref: '#/components/parameters/ORDER_FILTER' @@ -10799,8 +10828,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/STUDYINVESTIGATION' - description: Success - a STUDYINVESTIGATION object that satisfies the filters + items: + $ref: '#/components/schemas/USERGROUP' + type: array + description: Success - returns USERGROUP that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -10810,12 +10841,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get single STUDYINVESTIGATION + summary: Get UserGroups tags: - - StudyInvestigations - /usergroups: - post: - description: Creates new USERGROUP object(s) with details provided in the request + - UserGroups + patch: + description: Updates USERGROUP object(s) with details provided in the request body requestBody: content: @@ -10826,7 +10856,7 @@ paths: - items: $ref: '#/components/schemas/USERGROUP' type: array - description: The values to use to create the new object(s) with + description: The values to use to update the object(s) with required: true responses: '200': @@ -10838,7 +10868,7 @@ paths: - items: $ref: '#/components/schemas/USERGROUP' type: array - description: Success - returns the created object + description: Success - returns the updated object(s) '400': description: Bad request - Something was wrong with the request '401': @@ -10848,11 +10878,11 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new UserGroups + summary: Update UserGroups tags: - UserGroups - patch: - description: Updates USERGROUP object(s) with details provided in the request + post: + description: Creates new USERGROUP object(s) with details provided in the request body requestBody: content: @@ -10863,7 +10893,7 @@ paths: - items: $ref: '#/components/schemas/USERGROUP' type: array - description: The values to use to update the object(s) with + description: The values to use to create the new object(s) with required: true responses: '200': @@ -10875,37 +10905,7 @@ paths: - items: $ref: '#/components/schemas/USERGROUP' 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 was found in the HTTP Authorization - header - '403': - description: Forbidden - The session ID provided is invalid - '404': - description: No such record - Unable to find a record in the database - summary: Update UserGroups - tags: - - UserGroups - get: - description: Retrieves a list of USERGROUP 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/USERGROUP' - type: array - description: Success - returns USERGROUP that satisfy the filters + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -10915,7 +10915,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get UserGroups + summary: Create new UserGroups tags: - UserGroups /usergroups/{id_}: @@ -10944,30 +10944,22 @@ paths: summary: Delete UserGroups by id tags: - UserGroups - patch: - description: Updates USERGROUP with the specified ID with details provided in - the request body + get: + description: Retrieves a list of USERGROUP objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/USERGROUP' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/USERGROUP' - description: Success - returns the updated object + description: Success - the matching USERGROUP '400': description: Bad request - Something was wrong with the request '401': @@ -10977,25 +10969,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update UserGroups by id + summary: Find the USERGROUP matching the given ID tags: - UserGroups - get: - description: Retrieves a list of USERGROUP objects + patch: + description: Updates USERGROUP with the specified ID with details provided in + the request body parameters: - - description: The id of the entity to retrieve + - 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/USERGROUP' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/USERGROUP' - description: Success - the matching USERGROUP + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -11005,7 +11005,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the USERGROUP matching the given ID + summary: Update UserGroups by id tags: - UserGroups /usergroups/count: @@ -11065,31 +11065,24 @@ paths: tags: - UserGroups /users: - post: - description: Creates new USER object(s) with details provided in the request - body - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/USER' - - items: - $ref: '#/components/schemas/USER' - type: array - description: The values to use to create the new object(s) with - required: true + get: + description: Retrieves a list of USER 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: - oneOf: - - $ref: '#/components/schemas/USER' - - items: - $ref: '#/components/schemas/USER' - type: array - description: Success - returns the created object + items: + $ref: '#/components/schemas/USER' + type: array + description: Success - returns USER that satisfy the filters '400': description: Bad request - Something was wrong with the request '401': @@ -11099,7 +11092,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Create new Users + summary: Get Users tags: - Users patch: @@ -11138,24 +11131,31 @@ paths: summary: Update Users tags: - Users - get: - description: Retrieves a list of USER 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' + post: + description: Creates new USER object(s) with details provided in the request + body + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/USER' + - items: + $ref: '#/components/schemas/USER' + 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/USER' - type: array - description: Success - returns USER that satisfy the filters + oneOf: + - $ref: '#/components/schemas/USER' + - items: + $ref: '#/components/schemas/USER' + type: array + description: Success - returns the created object '400': description: Bad request - Something was wrong with the request '401': @@ -11165,7 +11165,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Get Users + summary: Create new Users tags: - Users /users/{id_}: @@ -11194,30 +11194,22 @@ paths: summary: Delete Users by id tags: - Users - patch: - description: Updates USER with the specified ID with details provided in the - request body + get: + description: Retrieves a list of USER objects parameters: - - description: The id of the entity to update + - description: The id of the entity to retrieve in: path name: id required: true schema: type: integer - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/USER' - description: The values to use to update the object(s) with - required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/USER' - description: Success - returns the updated object + description: Success - the matching USER '400': description: Bad request - Something was wrong with the request '401': @@ -11227,25 +11219,33 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Update Users by id + summary: Find the USER matching the given ID tags: - Users - get: - description: Retrieves a list of USER objects + patch: + description: Updates USER with the specified ID with details provided in the + request body parameters: - - description: The id of the entity to retrieve + - 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/USER' + description: The values to use to update the object(s) with + required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/USER' - description: Success - the matching USER + description: Success - returns the updated object '400': description: Bad request - Something was wrong with the request '401': @@ -11255,7 +11255,7 @@ paths: description: Forbidden - The session ID provided is invalid '404': description: No such record - Unable to find a record in the database - summary: Find the USER matching the given ID + summary: Update Users by id tags: - Users /users/count: @@ -11332,23 +11332,34 @@ paths: summary: Delete session tags: - Sessions - put: - description: Refreshes a users session + get: + description: Gives details of a user's session responses: '200': content: application/json: schema: - description: Session ID - example: xxxxxx-yyyyyyy-zzzzzz - type: string - description: Success - the user's session ID that has been refreshed + properties: + EXPIREDATETIME: + description: When this session expires + example: '2017-07-21T17:32:28Z' + format: datetime + type: string + ID: + description: The session ID + example: xxxxxx-yyyyyyy-zzzzzz + type: string + USERNAME: + description: Username associated with this session + type: string + type: object + description: Success - a user's session details '401': description: Unauthorized - No session ID was found in the HTTP Authorization header '403': description: Forbidden - The session ID provided is invalid - summary: Refresh session + summary: Get session details tags: - Sessions post: @@ -11388,34 +11399,23 @@ paths: summary: Login tags: - Sessions - get: - description: Gives details of a user's session + put: + description: Refreshes a users session responses: '200': content: application/json: schema: - properties: - EXPIREDATETIME: - description: When this session expires - example: '2017-07-21T17:32:28Z' - format: datetime - type: string - ID: - description: The session ID - example: xxxxxx-yyyyyyy-zzzzzz - type: string - USERNAME: - description: Username associated with this session - type: string - type: object - description: Success - a user's session details + description: Session ID + example: xxxxxx-yyyyyyy-zzzzzz + type: string + description: Success - the user's session ID that has been refreshed '401': description: Unauthorized - No session ID was found in the HTTP Authorization header '403': description: Forbidden - The session ID provided is invalid - summary: Get session details + summary: Refresh session tags: - Sessions /instruments/{id_}/facilitycycles: