diff --git a/HISTORY.rst b/HISTORY.rst index 21c0aab8..488a7bef 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -2,10 +2,10 @@ History ======= -4.1.6 (unreleased) ------------------- +4.1.6b (unreleased) +------------------- -- Nothing changed yet. +- Water quality and other additions. 4.1.5 (2023-11-21) diff --git a/schemas/swagger.yaml b/schemas/swagger.yaml index f1c8b351..99c6365f 100644 --- a/schemas/swagger.yaml +++ b/schemas/swagger.yaml @@ -1,25045 +1,26119 @@ -swagger: '2.0' -info: - title: 3Di API - description: |- - 3Di simulation API (latest stable version: v3) - Framework release: 3.2.65 - 3Di core release: 3.2.1 - deployed on: 12:21PM (UTC) on October 03, 2023 - termsOfService: '' - contact: - email: info@nelen-schuurmans.nl - license: - name: BSD License - version: v3 -host: null -schemes: - - https -basePath: / -consumes: - - application/json -produces: - - application/json -securityDefinitions: - Basic: - type: basic - description: This scheme is for Personal API Keys. Use the key as password. The - username must be '__key__' (the word 'key' enclosed in double underscores). - Bearer: - type: apiKey - name: Authorization - in: header - description: This scheme is for tokens generated by 3Di. A token can be retrieved - from auth/tokens. - OAuth2: - type: oauth2 - name: Authorization - flow: accessCode - authorizationUrl: https://auth.lizard.net/oauth2/authorize - tokenUrl: https://auth.lizard.net/oauth2/token - description: This scheme is for OAuth2 Bearer tokens. By default, a public client_id - is set. Optionally supply another client id / secret (for testing). -security: - - Basic: [] - - Bearer: [] - - OAuth2: [] -paths: - /v3-beta/personalapikeys/: - get: - operationId: personalapikeys_list - description: Personal API keys are used for authentication without password. - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/PersonalAPIKey' - tags: - - v3-beta - post: - operationId: personalapikeys_create - description: Personal API keys are used for authentication without password. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/PersonalAPIKey' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/PersonalAPIKeyWithSecret' - tags: - - v3-beta - parameters: [] - /v3-beta/personalapikeys/{prefix}/: - get: - operationId: personalapikeys_read - description: Personal API keys are used for authentication without password. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/PersonalAPIKey' - tags: - - v3-beta - delete: - operationId: personalapikeys_delete - description: Personal API keys are used for authentication without password. - parameters: [] - responses: - '204': - description: '' - tags: - - v3-beta - parameters: - - name: prefix - in: path - required: true - type: string - /v3-beta/personalapikeys/{prefix}/revoke/: - post: - operationId: personalapikeys_revoke - description: Revoke an API key and return the status. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/PersonalAPIKey' - tags: - - v3-beta - parameters: - - name: prefix - in: path - required: true - type: string - /v3-beta/simulation-templates/{id}/copy-to-threedimodel/: - post: - operationId: simulation-templates_copy_to_threedimodel - summary: Copy simulation template to a threedimodel. - description: |- - { - "threedimodel": ThreediModel id - "name": name for the new template - "tags": extra tags, added to existing simulation template tags - "clone_events": clone events like rain/sources & sinks etc - "clone_initials": clone initial waterlevels - "clone_settings": clone simulation settings, like physical settings etc - } - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/CopyToThreediModel' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/CopyToThreediModel' - '400': - description: validation errors - tags: - - v3-beta - parameters: - - name: id - in: path - required: true - type: string - /v3-beta/simulations/{simulation_pk}/events/obstacle-edits/: - get: - operationId: simulations_events_obstacle-edits_list - description: A simple ViewSet for viewing obstacle edits - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/ObstacleEdit' - tags: - - v3-beta - post: - operationId: simulations_events_obstacle-edits_create - description: Create an obstacle edit - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ObstacleEdit' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/ObstacleEdit' - tags: - - v3-beta - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3-beta/simulations/{simulation_pk}/events/obstacle-edits/{id}/: - get: - operationId: simulations_events_obstacle-edits_read - description: A simple ViewSet for viewing obstacle edits - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ObstacleEdit' - tags: - - v3-beta - put: - operationId: simulations_events_obstacle-edits_update - description: A simple ViewSet for viewing obstacle edits - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ObstacleEdit' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ObstacleEdit' - tags: - - v3-beta - patch: - operationId: simulations_events_obstacle-edits_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ObstacleEdit' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3-beta - delete: - operationId: simulations_events_obstacle-edits_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3-beta - parameters: - - name: id - in: path - description: A unique integer value identifying this obstacle edit. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3-beta/simulations/{simulation_pk}/events/obstacle-edits/{id}/processed/: - put: - operationId: simulations_events_obstacle-edits_processed - description: A simple ViewSet for viewing obstacle edits - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/BaseEventState' - responses: - '200': - description: OK - tags: - - v3-beta - parameters: - - name: id - in: path - description: A unique integer value identifying this obstacle edit. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3-beta/simulations/{simulation_pk}/events/obstacle-edits/{id}/register_related_rasters/: - get: - operationId: simulations_events_obstacle-edits_register_related_rasters - summary: |- - Register all related rasters in the results-api and return - read_bbox urls of the registered rasters - description: |- - Skips registering of related rasters when the simulation is not in the - state 'starting' or 'initialized'. In this case the urls will be empty - parameters: [] - responses: - '200': - description: '' - schema: - type: array - items: - $ref: '#/definitions/RasterEditUrls' - tags: - - v3-beta - parameters: - - name: id - in: path - description: A unique integer value identifying this obstacle edit. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3-beta/status/: - get: - operationId: status_list - description: '' - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Status' - tags: - - v3-beta - parameters: [] - /v3-beta/status/current-version/: - get: - operationId: status_current_version - description: '' - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/CurrentVersion' - tags: - - v3-beta - parameters: [] - /v3/auth/profile/: - get: - operationId: auth_profile_list - description: Read-only API endpoint for viewing user details for current user - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - $ref: '#/definitions/User' - tags: - - v3 - parameters: [] - /v3/auth/refresh-token/: - post: - operationId: auth_refresh-token_create - summary: Refresh API authentication token by refresh_token. - description: |- - Post "refresh" token as "refresh". - - The return "access" token needs to be sent as HTTP authentication header - with every request with 'Bearer ' prefix (case-sensitive). - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Refresh' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Tokens' - tags: - - v3 - parameters: [] - /v3/auth/token/: - post: - operationId: auth_token_create - summary: Retrieve tokens for API authentication. - description: |- - There are two ways for retrieving a tokens. The preferred way is attaching - a Personal API Key to the request and leave the request body empty. For - backwards compatibility, you can also supply your username and password - in the request body directly. - - The response will contain an "access" and "refresh" JWT token. - - The "access" token needs to be sent as HTTP authentication header - with every request with a 'Bearer ' prefix (case-sensitive). - - Note that the "access" token expires after some time. - - The "refresh" token can be used to get a new access token - via the "refresh" endpoint. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Authenticate' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Tokens' - tags: - - v3 - parameters: [] - /v3/auth/users/: - get: - operationId: auth_users_list - summary: Read-only API endpoint for viewing user details. - description: |- - - superusers and staff users might view all users - - user with a manager role might view all users for the - organisations they have the manager role for - - regular users might view their user details - parameters: - - name: username - in: query - description: '' - required: false - type: string - - name: username__iexact - in: query - description: '' - required: false - type: string - - name: username__contains - in: query - description: '' - required: false - type: string - - name: username__icontains - in: query - description: '' - required: false - type: string - - name: username__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: username__startswith - in: query - description: '' - required: false - type: string - - name: username__istartswith - in: query - description: '' - required: false - type: string - - name: username__endswith - in: query - description: '' - required: false - type: string - - name: username__regex - in: query - description: '' - required: false - type: string - - name: email - in: query - description: '' - required: false - type: string - - name: email__iexact - in: query - description: '' - required: false - type: string - - name: email__contains - in: query - description: '' - required: false - type: string - - name: email__icontains - in: query - description: '' - required: false - type: string - - name: email__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: email__startswith - in: query - description: '' - required: false - type: string - - name: email__istartswith - in: query - description: '' - required: false - type: string - - name: email__endswith - in: query - description: '' - required: false - type: string - - name: email__regex - in: query - description: '' - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/User' - tags: - - v3 - parameters: [] - /v3/auth/users/{id}/: - get: - operationId: auth_users_read - description: '' - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/User' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this user. - required: true - type: integer - /v3/auth/users/{id}/tokens/: - get: - operationId: auth_users_tokens - description: '' - parameters: - - name: required_scopes - in: query - required: false - type: array - items: - type: string - minLength: 1 - default: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/UserTokens' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this user. - required: true - type: integer - /v3/contracts/: - get: - operationId: contracts_list - summary: Overview of organisations that have a valid 3Di contract. - description: |- - List all organisations that already have used some fraction - of their calculation quota (for the current year - the `hours_used` - property is based on the current calender year) - ``` - ?hours_used__gt=0 - ``` - parameters: - - name: organisation__id - in: query - description: '' - required: false - type: number - - name: organisation__id__gt - in: query - description: '' - required: false - type: number - - name: organisation__id__gte - in: query - description: '' - required: false - type: number - - name: organisation__id__lt - in: query - description: '' - required: false - type: number - - name: organisation__id__lte - in: query - description: '' - required: false - type: number - - name: organisation__id__isnull - in: query - description: '' - required: false - type: string - - name: organisation__name - in: query - description: '' - required: false - type: string - - name: organisation__name__iexact - in: query - description: '' - required: false - type: string - - name: organisation__name__contains - in: query - description: '' - required: false - type: string - - name: organisation__name__icontains - in: query - description: '' - required: false - type: string - - name: organisation__name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: organisation__name__startswith - in: query - description: '' - required: false - type: string - - name: organisation__name__istartswith - in: query - description: '' - required: false - type: string - - name: organisation__name__endswith - in: query - description: '' - required: false - type: string - - name: organisation__name__regex - in: query - description: '' - required: false - type: string - - name: organisation__unique_id - in: query - description: '' - required: false - type: string - - name: organisation__unique_id__iexact - in: query - description: '' - required: false - type: string - - name: organisation__unique_id__contains - in: query - description: '' - required: false - type: string - - name: organisation__unique_id__icontains - in: query - description: '' - required: false - type: string - - name: organisation__unique_id__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: organisation__unique_id__startswith - in: query - description: '' - required: false - type: string - - name: organisation__unique_id__istartswith - in: query - description: '' - required: false - type: string - - name: organisation__unique_id__endswith - in: query - description: '' - required: false - type: string - - name: organisation__unique_id__regex - in: query - description: '' - required: false - type: string - - name: hours_used__gt - in: query - description: '' - required: false - type: number - - name: hours_used__lt - in: query - description: '' - required: false - type: number - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/Contract' - tags: - - v3 - post: - operationId: contracts_create - description: API endpoint for interacting with contracts. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Contract' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Contract' - tags: - - v3 - parameters: [] - /v3/contracts/{id}/: - get: - operationId: contracts_read - description: API endpoint for interacting with contracts. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Contract' - tags: - - v3 - put: - operationId: contracts_update - description: API endpoint for interacting with contracts. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Contract' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Contract' - tags: - - v3 - patch: - operationId: contracts_partial_update - description: API endpoint for interacting with contracts. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Contract' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Contract' - tags: - - v3 - delete: - operationId: contracts_delete - description: API endpoint for interacting with contracts. - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this contract. - required: true - type: integer - /v3/files/: - get: - operationId: files_list - description: A simple ViewSet for viewing files - parameters: - - name: filename - in: query - description: '' - required: false - type: string - - name: filename__icontains - in: query - description: '' - required: false - type: string - - name: etag - in: query - description: '' - required: false - type: string - - name: expiry_date - in: query - description: '' - required: false - type: string - - name: expiry_date__lte - in: query - description: '' - required: false - type: string - - name: expiry_date__lt - in: query - description: '' - required: false - type: string - - name: expiry_date__gte - in: query - description: '' - required: false - type: string - - name: expiry_date__gt - in: query - description: '' - required: false - type: string - - name: state - in: query - description: '' - required: false - type: string - - name: state__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: type - in: query - description: '' - required: false - type: string - - name: type__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: meta - in: query - description: '' - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/File' - tags: - - v3 - parameters: [] - /v3/files/{id}/: - get: - operationId: files_read - description: A simple ViewSet for viewing files - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/File' - tags: - - v3 - put: - operationId: files_update - description: A simple ViewSet for viewing files - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/File' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/File' - tags: - - v3 - patch: - operationId: files_partial_update - description: A simple ViewSet for viewing files - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/File' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/File' - tags: - - v3 - delete: - operationId: files_delete - description: A simple ViewSet for viewing files - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this file. - required: true - type: integer - /v3/files/{id}/destroy_file/: - delete: - operationId: files_destroy_file - description: A simple ViewSet for viewing files - parameters: [] - responses: - '204': - description: '' - schema: - $ref: '#/definitions/File' - '405': - description: "types that are allowed to be destroyed: ['timeseries', 'rastertimeseries',\ - \ 'savedstate', 'results', 'bulklateral', 'bulkcontrol']" - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this file. - required: true - type: integer - /v3/files/{id}/download/: - get: - operationId: files_download - description: A simple ViewSet for viewing files - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this file. - required: true - type: integer - /v3/files/{id}/processed/: - put: - operationId: files_processed - summary: |- - Endpoint to which the upload-processor can enrich file objects - (and their related objects) with metadata. - description: For example the geotransform of raster files. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/FileMeta' - responses: - '200': - description: OK - '400': - description: Upload is already processed - '404': - description: upload not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this file. - required: true - type: integer - /v3/inpy-versions/: - get: - operationId: inpy-versions_list - description: |- - Inpy was the service for preparing user-supplied schematisations into 3Di - models (threedimodels) usable by the 3Di calculation core. - - Currently, this route is pending deprecation: most newly generated - 3Di models will carry an empty inpy_version. - parameters: - - name: threedi_version - in: query - description: '' - required: false - type: string - - name: threedi_version__iexact - in: query - description: '' - required: false - type: string - - name: threedi_version__contains - in: query - description: '' - required: false - type: string - - name: threedi_version__icontains - in: query - description: '' - required: false - type: string - - name: threedi_version__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: threedi_version__startswith - in: query - description: '' - required: false - type: string - - name: threedi_version__istartswith - in: query - description: '' - required: false - type: string - - name: threedi_version__endswith - in: query - description: '' - required: false - type: string - - name: threedi_version__regex - in: query - description: '' - required: false - type: string - - name: threedicore_version - in: query - description: '' - required: false - type: string - - name: threedicore_version__iexact - in: query - description: '' - required: false - type: string - - name: threedicore_version__contains - in: query - description: '' - required: false - type: string - - name: threedicore_version__icontains - in: query - description: '' - required: false - type: string - - name: threedicore_version__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: threedicore_version__startswith - in: query - description: '' - required: false - type: string - - name: threedicore_version__istartswith - in: query - description: '' - required: false - type: string - - name: threedicore_version__endswith - in: query - description: '' - required: false - type: string - - name: threedicore_version__regex - in: query - description: '' - required: false - type: string - - name: slug - in: query - description: '' - required: false - type: string - - name: slug__iexact - in: query - description: '' - required: false - type: string - - name: slug__contains - in: query - description: '' - required: false - type: string - - name: slug__icontains - in: query - description: '' - required: false - type: string - - name: slug__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: slug__startswith - in: query - description: '' - required: false - type: string - - name: slug__istartswith - in: query - description: '' - required: false - type: string - - name: slug__endswith - in: query - description: '' - required: false - type: string - - name: slug__regex - in: query - description: '' - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/InpyVersion' - tags: - - v3 - post: - operationId: inpy-versions_create - description: |- - Inpy was the service for preparing user-supplied schematisations into 3Di - models (threedimodels) usable by the 3Di calculation core. - - Currently, this route is pending deprecation: most newly generated - 3Di models will carry an empty inpy_version. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/InpyVersion' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/InpyVersion' - tags: - - v3 - parameters: [] - /v3/inpy-versions/{id}/: - get: - operationId: inpy-versions_read - description: |- - Inpy was the service for preparing user-supplied schematisations into 3Di - models (threedimodels) usable by the 3Di calculation core. - - Currently, this route is pending deprecation: most newly generated - 3Di models will carry an empty inpy_version. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/InpyVersion' - tags: - - v3 - put: - operationId: inpy-versions_update - description: |- - Inpy was the service for preparing user-supplied schematisations into 3Di - models (threedimodels) usable by the 3Di calculation core. - - Currently, this route is pending deprecation: most newly generated - 3Di models will carry an empty inpy_version. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/InpyVersion' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/InpyVersion' - tags: - - v3 - patch: - operationId: inpy-versions_partial_update - description: |- - Inpy was the service for preparing user-supplied schematisations into 3Di - models (threedimodels) usable by the 3Di calculation core. - - Currently, this route is pending deprecation: most newly generated - 3Di models will carry an empty inpy_version. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/InpyVersion' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/InpyVersion' - tags: - - v3 - delete: - operationId: inpy-versions_delete - description: |- - Inpy was the service for preparing user-supplied schematisations into 3Di - models (threedimodels) usable by the 3Di calculation core. - - Currently, this route is pending deprecation: most newly generated - 3Di models will carry an empty inpy_version. - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this inpy version. - required: true - type: integer - /v3/organisations/: - get: - operationId: organisations_list - description: Read-only API endpoint for interacting with organisations. - parameters: - - name: name - in: query - description: '' - required: false - type: string - - name: name__iexact - in: query - description: '' - required: false - type: string - - name: name__contains - in: query - description: '' - required: false - type: string - - name: name__icontains - in: query - description: '' - required: false - type: string - - name: name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: name__startswith - in: query - description: '' - required: false - type: string - - name: name__istartswith - in: query - description: '' - required: false - type: string - - name: name__endswith - in: query - description: '' - required: false - type: string - - name: name__regex - in: query - description: '' - required: false - type: string - - name: unique_id - in: query - description: '' - required: false - type: string - - name: unique_id__iexact - in: query - description: '' - required: false - type: string - - name: unique_id__contains - in: query - description: '' - required: false - type: string - - name: unique_id__icontains - in: query - description: '' - required: false - type: string - - name: unique_id__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: unique_id__startswith - in: query - description: '' - required: false - type: string - - name: unique_id__istartswith - in: query - description: '' - required: false - type: string - - name: unique_id__endswith - in: query - description: '' - required: false - type: string - - name: unique_id__regex - in: query - description: '' - required: false - type: string - - name: valid_contracts_only - in: query - description: '' - required: false - type: string - - name: logged_in_user_has_role - in: query - description: '' - required: false - type: string - - name: contract__scope__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/Organisation' - tags: - - v3 - parameters: [] - /v3/organisations/{unique_id}/: - get: - operationId: organisations_read - description: Read-only API endpoint for interacting with organisations. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Organisation' - tags: - - v3 - parameters: - - name: unique_id - in: path - required: true - type: string - /v3/organisations/{unique_id}/permissions/: - get: - operationId: organisations_permissions - description: Read-only API endpoint for interacting with organisations. - parameters: [] - responses: - '200': - description: '' - schema: - type: array - items: - $ref: '#/definitions/OrganisationRole' - tags: - - v3 - parameters: - - name: unique_id - in: path - required: true - type: string - /v3/organisations/{unique_id}/users/: - get: - operationId: organisations_users_list - description: Endpoint for interacting with users in an organisation. - parameters: - - name: username - in: query - description: '' - required: false - type: string - - name: username__iexact - in: query - description: '' - required: false - type: string - - name: username__contains - in: query - description: '' - required: false - type: string - - name: username__icontains - in: query - description: '' - required: false - type: string - - name: username__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: username__startswith - in: query - description: '' - required: false - type: string - - name: username__istartswith - in: query - description: '' - required: false - type: string - - name: username__endswith - in: query - description: '' - required: false - type: string - - name: username__regex - in: query - description: '' - required: false - type: string - - name: email - in: query - description: '' - required: false - type: string - - name: email__iexact - in: query - description: '' - required: false - type: string - - name: email__contains - in: query - description: '' - required: false - type: string - - name: email__icontains - in: query - description: '' - required: false - type: string - - name: email__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: email__startswith - in: query - description: '' - required: false - type: string - - name: email__istartswith - in: query - description: '' - required: false - type: string - - name: email__endswith - in: query - description: '' - required: false - type: string - - name: email__regex - in: query - description: '' - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/OrganisationUser' - tags: - - v3 - parameters: - - name: unique_id - in: path - required: true - type: string - /v3/organisations/{unique_id}/users/{id}/: - get: - operationId: organisations_users_read - description: Endpoint for interacting with users in an organisation. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/OrganisationUser' - tags: - - v3 - patch: - operationId: organisations_users_partial_update - description: Patch the roles of a user in this organisation. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/OrganisationUserRolePatch' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/OrganisationUser' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this user. - required: true - type: integer - - name: unique_id - in: path - required: true - type: string - /v3/permissions/: - get: - operationId: permissions_list - description: Permissions management endpoints. - parameters: - - name: user__username - in: query - description: '' - required: false - type: string - - name: user__username__iexact - in: query - description: '' - required: false - type: string - - name: user__username__contains - in: query - description: '' - required: false - type: string - - name: user__username__icontains - in: query - description: '' - required: false - type: string - - name: user__username__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: user__username__startswith - in: query - description: '' - required: false - type: string - - name: user__username__istartswith - in: query - description: '' - required: false - type: string - - name: user__username__endswith - in: query - description: '' - required: false - type: string - - name: user__username__regex - in: query - description: '' - required: false - type: string - - name: role__name - in: query - description: '' - required: false - type: string - - name: role__name__iexact - in: query - description: '' - required: false - type: string - - name: role__name__contains - in: query - description: '' - required: false - type: string - - name: role__name__icontains - in: query - description: '' - required: false - type: string - - name: role__name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: role__name__startswith - in: query - description: '' - required: false - type: string - - name: role__name__istartswith - in: query - description: '' - required: false - type: string - - name: role__name__endswith - in: query - description: '' - required: false - type: string - - name: role__name__regex - in: query - description: '' - required: false - type: string - - name: organisation__name - in: query - description: '' - required: false - type: string - - name: organisation__name__iexact - in: query - description: '' - required: false - type: string - - name: organisation__name__contains - in: query - description: '' - required: false - type: string - - name: organisation__name__icontains - in: query - description: '' - required: false - type: string - - name: organisation__name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: organisation__name__startswith - in: query - description: '' - required: false - type: string - - name: organisation__name__istartswith - in: query - description: '' - required: false - type: string - - name: organisation__name__endswith - in: query - description: '' - required: false - type: string - - name: organisation__name__regex - in: query - description: '' - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/OrganisationRole' - tags: - - v3 - post: - operationId: permissions_create - summary: create a role for an existing user in an existing organisation - description: |- - Example payload: - - { - "user": "chuck.norris", # user name - "role": "simulation_runner", # role name - "organisation": "48dac75bef8a42ebbb52e8f89bbdb9f2" # unique id - } - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/OrganisationRole' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/OrganisationRole' - tags: - - v3 - parameters: [] - /v3/permissions/{id}/: - get: - operationId: permissions_read - description: Permissions management endpoints. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/OrganisationRole' - tags: - - v3 - delete: - operationId: permissions_delete - description: Permissions management endpoints. - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this user organisation role. - required: true - type: integer - /v3/repositories/: - get: - operationId: repositories_list - description: A simple ViewSet for viewing modelmeta - parameters: - - name: slug - in: query - description: '' - required: false - type: string - - name: slug__iexact - in: query - description: '' - required: false - type: string - - name: slug__contains - in: query - description: '' - required: false - type: string - - name: slug__icontains - in: query - description: '' - required: false - type: string - - name: slug__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: slug__startswith - in: query - description: '' - required: false - type: string - - name: slug__istartswith - in: query - description: '' - required: false - type: string - - name: slug__endswith - in: query - description: '' - required: false - type: string - - name: slug__regex - in: query - description: '' - required: false - type: string - - name: organisation__id - in: query - description: '' - required: false - type: number - - name: organisation__id__gt - in: query - description: '' - required: false - type: number - - name: organisation__id__gte - in: query - description: '' - required: false - type: number - - name: organisation__id__lt - in: query - description: '' - required: false - type: number - - name: organisation__id__lte - in: query - description: '' - required: false - type: number - - name: organisation__id__isnull - in: query - description: '' - required: false - type: string - - name: organisation__name - in: query - description: '' - required: false - type: string - - name: organisation__name__iexact - in: query - description: '' - required: false - type: string - - name: organisation__name__contains - in: query - description: '' - required: false - type: string - - name: organisation__name__icontains - in: query - description: '' - required: false - type: string - - name: organisation__name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: organisation__name__startswith - in: query - description: '' - required: false - type: string - - name: organisation__name__istartswith - in: query - description: '' - required: false - type: string - - name: organisation__name__endswith - in: query - description: '' - required: false - type: string - - name: organisation__name__regex - in: query - description: '' - required: false - type: string - - name: organisation__unique_id - in: query - description: '' - required: false - type: string - - name: organisation__unique_id__iexact - in: query - description: '' - required: false - type: string - - name: organisation__unique_id__contains - in: query - description: '' - required: false - type: string - - name: organisation__unique_id__icontains - in: query - description: '' - required: false - type: string - - name: organisation__unique_id__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: organisation__unique_id__startswith - in: query - description: '' - required: false - type: string - - name: organisation__unique_id__istartswith - in: query - description: '' - required: false - type: string - - name: organisation__unique_id__endswith - in: query - description: '' - required: false - type: string - - name: organisation__unique_id__regex - in: query - description: '' - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/Repository' - tags: - - v3 - post: - operationId: repositories_create - description: A simple ViewSet for viewing modelmeta - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Repository' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Repository' - tags: - - v3 - parameters: [] - /v3/repositories/{id}/: - get: - operationId: repositories_read - description: A simple ViewSet for viewing modelmeta - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Repository' - tags: - - v3 - put: - operationId: repositories_update - description: A simple ViewSet for viewing modelmeta - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Repository' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Repository' - tags: - - v3 - patch: - operationId: repositories_partial_update - description: A simple ViewSet for viewing modelmeta - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Repository' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Repository' - tags: - - v3 - delete: - operationId: repositories_delete - description: A simple ViewSet for viewing modelmeta - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this repository. - required: true - type: integer - /v3/repositories/{id}/revisions/: - get: - operationId: repositories_revisions - description: A simple ViewSet for viewing modelmeta - parameters: [] - responses: - '200': - description: '' - schema: - type: array - items: - $ref: '#/definitions/Revision' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this repository. - required: true - type: integer - /v3/repositories/{id}/threedimodels/: - get: - operationId: repositories_threedimodels - description: A simple ViewSet for viewing modelmeta - parameters: [] - responses: - '200': - description: '' - schema: - type: array - items: - $ref: '#/definitions/ThreediModel' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this repository. - required: true - type: integer - /v3/revisions/: - get: - operationId: revisions_list - description: A simple ViewSet for viewing modelmeta - parameters: - - name: number - in: query - description: '' - required: false - type: number - - name: number__gt - in: query - description: '' - required: false - type: number - - name: number__gte - in: query - description: '' - required: false - type: number - - name: number__lt - in: query - description: '' - required: false - type: number - - name: number__lte - in: query - description: '' - required: false - type: number - - name: number__isnull - in: query - description: '' - required: false - type: string - - name: hash - in: query - description: '' - required: false - type: string - - name: hash__iexact - in: query - description: '' - required: false - type: string - - name: hash__contains - in: query - description: '' - required: false - type: string - - name: hash__icontains - in: query - description: '' - required: false - type: string - - name: hash__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: hash__startswith - in: query - description: '' - required: false - type: string - - name: hash__istartswith - in: query - description: '' - required: false - type: string - - name: hash__endswith - in: query - description: '' - required: false - type: string - - name: hash__regex - in: query - description: '' - required: false - type: string - - name: repository__id - in: query - description: '' - required: false - type: number - - name: repository__id__gt - in: query - description: '' - required: false - type: number - - name: repository__id__gte - in: query - description: '' - required: false - type: number - - name: repository__id__lt - in: query - description: '' - required: false - type: number - - name: repository__id__lte - in: query - description: '' - required: false - type: number - - name: repository__id__isnull - in: query - description: '' - required: false - type: string - - name: repository__slug - in: query - description: '' - required: false - type: string - - name: repository__slug__iexact - in: query - description: '' - required: false - type: string - - name: repository__slug__contains - in: query - description: '' - required: false - type: string - - name: repository__slug__icontains - in: query - description: '' - required: false - type: string - - name: repository__slug__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: repository__slug__startswith - in: query - description: '' - required: false - type: string - - name: repository__slug__istartswith - in: query - description: '' - required: false - type: string - - name: repository__slug__endswith - in: query - description: '' - required: false - type: string - - name: repository__slug__regex - in: query - description: '' - required: false - type: string - - name: repository__organisation__name - in: query - description: '' - required: false - type: string - - name: repository__organisation__name__iexact - in: query - description: '' - required: false - type: string - - name: repository__organisation__name__contains - in: query - description: '' - required: false - type: string - - name: repository__organisation__name__icontains - in: query - description: '' - required: false - type: string - - name: repository__organisation__name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: repository__organisation__name__startswith - in: query - description: '' - required: false - type: string - - name: repository__organisation__name__istartswith - in: query - description: '' - required: false - type: string - - name: repository__organisation__name__endswith - in: query - description: '' - required: false - type: string - - name: repository__organisation__name__regex - in: query - description: '' - required: false - type: string - - name: repository__organisation__unique_id - in: query - description: '' - required: false - type: string - - name: repository__organisation__unique_id__iexact - in: query - description: '' - required: false - type: string - - name: repository__organisation__unique_id__contains - in: query - description: '' - required: false - type: string - - name: repository__organisation__unique_id__icontains - in: query - description: '' - required: false - type: string - - name: repository__organisation__unique_id__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: repository__organisation__unique_id__startswith - in: query - description: '' - required: false - type: string - - name: repository__organisation__unique_id__istartswith - in: query - description: '' - required: false - type: string - - name: repository__organisation__unique_id__endswith - in: query - description: '' - required: false - type: string - - name: repository__organisation__unique_id__regex - in: query - description: '' - required: false - type: string - - name: is_pinned - in: query - description: '' - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/Revision' - tags: - - v3 - post: - operationId: revisions_create - description: A simple ViewSet for viewing modelmeta - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Revision' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Revision' - tags: - - v3 - parameters: [] - /v3/revisions/{id}/: - get: - operationId: revisions_read - description: A simple ViewSet for viewing modelmeta - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Revision' - tags: - - v3 - put: - operationId: revisions_update - description: A simple ViewSet for viewing modelmeta - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Revision' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Revision' - tags: - - v3 - patch: - operationId: revisions_partial_update - description: A simple ViewSet for viewing modelmeta - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Revision' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Revision' - tags: - - v3 - delete: - operationId: revisions_delete - description: A simple ViewSet for viewing modelmeta - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this revision. - required: true - type: integer - /v3/revisions/{id}/threedimodels/: - get: - operationId: revisions_threedimodels - description: A simple ViewSet for viewing modelmeta - parameters: [] - responses: - '200': - description: '' - schema: - type: array - items: - $ref: '#/definitions/ThreediModel' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this revision. - required: true - type: integer - /v3/roles/: - get: - operationId: roles_list - description: Read-only API endpoint for viewing roles - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/Role' - tags: - - v3 - parameters: [] - /v3/roles/{id}/: - get: - operationId: roles_read - description: Read-only API endpoint for viewing roles - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Role' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this role. - required: true - type: integer - /v3/schematisations/: - get: - operationId: schematisations_list - description: Manage schematisations - parameters: - - name: created__range - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: created__date - in: query - description: '' - required: false - type: string - - name: created__date__gt - in: query - description: '' - required: false - type: string - - name: created__date__gte - in: query - description: '' - required: false - type: string - - name: created__date__lt - in: query - description: '' - required: false - type: string - - name: created__date__lte - in: query - description: '' - required: false - type: string - - name: created__year - in: query - description: '' - required: false - type: number - - name: created__year__gt - in: query - description: '' - required: false - type: number - - name: created__year__gte - in: query - description: '' - required: false - type: number - - name: created__year__lt - in: query - description: '' - required: false - type: number - - name: created__year__lte - in: query - description: '' - required: false - type: number - - name: created__month - in: query - description: '' - required: false - type: number - - name: created__month__lte - in: query - description: '' - required: false - type: number - - name: created__day - in: query - description: '' - required: false - type: number - - name: created__day__lt - in: query - description: '' - required: false - type: number - - name: created__week - in: query - description: '' - required: false - type: number - - name: created__week_day - in: query - description: '' - required: false - type: number - - name: created__quarter - in: query - description: '' - required: false - type: number - - name: created__time - in: query - description: '' - required: false - type: string - - name: created__hour - in: query - description: '' - required: false - type: number - - name: created__minute - in: query - description: '' - required: false - type: number - - name: created__second - in: query - description: '' - required: false - type: number - - name: created__isnull - in: query - description: '' - required: false - type: string - - name: last_updated__range - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: last_updated__date - in: query - description: '' - required: false - type: string - - name: last_updated__date__gt - in: query - description: '' - required: false - type: string - - name: last_updated__date__gte - in: query - description: '' - required: false - type: string - - name: last_updated__date__lt - in: query - description: '' - required: false - type: string - - name: last_updated__date__lte - in: query - description: '' - required: false - type: string - - name: last_updated__year - in: query - description: '' - required: false - type: number - - name: last_updated__year__gt - in: query - description: '' - required: false - type: number - - name: last_updated__year__gte - in: query - description: '' - required: false - type: number - - name: last_updated__year__lt - in: query - description: '' - required: false - type: number - - name: last_updated__year__lte - in: query - description: '' - required: false - type: number - - name: last_updated__month - in: query - description: '' - required: false - type: number - - name: last_updated__month__lte - in: query - description: '' - required: false - type: number - - name: last_updated__day - in: query - description: '' - required: false - type: number - - name: last_updated__day__lt - in: query - description: '' - required: false - type: number - - name: last_updated__week - in: query - description: '' - required: false - type: number - - name: last_updated__week_day - in: query - description: '' - required: false - type: number - - name: last_updated__quarter - in: query - description: '' - required: false - type: number - - name: last_updated__time - in: query - description: '' - required: false - type: string - - name: last_updated__hour - in: query - description: '' - required: false - type: number - - name: last_updated__minute - in: query - description: '' - required: false - type: number - - name: last_updated__second - in: query - description: '' - required: false - type: number - - name: last_updated__isnull - in: query - description: '' - required: false - type: string - - name: created_by__username - in: query - description: '' - required: false - type: string - - name: created_by__username__iexact - in: query - description: '' - required: false - type: string - - name: created_by__username__contains - in: query - description: '' - required: false - type: string - - name: created_by__username__icontains - in: query - description: '' - required: false - type: string - - name: created_by__username__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: created_by__username__startswith - in: query - description: '' - required: false - type: string - - name: created_by__username__istartswith - in: query - description: '' - required: false - type: string - - name: created_by__username__endswith - in: query - description: '' - required: false - type: string - - name: created_by__username__regex - in: query - description: '' - required: false - type: string - - name: name - in: query - description: '' - required: false - type: string - - name: name__iexact - in: query - description: '' - required: false - type: string - - name: name__contains - in: query - description: '' - required: false - type: string - - name: name__icontains - in: query - description: '' - required: false - type: string - - name: name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: name__startswith - in: query - description: '' - required: false - type: string - - name: name__istartswith - in: query - description: '' - required: false - type: string - - name: name__endswith - in: query - description: '' - required: false - type: string - - name: name__regex - in: query - description: '' - required: false - type: string - - name: slug - in: query - description: '' - required: false - type: string - - name: slug__iexact - in: query - description: '' - required: false - type: string - - name: slug__contains - in: query - description: '' - required: false - type: string - - name: slug__icontains - in: query - description: '' - required: false - type: string - - name: slug__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: slug__startswith - in: query - description: '' - required: false - type: string - - name: slug__istartswith - in: query - description: '' - required: false - type: string - - name: slug__endswith - in: query - description: '' - required: false - type: string - - name: slug__regex - in: query - description: '' - required: false - type: string - - name: owner__name - in: query - description: '' - required: false - type: string - - name: owner__name__iexact - in: query - description: '' - required: false - type: string - - name: owner__name__contains - in: query - description: '' - required: false - type: string - - name: owner__name__icontains - in: query - description: '' - required: false - type: string - - name: owner__name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: owner__name__startswith - in: query - description: '' - required: false - type: string - - name: owner__name__istartswith - in: query - description: '' - required: false - type: string - - name: owner__name__endswith - in: query - description: '' - required: false - type: string - - name: owner__name__regex - in: query - description: '' - required: false - type: string - - name: owner__unique_id - in: query - description: '' - required: false - type: string - - name: owner__unique_id__iexact - in: query - description: '' - required: false - type: string - - name: owner__unique_id__contains - in: query - description: '' - required: false - type: string - - name: owner__unique_id__icontains - in: query - description: '' - required: false - type: string - - name: owner__unique_id__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: owner__unique_id__startswith - in: query - description: '' - required: false - type: string - - name: owner__unique_id__istartswith - in: query - description: '' - required: false - type: string - - name: owner__unique_id__endswith - in: query - description: '' - required: false - type: string - - name: owner__unique_id__regex - in: query - description: '' - required: false - type: string - - name: tags__in - in: query - description: '' - required: false - type: string - - name: archived - in: query - description: '' - required: false - type: string - - name: ordering - in: query - description: Which field to use when ordering the results. - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/Schematisation' - tags: - - v3 - post: - operationId: schematisations_create - description: Manage schematisations - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Schematisation' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Schematisation' - tags: - - v3 - parameters: [] - /v3/schematisations/{id}/: - get: - operationId: schematisations_read - description: Manage schematisations - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Schematisation' - tags: - - v3 - put: - operationId: schematisations_update - description: Manage schematisations - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Schematisation' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Schematisation' - tags: - - v3 - patch: - operationId: schematisations_partial_update - description: Manage schematisations - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Schematisation' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Schematisation' - tags: - - v3 - delete: - operationId: schematisations_delete - description: Archive schematisation. - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this schematisation. - required: true - type: integer - /v3/schematisations/{id}/latest-revision/: - get: - operationId: schematisations_latest_revision - summary: Get the latest committed revision. - description: 'For retrieving all revisions use: `/schematisations/{id}/revisions`' - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/SchematisationRevision' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this schematisation. - required: true - type: integer - /v3/schematisations/{schematisation_pk}/revisions/: - get: - operationId: schematisations_revisions_list - description: Manage revisions of schematisations. - parameters: - - name: number - in: query - description: '' - required: false - type: number - - name: commit_message - in: query - description: '' - required: false - type: string - - name: commit_message__iexact - in: query - description: '' - required: false - type: string - - name: commit_message__contains - in: query - description: '' - required: false - type: string - - name: commit_message__icontains - in: query - description: '' - required: false - type: string - - name: commit_message__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: commit_message__startswith - in: query - description: '' - required: false - type: string - - name: commit_message__istartswith - in: query - description: '' - required: false - type: string - - name: commit_message__endswith - in: query - description: '' - required: false - type: string - - name: commit_message__regex - in: query - description: '' - required: false - type: string - - name: schematisation__id - in: query - description: '' - required: false - type: number - - name: schematisation__slug - in: query - description: '' - required: false - type: string - - name: schematisation__slug__iexact - in: query - description: '' - required: false - type: string - - name: schematisation__slug__contains - in: query - description: '' - required: false - type: string - - name: schematisation__slug__icontains - in: query - description: '' - required: false - type: string - - name: schematisation__slug__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: schematisation__slug__startswith - in: query - description: '' - required: false - type: string - - name: schematisation__slug__istartswith - in: query - description: '' - required: false - type: string - - name: schematisation__slug__endswith - in: query - description: '' - required: false - type: string - - name: schematisation__slug__regex - in: query - description: '' - required: false - type: string - - name: schematisation__owner__name - in: query - description: '' - required: false - type: string - - name: schematisation__owner__name__iexact - in: query - description: '' - required: false - type: string - - name: schematisation__owner__name__contains - in: query - description: '' - required: false - type: string - - name: schematisation__owner__name__icontains - in: query - description: '' - required: false - type: string - - name: schematisation__owner__name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: schematisation__owner__name__startswith - in: query - description: '' - required: false - type: string - - name: schematisation__owner__name__istartswith - in: query - description: '' - required: false - type: string - - name: schematisation__owner__name__endswith - in: query - description: '' - required: false - type: string - - name: schematisation__owner__name__regex - in: query - description: '' - required: false - type: string - - name: schematisation__owner__unique_id - in: query - description: '' - required: false - type: string - - name: schematisation__owner__unique_id__iexact - in: query - description: '' - required: false - type: string - - name: schematisation__owner__unique_id__contains - in: query - description: '' - required: false - type: string - - name: schematisation__owner__unique_id__icontains - in: query - description: '' - required: false - type: string - - name: schematisation__owner__unique_id__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: schematisation__owner__unique_id__startswith - in: query - description: '' - required: false - type: string - - name: schematisation__owner__unique_id__istartswith - in: query - description: '' - required: false - type: string - - name: schematisation__owner__unique_id__endswith - in: query - description: '' - required: false - type: string - - name: schematisation__owner__unique_id__regex - in: query - description: '' - required: false - type: string - - name: commit_user__username - in: query - description: '' - required: false - type: string - - name: commit_user__username__iexact - in: query - description: '' - required: false - type: string - - name: commit_user__username__contains - in: query - description: '' - required: false - type: string - - name: commit_user__username__icontains - in: query - description: '' - required: false - type: string - - name: commit_user__username__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: commit_user__username__startswith - in: query - description: '' - required: false - type: string - - name: commit_user__username__istartswith - in: query - description: '' - required: false - type: string - - name: commit_user__username__endswith - in: query - description: '' - required: false - type: string - - name: commit_user__username__regex - in: query - description: '' - required: false - type: string - - name: commit_date - in: query - description: '' - required: false - type: string - - name: commit_date__gt - in: query - description: '' - required: false - type: string - - name: commit_date__gte - in: query - description: '' - required: false - type: string - - name: commit_date__lt - in: query - description: '' - required: false - type: string - - name: commit_date__lte - in: query - description: '' - required: false - type: string - - name: commit_date__date - in: query - description: '' - required: false - type: string - - name: commit_date__date__gt - in: query - description: '' - required: false - type: string - - name: commit_date__date__gte - in: query - description: '' - required: false - type: string - - name: commit_date__date__lt - in: query - description: '' - required: false - type: string - - name: commit_date__date__lte - in: query - description: '' - required: false - type: string - - name: commit_date__year - in: query - description: '' - required: false - type: number - - name: commit_date__year__gt - in: query - description: '' - required: false - type: number - - name: commit_date__year__gte - in: query - description: '' - required: false - type: number - - name: commit_date__year__lt - in: query - description: '' - required: false - type: number - - name: commit_date__year__lte - in: query - description: '' - required: false - type: number - - name: commit_date__month - in: query - description: '' - required: false - type: number - - name: commit_date__month__lte - in: query - description: '' - required: false - type: number - - name: commit_date__day - in: query - description: '' - required: false - type: number - - name: commit_date__day__lt - in: query - description: '' - required: false - type: number - - name: commit_date__week - in: query - description: '' - required: false - type: number - - name: commit_date__week_day - in: query - description: '' - required: false - type: number - - name: committed - in: query - description: '' - required: false - type: string - - name: archived - in: query - description: '' - required: false - type: string - - name: is_valid - in: query - description: '' - required: false - type: string - - name: has_threedimodel - in: query - description: '' - required: false - type: string - - name: ordering - in: query - description: Which field to use when ordering the results. - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/SchematisationRevision' - tags: - - v3 - post: - operationId: schematisations_revisions_create - summary: Create a new revision - description: |- - Creates a clone of the last committed revision (if present) - by default except when empty=true is passed in the data. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/CreateRevision' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/SchematisationRevision' - tags: - - v3 - parameters: - - name: schematisation_pk - in: path - required: true - type: string - /v3/schematisations/{schematisation_pk}/revisions/{id}/: - get: - operationId: schematisations_revisions_read - description: Manage revisions of schematisations. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/SchematisationRevision' - tags: - - v3 - patch: - operationId: schematisations_revisions_partial_update - description: Manage revisions of schematisations. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/UpdateRevision' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/UpdateRevision' - tags: - - v3 - delete: - operationId: schematisations_revisions_delete - description: Provide the revision id to delete the revision - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/DestroyRevision' - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this revision. - required: true - type: integer - - name: schematisation_pk - in: path - required: true - type: string - /v3/schematisations/{schematisation_pk}/revisions/{id}/check/: - post: - operationId: schematisations_revisions_check - description: Manage revisions of schematisations. - parameters: [] - responses: - '201': - description: '' - schema: - $ref: '#/definitions/RevisionTask' - '409': - description: Conflict with other task already pending - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this revision. - required: true - type: integer - - name: schematisation_pk - in: path - required: true - type: string - /v3/schematisations/{schematisation_pk}/revisions/{id}/commit/: - post: - operationId: schematisations_revisions_commit - summary: Commit the revision - description: |- - The `commit_message` can be used to describe the changes. - - The `force_as` parameter allows to override the default behaviour - of committing the revision with the already assigned revision number. - - In case another user has already committed a revision with the same - number, an HTTP 409 status code is returned. - - In this case you can either: - 1) Save the revision with a higher revision number using - `force_as` = `new_revision`, effectively overwriting changes - from the other user. - 2) Save the revision under a new schematisation using - `force_as` = `new_schematisation` and specifying - a `schematisation_name`. - - If you want to merge your changes with the changes from the - other user, you need to download his/hers revision locally and merge - it yourselves. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Commit' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/SchematisationRevision' - '409': - description: Conflict with other revision already committed - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this revision. - required: true - type: integer - - name: schematisation_pk - in: path - required: true - type: string - /v3/schematisations/{schematisation_pk}/revisions/{id}/create-threedimodel/: - post: - operationId: schematisations_revisions_create_threedimodel - description: Manage revisions of schematisations. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/CreateThreedimodel' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ThreediModel' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this revision. - required: true - type: integer - - name: schematisation_pk - in: path - required: true - type: string - /v3/schematisations/{schematisation_pk}/revisions/{id}/sqlite/delete/: - delete: - operationId: schematisations_revisions_sqlite_delete - description: Manage revisions of schematisations. - parameters: [] - responses: - '204': - description: Deleted - '404': - description: sqlite not found - '400': - description: Not allowed after commit - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this revision. - required: true - type: integer - - name: schematisation_pk - in: path - required: true - type: string - /v3/schematisations/{schematisation_pk}/revisions/{id}/sqlite/download/: - get: - operationId: schematisations_revisions_sqlite_download - description: Endpoint for downloading files. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this revision. - required: true - type: integer - - name: schematisation_pk - in: path - required: true - type: string - /v3/schematisations/{schematisation_pk}/revisions/{id}/sqlite/upload/: - post: - operationId: schematisations_revisions_sqlite_upload - summary: Endpoint for uploading the sqlite file. - description: |- - The file should preferably be zipped (deflate). - - Replaces the present sqlite file if there already exists one. - - Optional md5sum can be added to detect if the file already - has been uploaded and perform de-duplication. - (md5sum of the compressed sqlite file) - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/SqliteFileUpload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - '200': - description: '' - schema: - $ref: '#/definitions/Upload' - '400': - description: Any validation errors - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this revision. - required: true - type: integer - - name: schematisation_pk - in: path - required: true - type: string - /v3/schematisations/{schematisation_pk}/revisions/{id}/threedimodels/: - get: - operationId: schematisations_revisions_threedimodels - description: Manage revisions of schematisations. - parameters: [] - responses: - '200': - description: '' - schema: - type: array - items: - $ref: '#/definitions/ThreediModel' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this revision. - required: true - type: integer - - name: schematisation_pk - in: path - required: true - type: string - /v3/schematisations/{schematisation_pk}/revisions/{revision_pk}/rasters/: - get: - operationId: schematisations_revisions_rasters_list - description: '' - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/RevisionRaster' - tags: - - v3 - post: - operationId: schematisations_revisions_rasters_create - summary: Endpoint for creating a raster linked to a revision. - description: |- - Every raster type can be created/uploaded only once. - - Optional md5sum can be added to detect if the file already - has been uploaded and automatically perform de-duplication. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/RasterCreate' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/RevisionRaster' - tags: - - v3 - parameters: - - name: revision_pk - in: path - required: true - type: string - - name: schematisation_pk - in: path - required: true - type: string - /v3/schematisations/{schematisation_pk}/revisions/{revision_pk}/rasters/{id}/: - get: - operationId: schematisations_revisions_rasters_read - description: '' - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/RevisionRaster' - tags: - - v3 - put: - operationId: schematisations_revisions_rasters_update - description: '' - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/RevisionRaster' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/RevisionRaster' - tags: - - v3 - patch: - operationId: schematisations_revisions_rasters_partial_update - description: '' - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/RevisionRaster' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/RevisionRaster' - tags: - - v3 - delete: - operationId: schematisations_revisions_rasters_delete - description: '' - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this revision raster. - required: true - type: integer - - name: revision_pk - in: path - required: true - type: string - - name: schematisation_pk - in: path - required: true - type: string - /v3/schematisations/{schematisation_pk}/revisions/{revision_pk}/rasters/{id}/download/: - get: - operationId: schematisations_revisions_rasters_download - description: Endpoint for downloading files. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this revision raster. - required: true - type: integer - - name: revision_pk - in: path - required: true - type: string - - name: schematisation_pk - in: path - required: true - type: string - /v3/schematisations/{schematisation_pk}/revisions/{revision_pk}/rasters/{id}/upload/: - post: - operationId: schematisations_revisions_rasters_upload - description: Endpoint for uploading a raster. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this revision raster. - required: true - type: integer - - name: revision_pk - in: path - required: true - type: string - - name: schematisation_pk - in: path - required: true - type: string - /v3/schematisations/{schematisation_pk}/revisions/{revision_pk}/tasks/: - get: - operationId: schematisations_revisions_tasks_list - description: View revision tasks - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/RevisionTask' - tags: - - v3 - post: - operationId: schematisations_revisions_tasks_create - description: View revision tasks - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/RevisionTask' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/RevisionTask' - tags: - - v3 - parameters: - - name: revision_pk - in: path - required: true - type: string - - name: schematisation_pk - in: path - required: true - type: string - /v3/schematisations/{schematisation_pk}/revisions/{revision_pk}/tasks/{id}/: - get: - operationId: schematisations_revisions_tasks_read - description: View revision tasks - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/RevisionTask' - tags: - - v3 - put: - operationId: schematisations_revisions_tasks_update - description: View revision tasks - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/RevisionTask' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/RevisionTask' - tags: - - v3 - patch: - operationId: schematisations_revisions_tasks_partial_update - description: View revision tasks - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/RevisionTask' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/RevisionTask' - tags: - - v3 - delete: - operationId: schematisations_revisions_tasks_delete - description: View revision tasks - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this revision task. - required: true - type: integer - - name: revision_pk - in: path - required: true - type: string - - name: schematisation_pk - in: path - required: true - type: string - /v3/simulation-templates/: - get: - operationId: simulation-templates_list - description: '' - parameters: - - name: name - in: query - description: '' - required: false - type: string - - name: name__iexact - in: query - description: '' - required: false - type: string - - name: name__contains - in: query - description: '' - required: false - type: string - - name: name__icontains - in: query - description: '' - required: false - type: string - - name: name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: name__startswith - in: query - description: '' - required: false - type: string - - name: name__istartswith - in: query - description: '' - required: false - type: string - - name: name__endswith - in: query - description: '' - required: false - type: string - - name: name__regex - in: query - description: '' - required: false - type: string - - name: uuid - in: query - description: '' - required: false - type: string - - name: uuid__iexact - in: query - description: '' - required: false - type: string - - name: uuid__contains - in: query - description: '' - required: false - type: string - - name: uuid__icontains - in: query - description: '' - required: false - type: string - - name: uuid__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: uuid__startswith - in: query - description: '' - required: false - type: string - - name: uuid__istartswith - in: query - description: '' - required: false - type: string - - name: uuid__endswith - in: query - description: '' - required: false - type: string - - name: uuid__regex - in: query - description: '' - required: false - type: string - - name: created__date - in: query - description: '' - required: false - type: string - - name: created__date__gt - in: query - description: '' - required: false - type: string - - name: created__date__gte - in: query - description: '' - required: false - type: string - - name: created__date__lt - in: query - description: '' - required: false - type: string - - name: created__date__lte - in: query - description: '' - required: false - type: string - - name: created__year - in: query - description: '' - required: false - type: number - - name: created__year__gt - in: query - description: '' - required: false - type: number - - name: created__year__gte - in: query - description: '' - required: false - type: number - - name: created__year__lt - in: query - description: '' - required: false - type: number - - name: created__year__lte - in: query - description: '' - required: false - type: number - - name: created__month - in: query - description: '' - required: false - type: number - - name: created__month__lte - in: query - description: '' - required: false - type: number - - name: created__day - in: query - description: '' - required: false - type: number - - name: created__day__lt - in: query - description: '' - required: false - type: number - - name: simulation__threedimodel__id - in: query - description: '' - required: false - type: number - - name: simulation__threedimodel__id__range - in: query - description: Multiple values may be separated by commas. - required: false - type: number - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/Template' - tags: - - v3 - post: - operationId: simulation-templates_create - summary: Create a (optionally cloned) simulation template from the given simulation. - description: |- - A simulation template is actually nothing more than a simulation with a special status. - It's immutable after creation and only can be used to create new simulations. - - Simulations 'upgraded' to simulations templates can't be directly run. The 'from_template' endpoint - allows to create a new simulation from a template in a runnable state. - - A simulation template can be changed by first creating a simulation from it with 'from_template'. - Changing that simulation and use this endpoint to 'upgrade' it to a simulation template. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/CreateTemplate' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Template' - '400': - description: validation errors - tags: - - v3 - parameters: [] - /v3/simulation-templates/{id}/: - get: - operationId: simulation-templates_read - description: '' - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Template' - tags: - - v3 - patch: - operationId: simulation-templates_partial_update - description: '' - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/UpdateTemplate' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/UpdateTemplate' - tags: - - v3 - delete: - operationId: simulation-templates_delete - description: '' - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this template. - required: true - type: integer - /v3/simulations/: - get: - operationId: simulations_list - summary: |- - List all simulations resources. - By default the results are sorted from newest to oldest. - description: |- - The reverse this order - - ``` - ?created - ``` - In general it is possible to specify reverse orderings by prefixing - the field name with '-', like so: - - ``` - ?-id - ``` - Other fields that can be used to order the results are `name` and `id`. - - Several filter are available, for instance the creation date of - the resource. Some usage examples: - - To get all simulation resources that have been created on - Guido van Rossum's birthday - - ``` - ?created__date=1956-01-31 - ``` - - To get all simulation resources that have been created during the - 1988 UEFA European Football Championship - ``` - ?created__date__gte=1988-06-10&created__date__lte=1988-06-25 - ``` - - To get all simulation resources that have been created in the month of - the Carnation Revolution - ``` - ?created__year=1974&created__month=04 - ``` - parameters: - - name: id__contains - in: query - description: '' - required: false - type: number - - name: name - in: query - description: '' - required: false - type: string - - name: name__iexact - in: query - description: '' - required: false - type: string - - name: name__contains - in: query - description: '' - required: false - type: string - - name: name__icontains - in: query - description: '' - required: false - type: string - - name: name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: name__startswith - in: query - description: '' - required: false - type: string - - name: name__istartswith - in: query - description: '' - required: false - type: string - - name: name__endswith - in: query - description: '' - required: false - type: string - - name: name__regex - in: query - description: '' - required: false - type: string - - name: uuid - in: query - description: '' - required: false - type: string - - name: uuid__iexact - in: query - description: '' - required: false - type: string - - name: uuid__contains - in: query - description: '' - required: false - type: string - - name: uuid__icontains - in: query - description: '' - required: false - type: string - - name: uuid__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: uuid__startswith - in: query - description: '' - required: false - type: string - - name: uuid__istartswith - in: query - description: '' - required: false - type: string - - name: uuid__endswith - in: query - description: '' - required: false - type: string - - name: uuid__regex - in: query - description: '' - required: false - type: string - - name: created__date - in: query - description: '' - required: false - type: string - - name: created__date__gt - in: query - description: '' - required: false - type: string - - name: created__date__gte - in: query - description: '' - required: false - type: string - - name: created__date__lt - in: query - description: '' - required: false - type: string - - name: created__date__lte - in: query - description: '' - required: false - type: string - - name: created__year - in: query - description: '' - required: false - type: number - - name: created__year__gt - in: query - description: '' - required: false - type: number - - name: created__year__gte - in: query - description: '' - required: false - type: number - - name: created__year__lt - in: query - description: '' - required: false - type: number - - name: created__year__lte - in: query - description: '' - required: false - type: number - - name: created__month - in: query - description: '' - required: false - type: number - - name: created__month__lte - in: query - description: '' - required: false - type: number - - name: created__day - in: query - description: '' - required: false - type: number - - name: created__day__lt - in: query - description: '' - required: false - type: number - - name: user__username - in: query - description: '' - required: false - type: string - - name: user__username__istartswith - in: query - description: '' - required: false - type: string - - name: threedimodel__id - in: query - description: '' - required: false - type: number - - name: threedimodel__revision__id - in: query - description: '' - required: false - type: number - - name: organisation__unique_id - in: query - description: '' - required: false - type: string - - name: tags__in - in: query - description: '' - required: false - type: string - - name: is_template - in: query - description: '' - required: false - type: string - - name: ordering - in: query - description: Which field to use when ordering the results. - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/Simulation' - tags: - - v3 - post: - operationId: simulations_create - summary: Create a simulation resource - description: |- - There are two options to specify the desired duration for the - simulation, either by using the ``end_datetime`` **or** the - ``duration`` parameter. - - ``` - { - "name": # give the simulation a name - "tags": # add as many tags as you like: handy to find your simulation back later! - "threedimodel": # The model schema to use for the simulation by - referring to the id of the threedimodel resource - "organisation": # uuid of the organisation for which the - simulation is run - "start_datetime": # datetime (in ISO 8601 (UTC) format) for the - simulation start, e.g. "YYYY-MM-DDThh:mm:ss" - "end_datetime": # datetime (in ISO 8601 (UTC) format) for the - simulation end, e.g. "YYYY-MM-DDThh:mm:ss" - "duration": # in seconds, can be used instead of end_datetime - } - ``` - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Simulation' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Simulation' - tags: - - v3 - parameters: [] - /v3/simulations/from-template/: - post: - operationId: simulations_from_template - summary: Create a (new/cloned) simulation from a simulation template. - description: |- - There are two options to specify the desired duration for the - new simulation, either by using the ``end_datetime`` **or** the - ``duration`` parameter. - - { - "template": # source simulation template resource id - "name": # name for the new simulation. - "tags": # extra tags, added to existing simulation template tags. - "organisation": # uuid of the organisation for which the - simulation is run - "start_datetime": # datetime (in ISO 8601 (UTC) format) for the - simulation start, e.g. "YYYY-MM-DDThh:mm:ss" - "end_datetime": # datetime (in ISO 8601 (UTC) format) for the - simulation end, e.g. "YYYY-MM-DDThh:mm:ss" - "duration": # in seconds, can be used instead of end_datetime - "clone_events": # if true, clone events like rain/sources & sinks etc. - "clone_initials": # if true, clone initial waterlevels - "clone_settings": # if true, clone simulation settings, like physical settings etc. - "threedimodel_id": # copy simulation template to threedimodel - } - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/FromTemplate' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Simulation' - '400': - description: validation errors - tags: - - v3 - parameters: [] - /v3/simulations/post_processing/lizard/queue/: - get: - operationId: simulations_post_processing_lizard_queue_list - description: |- - Read-only API endpoint for viewing simulations that need to be - post-processed by Lizard (post-processing status is 'requested'). - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/PostProcessingQueue' - tags: - - v3 - parameters: [] - /v3/simulations/{id}/: - get: - operationId: simulations_read - description: '' - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Simulation' - tags: - - v3 - put: - operationId: simulations_update - description: '' - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/SimulationUpdate' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/SimulationUpdate' - tags: - - v3 - patch: - operationId: simulations_partial_update - description: '' - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/SimulationUpdate' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/SimulationUpdate' - tags: - - v3 - delete: - operationId: simulations_delete - description: '' - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this simulation. - required: true - type: integer - /v3/simulations/{id}/clone/: - post: - operationId: simulations_clone - summary: Clone the simulation. - description: Clones the simulation in a runnable state, only events & initials. - parameters: [] - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Simulation' - '400': - description: validation errors - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this simulation. - required: true - type: integer - /v3/simulations/{id}/events/: - get: - operationId: simulations_events - description: '' - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Event' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this simulation. - required: true - type: integer - /v3/simulations/{simulation_pk}/actions/: - post: - operationId: simulations_actions_create - summary: Post an action to the simulation to start, pause or end it. - description: |- - Example usage: - - To initialize a simulation (and pause) - ``` - {"name": "initialize"} - ``` - - To initialize and directly run a simulation - ``` - {"name": "start"} - ``` - Also use "start" to resume a paused simulation. - - If you want to pause the simulation automatically after a given - duration use the duration parameter - ``` - { - "name": "start", - "duration": 2500 - } - ``` - - To pause a simulation - ``` - {"name": "pause"} - ``` - Please note: The simulation will automatically be shut down after the - default timeout of 300 seconds has been reached. You can customize - this value by specifying the timeout parameter - ``` - { - "name": "pause", - "timeout": 999 - } - ``` - - To end a simulation - ``` - {"name": "shutdown"} - ``` - - To queue a simulation - ``` - {"name": "queue"} - ``` - Queued simulations will be started as soon as a session spot becomes - available. If a session spot is directly is available the simulation - will also be started immediately. The response body will then contain - `{"name": "start"}` - ``` - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Action' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Action' - '202': - description: '' - schema: - $ref: '#/definitions/Action' - '400': - description: Bad request - '429': - description: No available/free sessions - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/actions/reset_pause_timeout/: - post: - operationId: simulations_actions_reset_pause_timeout - summary: Reset the pause timeout with the new specified timeout value - description: |- - You can only reset the pause timeout when the SimulationStatus.name is - 'initialized' and SimulationStatus.paused is True. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Timeout' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Action' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/create-saved-states/stable-threshold/: - get: - operationId: simulations_create-saved-states_stable-threshold_list - description: Stable threshold SavedState - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/StableThresholdSavedState' - tags: - - v3 - post: - operationId: simulations_create-saved-states_stable-threshold_create - summary: |- - Save the state of the simulation to file when a given (set of) - variable(s) becomes stable - description: |- - Example - ``` - { - "expiry": "2020-08-15T13:02:30.317Z", - "thresholds": [ - { - "variable": "s1", - "value": 0.005 - } - ] - } - ``` - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/StableThresholdSavedState' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/StableThresholdSavedState' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/create-saved-states/stable-threshold/{id}/: - get: - operationId: simulations_create-saved-states_stable-threshold_read - description: Stable threshold SavedState - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/StableThresholdSavedState' - tags: - - v3 - put: - operationId: simulations_create-saved-states_stable-threshold_update - description: Stable threshold SavedState - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/StableThresholdSavedState' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/StableThresholdSavedState' - tags: - - v3 - patch: - operationId: simulations_create-saved-states_stable-threshold_partial_update - description: When the simulation has started this resource can not be patched. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/StableThresholdSavedState' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_create-saved-states_stable-threshold_delete - description: Stable threshold SavedState - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this saved state. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/create-saved-states/stable-threshold/{id}/upload/: - post: - operationId: simulations_create-saved-states_stable-threshold_upload - description: Stable threshold SavedState - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - '404': - description: Simulation not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this saved state. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/create-saved-states/timed/: - get: - operationId: simulations_create-saved-states_timed_list - description: Timed SavedState - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/TimedSavedStateUpdate' - tags: - - v3 - post: - operationId: simulations_create-saved-states_timed_create - summary: Save the state at a given time of the simulation to file - description: |- - ``` - { - "name": # custom name for the saved state (optional) - "tags": # add tags to the resource. Either space or comma - separated (optional) - "expiry": # datetime (in ISO 8601 (UTC) format) until the saved - state file will be kept - "time": # the state at this given time of the simulation will - be saved to file - } - ``` - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimedSavedStateUpdate' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/TimedSavedStateUpdate' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/create-saved-states/timed/{id}/: - get: - operationId: simulations_create-saved-states_timed_read - description: Timed SavedState - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TimedSavedStateUpdate' - tags: - - v3 - put: - operationId: simulations_create-saved-states_timed_update - description: Timed SavedState - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimedSavedStateUpdate' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TimedSavedStateUpdate' - tags: - - v3 - patch: - operationId: simulations_create-saved-states_timed_partial_update - description: Timed SavedState - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimedSavedStateUpdate' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_create-saved-states_timed_delete - description: Timed SavedState - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this saved state. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/create-saved-states/timed/{id}/upload/: - post: - operationId: simulations_create-saved-states_timed_upload - description: Timed SavedState - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - '404': - description: Simulation not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this saved state. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/boundaryconditions/file/: - get: - operationId: simulations_events_boundaryconditions_file_list - description: '' - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/FileBoundaryCondition' - tags: - - v3 - post: - operationId: simulations_events_boundaryconditions_file_create - summary: Endpoint for uploading a boundary-conditions file. - description: |- - The format of the filename should be ., e.g. - - `boundary_conditions_bergermeer.json` - - Every leading and trailing spaces will be removed. Other spaces are - converted to underscores and anything that is not an alphanumeric, dash, - underscore, or dot will be removed as well. - - The response provides a put_url which allows you to upload a file containing one - or more boundary-conditions. - - The uploaded file should be a JSON-file containing an array of - boundary-conditions timeseries. - - The file must contain a timeseries for each boundary condition in the - threedimodel. This is validated after upload. - - Boundary-conditions need to be added before initializing/starting - the simulation and cannot be changed once the simulation is - initialized. - - Example - ------- - - **Notes** - The ordering of the boundaries does not matter. - - ``` - [ - { - "id": 1, # sqlite boundary_1d table id - "type": "1D", # "1D" for 1d boundaries - "interpolate": false, - "values": [ - [0, 0.5], - [500, 0,8], - [1000, 0] - ] - }, - { - "id": 2, # sqlite boundary_2d table id - "type": "2D", # "2D" for 2d boundaries - "interpolate": false, - "values": [ - [0, 0,3], - [400, 0.1] - ] - }, - { - "id": 3, - "type": "2D", - "interpolate": false, - "values": [ - [0, -2.4], - [1300, 0,3], - [3000, 1.2], - [3600, 0] - ] - } - ] - ``` - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/boundaryconditions/file/{id}/: - get: - operationId: simulations_events_boundaryconditions_file_read - description: '' - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/FileBoundaryCondition' - tags: - - v3 - put: - operationId: simulations_events_boundaryconditions_file_update - description: '' - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/FileBoundaryCondition' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/FileBoundaryCondition' - tags: - - v3 - patch: - operationId: simulations_events_boundaryconditions_file_partial_update - description: '' - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/FileBoundaryCondition' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/FileBoundaryCondition' - tags: - - v3 - delete: - operationId: simulations_events_boundaryconditions_file_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this bulk boundary condition. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/boundaryconditions/file/{id}/download/: - get: - operationId: simulations_events_boundaryconditions_file_download - description: Endpoint for downloading files. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this bulk boundary condition. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/boundaryconditions/file/{id}/processed/: - put: - operationId: simulations_events_boundaryconditions_file_processed - description: '' - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/BaseEventState' - responses: - '200': - description: OK - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this bulk boundary condition. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/breaches/: - get: - operationId: simulations_events_breaches_list - description: A simple ViewSet for viewing Breaches - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/Breach' - tags: - - v3 - post: - operationId: simulations_events_breaches_create - description: |- - Create a breach during a given simulation. The `potential_breach` - parameter refers to the id of a potential location associated with the - threedimodel. A list of these locations can be retrieved at the uri - `/threedimodels/{id}/potentialbreaches/` - - The `duration_till_max_depth` parameter describes the time it takes until - the deepest point of the breach is reached. [seconds] - - `maximum_breach_depth` specifies the maximum depth of the breach - relative to the top of the levee [meters] - - `initial_width` of the breach [meters] - - `discharge_coefficient_positive` and `discharge_coefficient_negative` - are dimensionless parameters to deal with behaviour of energy loss - around a breach. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Breach' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Breach' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/breaches/{id}/: - get: - operationId: simulations_events_breaches_read - description: A simple ViewSet for viewing Breaches - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Breach' - tags: - - v3 - put: - operationId: simulations_events_breaches_update - description: A simple ViewSet for viewing Breaches - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Breach' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Breach' - tags: - - v3 - patch: - operationId: simulations_events_breaches_partial_update - description: |- - Please note: **Breach resources are not allowed to be patched after the - simulation has started** - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Breach' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_breaches_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this breach. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/lateral/constant/: - get: - operationId: simulations_events_lateral_constant_list - description: A simple ViewSet for viewing ConstantLateral - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/ConstantLateral' - tags: - - v3 - post: - operationId: simulations_events_lateral_constant_create - description: A simple ViewSet for viewing ConstantLateral - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantLateral' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/ConstantLateral' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/lateral/constant/{id}/: - get: - operationId: simulations_events_lateral_constant_read - description: A simple ViewSet for viewing ConstantLateral - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ConstantLateral' - tags: - - v3 - put: - operationId: simulations_events_lateral_constant_update - description: A simple ViewSet for viewing ConstantLateral - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantLateral' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ConstantLateral' - tags: - - v3 - patch: - operationId: simulations_events_lateral_constant_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantLateral' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_lateral_constant_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this lateral. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/lateral/constant/{id}/processed/: - put: - operationId: simulations_events_lateral_constant_processed - description: A simple ViewSet for viewing ConstantLateral - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/GridEventState' - responses: - '200': - description: OK - '400': - description: Event is already processed - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this lateral. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/lateral/file/: - get: - operationId: simulations_events_lateral_file_list - description: '' - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/FileLateral' - tags: - - v3 - post: - operationId: simulations_events_lateral_file_create - summary: Endpoint for uploading a file with one or more laterals. - description: |- - The format of the filename should be ., e.g. - - `laterals_bergermeer.json` - - Every leading and trailing spaces will be removed. Other spaces are - converted to underscores and anything that is not an alphanumeric, dash, - underscore, or dot will be removed as well. - - The response provides a put_url which allows you to upload a file containing one - or more laterals. These laterals should either be a constant- or a - timeseries-lateral, or a combination of both. See their respective endpoint for - the required fields of these laterals. - - The uploaded file should be a JSON-file containing an array of laterals. Example - of the content of such a file: - ``` - [ - { - "offset": 100, - "value": 0.05, - "duration": 300, - "units": "m3/s", - "connection_node": 5 - }, - { - "offset": 180, - "interpolate": false, - "values": [ - [0.0, 0.0002], - [900.0, 0.0], - [1200.0, 0.0001], - [1620.0, 0.0] - ], - "units": "m3/s", - "connection_node": 4 - }, - { - "offset": 0, - "value": 0.03, - "duration": 500, - "units": "m3/s", - "point": { - "type": "Point", - "coordinates": [4.70184629, 52.62586862] # longitude, latitude - } - } - ] - ``` - - The `offset` of this file-lateral-event will be applied to each individual - lateral offset in the uploaded file - - If the `periodic` field is set to `daily` the values given are used for every hour of - every day in the simulation. Exactly 25 (0-24) timeseries per entry are required like such: - "values": [ - [0.0, 0.0002], - [3600, 0.01], - ..... - - ..... - [82800, 0.15] # 3600.0 * 23 - [86400, 0.0] # 3600.0 * 24 - ] - - Only laterals with 'values' are allowed in this case. - - The **hour** (not minutes or seconds) of the simulation `start_datetime` (UTC) is taken into consideration for the first timeseries value to use. - Periodic laterals are intended for dry weather flow. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/UploadEventFile' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/UploadEventFile' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/lateral/file/{id}/: - get: - operationId: simulations_events_lateral_file_read - description: '' - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/FileLateral' - tags: - - v3 - put: - operationId: simulations_events_lateral_file_update - description: '' - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/FileLateral' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/FileLateral' - tags: - - v3 - patch: - operationId: simulations_events_lateral_file_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/FileLateral' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_lateral_file_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this bulk lateral. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/lateral/file/{id}/download/: - get: - operationId: simulations_events_lateral_file_download - description: Endpoint for downloading files. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this bulk lateral. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/lateral/file/{id}/processed/: - put: - operationId: simulations_events_lateral_file_processed - description: '' - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/BaseEventState' - responses: - '200': - description: OK - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this bulk lateral. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/lateral/timeseries/: - get: - operationId: simulations_events_lateral_timeseries_list - description: A simple ViewSet for viewing TimeseriesLateral - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/TimeseriesLateral' - tags: - - v3 - post: - operationId: simulations_events_lateral_timeseries_create - description: A simple ViewSet for viewing TimeseriesLateral - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesLateral' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/TimeseriesLateral' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/lateral/timeseries/{id}/: - get: - operationId: simulations_events_lateral_timeseries_read - description: A simple ViewSet for viewing TimeseriesLateral - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TimeseriesLateral' - tags: - - v3 - put: - operationId: simulations_events_lateral_timeseries_update - description: A simple ViewSet for viewing TimeseriesLateral - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesLateral' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TimeseriesLateral' - tags: - - v3 - patch: - operationId: simulations_events_lateral_timeseries_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesLateral' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_lateral_timeseries_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this lateral. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/lateral/timeseries/{id}/processed/: - put: - operationId: simulations_events_lateral_timeseries_processed - description: A simple ViewSet for viewing TimeseriesLateral - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/GridEventState' - responses: - '200': - description: OK - '400': - description: Event is already processed - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this lateral. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/leakage/constant/: - get: - operationId: simulations_events_leakage_constant_list - description: A simple ViewSet for viewing ConstantLeakage - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/ConstantLeakage' - tags: - - v3 - post: - operationId: simulations_events_leakage_constant_create - description: A simple ViewSet for viewing ConstantLeakage - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantLeakage' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/ConstantLeakage' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/leakage/constant/{id}/: - get: - operationId: simulations_events_leakage_constant_read - description: A simple ViewSet for viewing ConstantLeakage - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ConstantLeakage' - tags: - - v3 - put: - operationId: simulations_events_leakage_constant_update - description: A simple ViewSet for viewing ConstantLeakage - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantLeakage' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ConstantLeakage' - tags: - - v3 - patch: - operationId: simulations_events_leakage_constant_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantLeakage' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_leakage_constant_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this timeseries leakage. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/leakage/rasters/netcdf/: - get: - operationId: simulations_events_leakage_rasters_netcdf_list - description: NetCDF 4 raster leakage - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/NetCDFRasterLeakage' - tags: - - v3 - post: - operationId: simulations_events_leakage_rasters_netcdf_create - description: NetCDF 4 raster leakage - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/leakage/rasters/netcdf/{id}/: - get: - operationId: simulations_events_leakage_rasters_netcdf_read - description: NetCDF 4 raster leakage - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/NetCDFRasterLeakage' - tags: - - v3 - delete: - operationId: simulations_events_leakage_rasters_netcdf_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this file raster leakage. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/leakage/timeseries/: - get: - operationId: simulations_events_leakage_timeseries_list - description: A simple ViewSet for viewing TimeseriesLeakage - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/TimeseriesLeakage' - tags: - - v3 - post: - operationId: simulations_events_leakage_timeseries_create - description: '' - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesLeakage' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/TimeseriesLeakage' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/leakage/timeseries/netcdf/: - get: - operationId: simulations_events_leakage_timeseries_netcdf_list - description: NetCDF 4 timeseries leakage - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/NetCDFTimeseriesLeakage' - tags: - - v3 - post: - operationId: simulations_events_leakage_timeseries_netcdf_create - description: NetCDF 4 timeseries leakage - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/leakage/timeseries/netcdf/{id}/: - get: - operationId: simulations_events_leakage_timeseries_netcdf_read - description: NetCDF 4 timeseries leakage - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/NetCDFTimeseriesLeakage' - tags: - - v3 - delete: - operationId: simulations_events_leakage_timeseries_netcdf_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this file timeseries leakage. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/leakage/timeseries/{id}/: - get: - operationId: simulations_events_leakage_timeseries_read - description: A simple ViewSet for viewing TimeseriesLeakage - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TimeseriesLeakage' - tags: - - v3 - put: - operationId: simulations_events_leakage_timeseries_update - description: A simple ViewSet for viewing TimeseriesLeakage - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesLeakage' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TimeseriesLeakage' - tags: - - v3 - patch: - operationId: simulations_events_leakage_timeseries_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesLeakage' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_leakage_timeseries_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this timeseries leakage. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/rain/constant/: - get: - operationId: simulations_events_rain_constant_list - description: A simple ViewSet for viewing TimeseriesRain - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/ConstantRain' - tags: - - v3 - post: - operationId: simulations_events_rain_constant_create - description: A simple ViewSet for viewing TimeseriesRain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantRain' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/ConstantRain' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/rain/constant/{id}/: - get: - operationId: simulations_events_rain_constant_read - description: A simple ViewSet for viewing TimeseriesRain - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ConstantRain' - tags: - - v3 - put: - operationId: simulations_events_rain_constant_update - description: A simple ViewSet for viewing TimeseriesRain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantRain' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ConstantRain' - tags: - - v3 - patch: - operationId: simulations_events_rain_constant_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantRain' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_rain_constant_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this timeseries rain. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/rain/local/constant/: - get: - operationId: simulations_events_rain_local_constant_list - description: A simple ViewSet for viewing TimeseriesRain - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/ConstantLocalRain' - tags: - - v3 - post: - operationId: simulations_events_rain_local_constant_create - description: A simple ViewSet for viewing TimeseriesRain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantLocalRain' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/ConstantLocalRain' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/rain/local/constant/{id}/: - get: - operationId: simulations_events_rain_local_constant_read - description: A simple ViewSet for viewing TimeseriesRain - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ConstantLocalRain' - tags: - - v3 - put: - operationId: simulations_events_rain_local_constant_update - description: A simple ViewSet for viewing TimeseriesRain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantLocalRain' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ConstantLocalRain' - tags: - - v3 - patch: - operationId: simulations_events_rain_local_constant_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantLocalRain' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_rain_local_constant_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this local rain. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/rain/local/timeseries/: - get: - operationId: simulations_events_rain_local_timeseries_list - description: A simple ViewSet for viewing TimeseriesLateral - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/TimeseriesLocalRain' - tags: - - v3 - post: - operationId: simulations_events_rain_local_timeseries_create - description: A simple ViewSet for viewing TimeseriesLateral - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesLocalRain' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/TimeseriesLocalRain' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/rain/local/timeseries/{id}/: - get: - operationId: simulations_events_rain_local_timeseries_read - description: A simple ViewSet for viewing TimeseriesLateral - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TimeseriesLocalRain' - tags: - - v3 - put: - operationId: simulations_events_rain_local_timeseries_update - description: A simple ViewSet for viewing TimeseriesLateral - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesLocalRain' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TimeseriesLocalRain' - tags: - - v3 - patch: - operationId: simulations_events_rain_local_timeseries_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesLocalRain' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_rain_local_timeseries_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this local rain. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/rain/rasters/lizard/: - get: - operationId: simulations_events_rain_rasters_lizard_list - description: A simple ViewSet for viewing lizardRasterRain - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/LizardRasterRain' - tags: - - v3 - post: - operationId: simulations_events_rain_rasters_lizard_create - description: A simple ViewSet for viewing lizardRasterRain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/LizardRasterRain' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/LizardRasterRain' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/rain/rasters/lizard/{id}/: - get: - operationId: simulations_events_rain_rasters_lizard_read - description: A simple ViewSet for viewing lizardRasterRain - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/LizardRasterRain' - tags: - - v3 - put: - operationId: simulations_events_rain_rasters_lizard_update - description: A simple ViewSet for viewing lizardRasterRain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/LizardRasterRain' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/LizardRasterRain' - tags: - - v3 - patch: - operationId: simulations_events_rain_rasters_lizard_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/LizardRasterRain' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_rain_rasters_lizard_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this lizard raster rain. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/rain/rasters/netcdf/: - get: - operationId: simulations_events_rain_rasters_netcdf_list - description: NetCDF 4 raster rain - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/NetCDFRasterRain' - tags: - - v3 - post: - operationId: simulations_events_rain_rasters_netcdf_create - description: NetCDF 4 raster rain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/rain/rasters/netcdf/{id}/: - get: - operationId: simulations_events_rain_rasters_netcdf_read - description: NetCDF 4 raster rain - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/NetCDFRasterRain' - tags: - - v3 - put: - operationId: simulations_events_rain_rasters_netcdf_update - description: NetCDF 4 raster rain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/NetCDFRasterRain' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/NetCDFRasterRain' - tags: - - v3 - patch: - operationId: simulations_events_rain_rasters_netcdf_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/NetCDFRasterRain' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_rain_rasters_netcdf_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this file raster rain. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/rain/timeseries/: - get: - operationId: simulations_events_rain_timeseries_list - description: A simple ViewSet for viewing TimeseriesRain - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/TimeseriesRain' - tags: - - v3 - post: - operationId: simulations_events_rain_timeseries_create - description: A simple ViewSet for viewing TimeseriesRain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesRain' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/TimeseriesRain' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/rain/timeseries/lizard/: - get: - operationId: simulations_events_rain_timeseries_lizard_list - description: A simple ViewSet for viewing LizardTimeseriesRain - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/LizardTimeseriesRain' - tags: - - v3 - post: - operationId: simulations_events_rain_timeseries_lizard_create - description: A simple ViewSet for viewing LizardTimeseriesRain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/LizardTimeseriesRain' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/LizardTimeseriesRain' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/rain/timeseries/lizard/{id}/: - get: - operationId: simulations_events_rain_timeseries_lizard_read - description: A simple ViewSet for viewing LizardTimeseriesRain - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/LizardTimeseriesRain' - tags: - - v3 - put: - operationId: simulations_events_rain_timeseries_lizard_update - description: A simple ViewSet for viewing LizardTimeseriesRain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/LizardTimeseriesRain' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/LizardTimeseriesRain' - tags: - - v3 - patch: - operationId: simulations_events_rain_timeseries_lizard_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/LizardTimeseriesRain' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_rain_timeseries_lizard_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this lizard timeseries rain. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/rain/timeseries/netcdf/: - get: - operationId: simulations_events_rain_timeseries_netcdf_list - description: NetCDF 4 timeseries rain - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/NetCDFTimeseriesRain' - tags: - - v3 - post: - operationId: simulations_events_rain_timeseries_netcdf_create - description: NetCDF 4 timeseries rain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/rain/timeseries/netcdf/{id}/: - get: - operationId: simulations_events_rain_timeseries_netcdf_read - description: NetCDF 4 timeseries rain - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/NetCDFTimeseriesRain' - tags: - - v3 - put: - operationId: simulations_events_rain_timeseries_netcdf_update - description: NetCDF 4 timeseries rain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/NetCDFTimeseriesRain' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/NetCDFTimeseriesRain' - tags: - - v3 - patch: - operationId: simulations_events_rain_timeseries_netcdf_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/NetCDFTimeseriesRain' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_rain_timeseries_netcdf_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this file timeseries rain. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/rain/timeseries/{id}/: - get: - operationId: simulations_events_rain_timeseries_read - description: A simple ViewSet for viewing TimeseriesRain - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TimeseriesRain' - tags: - - v3 - put: - operationId: simulations_events_rain_timeseries_update - description: A simple ViewSet for viewing TimeseriesRain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesRain' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TimeseriesRain' - tags: - - v3 - patch: - operationId: simulations_events_rain_timeseries_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesRain' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_rain_timeseries_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this timeseries rain. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/raster-edits/: - get: - operationId: simulations_events_raster-edits_list - description: A simple ViewSet for viewing raster edits - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/RasterEdit' - tags: - - v3 - post: - operationId: simulations_events_raster-edits_create - description: A simple ViewSet for viewing raster edits - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/RasterEdit' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/RasterEdit' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/raster-edits/{id}/: - get: - operationId: simulations_events_raster-edits_read - description: A simple ViewSet for viewing raster edits - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/RasterEdit' - tags: - - v3 - put: - operationId: simulations_events_raster-edits_update - description: A simple ViewSet for viewing raster edits - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/RasterEdit' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/RasterEdit' - tags: - - v3 - patch: - operationId: simulations_events_raster-edits_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/RasterEdit' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_raster-edits_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this raster edit. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/raster-edits/{id}/register_related_rasters/: - get: - operationId: simulations_events_raster-edits_register_related_rasters - summary: |- - Register all related rasters in the results-api and return - read_bbox urls of the registered rasters - description: |- - Skips registering of related rasters when the simulation is not in the - state 'starting' or 'initialized'. In this case the urls will be empty - parameters: [] - responses: - '200': - description: '' - schema: - type: array - items: - $ref: '#/definitions/RasterEditUrls' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this raster edit. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/sources-sinks/constant/: - get: - operationId: simulations_events_sources-sinks_constant_list - description: A simple ViewSet for viewing ConstantSourcesSinks - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/ConstantSourcesSinks' - tags: - - v3 - post: - operationId: simulations_events_sources-sinks_constant_create - description: A simple ViewSet for viewing ConstantSourcesSinks - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantSourcesSinks' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/ConstantSourcesSinks' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/sources-sinks/constant/{id}/: - get: - operationId: simulations_events_sources-sinks_constant_read - description: A simple ViewSet for viewing ConstantSourcesSinks - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ConstantSourcesSinks' - tags: - - v3 - put: - operationId: simulations_events_sources-sinks_constant_update - description: A simple ViewSet for viewing ConstantSourcesSinks - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantSourcesSinks' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ConstantSourcesSinks' - tags: - - v3 - patch: - operationId: simulations_events_sources-sinks_constant_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantSourcesSinks' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_sources-sinks_constant_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this timeseries sources sinks. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/sources-sinks/rasters/lizard/: - get: - operationId: simulations_events_sources-sinks_rasters_lizard_list - description: A simple ViewSet for viewing lizardRasterRain - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/LizardRasterSourcesSinks' - tags: - - v3 - post: - operationId: simulations_events_sources-sinks_rasters_lizard_create - description: A simple ViewSet for viewing lizardRasterRain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/LizardRasterSourcesSinks' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/LizardRasterSourcesSinks' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/sources-sinks/rasters/lizard/{id}/: - get: - operationId: simulations_events_sources-sinks_rasters_lizard_read - description: A simple ViewSet for viewing lizardRasterRain - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/LizardRasterSourcesSinks' - tags: - - v3 - put: - operationId: simulations_events_sources-sinks_rasters_lizard_update - description: A simple ViewSet for viewing lizardRasterRain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/LizardRasterSourcesSinks' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/LizardRasterSourcesSinks' - tags: - - v3 - patch: - operationId: simulations_events_sources-sinks_rasters_lizard_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/LizardRasterSourcesSinks' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_sources-sinks_rasters_lizard_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this lizard raster sources - sinks. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/sources-sinks/rasters/netcdf/: - get: - operationId: simulations_events_sources-sinks_rasters_netcdf_list - description: NetCDF 4 raster sources & sinks - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/NetCDFRasterSourcesSinks' - tags: - - v3 - post: - operationId: simulations_events_sources-sinks_rasters_netcdf_create - description: NetCDF 4 raster sources & sinks - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/sources-sinks/rasters/netcdf/{id}/: - get: - operationId: simulations_events_sources-sinks_rasters_netcdf_read - description: NetCDF 4 raster sources & sinks - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/NetCDFRasterSourcesSinks' - tags: - - v3 - put: - operationId: simulations_events_sources-sinks_rasters_netcdf_update - description: NetCDF 4 raster sources & sinks - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/NetCDFRasterSourcesSinks' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/NetCDFRasterSourcesSinks' - tags: - - v3 - patch: - operationId: simulations_events_sources-sinks_rasters_netcdf_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/NetCDFRasterSourcesSinks' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_sources-sinks_rasters_netcdf_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this file raster sources sinks. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/sources-sinks/timeseries/: - get: - operationId: simulations_events_sources-sinks_timeseries_list - description: A simple ViewSet for viewing TimeseriesSourcesSinks - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/TimeseriesSourcesSinks' - tags: - - v3 - post: - operationId: simulations_events_sources-sinks_timeseries_create - description: |- - Example payload: - ``` - { - "offset": 0, - "values": [ - [ - 0, - 0.0005 - ], - [ - 300, - 0.0002 - ] - ], - "units": "m/s" - } - ``` - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesSourcesSinks' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/TimeseriesSourcesSinks' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/sources-sinks/timeseries/lizard/: - get: - operationId: simulations_events_sources-sinks_timeseries_lizard_list - description: A simple ViewSet for viewing LizardTimeseriesRain - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/LizardTimeseriesSourcesSinks' - tags: - - v3 - post: - operationId: simulations_events_sources-sinks_timeseries_lizard_create - description: A simple ViewSet for viewing LizardTimeseriesRain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/LizardTimeseriesSourcesSinks' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/LizardTimeseriesSourcesSinks' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/sources-sinks/timeseries/lizard/{id}/: - get: - operationId: simulations_events_sources-sinks_timeseries_lizard_read - description: A simple ViewSet for viewing LizardTimeseriesRain - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/LizardTimeseriesSourcesSinks' - tags: - - v3 - put: - operationId: simulations_events_sources-sinks_timeseries_lizard_update - description: A simple ViewSet for viewing LizardTimeseriesRain - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/LizardTimeseriesSourcesSinks' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/LizardTimeseriesSourcesSinks' - tags: - - v3 - patch: - operationId: simulations_events_sources-sinks_timeseries_lizard_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/LizardTimeseriesSourcesSinks' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_sources-sinks_timeseries_lizard_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this lizard timeseries sources - sinks. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/sources-sinks/timeseries/netcdf/: - get: - operationId: simulations_events_sources-sinks_timeseries_netcdf_list - description: NetCDF 4 timeseries sources & sinks - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/NetCDFTimeseriesSourcesSinks' - tags: - - v3 - post: - operationId: simulations_events_sources-sinks_timeseries_netcdf_create - description: NetCDF 4 timeseries sources & sinks - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/sources-sinks/timeseries/netcdf/{id}/: - get: - operationId: simulations_events_sources-sinks_timeseries_netcdf_read - description: NetCDF 4 timeseries sources & sinks - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/NetCDFTimeseriesSourcesSinks' - tags: - - v3 - delete: - operationId: simulations_events_sources-sinks_timeseries_netcdf_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this file timeseries sources - sinks. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/sources-sinks/timeseries/{id}/: - get: - operationId: simulations_events_sources-sinks_timeseries_read - description: A simple ViewSet for viewing TimeseriesSourcesSinks - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TimeseriesSourcesSinks' - tags: - - v3 - put: - operationId: simulations_events_sources-sinks_timeseries_update - description: A simple ViewSet for viewing TimeseriesSourcesSinks - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesSourcesSinks' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TimeseriesSourcesSinks' - tags: - - v3 - patch: - operationId: simulations_events_sources-sinks_timeseries_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesSourcesSinks' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_sources-sinks_timeseries_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this timeseries sources sinks. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/structure-control/file/: - get: - operationId: simulations_events_structure-control_file_list - description: '' - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/FileStructureControl' - tags: - - v3 - post: - operationId: simulations_events_structure-control_file_create - summary: Endpoint for uploading a file with one or more structure controls. - description: |- - The supplied filename should be include the extension, for example "bergermeer_controls.json". - - `bergermeer_controls.json` - - The response provides a put_url which may be used to upload a file containing one - or more controls. These controls are divided in memory, table and timed - structure controls. See the respective endpoints for - the required fields of these controls. - - The uploaded file should be a JSON-file containing an array of controls per control type. Example - of the content of such a file: - ``` - { - "timed": [ - { - "offset": 0, - "duration": 100, - "value": [ - 0.4, 0.8 - ], - "type": "set_discharge_coefficients", - "structure_id": 21, - "structure_type": "v2_weir" - } - ], - "memory": [ - { - "offset": 0, - "duration": 3600, - "measure_specification": { - "name": "Measurement location", - "locations": [ - { - "weight": "1.00", - "content_type": "v2_connection_node", - "content_pk": 356, - } - ], - "variable": "s1", - "operator": "<" - }, - "structure_id": 10250, - "structure_type": "v2_weir", - "type": "set_crest_level", - "value": [ - 9.05 - ], - "upper_threshold": 0.3, - "lower_threshold": 0.1, - "is_active": false, - "is_inverse": false - } - ], - "table": [ - { - "offset": 0, - "duration": 3600, - "measure_specification": { - "name": "Measurement location", - "locations": [ - { - "weight": "1.00", - "content_type": "v2_connection_node", - "content_pk": 356, - } - ], - "variable": "s1", - "operator": "<" - }, - "structure_id": 10249, - "structure_type": "v2_weir", - "type": "set_crest_level", - "values": [ - [ - 9.05, - -1.45 - ], - ] - } - ] - } - ``` - - If there are only controls of one category, the other arrays can be omitted, like for example: - ``` - { - "timed": [ - { - "offset": 0, - "duration": 100, - "value": [ - 0.4, 0.8 - ], - "type": "set_discharge_coefficients", - "structure_id": 21, - "structure_type": "v2_weir" - } - ] - } - ``` - - The `offset` supplied in the request body will be applied on top of each individual - structure control offset in the uploaded file. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/UploadEventFile' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/UploadEventFile' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/structure-control/file/{id}/: - get: - operationId: simulations_events_structure-control_file_read - description: '' - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/FileStructureControl' - tags: - - v3 - put: - operationId: simulations_events_structure-control_file_update - description: '' - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/FileStructureControl' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/FileStructureControl' - tags: - - v3 - patch: - operationId: simulations_events_structure-control_file_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/FileStructureControl' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_structure-control_file_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this bulk control. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/structure-control/file/{id}/download/: - get: - operationId: simulations_events_structure-control_file_download - description: Endpoint for downloading files. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this bulk control. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/structure-control/file/{id}/processed/: - put: - operationId: simulations_events_structure-control_file_processed - description: '' - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/BaseEventState' - responses: - '200': - description: OK - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this bulk control. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/structure-control/memory/: - get: - operationId: simulations_events_structure-control_memory_list - description: ViewSet for viewing MemoryStructureControls - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/MemoryStructureControl' - tags: - - v3 - post: - operationId: simulations_events_structure-control_memory_create - description: See tables structure endpoint for more information. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/MemoryStructureControl' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/MemoryStructureControl' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/structure-control/memory/{id}/: - get: - operationId: simulations_events_structure-control_memory_read - description: ViewSet for viewing MemoryStructureControls - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/MemoryStructureControl' - tags: - - v3 - put: - operationId: simulations_events_structure-control_memory_update - description: ViewSet for viewing MemoryStructureControls - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/MemoryStructureControl' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/MemoryStructureControl' - tags: - - v3 - patch: - operationId: simulations_events_structure-control_memory_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/MemoryStructureControl' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_structure-control_memory_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this memory structure control. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/structure-control/memory/{id}/processed/: - put: - operationId: simulations_events_structure-control_memory_processed - description: ViewSet for viewing MemoryStructureControls - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/MeasureLocationGridEventState' - responses: - '200': - description: OK - '400': - description: Event is already processed - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this memory structure control. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/structure-control/table/: - get: - operationId: simulations_events_structure-control_table_list - description: ViewSet for viewing TableStructureControls - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/TableStructureControl' - tags: - - v3 - post: - operationId: simulations_events_structure-control_table_create - description: |- - A table structure control can used to apply a certain action, e.g - increase the pump capacity of a pump station, based on the measured - values of one or more locations. - - **type** - - *for weirs and orifices* - - - set_crest_level - - set_discharge_coefficients - - *for culverts, channels and pipes* - - - set_discharge_coefficients - - *for pumps* - - - set_pump_capacity (m3/s) - - **values** - - The action table consists of one or more value pairs (threshold, action_value) - - To close/open or partially close/open a structure using the `set_discharge_coefficients` type - the values must contain **three** values. For example `[[1.2, 0.5, 0.7]]`, where - 1.2 is the threshold value - 0.5 the action value for the left flow direction - 0.7 action value for the right flow direction - - Please note: action values for `set_discharge_coefficients` type must be > 0. - - For ALL operators threshold values must be ascending, - - In most cases the measure location will be of type `v2_connection_node`. - For this location type only the variables `s1` and `vol1` apply. If your - measure location, however, is of any other type the variable must either - be `q` or `u1`. - - - For both the target structure as well as for the measure location it is - allowed to use a grid id as input directly. In this case we will check - if the structure type associated with the given id matches with the grid - administration data. - - Nonetheless, we encourage you to use the structure id (that is the id of the - structure in the model sqlite database) as input data. We will look up the - corresponding grid id for you. If the validation holds, the state of the - resource will be updated from `processing` to `valid`. Using the structure id - will enable you to re-use the structure control resource after a model revision - as a grid id will most likely change with every new grid generation. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TableStructureControl' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/TableStructureControl' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/structure-control/table/{id}/: - get: - operationId: simulations_events_structure-control_table_read - description: ViewSet for viewing TableStructureControls - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TableStructureControl' - tags: - - v3 - put: - operationId: simulations_events_structure-control_table_update - description: ViewSet for viewing TableStructureControls - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TableStructureControl' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TableStructureControl' - tags: - - v3 - patch: - operationId: simulations_events_structure-control_table_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TableStructureControl' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_structure-control_table_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this table structure control. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/structure-control/table/{id}/processed/: - put: - operationId: simulations_events_structure-control_table_processed - description: ViewSet for viewing TableStructureControls - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/MeasureLocationGridEventState' - responses: - '200': - description: OK - '400': - description: Event is already processed - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this table structure control. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/structure-control/timed/: - get: - operationId: simulations_events_structure-control_timed_list - description: A simple ViewSet for viewing TimedStructureControls - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/TimedStructureControl' - tags: - - v3 - post: - operationId: simulations_events_structure-control_timed_create - description: |- - A timed structure control allows for actively altering parameters of - structures at a given point in time of the simulation for a given - period of time. - The ``type`` parameter specifies which action should be applied to - the structure. Not all valid action types can be applied to every - structure. An overview of valid combinations: - - set_discharge_coefficients: v2_orifice, v2_weir, v2_pipe, - v2_channel, v2_culvert - set_crest_level: v2_orifice, v2_weir - set_pump_capacity: v2_pumpstation - - The value parameter must contain 1 value, except for the - ``set_discharge_coefficients``action that expects a value for - both flow directions. - - Example payload: - - ``` - { - "offset": 0, - "duration": 100, - "value": [ - 0.4, 0.8 - ], - "type": "set_discharge_coefficients", - "structure_id": 21, - "structure_type": "v2_weir" - } - ``` - - **v2_channel and v2_pipe are for internal use only. They expect a - grid_id instead of a structure_id!** - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimedStructureControl' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/TimedStructureControl' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/structure-control/timed/{id}/: - get: - operationId: simulations_events_structure-control_timed_read - description: A simple ViewSet for viewing TimedStructureControls - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TimedStructureControl' - tags: - - v3 - put: - operationId: simulations_events_structure-control_timed_update - description: A simple ViewSet for viewing TimedStructureControls - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimedStructureControl' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TimedStructureControl' - tags: - - v3 - patch: - operationId: simulations_events_structure-control_timed_partial_update - description: |- - when the simulation has started only the duration parameter might - be patched - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimedStructureControl' - responses: - '200': - description: Successfully patched the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - delete: - operationId: simulations_events_structure-control_timed_delete - description: |- - destroy resource only if the event has not yet been applied to - the associated simulation - parameters: [] - responses: - '204': - description: Successfully deleted the resource - '409': - description: Conflict with the current simulation status - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this timed structure control. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/structure-control/timed/{id}/processed/: - put: - operationId: simulations_events_structure-control_timed_processed - description: A simple ViewSet for viewing TimedStructureControls - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/GridEventState' - responses: - '200': - description: OK - '400': - description: Event is already processed - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this timed structure control. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/wind/constant/: - get: - operationId: simulations_events_wind_constant_list - description: A simple ViewSet for viewing Wind. - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/ConstantWind' - tags: - - v3 - post: - operationId: simulations_events_wind_constant_create - description: |- - A constant wind event allows for wind forcing at a given point in - time of the simulation for a given period of time. - No distinction is made (yet) between the 1D and 2D model domain. - - The ``units`` parameter is the wind speed unit ('m/s' or 'km/h'). - - The ``direction_value`` parameter is the wind direction in - degrees (0-360) from the north - meteorological standard. - Thus, a direction_value of 180 represents a south wind (which - comes from the south and blows your hat towards the north. - - The ``speed_value`` parameter as well as the ``direction_value`` - must contain 1 value. Behind the the scenes these are converted - into nested array [time, speed_value, direction_value]. - This means that this payload (example): - - ``` - { - "offset": 100, - "duration": 400, - "units": "m/s", - "speed_value": 80, - "direction_value": 220 - } - ``` - - becomes an Timeseries object with values: - - ``` - { - "values": [ - [ 0, 80, 220], # time, speed, direction - [ 400, 0, 0] # time, speed, direction - ], - } - ``` - - Note that the (dimensionless) ``drag-coefficient`` is not part - of a simulation event, but part of simulation initial condition. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantWind' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/ConstantWind' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/wind/constant/{id}/: - get: - operationId: simulations_events_wind_constant_read - description: A simple ViewSet for viewing Wind. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ConstantWind' - tags: - - v3 - put: - operationId: simulations_events_wind_constant_update - description: A simple ViewSet for viewing Wind. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantWind' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ConstantWind' - tags: - - v3 - patch: - operationId: simulations_events_wind_constant_partial_update - description: A simple ViewSet for viewing Wind. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ConstantWind' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ConstantWind' - tags: - - v3 - delete: - operationId: simulations_events_wind_constant_delete - description: A simple ViewSet for viewing Wind. - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this wind. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/wind/timeseries/: - get: - operationId: simulations_events_wind_timeseries_list - description: A simple ViewSet for viewig Wind. - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/TimeseriesWind' - tags: - - v3 - post: - operationId: simulations_events_wind_timeseries_create - description: |- - Same as constant wind event but now without separate fields - for ``speed_value`` and ``direction_value``. - Instead - to avoid time-mapping issues - the field ``values`` - holds the speed and direction values: - ``` - [ - [time, speed1, direction1], - [time, speed2, direction2], - ] - ``` - - example payload: - ``` - { - "offset": 2, - "values": [ - [0, 40, 180], - [60, 35, 181] - ], - "units": "m/s", - } - ``` - - becomes an Timeseries object with values: - ``` - { - "values": [ - [ 0, 40, 180 ], - [60, 35, 181 ] - ] - } - ``` - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesWind' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/TimeseriesWind' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/events/wind/timeseries/{id}/: - get: - operationId: simulations_events_wind_timeseries_read - description: A simple ViewSet for viewig Wind. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TimeseriesWind' - tags: - - v3 - put: - operationId: simulations_events_wind_timeseries_update - description: A simple ViewSet for viewig Wind. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesWind' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TimeseriesWind' - tags: - - v3 - patch: - operationId: simulations_events_wind_timeseries_partial_update - description: A simple ViewSet for viewig Wind. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeseriesWind' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TimeseriesWind' - tags: - - v3 - delete: - operationId: simulations_events_wind_timeseries_delete - description: A simple ViewSet for viewig Wind. - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this wind. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/1d_water_level/constant/: - get: - operationId: simulations_initial_1d_water_level_constant_list - description: Initial 1D water levels - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/OneDWaterLevel' - tags: - - v3 - post: - operationId: simulations_initial_1d_water_level_constant_create - description: Start the simulation with a global 1D water level - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/OneDWaterLevel' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/OneDWaterLevel' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/1d_water_level/constant/{id}/: - get: - operationId: simulations_initial_1d_water_level_constant_read - description: Initial 1D water levels - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/OneDWaterLevel' - tags: - - v3 - put: - operationId: simulations_initial_1d_water_level_constant_update - description: Initial 1D water levels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/OneDWaterLevel' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/OneDWaterLevel' - tags: - - v3 - patch: - operationId: simulations_initial_1d_water_level_constant_partial_update - description: Initial 1D water levels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/OneDWaterLevel' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/OneDWaterLevel' - tags: - - v3 - delete: - operationId: simulations_initial_1d_water_level_constant_delete - description: Initial 1D water levels - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this one d water level. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/1d_water_level/file/: - get: - operationId: simulations_initial_1d_water_level_file_list - description: Initial 1D water levels - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/OneDWaterLevelFile' - tags: - - v3 - post: - operationId: simulations_initial_1d_water_level_file_create - description: |- - Start the simulation with a 1D water levels from a file. Applies the - given values to the predefined nodes subset "1D" - as described in the [threedigrid documentation] [ref] - - [ref]: https://threedigrid.readthedocs.io/en/latest/api.html#subsets - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/OneDWaterLevelFile' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/OneDWaterLevelFile' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/1d_water_level/file/{id}/: - get: - operationId: simulations_initial_1d_water_level_file_read - description: Initial 1D water levels - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/OneDWaterLevelFile' - tags: - - v3 - put: - operationId: simulations_initial_1d_water_level_file_update - description: Initial 1D water levels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/OneDWaterLevelFile' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/OneDWaterLevelFile' - tags: - - v3 - patch: - operationId: simulations_initial_1d_water_level_file_partial_update - description: Initial 1D water levels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/OneDWaterLevelFile' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/OneDWaterLevelFile' - tags: - - v3 - delete: - operationId: simulations_initial_1d_water_level_file_delete - description: Initial 1D water levels - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this one d water level file. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/1d_water_level/predefined/: - get: - operationId: simulations_initial_1d_water_level_predefined_list - description: initial predefined 1D water levels - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/OneDWaterLevelPredefined' - tags: - - v3 - post: - operationId: simulations_initial_1d_water_level_predefined_create - summary: This endpoint is pending deprecation. - description: |- - For threedimodels that came from a repository on models.lizard.net: - Start the simulation with predefined 1D water levels. That is, - use the initial water levels that have been specified in the - ``v2_connection_nodes`` schema. - - For threedimodels that came from a schematisation in this API, there - might be a threedimodels/{}/initial_waterlevels 1D resource. If such - a resource exists, there will also be a /file initial condition - created. The /predefined resource will still be created but is - ignored by the simulation. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/OneDWaterLevelPredefined' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/OneDWaterLevelPredefined' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/1d_water_level/predefined/{id}/: - get: - operationId: simulations_initial_1d_water_level_predefined_read - description: initial predefined 1D water levels - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/OneDWaterLevelPredefined' - tags: - - v3 - put: - operationId: simulations_initial_1d_water_level_predefined_update - description: initial predefined 1D water levels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/OneDWaterLevelPredefined' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/OneDWaterLevelPredefined' - tags: - - v3 - patch: - operationId: simulations_initial_1d_water_level_predefined_partial_update - description: initial predefined 1D water levels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/OneDWaterLevelPredefined' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/OneDWaterLevelPredefined' - tags: - - v3 - delete: - operationId: simulations_initial_1d_water_level_predefined_delete - description: initial predefined 1D water levels - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this one d water level predefined. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/2d_water_level/constant/: - get: - operationId: simulations_initial_2d_water_level_constant_list - description: Initial 2D water levels - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/TwoDWaterLevel' - tags: - - v3 - post: - operationId: simulations_initial_2d_water_level_constant_create - description: |- - Start the simulation with a global 2D water level. Applies the - given value to the predefined nodes subset "2D_OPEN_WATER" - as described in the [threedigrid documentation] [ref] - - [ref]: https://threedigrid.readthedocs.io/en/latest/api.html#subsets - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TwoDWaterLevel' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/TwoDWaterLevel' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/2d_water_level/constant/{id}/: - get: - operationId: simulations_initial_2d_water_level_constant_read - description: Initial 2D water levels - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TwoDWaterLevel' - tags: - - v3 - put: - operationId: simulations_initial_2d_water_level_constant_update - description: Initial 2D water levels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TwoDWaterLevel' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TwoDWaterLevel' - tags: - - v3 - patch: - operationId: simulations_initial_2d_water_level_constant_partial_update - description: Initial 2D water levels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TwoDWaterLevel' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TwoDWaterLevel' - tags: - - v3 - delete: - operationId: simulations_initial_2d_water_level_constant_delete - description: Initial 2D water levels - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this two d water level. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/2d_water_level/raster/: - get: - operationId: simulations_initial_2d_water_level_raster_list - description: Initial 2D water raster - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/TwoDWaterRaster' - tags: - - v3 - post: - operationId: simulations_initial_2d_water_level_raster_create - description: |- - Start the simulation with 2D water levels derived from the raster by - using the aggregation method. Applies the resulting levels - to the predefined nodes subset "2D_OPEN_WATER" - as described in the [threedigrid documentation] [ref] - - [ref]: https://threedigrid.readthedocs.io/en/latest/api.html#subsets - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TwoDWaterRaster' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/TwoDWaterRaster' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/2d_water_level/raster/{id}/: - get: - operationId: simulations_initial_2d_water_level_raster_read - description: Initial 2D water raster - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TwoDWaterRaster' - tags: - - v3 - put: - operationId: simulations_initial_2d_water_level_raster_update - description: Initial 2D water raster - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TwoDWaterRaster' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TwoDWaterRaster' - tags: - - v3 - patch: - operationId: simulations_initial_2d_water_level_raster_partial_update - description: Initial 2D water raster - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TwoDWaterRaster' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TwoDWaterRaster' - tags: - - v3 - delete: - operationId: simulations_initial_2d_water_level_raster_delete - description: Initial 2D water raster - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this two d water raster. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/groundwater_level/constant/: - get: - operationId: simulations_initial_groundwater_level_constant_list - description: Initial groundwater levels. - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/GroundWaterLevel' - tags: - - v3 - post: - operationId: simulations_initial_groundwater_level_constant_create - description: |- - Start the simulation with a global 2D groundwater level. Applies the - given value to the predefined nodes subset "2D_GROUNDWATER" - as described in the [threedigrid documentation] [ref] - - [ref]: https://threedigrid.readthedocs.io/en/latest/api.html#subsets - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/GroundWaterLevel' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/GroundWaterLevel' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/groundwater_level/constant/{id}/: - get: - operationId: simulations_initial_groundwater_level_constant_read - description: Initial groundwater levels. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/GroundWaterLevel' - tags: - - v3 - put: - operationId: simulations_initial_groundwater_level_constant_update - description: Initial groundwater levels. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/GroundWaterLevel' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/GroundWaterLevel' - tags: - - v3 - patch: - operationId: simulations_initial_groundwater_level_constant_partial_update - description: Initial groundwater levels. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/GroundWaterLevel' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/GroundWaterLevel' - tags: - - v3 - delete: - operationId: simulations_initial_groundwater_level_constant_delete - description: Initial groundwater levels. - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this ground water level. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/groundwater_level/raster/: - get: - operationId: simulations_initial_groundwater_level_raster_list - description: Initial 2D water raster - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/GroundWaterRaster' - tags: - - v3 - post: - operationId: simulations_initial_groundwater_level_raster_create - description: |- - Start the simulation with groundwaterlevels derived from the raster by - using the aggregation method. Applies the - given value to the predefined nodes subset "2D_GROUNDWATER" - as described in the [threedigrid documentation] [ref] - - [ref]: https://threedigrid.readthedocs.io/en/latest/api.html#subsets - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/GroundWaterRaster' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/GroundWaterRaster' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/groundwater_level/raster/{id}/: - get: - operationId: simulations_initial_groundwater_level_raster_read - description: Initial 2D water raster - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/GroundWaterRaster' - tags: - - v3 - put: - operationId: simulations_initial_groundwater_level_raster_update - description: Initial 2D water raster - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/GroundWaterRaster' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/GroundWaterRaster' - tags: - - v3 - patch: - operationId: simulations_initial_groundwater_level_raster_partial_update - description: Initial 2D water raster - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/GroundWaterRaster' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/GroundWaterRaster' - tags: - - v3 - delete: - operationId: simulations_initial_groundwater_level_raster_delete - description: Initial 2D water raster - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this ground water raster. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/saved_state/: - get: - operationId: simulations_initial_saved_state_list - description: A simple ViewSet for initial SavedState's - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/InitialSavedState' - tags: - - v3 - post: - operationId: simulations_initial_saved_state_create - description: A simple ViewSet for initial SavedState's - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/InitialSavedState' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/InitialSavedState' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/saved_state/{id}/: - get: - operationId: simulations_initial_saved_state_read - description: A simple ViewSet for initial SavedState's - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/InitialSavedState' - tags: - - v3 - put: - operationId: simulations_initial_saved_state_update - description: A simple ViewSet for initial SavedState's - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/InitialSavedState' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/InitialSavedState' - tags: - - v3 - patch: - operationId: simulations_initial_saved_state_partial_update - description: A simple ViewSet for initial SavedState's - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/InitialSavedState' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/InitialSavedState' - tags: - - v3 - delete: - operationId: simulations_initial_saved_state_delete - description: A simple ViewSet for initial SavedState's - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this initial saved state. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/wind_drag-coefficient/: - get: - operationId: simulations_initial_wind_drag-coefficient_list - description: A simple ViewSet for initial Wind drag coefficient - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/WindDragCoefficient' - tags: - - v3 - post: - operationId: simulations_initial_wind_drag-coefficient_create - description: |- - Start the simulation with a global wind drag-coefficient. This - (dimensionless) ``drag-coefficient`` translates the wind speed - on a 10 m elevation to the speed on the ground (default=0.005). - Currently the drag-coefficient works as a global factor for - the entire model: 1D lines and 2D lines if exists - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/WindDragCoefficient' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/WindDragCoefficient' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/initial/wind_drag-coefficient/{id}/: - get: - operationId: simulations_initial_wind_drag-coefficient_read - description: A simple ViewSet for initial Wind drag coefficient - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/WindDragCoefficient' - tags: - - v3 - put: - operationId: simulations_initial_wind_drag-coefficient_update - description: A simple ViewSet for initial Wind drag coefficient - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/WindDragCoefficient' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/WindDragCoefficient' - tags: - - v3 - patch: - operationId: simulations_initial_wind_drag-coefficient_partial_update - description: A simple ViewSet for initial Wind drag coefficient - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/WindDragCoefficient' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/WindDragCoefficient' - tags: - - v3 - delete: - operationId: simulations_initial_wind_drag-coefficient_delete - description: A simple ViewSet for initial Wind drag coefficient - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this wind drag coefficient. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/progress/: - get: - operationId: simulations_progress_list - description: A simple ViewSet for viewing simulations - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Progress' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/results/files/: - get: - operationId: simulations_results_files_list - description: Retrieve simulation results - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/ResultFile' - tags: - - v3 - post: - operationId: simulations_results_files_create - description: Retrieve simulation results - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ResultFile' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/ResultFile' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/results/files/{id}/: - get: - operationId: simulations_results_files_read - description: Retrieve simulation results - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ResultFile' - tags: - - v3 - put: - operationId: simulations_results_files_update - description: Retrieve simulation results - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ResultFile' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ResultFile' - tags: - - v3 - patch: - operationId: simulations_results_files_partial_update - description: Retrieve simulation results - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ResultFile' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ResultFile' - tags: - - v3 - delete: - operationId: simulations_results_files_delete - description: Retrieve simulation results - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this result file. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/results/files/{id}/download/: - get: - operationId: simulations_results_files_download - description: Endpoint for downloading files. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this result file. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/results/files/{id}/upload/: - post: - operationId: simulations_results_files_upload - description: Endpoint for uploading a result file - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - '404': - description: Simulation not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this result file. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/results/post_processing/lizard/arrival/: - get: - operationId: simulations_results_post_processing_lizard_arrival_list - description: |- - A Custom ViewSet for creating, listing or deleting an - ArrivalTimePostProcessing resource. It includes a custom destroy - action (with detail=False) as a BasicPostProcessing object can - have only one ArrivalTimePostProcessing object. An - ArrivalTimePostProcessing resource is created with an empty POST. - - Three conditions are validated when creating an resource: - - The simulation may not already have an ArrivalTimePostProcessing resource. - - The simulation must have a BasicPostProcessing resource with 'process_basic_results'=True. - - Lizard may not already have been triggered to processing this simulation. - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '404': - description: resource arrival time not found - '200': - description: '' - schema: - $ref: '#/definitions/ArrivalTimePostProcessing' - tags: - - v3 - post: - operationId: simulations_results_post_processing_lizard_arrival_create - description: |- - A Custom ViewSet for creating, listing or deleting an - ArrivalTimePostProcessing resource. It includes a custom destroy - action (with detail=False) as a BasicPostProcessing object can - have only one ArrivalTimePostProcessing object. An - ArrivalTimePostProcessing resource is created with an empty POST. - - Three conditions are validated when creating an resource: - - The simulation may not already have an ArrivalTimePostProcessing resource. - - The simulation must have a BasicPostProcessing resource with 'process_basic_results'=True. - - Lizard may not already have been triggered to processing this simulation. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ArrivalTimePostProcessing' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/ArrivalTimePostProcessing' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/results/post_processing/lizard/arrival/delete/: - delete: - operationId: simulations_results_post_processing_lizard_arrival_delete - description: |- - A Custom ViewSet for creating, listing or deleting an - ArrivalTimePostProcessing resource. It includes a custom destroy - action (with detail=False) as a BasicPostProcessing object can - have only one ArrivalTimePostProcessing object. An - ArrivalTimePostProcessing resource is created with an empty POST. - - Three conditions are validated when creating an resource: - - The simulation may not already have an ArrivalTimePostProcessing resource. - - The simulation must have a BasicPostProcessing resource with 'process_basic_results'=True. - - Lizard may not already have been triggered to processing this simulation. - parameters: [] - responses: - '404': - description: resource arrival_time not found - '400': - description: not allowed, Lizard already started post-processing - '204': - description: deleted resource arrival_time - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/results/post_processing/lizard/basic/: - get: - operationId: simulations_results_post_processing_lizard_basic_list - description: |- - A Custom ViewSet for creating, listing or deleting - a BasicPostProcessing resource. It includes a custom - destroy action (with detail=False) as a BasicPostProcessing - object can have only one DamagePostProcessing object. - - Three conditions are validated when creating an resource: - - The simulation may not already have a BasicPostProcessing resource. - - Lizard may not already have been triggered to processing this simulation. - - The Simulation must hold a 'dem_raw_file' in case parameter 'process_basic_results' is True. - - The ``scenario_name`` parameter is optional (max 50 chars). If not - provided it becomes an empty string. - - THe ``result_uuid`` can be defined for e.g. operational models. Defaults to - an uuid4 if not provided. - - If ``process_basic_results`` (boolean) is False then: - - It is not possible to have ArrivalTimePostProcessing and DamagePostProcessing. - - Only raw_results (.nc, .log, etc) are uploaded to Lizard. - - If ``process_basic_results`` (boolean) is True then: - - It is possible to have ArrivalTimePostProcessing and DamagePostProcessing. - - raw_results are uploaded to Lizard and additional WMS layers are available on Lizard. - - Payload example - ``` - { - "scenario_name": "my_scenario_name", - "process_basic_results": True, - } - ``` - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '404': - description: resource basic postprocessing not found - '200': - description: '' - schema: - $ref: '#/definitions/BasicPostProcessing' - tags: - - v3 - post: - operationId: simulations_results_post_processing_lizard_basic_create - description: |- - A Custom ViewSet for creating, listing or deleting - a BasicPostProcessing resource. It includes a custom - destroy action (with detail=False) as a BasicPostProcessing - object can have only one DamagePostProcessing object. - - Three conditions are validated when creating an resource: - - The simulation may not already have a BasicPostProcessing resource. - - Lizard may not already have been triggered to processing this simulation. - - The Simulation must hold a 'dem_raw_file' in case parameter 'process_basic_results' is True. - - The ``scenario_name`` parameter is optional (max 50 chars). If not - provided it becomes an empty string. - - THe ``result_uuid`` can be defined for e.g. operational models. Defaults to - an uuid4 if not provided. - - If ``process_basic_results`` (boolean) is False then: - - It is not possible to have ArrivalTimePostProcessing and DamagePostProcessing. - - Only raw_results (.nc, .log, etc) are uploaded to Lizard. - - If ``process_basic_results`` (boolean) is True then: - - It is possible to have ArrivalTimePostProcessing and DamagePostProcessing. - - raw_results are uploaded to Lizard and additional WMS layers are available on Lizard. - - Payload example - ``` - { - "scenario_name": "my_scenario_name", - "process_basic_results": True, - } - ``` - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/BasicPostProcessing' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/BasicPostProcessing' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/results/post_processing/lizard/basic/delete/: - delete: - operationId: simulations_results_post_processing_lizard_basic_delete - description: |- - A Custom ViewSet for creating, listing or deleting - a BasicPostProcessing resource. It includes a custom - destroy action (with detail=False) as a BasicPostProcessing - object can have only one DamagePostProcessing object. - - Three conditions are validated when creating an resource: - - The simulation may not already have a BasicPostProcessing resource. - - Lizard may not already have been triggered to processing this simulation. - - The Simulation must hold a 'dem_raw_file' in case parameter 'process_basic_results' is True. - - The ``scenario_name`` parameter is optional (max 50 chars). If not - provided it becomes an empty string. - - THe ``result_uuid`` can be defined for e.g. operational models. Defaults to - an uuid4 if not provided. - - If ``process_basic_results`` (boolean) is False then: - - It is not possible to have ArrivalTimePostProcessing and DamagePostProcessing. - - Only raw_results (.nc, .log, etc) are uploaded to Lizard. - - If ``process_basic_results`` (boolean) is True then: - - It is possible to have ArrivalTimePostProcessing and DamagePostProcessing. - - raw_results are uploaded to Lizard and additional WMS layers are available on Lizard. - - Payload example - ``` - { - "scenario_name": "my_scenario_name", - "process_basic_results": True, - } - ``` - parameters: [] - responses: - '404': - description: resource basic_post_processing not found - '400': - description: not allowed, Lizard already started post-processing - '204': - description: deleted resource basic_post_processing - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/results/post_processing/lizard/damage/: - get: - operationId: simulations_results_post_processing_lizard_damage_list - description: |- - A Custom ViewSet for creating, listing or deleting - a DamagePostProcessing resource. It includes a custom - destroy action (with detail=False) as a BasicPostProcessing - object can have only one DamagePostProcessing object. - - Three conditions are validated when creating an resource: - - The simulation may not already have a DamagePostProcessing resource. - - The simulation must have a BasicPostProcessing resource with 'process_basic_results'=True. - - Lizard may not already have been triggered to processing this simulation. - - The ``cost_type`` parameter choices are: 'min', 'avg', 'max'. - - The ``flood_month`` parameter choices are: 'jan', 'feb', etc - - The ``inundation_period`` parameter is ime in hours (float), - min_value=1.0 - - The ``repair_time_infrastructure`` parameter is time in - hours (integer), min_value=1, max_value=240 - - The ``repair_time_buildings`` parameter is time in hours (integer), - min_value=1, max_value=240 - - Payload example - ``` - { - "cost_type": "min", - "flood_month": "jan", - "inundation_period": 12.0, - "repair_time_infrastructure": 120, - "repair_time_buildings": 240 - } - ``` - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '404': - description: resource damage_estimation not found - '200': - description: '' - schema: - $ref: '#/definitions/DamagePostProcessing' - tags: - - v3 - post: - operationId: simulations_results_post_processing_lizard_damage_create - description: |- - A Custom ViewSet for creating, listing or deleting - a DamagePostProcessing resource. It includes a custom - destroy action (with detail=False) as a BasicPostProcessing - object can have only one DamagePostProcessing object. - - Three conditions are validated when creating an resource: - - The simulation may not already have a DamagePostProcessing resource. - - The simulation must have a BasicPostProcessing resource with 'process_basic_results'=True. - - Lizard may not already have been triggered to processing this simulation. - - The ``cost_type`` parameter choices are: 'min', 'avg', 'max'. - - The ``flood_month`` parameter choices are: 'jan', 'feb', etc - - The ``inundation_period`` parameter is ime in hours (float), - min_value=1.0 - - The ``repair_time_infrastructure`` parameter is time in - hours (integer), min_value=1, max_value=240 - - The ``repair_time_buildings`` parameter is time in hours (integer), - min_value=1, max_value=240 - - Payload example - ``` - { - "cost_type": "min", - "flood_month": "jan", - "inundation_period": 12.0, - "repair_time_infrastructure": 120, - "repair_time_buildings": 240 - } - ``` - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/DamagePostProcessing' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/DamagePostProcessing' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/results/post_processing/lizard/damage/delete/: - delete: - operationId: simulations_results_post_processing_lizard_damage_delete - description: |- - A Custom ViewSet for creating, listing or deleting - a DamagePostProcessing resource. It includes a custom - destroy action (with detail=False) as a BasicPostProcessing - object can have only one DamagePostProcessing object. - - Three conditions are validated when creating an resource: - - The simulation may not already have a DamagePostProcessing resource. - - The simulation must have a BasicPostProcessing resource with 'process_basic_results'=True. - - Lizard may not already have been triggered to processing this simulation. - - The ``cost_type`` parameter choices are: 'min', 'avg', 'max'. - - The ``flood_month`` parameter choices are: 'jan', 'feb', etc - - The ``inundation_period`` parameter is ime in hours (float), - min_value=1.0 - - The ``repair_time_infrastructure`` parameter is time in - hours (integer), min_value=1, max_value=240 - - The ``repair_time_buildings`` parameter is time in hours (integer), - min_value=1, max_value=240 - - Payload example - ``` - { - "cost_type": "min", - "flood_month": "jan", - "inundation_period": 12.0, - "repair_time_infrastructure": 120, - "repair_time_buildings": 240 - } - ``` - parameters: [] - responses: - '404': - description: resource damage_estimation not found - '401': - description: not allowed, Lizard already started post-processing - '204': - description: deleted resource damage_estimation - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/results/post_processing/lizard/overview/: - get: - operationId: simulations_results_post_processing_lizard_overview_list - description: |- - Custom list that provides overview of post-processing configuration. - Below a format specification is provided. All keys always exists, - regardless post-processing config: - - ``` - { - "username": str, - "external_user_id": Optional[str], - "metadata_version": float, - "start_time_sim": datetime (UTC), - "end_time_sim": datetime (UTC), - "results": { - "basic": bool, - "damage_estimation": bool, - "arrival_time": bool - }, - "settings": { - "damage_estimation": { - "damage_table": str, - "elevation_raster_uuid": str, - "landcover_raster_uuid": str, - "road_rail_raster_uuid": str, - "cost_type": int, - "flood_month": int, - "inundation_period": int, - "repair_time_infrastructure": int, - "repair_time_buildings": int - }, - }, - "model_name": str, (=threedimodel_slug) - "simulation_name": str, (=simulation_slug) - "scenario_name": str, - "model_id": int, - "model_revision_id": str, - "email": str, - "result_uuid": str, - "organisation_uuid": str, - "simulation": int - } - ``` - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - $ref: '#/definitions/PostProcessingOverview' - '404': - description: No basic post-processing resource found - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/results/post_processing/lizard/start/: - post: - operationId: simulations_results_post_processing_lizard_start_create - description: Empty post to start Lizard post-processing for one Simulation result. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/PostProcessingStart' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/PostProcessingStart' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/results/post_processing/lizard/start/retry/: - post: - operationId: simulations_results_post_processing_lizard_start_retry - summary: Retry the Lizard post-processing - description: |- - Will only re-trigger the post-processing if the post-processing status is in - `archiving_failed`. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/PostProcessingStart' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/PostProcessingStart' - '400': - description: Bad request - '403': - description: Forbidden - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/results/post_processing/lizard/status/: - get: - operationId: simulations_results_post_processing_lizard_status_list - description: Show the latest post-processing status of one simulation. - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '404': - description: resource post_processing_status not found - '200': - description: '' - schema: - $ref: '#/definitions/PostProcessingStatus' - tags: - - v3 - post: - operationId: simulations_results_post_processing_lizard_status_create - description: |- - Endpoint to keep track of post-processing status (done by Lizard) - per Simulation result. Status is updated internal by 3Di, and once - processing starts it is updated by Lizard backend. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/PostProcessingStatus' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/PostProcessingStatus' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/results/post_processing/lizard/status/delete/: - delete: - operationId: simulations_results_post_processing_lizard_status_delete - description: |- - Endpoint to keep track of post-processing status (done by Lizard) - per Simulation result. Status is updated internal by 3Di, and once - processing starts it is updated by Lizard backend. - parameters: [] - responses: - '404': - description: resource post_processing_status not found - '204': - description: post_processing_status deleted - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/results/post_processing/lizard/status/history/: - get: - operationId: simulations_results_post_processing_lizard_status_history_list - description: '' - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/PostProcessingStatus' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/settings/aggregation/: - get: - operationId: simulations_settings_aggregation_list - summary: Simulation aggregation settings. - description: |- - For a consistent water balance often the results of various snap shots - - as provided by the results_3di.nc file - are not enough. Especially in case - of an time step setting that is larger than the computational time step. - For this purpose, an aggregated results file is available called - aggregate_results_3di.nc. The structure of the file is very similar to the - other result file. Each Mesh variable (s1, u1, etc.) described in the results - section can be aggregated. - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/AggregationSettings' - tags: - - v3 - post: - operationId: simulations_settings_aggregation_create - summary: Simulation aggregation settings. - description: |- - For a consistent water balance often the results of various snap shots - - as provided by the results_3di.nc file - are not enough. Especially in case - of an time step setting that is larger than the computational time step. - For this purpose, an aggregated results file is available called - aggregate_results_3di.nc. The structure of the file is very similar to the - other result file. Each Mesh variable (s1, u1, etc.) described in the results - section can be aggregated. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/AggregationSettings' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/AggregationSettings' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/settings/aggregation/{id}/: - get: - operationId: simulations_settings_aggregation_read - summary: Simulation aggregation settings. - description: |- - For a consistent water balance often the results of various snap shots - - as provided by the results_3di.nc file - are not enough. Especially in case - of an time step setting that is larger than the computational time step. - For this purpose, an aggregated results file is available called - aggregate_results_3di.nc. The structure of the file is very similar to the - other result file. Each Mesh variable (s1, u1, etc.) described in the results - section can be aggregated. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/AggregationSettings' - tags: - - v3 - put: - operationId: simulations_settings_aggregation_update - summary: Simulation aggregation settings. - description: |- - For a consistent water balance often the results of various snap shots - - as provided by the results_3di.nc file - are not enough. Especially in case - of an time step setting that is larger than the computational time step. - For this purpose, an aggregated results file is available called - aggregate_results_3di.nc. The structure of the file is very similar to the - other result file. Each Mesh variable (s1, u1, etc.) described in the results - section can be aggregated. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/AggregationSettings' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/AggregationSettings' - tags: - - v3 - patch: - operationId: simulations_settings_aggregation_partial_update - summary: Simulation aggregation settings. - description: |- - For a consistent water balance often the results of various snap shots - - as provided by the results_3di.nc file - are not enough. Especially in case - of an time step setting that is larger than the computational time step. - For this purpose, an aggregated results file is available called - aggregate_results_3di.nc. The structure of the file is very similar to the - other result file. Each Mesh variable (s1, u1, etc.) described in the results - section can be aggregated. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/AggregationSettings' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/AggregationSettings' - tags: - - v3 - delete: - operationId: simulations_settings_aggregation_delete - summary: Simulation aggregation settings. - description: |- - For a consistent water balance often the results of various snap shots - - as provided by the results_3di.nc file - are not enough. Especially in case - of an time step setting that is larger than the computational time step. - For this purpose, an aggregated results file is available called - aggregate_results_3di.nc. The structure of the file is very similar to the - other result file. Each Mesh variable (s1, u1, etc.) described in the results - section can be aggregated. - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this aggregation settings. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/settings/numerical/: - post: - operationId: simulations_settings_numerical_create - description: create a numerical settings resource - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/NumericalSettings' - responses: - '200': - description: OK - '400': - description: Bad request - '404': - description: Resource not found - '409': - description: Conflict with current state - tags: - - v3 - put: - operationId: simulations_settings_numerical_update - description: update the numerical settings resource - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/NumericalSettings' - responses: - '200': - description: OK - '404': - description: Resource not found - '409': - description: Conflict with current state - tags: - - v3 - patch: - operationId: simulations_settings_numerical_partial_update - description: update the numerical settings resource - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/NumericalSettings' - responses: - '200': - description: OK - '404': - description: Resource not found - '409': - description: Conflict with current state - tags: - - v3 - delete: - operationId: simulations_settings_numerical_delete - description: delete the numerical settings resource - parameters: [] - responses: - '204': - description: Resource deleted successfully - '404': - description: Resource not found - '409': - description: Conflict with current state - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/settings/overview/: - get: - operationId: simulations_settings_overview - description: Overview of the the simulation settings. - parameters: [] - responses: - '200': - description: OK - schema: - $ref: '#/definitions/SimulationSettingsOverview' - '404': - description: Resource not found - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/settings/physical/: - post: - operationId: simulations_settings_physical_create - description: Create a general settings resource. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/PhysicalSettings' - responses: - '200': - description: OK - '400': - description: Bad request - '404': - description: Resource not found - '409': - description: Conflict with current state - tags: - - v3 - put: - operationId: simulations_settings_physical_update - description: Update the general settings resource. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/PhysicalSettings' - responses: - '200': - description: OK - '404': - description: Resource not found - '409': - description: Conflict with current state - tags: - - v3 - patch: - operationId: simulations_settings_physical_partial_update - description: Update the general settings resource. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/PhysicalSettings' - responses: - '200': - description: OK - '404': - description: Resource not found - '409': - description: Conflict with current state - tags: - - v3 - delete: - operationId: simulations_settings_physical_delete - description: Delete the general settings resource. - parameters: [] - responses: - '204': - description: Resource deleted successfully - '404': - description: Resource not found - '409': - description: Conflict with current state - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/settings/time_step/: - post: - operationId: simulations_settings_time_step_create - description: create a time step settings resource - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeStepSettings' - responses: - '200': - description: OK - '400': - description: Bad request - '404': - description: Resource not found - '409': - description: Conflict with current state - tags: - - v3 - put: - operationId: simulations_settings_time_step_update - description: update the time step settings resource - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeStepSettings' - responses: - '200': - description: OK - '404': - description: Resource not found - '409': - description: Conflict with current state - tags: - - v3 - patch: - operationId: simulations_settings_time_step_partial_update - description: update the time step settings resource - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/TimeStepSettings' - responses: - '200': - description: OK - '404': - description: Resource not found - '409': - description: Conflict with current state - tags: - - v3 - delete: - operationId: simulations_settings_time_step_delete - description: delete the time step settings resource - parameters: [] - responses: - '204': - description: Resource deleted successfully - '404': - description: Resource not found - '409': - description: Conflict with current state - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/status/: - get: - operationId: simulations_status_list - description: A simple ViewSet for viewing simulations - parameters: - - name: ordering - in: query - description: Which field to use when ordering the results. - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - $ref: '#/definitions/CurrentStatus' - tags: - - v3 - post: - operationId: simulations_status_create - description: A simple ViewSet for viewing simulations - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/SimulationStatus' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/SimulationStatus' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/status/history/: - get: - operationId: simulations_status_history_list - description: '' - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/SimulationStatus' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/status/history/{id}/: - get: - operationId: simulations_status_history_read - description: '' - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/SimulationStatus' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this simulation status. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/status/patch/: - patch: - operationId: simulations_status_patch - description: A simple ViewSet for viewing simulations - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/SimulationStatus' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/SimulationStatus' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/status/{id}/: - put: - operationId: simulations_status_update - description: A simple ViewSet for viewing simulations - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/SimulationStatus' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/SimulationStatus' - tags: - - v3 - patch: - operationId: simulations_status_partial_update - description: A simple ViewSet for viewing simulations - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/SimulationStatus' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/SimulationStatus' - tags: - - v3 - delete: - operationId: simulations_status_delete - description: A simple ViewSet for viewing simulations - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this simulation status. - required: true - type: integer - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/visualisations/breach_graph/: - post: - operationId: simulations_visualisations_breach_graph_create - summary: Get a websocket URL returning breaches (graph) data - description: |- - The websocket-url in the response returns binary data - messages consisting of timestamp, breach_width, - breach_depth, q (discharge), au (wet cross-sectional area) - as float32 data. - - The values are alternated like: - [timestamp, breach_width, breach_depth, q, au ... - timestamp_N, breach_width_N, breach_depth_N, q_N, au_N] - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/BreachGraphRequest' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/BreachGraph' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/visualisations/pump_discharge_graph/: - post: - operationId: simulations_visualisations_pump_discharge_graph_create - summary: Get a websocket URL returning pump discharge (graph) data - description: |- - The websocket-url in the response returns binary data - messages consisting of timestamp, q_pump (discharge) - float32 data. The values are alternated like: - [timestamp, q_pump, timestamp_2, q_pump_2... timestamp_N, q_pump_N] - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/PumpDischargeGraphRequest' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/PumpDischargeGraph' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/visualisations/rain_graph/: - post: - operationId: simulations_visualisations_rain_graph_create - summary: Get a websocket URL returning node rain (graph) data. - description: |- - The websocket-url in the response returns binary data - messages consisting of timestamp and rain float32 data. - The values are alternated like: - [timestamp, rain, timestamp_2, rain_2... timestamp_N, rain_N] - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/RainGraphRequest' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/RainGraph' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/visualisations/water_flow_graph/: - post: - operationId: simulations_visualisations_water_flow_graph_create - summary: Get a websocket URL returning line flow (graph) data. - description: |- - The websocket-url in the response returns binary data - messages consisting of timestamp, u1 (velocity), q (discharge) - float32 data. The values are alternated like: - [timestamp, u1, q, timestamp_2, u1_2, q_2... timestamp_N, u1_N, q_N] - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/WaterFlowGraphRequest' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/WaterGraph' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/visualisations/water_level_graph/: - post: - operationId: simulations_visualisations_water_level_graph_create - summary: Get a websocket URL returning node waterlevel (graph) data. - description: |- - The websocket-url in the response returns binary data - messages consisting of timestamp and waterlevel float32 data. - The values are alternated like: - [timestamp, s1, timestamp_2, s1_2... timestamp_N, s1_N] - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/WaterLevelGraphRequest' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/WaterGraph' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/visualisations/water_level_profile/: - post: - operationId: simulations_visualisations_water_level_profile_create - summary: Get a websocket URL returning waterlevel profile data. - description: |- - The websocket returns binary data messages consisting of - timestep and waterlevel float32 values in one message like: - timestep, waterlevel, waterlevel, waterlevel, waterlevel - - Groundwater waterlevel values are automatically added - (after open water) if groundwater is present. The returned - waterlevel values have length 'points_limit' * 2 in this case. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/WaterLevelProfileRequest' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/WaterLevelProfile' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/visualisations/waterdepth/: - get: - operationId: simulations_visualisations_waterdepth_list - description: '' - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Waterdepth' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/visualisations/{layer}/profile/: - get: - operationId: simulations_visualisations_profile_list - description: '' - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Profile' - tags: - - v3 - parameters: - - name: layer - in: path - required: true - type: string - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/visualisations/{layer}/tms/: - get: - operationId: simulations_visualisations_tms_list - description: '' - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - $ref: '#/definitions/TMS' - tags: - - v3 - parameters: - - name: layer - in: path - required: true - type: string - - name: simulation_pk - in: path - required: true - type: string - /v3/simulations/{simulation_pk}/websockets/: - get: - operationId: simulations_websockets_list - description: List active websocket connections for a given simulation - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/SimulationChannel' - tags: - - v3 - parameters: - - name: simulation_pk - in: path - required: true - type: string - /v3/statuses/: - get: - operationId: statuses_list - summary: Show the latest status off all simulations. - description: |- - List all simulations that ever have finished successfully - - ``` - ?name=finished - ``` - - List all simulations that have finished successfully during the week - of the 1988 UEFA European Football Championship - ``` - ?name=finished&created__date__gte=1988-06-10&created__date__lte=1988-06-25 - ``` - - The `created` field is of type date-time in ISO 8601 (UTC) format. To - get all crashed simulations since St Nicolas 2018 - - ``` - ?name=crashed&created__gte=2018-12-05T00:00:00Z - ``` - parameters: - - name: name - in: query - description: '' - required: false - type: string - - name: name__iexact - in: query - description: '' - required: false - type: string - - name: name__contains - in: query - description: '' - required: false - type: string - - name: name__icontains - in: query - description: '' - required: false - type: string - - name: name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: name__startswith - in: query - description: '' - required: false - type: string - - name: name__istartswith - in: query - description: '' - required: false - type: string - - name: name__endswith - in: query - description: '' - required: false - type: string - - name: name__regex - in: query - description: '' - required: false - type: string - - name: simulation__name - in: query - description: '' - required: false - type: string - - name: simulation__name__iexact - in: query - description: '' - required: false - type: string - - name: simulation__name__contains - in: query - description: '' - required: false - type: string - - name: simulation__name__icontains - in: query - description: '' - required: false - type: string - - name: simulation__name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: simulation__name__startswith - in: query - description: '' - required: false - type: string - - name: simulation__name__istartswith - in: query - description: '' - required: false - type: string - - name: simulation__name__endswith - in: query - description: '' - required: false - type: string - - name: simulation__name__regex - in: query - description: '' - required: false - type: string - - name: simulation__compute_cluster__name - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__slug - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__slug__iexact - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__slug__contains - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__slug__icontains - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__slug__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: simulation__threedimodel__slug__startswith - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__slug__istartswith - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__slug__endswith - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__slug__regex - in: query - description: '' - required: false - type: string - - name: created - in: query - description: '' - required: false - type: string - - name: created__gt - in: query - description: '' - required: false - type: string - - name: created__gte - in: query - description: '' - required: false - type: string - - name: created__lt - in: query - description: '' - required: false - type: string - - name: created__lte - in: query - description: '' - required: false - type: string - - name: created__date - in: query - description: '' - required: false - type: string - - name: created__date__gt - in: query - description: '' - required: false - type: string - - name: created__date__gte - in: query - description: '' - required: false - type: string - - name: created__date__lt - in: query - description: '' - required: false - type: string - - name: created__date__lte - in: query - description: '' - required: false - type: string - - name: created__year - in: query - description: '' - required: false - type: number - - name: created__year__gt - in: query - description: '' - required: false - type: number - - name: created__year__gte - in: query - description: '' - required: false - type: number - - name: created__year__lt - in: query - description: '' - required: false - type: number - - name: created__year__lte - in: query - description: '' - required: false - type: number - - name: created__month - in: query - description: '' - required: false - type: number - - name: created__month__lte - in: query - description: '' - required: false - type: number - - name: created__day - in: query - description: '' - required: false - type: number - - name: created__day__lt - in: query - description: '' - required: false - type: number - - name: created__week - in: query - description: '' - required: false - type: number - - name: created__week_day - in: query - description: '' - required: false - type: number - - name: id - in: query - description: '' - required: false - type: number - - name: id__gt - in: query - description: '' - required: false - type: number - - name: id__gte - in: query - description: '' - required: false - type: number - - name: id__lt - in: query - description: '' - required: false - type: number - - name: id__lte - in: query - description: '' - required: false - type: number - - name: id__isnull - in: query - description: '' - required: false - type: string - - name: exit_code - in: query - description: '' - required: false - type: string - - name: exit_code__gt - in: query - description: '' - required: false - type: number - - name: exit_code__gte - in: query - description: '' - required: false - type: number - - name: exit_code__lt - in: query - description: '' - required: false - type: number - - name: exit_code__lte - in: query - description: '' - required: false - type: number - - name: exit_code__isnull - in: query - description: '' - required: false - type: string - - name: simulation_id__in - in: query - description: Multiple values may be separated by commas. - required: false - type: number - - name: simulation__user__username - in: query - description: '' - required: false - type: string - - name: simulation__type__live - in: query - description: '' - required: false - type: string - - name: simulation__tags__contains - in: query - description: '' - required: false - type: string - - name: simulation__organisation__name__istartswith - in: query - description: '' - required: false - type: string - - name: simulation__organisation__unique_id - in: query - description: '' - required: false - type: string - - name: ordering - in: query - description: Which field to use when ordering the results. - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/SimulationStatus' - tags: - - v3 - parameters: [] - /v3/statuses/statistics/: - get: - operationId: statuses_statistics - summary: |- - Count of (latest/final) simulation statuses. Combine with filters to - get your weekly/monthly etc statistics - description: |- - For example, to get a count of finished simulations in 2020 - - ``` - ?name=finished&created__year=2020 - parameters: - - name: name - in: query - description: '' - required: false - type: string - - name: name__iexact - in: query - description: '' - required: false - type: string - - name: name__contains - in: query - description: '' - required: false - type: string - - name: name__icontains - in: query - description: '' - required: false - type: string - - name: name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: name__startswith - in: query - description: '' - required: false - type: string - - name: name__istartswith - in: query - description: '' - required: false - type: string - - name: name__endswith - in: query - description: '' - required: false - type: string - - name: name__regex - in: query - description: '' - required: false - type: string - - name: simulation__name - in: query - description: '' - required: false - type: string - - name: simulation__name__iexact - in: query - description: '' - required: false - type: string - - name: simulation__name__contains - in: query - description: '' - required: false - type: string - - name: simulation__name__icontains - in: query - description: '' - required: false - type: string - - name: simulation__name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: simulation__name__startswith - in: query - description: '' - required: false - type: string - - name: simulation__name__istartswith - in: query - description: '' - required: false - type: string - - name: simulation__name__endswith - in: query - description: '' - required: false - type: string - - name: simulation__name__regex - in: query - description: '' - required: false - type: string - - name: simulation__compute_cluster__name - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__slug - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__slug__iexact - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__slug__contains - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__slug__icontains - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__slug__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: simulation__threedimodel__slug__startswith - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__slug__istartswith - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__slug__endswith - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__slug__regex - in: query - description: '' - required: false - type: string - - name: created - in: query - description: '' - required: false - type: string - - name: created__gt - in: query - description: '' - required: false - type: string - - name: created__gte - in: query - description: '' - required: false - type: string - - name: created__lt - in: query - description: '' - required: false - type: string - - name: created__lte - in: query - description: '' - required: false - type: string - - name: created__date - in: query - description: '' - required: false - type: string - - name: created__date__gt - in: query - description: '' - required: false - type: string - - name: created__date__gte - in: query - description: '' - required: false - type: string - - name: created__date__lt - in: query - description: '' - required: false - type: string - - name: created__date__lte - in: query - description: '' - required: false - type: string - - name: created__year - in: query - description: '' - required: false - type: number - - name: created__year__gt - in: query - description: '' - required: false - type: number - - name: created__year__gte - in: query - description: '' - required: false - type: number - - name: created__year__lt - in: query - description: '' - required: false - type: number - - name: created__year__lte - in: query - description: '' - required: false - type: number - - name: created__month - in: query - description: '' - required: false - type: number - - name: created__month__lte - in: query - description: '' - required: false - type: number - - name: created__day - in: query - description: '' - required: false - type: number - - name: created__day__lt - in: query - description: '' - required: false - type: number - - name: created__week - in: query - description: '' - required: false - type: number - - name: created__week_day - in: query - description: '' - required: false - type: number - - name: id - in: query - description: '' - required: false - type: number - - name: id__gt - in: query - description: '' - required: false - type: number - - name: id__gte - in: query - description: '' - required: false - type: number - - name: id__lt - in: query - description: '' - required: false - type: number - - name: id__lte - in: query - description: '' - required: false - type: number - - name: id__isnull - in: query - description: '' - required: false - type: string - - name: exit_code - in: query - description: '' - required: false - type: string - - name: exit_code__gt - in: query - description: '' - required: false - type: number - - name: exit_code__gte - in: query - description: '' - required: false - type: number - - name: exit_code__lt - in: query - description: '' - required: false - type: number - - name: exit_code__lte - in: query - description: '' - required: false - type: number - - name: exit_code__isnull - in: query - description: '' - required: false - type: string - - name: simulation_id__in - in: query - description: Multiple values may be separated by commas. - required: false - type: number - - name: simulation__user__username - in: query - description: '' - required: false - type: string - - name: simulation__type__live - in: query - description: '' - required: false - type: string - - name: simulation__tags__contains - in: query - description: '' - required: false - type: string - - name: simulation__organisation__name__istartswith - in: query - description: '' - required: false - type: string - - name: simulation__organisation__unique_id - in: query - description: '' - required: false - type: string - - name: ordering - in: query - description: Which field to use when ordering the results. - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - type: array - items: - $ref: '#/definitions/SimulationStatusStatistics' - tags: - - v3 - parameters: [] - /v3/statuses/{id}/: - get: - operationId: statuses_read - description: '' - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/SimulationStatus' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this simulation status. - required: true - type: integer - /v3/threedimodels/: - get: - operationId: threedimodels_list - description: A simple ViewSet for viewing threedimodels - parameters: - - name: name - in: query - description: '' - required: false - type: string - - name: name__iexact - in: query - description: '' - required: false - type: string - - name: name__contains - in: query - description: '' - required: false - type: string - - name: name__icontains - in: query - description: '' - required: false - type: string - - name: name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: name__startswith - in: query - description: '' - required: false - type: string - - name: name__istartswith - in: query - description: '' - required: false - type: string - - name: name__endswith - in: query - description: '' - required: false - type: string - - name: name__regex - in: query - description: '' - required: false - type: string - - name: slug - in: query - description: '' - required: false - type: string - - name: slug__iexact - in: query - description: '' - required: false - type: string - - name: slug__contains - in: query - description: '' - required: false - type: string - - name: slug__icontains - in: query - description: '' - required: false - type: string - - name: slug__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: slug__startswith - in: query - description: '' - required: false - type: string - - name: slug__istartswith - in: query - description: '' - required: false - type: string - - name: slug__endswith - in: query - description: '' - required: false - type: string - - name: slug__regex - in: query - description: '' - required: false - type: string - - name: epsg - in: query - description: '' - required: false - type: number - - name: is_valid - in: query - description: '' - required: false - type: string - - name: inpy_version__slug - in: query - description: '' - required: false - type: string - - name: inpy_version__slug__iexact - in: query - description: '' - required: false - type: string - - name: inpy_version__slug__contains - in: query - description: '' - required: false - type: string - - name: inpy_version__slug__icontains - in: query - description: '' - required: false - type: string - - name: inpy_version__slug__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: inpy_version__slug__startswith - in: query - description: '' - required: false - type: string - - name: inpy_version__slug__istartswith - in: query - description: '' - required: false - type: string - - name: inpy_version__slug__endswith - in: query - description: '' - required: false - type: string - - name: inpy_version__slug__regex - in: query - description: '' - required: false - type: string - - name: inpy_version__threedi_version - in: query - description: '' - required: false - type: string - - name: inpy_version__threedi_version__iexact - in: query - description: '' - required: false - type: string - - name: inpy_version__threedi_version__contains - in: query - description: '' - required: false - type: string - - name: inpy_version__threedi_version__icontains - in: query - description: '' - required: false - type: string - - name: inpy_version__threedi_version__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: inpy_version__threedi_version__startswith - in: query - description: '' - required: false - type: string - - name: inpy_version__threedi_version__istartswith - in: query - description: '' - required: false - type: string - - name: inpy_version__threedi_version__endswith - in: query - description: '' - required: false - type: string - - name: inpy_version__threedi_version__regex - in: query - description: '' - required: false - type: string - - name: inpy_version__threedicore_version - in: query - description: '' - required: false - type: string - - name: inpy_version__threedicore_version__iexact - in: query - description: '' - required: false - type: string - - name: inpy_version__threedicore_version__contains - in: query - description: '' - required: false - type: string - - name: inpy_version__threedicore_version__icontains - in: query - description: '' - required: false - type: string - - name: inpy_version__threedicore_version__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: inpy_version__threedicore_version__startswith - in: query - description: '' - required: false - type: string - - name: inpy_version__threedicore_version__istartswith - in: query - description: '' - required: false - type: string - - name: inpy_version__threedicore_version__endswith - in: query - description: '' - required: false - type: string - - name: inpy_version__threedicore_version__regex - in: query - description: '' - required: false - type: string - - name: revision__id - in: query - description: '' - required: false - type: number - - name: revision__number - in: query - description: '' - required: false - type: number - - name: revision__number__gt - in: query - description: '' - required: false - type: number - - name: revision__number__gte - in: query - description: '' - required: false - type: number - - name: revision__number__lt - in: query - description: '' - required: false - type: number - - name: revision__number__lte - in: query - description: '' - required: false - type: number - - name: revision__number__isnull - in: query - description: '' - required: false - type: string - - name: revision__hash - in: query - description: '' - required: false - type: string - - name: revision__hash__iexact - in: query - description: '' - required: false - type: string - - name: revision__hash__contains - in: query - description: '' - required: false - type: string - - name: revision__hash__icontains - in: query - description: '' - required: false - type: string - - name: revision__hash__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: revision__hash__startswith - in: query - description: '' - required: false - type: string - - name: revision__hash__istartswith - in: query - description: '' - required: false - type: string - - name: revision__hash__endswith - in: query - description: '' - required: false - type: string - - name: revision__hash__regex - in: query - description: '' - required: false - type: string - - name: revision__schematisation__isnull - in: query - description: '' - required: false - type: string - - name: revision__schematisation__name - in: query - description: '' - required: false - type: string - - name: revision__schematisation__name__iexact - in: query - description: '' - required: false - type: string - - name: revision__schematisation__name__contains - in: query - description: '' - required: false - type: string - - name: revision__schematisation__name__icontains - in: query - description: '' - required: false - type: string - - name: revision__schematisation__name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: revision__schematisation__name__startswith - in: query - description: '' - required: false - type: string - - name: revision__schematisation__name__istartswith - in: query - description: '' - required: false - type: string - - name: revision__schematisation__name__endswith - in: query - description: '' - required: false - type: string - - name: revision__schematisation__name__regex - in: query - description: '' - required: false - type: string - - name: revision__repository__organisation__unique_id - in: query - description: '' - required: false - type: string - - name: revision__repository__organisation__unique_id__iexact - in: query - description: '' - required: false - type: string - - name: revision__repository__organisation__unique_id__contains - in: query - description: '' - required: false - type: string - - name: revision__repository__organisation__unique_id__icontains - in: query - description: '' - required: false - type: string - - name: revision__repository__organisation__unique_id__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: revision__repository__organisation__unique_id__startswith - in: query - description: '' - required: false - type: string - - name: revision__repository__organisation__unique_id__istartswith - in: query - description: '' - required: false - type: string - - name: revision__repository__organisation__unique_id__endswith - in: query - description: '' - required: false - type: string - - name: revision__repository__organisation__unique_id__regex - in: query - description: '' - required: false - type: string - - name: revision__schematisation__owner__unique_id - in: query - description: '' - required: false - type: string - - name: revision__schematisation__id - in: query - description: '' - required: false - type: number - - name: revision__is_pinned - in: query - description: '' - required: false - type: string - - name: disabled - in: query - description: '' - required: false - type: string - - name: inp_success - in: query - description: '' - required: false - type: string - - name: inpy_version__active - in: query - description: '' - required: false - type: string - - name: ordering - in: query - description: Which field to use when ordering the results. - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/ThreediModel' - tags: - - v3 - post: - operationId: threedimodels_create - description: A simple ViewSet for viewing threedimodels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ThreediModel' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/ThreediModel' - tags: - - v3 - parameters: [] - /v3/threedimodels/{id}/: - get: - operationId: threedimodels_read - description: A simple ViewSet for viewing threedimodels - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ThreediModel' - tags: - - v3 - put: - operationId: threedimodels_update - description: A simple ViewSet for viewing threedimodels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ThreediModel' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ThreediModel' - tags: - - v3 - patch: - operationId: threedimodels_partial_update - description: A simple ViewSet for viewing threedimodels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ThreediModel' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ThreediModel' - tags: - - v3 - delete: - operationId: threedimodels_delete - summary: Soft-delete the threedimodel (sets disabled to True) - description: |- - If the model is already disabled and the user is a superuser, delete - the threedimodel. - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/all/download/: - get: - operationId: threedimodels_geojson_download - description: Endpoint for downloading geojson file. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/all/upload/: - post: - operationId: threedimodels_geojson_upload - description: |- - Endpoint for uploading the geojson file - Replaces the geojson file if there already exists one. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/breaches/download/: - get: - operationId: threedimodels_geojson_breaches_download - description: A simple ViewSet for viewing threedimodels - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/breaches/upload/: - post: - operationId: threedimodels_breaches_geojson_upload - description: A simple ViewSet for viewing threedimodels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/cells/download/: - get: - operationId: threedimodels_geojson_cells_download - description: Note that this is the subset of 2d open_water cells - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/cells/upload/: - post: - operationId: threedimodels_cells_geojson_upload - description: A simple ViewSet for viewing threedimodels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/channels/download/: - get: - operationId: threedimodels_geojson_channels_download - description: A simple ViewSet for viewing threedimodels - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/channels/upload/: - post: - operationId: threedimodels_channels_geojson_upload - description: A simple ViewSet for viewing threedimodels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/culverts/download/: - get: - operationId: threedimodels_geojson_culverts_download - description: A simple ViewSet for viewing threedimodels - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/culverts/upload/: - post: - operationId: threedimodels_culverts_geojson_upload - description: A simple ViewSet for viewing threedimodels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/flowlines/download/: - get: - operationId: threedimodels_geojson_flowlines_download - description: Note that this is a subset of all lines - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/flowlines/upload/: - post: - operationId: threedimodels_flowlines_geojson_upload - description: A simple ViewSet for viewing threedimodels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/levees/download/: - get: - operationId: threedimodels_geojson_levees_download - description: A simple ViewSet for viewing threedimodels - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/levees/upload/: - post: - operationId: threedimodels_levees_geojson_upload - description: A simple ViewSet for viewing threedimodels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/manholes/download/: - get: - operationId: threedimodels_geojson_manholes_download - description: A simple ViewSet for viewing threedimodels - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/manholes/upload/: - post: - operationId: threedimodels_manholes_geojson_upload - description: A simple ViewSet for viewing threedimodels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/orifices/download/: - get: - operationId: threedimodels_geojson_orifices_download - description: A simple ViewSet for viewing threedimodels - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/orifices/upload/: - post: - operationId: threedimodels_orifices_geojson_upload - description: A simple ViewSet for viewing threedimodels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/pipes/download/: - get: - operationId: threedimodels_geojson_pipes_download - description: A simple ViewSet for viewing threedimodels - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/pipes/upload/: - post: - operationId: threedimodels_pipes_geojson_upload - description: A simple ViewSet for viewing threedimodels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/pumps/download/: - get: - operationId: threedimodels_geojson_pumps_download - description: A simple ViewSet for viewing threedimodels - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/pumps/upload/: - post: - operationId: threedimodels_pumps_geojson_upload - description: A simple ViewSet for viewing threedimodels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/weirs/download/: - get: - operationId: threedimodels_geojson_weirs_download - description: A simple ViewSet for viewing threedimodels - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geojson/weirs/upload/: - post: - operationId: threedimodels_weirs_geojson_upload - description: A simple ViewSet for viewing threedimodels - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geopackage/download/: - get: - operationId: threedimodels_geopackage_download - description: Endpoint for downloading geopackage file. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/geopackage/upload/: - post: - operationId: threedimodels_geopackage_upload - summary: Endpoint for uploading the gridadmin file - description: Replaces the gridadmin if there already exists one. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/gridadmin/download/: - get: - operationId: threedimodels_gridadmin_download - description: Endpoint for downloading files. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/gridadmin/upload/: - post: - operationId: threedimodels_gridadmin_upload - summary: Endpoint for uploading the gridadmin file - description: Replaces the gridadmin if there already exists one. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/raster_options/: - get: - operationId: threedimodels_raster_options - description: A simple ViewSet for viewing threedimodels - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/RasterOptions' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/tables/download/: - get: - operationId: threedimodels_tables_download - description: Endpoint for downloading tables files. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{id}/tables/upload/: - post: - operationId: threedimodels_tables_upload - summary: Endpoint for uploading the tables.h5 file - description: Replaces the tables file if there already exists one. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model. - required: true - type: integer - /v3/threedimodels/{threedimodel_pk}/boundaryconditions/: - get: - operationId: threedimodels_boundaryconditions_list - description: A simple ViewSet for viewing boundary conditions - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/BoundaryCondition' - tags: - - v3 - post: - operationId: threedimodels_boundaryconditions_create - description: A simple ViewSet for viewing boundary conditions - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/BoundaryCondition' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/BoundaryCondition' - tags: - - v3 - parameters: - - name: threedimodel_pk - in: path - required: true - type: string - /v3/threedimodels/{threedimodel_pk}/boundaryconditions/{id}/: - get: - operationId: threedimodels_boundaryconditions_read - description: A simple ViewSet for viewing boundary conditions - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/BoundaryCondition' - tags: - - v3 - put: - operationId: threedimodels_boundaryconditions_update - description: A simple ViewSet for viewing boundary conditions - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/BoundaryCondition' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/BoundaryCondition' - tags: - - v3 - patch: - operationId: threedimodels_boundaryconditions_partial_update - description: A simple ViewSet for viewing boundary conditions - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/BoundaryCondition' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/BoundaryCondition' - tags: - - v3 - delete: - operationId: threedimodels_boundaryconditions_delete - description: A simple ViewSet for viewing boundary conditions - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this boundary condition. - required: true - type: integer - - name: threedimodel_pk - in: path - required: true - type: string - /v3/threedimodels/{threedimodel_pk}/bulk_rasters/: - post: - operationId: threedimodels_bulk_rasters_create - description: '' - parameters: - - name: data - in: body - required: true - schema: - type: array - items: - $ref: '#/definitions/Raster' - responses: - '201': - description: '' - schema: - type: array - items: - $ref: '#/definitions/Raster' - tags: - - v3 - parameters: - - name: threedimodel_pk - in: path - required: true - type: string - /v3/threedimodels/{threedimodel_pk}/initial_waterlevels/: - get: - operationId: threedimodels_initial_waterlevels_list - description: |- - ## Description - Initial waterlevels on threedimodels can be used in a simulation to specify the initial - waterlevels on the 1D and/or 2D domain. - - ### Initial waterlevels from schematisation - 1D and 2D initial waterlevels in the schematisation are automatically picked up - during the creation of the threedimodel. - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/InitialWaterlevel' - tags: - - v3 - post: - operationId: threedimodels_initial_waterlevels_create - summary: Add new initial waterlevels - description: |- - ### Adding (extra) 1D initial waterlevels - Extra 1D initial waterlevels can be added by posting: - - {"dimension": "one_d"} - - Using the 'id' value from the response, a JSON file needs to be uploaded via the PUT_URL retrieved from - `initial_waterlevels/{id}/upload/` in the following JSON format: - - Python code: - - import json - file_contents = json.dumps({ - "node_ids": [node_id_1, node_id2, ....], - "values" : [value_for_node_id_1, value_for_node_id_2, ...] - }) - - # Notes: - # - Omitted values are considered dry. - # - `node_ids` need to be sorted and unique - # - Make sure that the positions of the node_id's and values match. - - ### Adding (extra) 2D initial waterlevels - 2D initial waterlevels can be added by uploading an 'initial_waterlevel_file' Geotiff raster via `rasters/{id}/upload/`. - This automatically triggers the creation of a 2D initial waterlevel. The source raster is - linked as 'source_raster'. The values in the `source_raster` are aggregated per node using - max, min and mean operators. The resulting values are stored in a file linked under `file`. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/InitialWaterlevel' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/InitialWaterlevel' - tags: - - v3 - parameters: - - name: threedimodel_pk - in: path - required: true - type: string - /v3/threedimodels/{threedimodel_pk}/initial_waterlevels/{id}/: - get: - operationId: threedimodels_initial_waterlevels_read - description: |- - ## Description - Initial waterlevels on threedimodels can be used in a simulation to specify the initial - waterlevels on the 1D and/or 2D domain. - - ### Initial waterlevels from schematisation - 1D and 2D initial waterlevels in the schematisation are automatically picked up - during the creation of the threedimodel. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/InitialWaterlevel' - tags: - - v3 - put: - operationId: threedimodels_initial_waterlevels_update - description: |- - ## Description - Initial waterlevels on threedimodels can be used in a simulation to specify the initial - waterlevels on the 1D and/or 2D domain. - - ### Initial waterlevels from schematisation - 1D and 2D initial waterlevels in the schematisation are automatically picked up - during the creation of the threedimodel. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/InitialWaterlevel' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/InitialWaterlevel' - tags: - - v3 - patch: - operationId: threedimodels_initial_waterlevels_partial_update - description: |- - ## Description - Initial waterlevels on threedimodels can be used in a simulation to specify the initial - waterlevels on the 1D and/or 2D domain. - - ### Initial waterlevels from schematisation - 1D and 2D initial waterlevels in the schematisation are automatically picked up - during the creation of the threedimodel. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/InitialWaterlevel' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/InitialWaterlevel' - tags: - - v3 - delete: - operationId: threedimodels_initial_waterlevels_delete - description: Delete initial waterlevel - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this initial waterlevel. - required: true - type: integer - - name: threedimodel_pk - in: path - required: true - type: string - /v3/threedimodels/{threedimodel_pk}/initial_waterlevels/{id}/download/: - get: - operationId: threedimodels_initial_waterlevels_download - description: Endpoint for downloading files. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this initial waterlevel. - required: true - type: integer - - name: threedimodel_pk - in: path - required: true - type: string - /v3/threedimodels/{threedimodel_pk}/initial_waterlevels/{id}/processed/: - put: - operationId: threedimodels_initial_waterlevels_processed - description: |- - ## Description - Initial waterlevels on threedimodels can be used in a simulation to specify the initial - waterlevels on the 1D and/or 2D domain. - - ### Initial waterlevels from schematisation - 1D and 2D initial waterlevels in the schematisation are automatically picked up - during the creation of the threedimodel. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/BaseEventState' - responses: - '200': - description: OK - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this initial waterlevel. - required: true - type: integer - - name: threedimodel_pk - in: path - required: true - type: string - /v3/threedimodels/{threedimodel_pk}/initial_waterlevels/{id}/upload/: - post: - operationId: threedimodels_initial_waterlevels_upload - description: |- - Endpoint for uploading an initial waterlevel file, see the POST - endpoint for documentation about the file format. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this initial waterlevel. - required: true - type: integer - - name: threedimodel_pk - in: path - required: true - type: string - /v3/threedimodels/{threedimodel_pk}/potentialbreaches/: - get: - operationId: threedimodels_potentialbreaches_list - description: A simple ViewSet for viewing breaches - parameters: - - name: connected_pnt_id - in: query - description: '' - required: false - type: number - - name: connected_pnt_id__gt - in: query - description: '' - required: false - type: number - - name: connected_pnt_id__gte - in: query - description: '' - required: false - type: number - - name: connected_pnt_id__lt - in: query - description: '' - required: false - type: number - - name: connected_pnt_id__lte - in: query - description: '' - required: false - type: number - - name: connected_pnt_id__isnull - in: query - description: '' - required: false - type: string - - name: threedimodel__id - in: query - description: '' - required: false - type: number - - name: threedimodel__id__gt - in: query - description: '' - required: false - type: number - - name: threedimodel__id__gte - in: query - description: '' - required: false - type: number - - name: threedimodel__id__lt - in: query - description: '' - required: false - type: number - - name: threedimodel__id__lte - in: query - description: '' - required: false - type: number - - name: threedimodel__id__isnull - in: query - description: '' - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/PotentialBreach' - tags: - - v3 - post: - operationId: threedimodels_potentialbreaches_create - description: A simple ViewSet for viewing breaches - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/PotentialBreach' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/PotentialBreach' - tags: - - v3 - parameters: - - name: threedimodel_pk - in: path - required: true - type: string - /v3/threedimodels/{threedimodel_pk}/potentialbreaches/{id}/: - get: - operationId: threedimodels_potentialbreaches_read - description: A simple ViewSet for viewing breaches - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/PotentialBreach' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this potential breach. - required: true - type: integer - - name: threedimodel_pk - in: path - required: true - type: string - /v3/threedimodels/{threedimodel_pk}/rasters/: - get: - operationId: threedimodels_rasters_list - description: View rasters for threedimodel - parameters: - - name: type - in: query - description: '' - required: false - type: string - - name: type__iexact - in: query - description: '' - required: false - type: string - - name: type__contains - in: query - description: '' - required: false - type: string - - name: type__icontains - in: query - description: '' - required: false - type: string - - name: type__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: type__startswith - in: query - description: '' - required: false - type: string - - name: type__istartswith - in: query - description: '' - required: false - type: string - - name: type__endswith - in: query - description: '' - required: false - type: string - - name: type__regex - in: query - description: '' - required: false - type: string - - name: name - in: query - description: '' - required: false - type: string - - name: name__iexact - in: query - description: '' - required: false - type: string - - name: name__contains - in: query - description: '' - required: false - type: string - - name: name__icontains - in: query - description: '' - required: false - type: string - - name: name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: name__startswith - in: query - description: '' - required: false - type: string - - name: name__istartswith - in: query - description: '' - required: false - type: string - - name: name__endswith - in: query - description: '' - required: false - type: string - - name: name__regex - in: query - description: '' - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/Raster' - tags: - - v3 - post: - operationId: threedimodels_rasters_create - description: View rasters for threedimodel - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Raster' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Raster' - tags: - - v3 - parameters: - - name: threedimodel_pk - in: path - required: true - type: string - /v3/threedimodels/{threedimodel_pk}/rasters/{id}/: - get: - operationId: threedimodels_rasters_read - description: View rasters for threedimodel - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Raster' - tags: - - v3 - put: - operationId: threedimodels_rasters_update - description: View rasters for threedimodel - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Raster' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Raster' - tags: - - v3 - patch: - operationId: threedimodels_rasters_partial_update - description: View rasters for threedimodel - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Raster' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Raster' - tags: - - v3 - delete: - operationId: threedimodels_rasters_delete - description: View rasters for threedimodel - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this raster. - required: true - type: integer - - name: threedimodel_pk - in: path - required: true - type: string - /v3/threedimodels/{threedimodel_pk}/rasters/{id}/download/: - get: - operationId: threedimodels_rasters_download - description: Endpoint for downloading files. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Download' - '400': - description: File is not uploaded yet or has been removed - '404': - description: File not found - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this raster. - required: true - type: integer - - name: threedimodel_pk - in: path - required: true - type: string - /v3/threedimodels/{threedimodel_pk}/rasters/{id}/upload/: - post: - operationId: threedimodels_rasters_upload - description: Endpoint for uploading a raster. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Upload' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/Upload' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this raster. - required: true - type: integer - - name: threedimodel_pk - in: path - required: true - type: string - /v3/threedimodels/{threedimodel_pk}/saved_states/: - get: - operationId: threedimodels_saved_states_list - description: View saved states created for this 3Di model - parameters: - - name: ordering - in: query - description: Which field to use when ordering the results. - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/ThreediModelSavedState' - tags: - - v3 - parameters: - - name: threedimodel_pk - in: path - required: true - type: string - /v3/threedimodels/{threedimodel_pk}/saved_states/{id}/: - get: - operationId: threedimodels_saved_states_read - description: View saved states created for this 3Di model - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ThreediModelSavedState' - tags: - - v3 - delete: - operationId: threedimodels_saved_states_delete - description: View saved states created for this 3Di model - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this saved state. - required: true - type: integer - - name: threedimodel_pk - in: path - required: true - type: string - /v3/threedimodels/{threedimodel_pk}/tasks/: - get: - operationId: threedimodels_tasks_list - description: View threedimodel tasks - parameters: - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/ThreediModelTask' - tags: - - v3 - post: - operationId: threedimodels_tasks_create - description: View threedimodel tasks - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ThreediModelTask' - responses: - '201': - description: '' - schema: - $ref: '#/definitions/ThreediModelTask' - tags: - - v3 - parameters: - - name: threedimodel_pk - in: path - required: true - type: string - /v3/threedimodels/{threedimodel_pk}/tasks/{id}/: - get: - operationId: threedimodels_tasks_read - description: View threedimodel tasks - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ThreediModelTask' - tags: - - v3 - put: - operationId: threedimodels_tasks_update - description: View threedimodel tasks - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ThreediModelTask' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ThreediModelTask' - tags: - - v3 - patch: - operationId: threedimodels_tasks_partial_update - description: View threedimodel tasks - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ThreediModelTask' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ThreediModelTask' - tags: - - v3 - delete: - operationId: threedimodels_tasks_delete - description: View threedimodel tasks - parameters: [] - responses: - '204': - description: '' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this threedi model task. - required: true - type: integer - - name: threedimodel_pk - in: path - required: true - type: string - /v3/usage/: - get: - operationId: usage_list - summary: View to display overview of ran simulations. - description: Only displays finished/crashed simulations. - parameters: - - name: started__gt - in: query - description: '' - required: false - type: string - - name: started__gte - in: query - description: '' - required: false - type: string - - name: started__lt - in: query - description: '' - required: false - type: string - - name: started__lte - in: query - description: '' - required: false - type: string - - name: started__date - in: query - description: '' - required: false - type: string - - name: started__date__gt - in: query - description: '' - required: false - type: string - - name: started__date__gte - in: query - description: '' - required: false - type: string - - name: started__date__lt - in: query - description: '' - required: false - type: string - - name: started__date__lte - in: query - description: '' - required: false - type: string - - name: started__year - in: query - description: '' - required: false - type: number - - name: started__year__gt - in: query - description: '' - required: false - type: number - - name: started__year__gte - in: query - description: '' - required: false - type: number - - name: started__year__lt - in: query - description: '' - required: false - type: number - - name: started__year__lte - in: query - description: '' - required: false - type: number - - name: started__month - in: query - description: '' - required: false - type: number - - name: started__month__lte - in: query - description: '' - required: false - type: number - - name: finished__gt - in: query - description: '' - required: false - type: string - - name: finished__gte - in: query - description: '' - required: false - type: string - - name: finished__lt - in: query - description: '' - required: false - type: string - - name: finished__lte - in: query - description: '' - required: false - type: string - - name: finished__date - in: query - description: '' - required: false - type: string - - name: finished__date__gt - in: query - description: '' - required: false - type: string - - name: finished__date__gte - in: query - description: '' - required: false - type: string - - name: finished__date__lt - in: query - description: '' - required: false - type: string - - name: finished__date__lte - in: query - description: '' - required: false - type: string - - name: finished__year - in: query - description: '' - required: false - type: number - - name: finished__year__gt - in: query - description: '' - required: false - type: number - - name: finished__year__gte - in: query - description: '' - required: false - type: number - - name: finished__year__lt - in: query - description: '' - required: false - type: number - - name: finished__year__lte - in: query - description: '' - required: false - type: number - - name: finished__month - in: query - description: '' - required: false - type: number - - name: finished__month__lte - in: query - description: '' - required: false - type: number - - name: total_time - in: query - description: '' - required: false - type: number - - name: total_time__gt - in: query - description: '' - required: false - type: number - - name: total_time__gte - in: query - description: '' - required: false - type: number - - name: total_time__lt - in: query - description: '' - required: false - type: number - - name: total_time__lte - in: query - description: '' - required: false - type: number - - name: total_time__isnull - in: query - description: '' - required: false - type: string - - name: simulation__name - in: query - description: '' - required: false - type: string - - name: simulation__name__iexact - in: query - description: '' - required: false - type: string - - name: simulation__name__contains - in: query - description: '' - required: false - type: string - - name: simulation__name__icontains - in: query - description: '' - required: false - type: string - - name: simulation__name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: simulation__name__startswith - in: query - description: '' - required: false - type: string - - name: simulation__name__istartswith - in: query - description: '' - required: false - type: string - - name: simulation__name__endswith - in: query - description: '' - required: false - type: string - - name: simulation__name__regex - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__id - in: query - description: '' - required: false - type: number - - name: simulation__threedimodel__id__gt - in: query - description: '' - required: false - type: number - - name: simulation__threedimodel__id__gte - in: query - description: '' - required: false - type: number - - name: simulation__threedimodel__id__lt - in: query - description: '' - required: false - type: number - - name: simulation__threedimodel__id__lte - in: query - description: '' - required: false - type: number - - name: simulation__threedimodel__id__isnull - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__name - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__name__iexact - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__name__contains - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__name__icontains - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: simulation__threedimodel__name__startswith - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__name__istartswith - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__name__endswith - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__name__regex - in: query - description: '' - required: false - type: string - - name: simulation__user__username - in: query - description: '' - required: false - type: string - - name: simulation__user__username__iexact - in: query - description: '' - required: false - type: string - - name: simulation__user__username__contains - in: query - description: '' - required: false - type: string - - name: simulation__user__username__icontains - in: query - description: '' - required: false - type: string - - name: simulation__user__username__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: simulation__user__username__startswith - in: query - description: '' - required: false - type: string - - name: simulation__user__username__istartswith - in: query - description: '' - required: false - type: string - - name: simulation__user__username__endswith - in: query - description: '' - required: false - type: string - - name: simulation__user__username__regex - in: query - description: '' - required: false - type: string - - name: simulation__active_status__name - in: query - description: '' - required: false - type: string - - name: simulation__active_status__name__iexact - in: query - description: '' - required: false - type: string - - name: simulation__active_status__name__contains - in: query - description: '' - required: false - type: string - - name: simulation__active_status__name__icontains - in: query - description: '' - required: false - type: string - - name: simulation__active_status__name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: simulation__active_status__name__startswith - in: query - description: '' - required: false - type: string - - name: simulation__active_status__name__istartswith - in: query - description: '' - required: false - type: string - - name: simulation__active_status__name__endswith - in: query - description: '' - required: false - type: string - - name: simulation__active_status__name__regex - in: query - description: '' - required: false - type: string - - name: simulation__type__live - in: query - description: '' - required: false - type: string - - name: simulation__organisation__name__istartswith - in: query - description: '' - required: false - type: string - - name: simulation__organisation__unique_id - in: query - description: '' - required: false - type: string - - name: simulation__status - in: query - description: '' - required: false - type: string - - name: simulation__tags__in - in: query - description: '' - required: false - type: string - - name: ordering - in: query - description: Which field to use when ordering the results. - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/Usage' - tags: - - v3 - parameters: [] - /v3/usage/statistics/: - get: - operationId: usage_statistics - summary: |- - Usage statistics like total session count, average session - duration and such. - description: |- - This endpoint comes in handy if you want to aggregate usage - number over a certain period of time, for a given user or organisation. - - It is also possible to limit the result to a certain simulation type, - e.g. to "live" sessions. Use the `simulation__type__live` filter with - either `true` or `false` as input values. - parameters: - - name: started__gt - in: query - description: '' - required: false - type: string - - name: started__gte - in: query - description: '' - required: false - type: string - - name: started__lt - in: query - description: '' - required: false - type: string - - name: started__lte - in: query - description: '' - required: false - type: string - - name: started__date - in: query - description: '' - required: false - type: string - - name: started__date__gt - in: query - description: '' - required: false - type: string - - name: started__date__gte - in: query - description: '' - required: false - type: string - - name: started__date__lt - in: query - description: '' - required: false - type: string - - name: started__date__lte - in: query - description: '' - required: false - type: string - - name: started__year - in: query - description: '' - required: false - type: number - - name: started__year__gt - in: query - description: '' - required: false - type: number - - name: started__year__gte - in: query - description: '' - required: false - type: number - - name: started__year__lt - in: query - description: '' - required: false - type: number - - name: started__year__lte - in: query - description: '' - required: false - type: number - - name: started__month - in: query - description: '' - required: false - type: number - - name: started__month__lte - in: query - description: '' - required: false - type: number - - name: finished__gt - in: query - description: '' - required: false - type: string - - name: finished__gte - in: query - description: '' - required: false - type: string - - name: finished__lt - in: query - description: '' - required: false - type: string - - name: finished__lte - in: query - description: '' - required: false - type: string - - name: finished__date - in: query - description: '' - required: false - type: string - - name: finished__date__gt - in: query - description: '' - required: false - type: string - - name: finished__date__gte - in: query - description: '' - required: false - type: string - - name: finished__date__lt - in: query - description: '' - required: false - type: string - - name: finished__date__lte - in: query - description: '' - required: false - type: string - - name: finished__year - in: query - description: '' - required: false - type: number - - name: finished__year__gt - in: query - description: '' - required: false - type: number - - name: finished__year__gte - in: query - description: '' - required: false - type: number - - name: finished__year__lt - in: query - description: '' - required: false - type: number - - name: finished__year__lte - in: query - description: '' - required: false - type: number - - name: finished__month - in: query - description: '' - required: false - type: number - - name: finished__month__lte - in: query - description: '' - required: false - type: number - - name: total_time - in: query - description: '' - required: false - type: number - - name: total_time__gt - in: query - description: '' - required: false - type: number - - name: total_time__gte - in: query - description: '' - required: false - type: number - - name: total_time__lt - in: query - description: '' - required: false - type: number - - name: total_time__lte - in: query - description: '' - required: false - type: number - - name: total_time__isnull - in: query - description: '' - required: false - type: string - - name: simulation__name - in: query - description: '' - required: false - type: string - - name: simulation__name__iexact - in: query - description: '' - required: false - type: string - - name: simulation__name__contains - in: query - description: '' - required: false - type: string - - name: simulation__name__icontains - in: query - description: '' - required: false - type: string - - name: simulation__name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: simulation__name__startswith - in: query - description: '' - required: false - type: string - - name: simulation__name__istartswith - in: query - description: '' - required: false - type: string - - name: simulation__name__endswith - in: query - description: '' - required: false - type: string - - name: simulation__name__regex - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__id - in: query - description: '' - required: false - type: number - - name: simulation__threedimodel__id__gt - in: query - description: '' - required: false - type: number - - name: simulation__threedimodel__id__gte - in: query - description: '' - required: false - type: number - - name: simulation__threedimodel__id__lt - in: query - description: '' - required: false - type: number - - name: simulation__threedimodel__id__lte - in: query - description: '' - required: false - type: number - - name: simulation__threedimodel__id__isnull - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__name - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__name__iexact - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__name__contains - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__name__icontains - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: simulation__threedimodel__name__startswith - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__name__istartswith - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__name__endswith - in: query - description: '' - required: false - type: string - - name: simulation__threedimodel__name__regex - in: query - description: '' - required: false - type: string - - name: simulation__user__username - in: query - description: '' - required: false - type: string - - name: simulation__user__username__iexact - in: query - description: '' - required: false - type: string - - name: simulation__user__username__contains - in: query - description: '' - required: false - type: string - - name: simulation__user__username__icontains - in: query - description: '' - required: false - type: string - - name: simulation__user__username__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: simulation__user__username__startswith - in: query - description: '' - required: false - type: string - - name: simulation__user__username__istartswith - in: query - description: '' - required: false - type: string - - name: simulation__user__username__endswith - in: query - description: '' - required: false - type: string - - name: simulation__user__username__regex - in: query - description: '' - required: false - type: string - - name: simulation__active_status__name - in: query - description: '' - required: false - type: string - - name: simulation__active_status__name__iexact - in: query - description: '' - required: false - type: string - - name: simulation__active_status__name__contains - in: query - description: '' - required: false - type: string - - name: simulation__active_status__name__icontains - in: query - description: '' - required: false - type: string - - name: simulation__active_status__name__in - in: query - description: Multiple values may be separated by commas. - required: false - type: string - - name: simulation__active_status__name__startswith - in: query - description: '' - required: false - type: string - - name: simulation__active_status__name__istartswith - in: query - description: '' - required: false - type: string - - name: simulation__active_status__name__endswith - in: query - description: '' - required: false - type: string - - name: simulation__active_status__name__regex - in: query - description: '' - required: false - type: string - - name: simulation__type__live - in: query - description: '' - required: false - type: string - - name: simulation__organisation__name__istartswith - in: query - description: '' - required: false - type: string - - name: simulation__organisation__unique_id - in: query - description: '' - required: false - type: string - - name: simulation__status - in: query - description: '' - required: false - type: string - - name: simulation__tags__in - in: query - description: '' - required: false - type: string - - name: ordering - in: query - description: Which field to use when ordering the results. - required: false - type: string - - name: limit - in: query - description: Number of results to return per page. - required: false - type: integer - - name: offset - in: query - description: The initial index from which to return the results. - required: false - type: integer - responses: - '200': - description: '' - schema: - $ref: '#/definitions/UsageStatistics' - tags: - - v3 - parameters: [] - /v3/usage/{id}/: - get: - operationId: usage_read - summary: View to display overview of ran simulations. - description: Only displays finished/crashed simulations. - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Usage' - tags: - - v3 - parameters: - - name: id - in: path - description: A unique integer value identifying this usage. - required: true - type: integer -definitions: - PersonalAPIKey: - required: - - scope - - name - type: object - properties: - prefix: - title: Prefix - type: string - readOnly: true - minLength: 1 - scope: - title: Scope - description: "A space-separated list of scopes (options: basic simulate create\ - \ lizardrain lizardprocess manageusers managecontracts test livesite). Alternatively,\ - \ use '*:readwrite' for all scopes." - type: string - minLength: 1 - name: - title: Name - description: A free-form name for the API key. Need not be unique. 50 characters - max. - type: string - maxLength: 50 - minLength: 1 - expiry_date: - title: Expires - description: Once API key expires, clients cannot use it anymore. - type: string - format: date-time - x-nullable: true - created: - title: Created - type: string - format: date-time - readOnly: true - revoked: - title: Revoked - description: If the API key is revoked, clients cannot use it anymore. (This - cannot be undone.) - type: boolean - last_used: - title: Last used - description: Last time the API key was used. - type: string - format: date - readOnly: true - PersonalAPIKeyWithSecret: - required: - - scope - - name - type: object - properties: - prefix: - title: Prefix - type: string - readOnly: true - minLength: 1 - scope: - title: Scope - description: "A space-separated list of scopes (options: basic simulate create\ - \ lizardrain lizardprocess manageusers managecontracts test livesite). Alternatively,\ - \ use '*:readwrite' for all scopes." - type: string - minLength: 1 - name: - title: Name - description: A free-form name for the API key. Need not be unique. 50 characters - max. - type: string - maxLength: 50 - minLength: 1 - expiry_date: - title: Expires - description: Once API key expires, clients cannot use it anymore. - type: string - format: date-time - x-nullable: true - created: - title: Created - type: string - format: date-time - readOnly: true - revoked: - title: Revoked - description: If the API key is revoked, clients cannot use it anymore. (This - cannot be undone.) - type: boolean - last_used: - title: Last used - description: Last time the API key was used. - type: string - format: date - readOnly: true - key: - title: Key - description: The API key. Please store the key somewhere safe, you will not - be able to see it again. - type: string - readOnly: true - minLength: 1 - message: - title: Message - type: string - readOnly: true - minLength: 1 - CopyToThreediModel: - required: - - threedimodel - type: object - properties: - threedimodel: - title: Threedimodel - type: integer - name: - title: Name - type: string - maxLength: 128 - minLength: 1 - tags: - type: array - items: - type: string - x-nullable: true - clone_events: - title: Clone events - type: boolean - default: true - clone_initials: - title: Clone initials - type: boolean - default: true - clone_settings: - title: Clone settings - type: boolean - default: true - ObstacleEdit: - required: - - offset - - value - - linestring - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - value: - title: Value - description: Absolute or relative height (in meters) to use for the linestring - type: number - linestring: - title: Linestring - type: object - description: Linestring (epsg:4326) specified in wkt or geojson. Coordinates - in longitude, latitude order. - required: - - type - - coordinates - properties: - type: - title: type - description: Type should always be 'linestring' or 'LINESTRING' - type: string - default: Linestring - coordinates: - title: coordinates - description: List of coordinates. (longitude, latitude order) - type: array - items: - type: array - items: - type: number - minItems: 2 - maxItems: 2 - minItems: 2 - example: - type: LineString - coordinates: - - - 4.668275805499175 - - 52.619558913867856 - - - 4.73849433310911 - - 52.66453976184968 - state: - title: State - type: string - enum: - - processing - - valid - - invalid - readOnly: true - state_detail: - title: State detail - type: object - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - BaseEventState: - required: - - state - - state_detail - type: object - properties: - state: - title: State - type: string - enum: - - processing - - valid - - invalid - state_detail: - title: State detail - type: object - RasterEditUrls: - required: - - raster_type - - url - type: object - properties: - raster_type: - title: Raster type - type: string - minLength: 1 - url: - title: Url - type: string - Status: - type: object - properties: - status: - title: Status - type: string - readOnly: true - CurrentVersion: - type: object - properties: - threedi_version: - title: Threedi version - type: string - readOnly: true - threedicore_version: - title: Threedicore version - type: string - readOnly: true - User: - required: - - username - type: object - properties: - id: - title: ID - type: integer - readOnly: true - username: - title: Username - description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ - only. - type: string - pattern: ^[\w.@+-]+$ - maxLength: 150 - minLength: 1 - first_name: - title: First name - type: string - maxLength: 150 - last_name: - title: Last name - type: string - maxLength: 150 - email: - title: Email address - type: string - format: email - maxLength: 254 - Refresh: - required: - - refresh - type: object - properties: - refresh: - title: Refresh - type: string - minLength: 1 - access: - title: Access - type: string - readOnly: true - minLength: 1 - Tokens: - type: object - properties: - access: - title: Access - type: string - minLength: 1 - refresh: - title: Refresh - type: string - minLength: 1 - Authenticate: - type: object - properties: - username: - title: Username - type: string - minLength: 1 - password: - title: Password - type: string - minLength: 1 - UserTokens: - required: - - user - - external_user_id - type: object - properties: - user: - title: User - type: integer - external_user_id: - title: External user id - description: The user ID in the external identity provider, which is present - as the 'sub' field in tokens. - type: string - maxLength: 255 - minLength: 1 - created: - title: Created - type: string - format: date-time - readOnly: true - last_modified: - title: Last modified - description: The last time this remote user logged in. - type: string - format: date-time - readOnly: true - id_token: - title: Id token - description: The most recent ID token provided by the external identity provider. - type: string - access_token: - title: Access token - description: The most recent access token provided by the external identity - provider. - type: string - refresh_token: - title: Refresh token - description: The most recent refresh token provided by the external identity - provider. - type: string - Contract: - required: - - organisation - - hours_bought - - session_limit - - created_by - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - id: - title: ID - type: integer - readOnly: true - organisation: - title: Organisation.unique_id - type: string - description: The unique_id of an organisation - organisation_name: - title: Organisation name - type: string - readOnly: true - scope: - title: Scope - description: 'A space-separated list of scopes (options: basic simulate create - lizardrain lizardprocess manageusers managecontracts test livesite)' - type: string - readOnly: true - minLength: 1 - start_date: - title: Start date - type: string - format: date - x-nullable: true - hours_bought: - title: Hours bought - type: integer - hours_used: - title: Hours used - type: number - format: decimal - readOnly: true - session_limit: - title: Session limit - type: integer - maximum: 2147483647 - minimum: -2147483648 - current_sessions: - title: Current sessions - type: string - readOnly: true - threedimodel_limit: - title: Threedimodel limit - description: Maximum amount of ThreediModels per Organisation - type: integer - maximum: 32767 - minimum: 0 - created_by: - title: Organisation.unique_id - type: string - description: The unique_id of an organisation - File: - required: - - filename - - bucket - - type - - state - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - storage_name: - title: Storage name - type: string - readOnly: true - minLength: 1 - filename: - title: Filename - type: string - maxLength: 256 - minLength: 1 - bucket: - title: Bucket - type: string - maxLength: 256 - minLength: 1 - prefix: - title: Prefix - type: string - maxLength: 256 - x-nullable: true - etag: - title: Etag - description: Optional eTag (md5sum) - type: string - maxLength: 256 - x-nullable: true - size: - title: Size - description: Filesize in bytes - type: integer - maximum: 9223372036854775807 - minimum: -9223372036854775808 - x-nullable: true - expiry_date: - title: Expiry date - type: string - format: date - related_object: - title: Related object - type: string - format: uri - readOnly: true - type: - title: Type - type: string - enum: - - timeseries - - rastertimeseries - - savedstate - - results - - rasters - - gridadmin - - geopackage - - geojson - - initialwaterlevel - - bulklateral - - bulkcontrol - - bulk_boundaryconditions - - sqlite - - tables - state: - title: State - type: string - enum: - - created - - uploaded - - processed - - error - - removed - state_description: - title: State description - type: string - maxLength: 512 - x-nullable: true - meta: - title: Meta - type: object - x-nullable: true - id: - title: ID - type: integer - readOnly: true - Download: - type: object - properties: - get_url: - title: Get url - type: string - readOnly: true - is_internal: - title: Is internal - type: boolean - default: true - etag: - title: Etag - description: Optional eTag (md5sum) - type: string - readOnly: true - minLength: 1 - size: - title: Size - description: Filesize in bytes - type: integer - readOnly: true - FileMeta: - type: object - properties: - values_reference: - title: Values reference - type: string - maxLength: 255 - minLength: 1 - units: - title: Units - type: string - maxLength: 64 - minLength: 1 - timestamps: - description: seconds in the simulation - type: array - items: - type: integer - minimum: 0 - offset: - title: Offset - description: seconds in the simulation - type: integer - minimum: 0 - duration: - title: Duration - description: seconds - type: integer - minimum: 0 - geotransform: - type: array - items: - type: number - epsg_code: - title: Epsg code - type: integer - interval: - title: Interval - type: integer - error: - title: Error - type: string - maxLength: 512 - minLength: 1 - fill_value: - title: Fill value - type: string - maxLength: 128 - minLength: 1 - InpyVersion: - required: - - threedi_version - - threedicore_version - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - threedi_version: - title: Threedi version - type: string - maxLength: 80 - minLength: 1 - threedicore_version: - title: Threedicore version - type: string - maxLength: 80 - minLength: 1 - slug: - title: Slug - type: string - readOnly: true - minLength: 1 - id: - title: ID - type: integer - readOnly: true - active: - title: Active - type: boolean - Organisation: - required: - - unique_id - - name - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - unique_id: - title: Unique id - type: string - maxLength: 32 - minLength: 1 - name: - title: Name - type: string - maxLength: 255 - minLength: 1 - OrganisationRole: - required: - - user - - role - - organisation - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - user: - title: User.username - type: string - pattern: ^[\w.@+-]+$ - description: The username of a user - role: - title: Role - type: string - organisation: - title: Organisation.unique_id - type: string - description: The unique_id of an organisation - organisation_name: - title: Organisation name - type: string - readOnly: true - OrganisationUser: - required: - - username - type: object - properties: - id: - title: ID - type: integer - readOnly: true - first_name: - title: First name - type: string - maxLength: 150 - last_name: - title: Last name - type: string - maxLength: 150 - username: - title: Username - description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ - only. - type: string - pattern: ^[\w.@+-]+$ - maxLength: 150 - minLength: 1 - email: - title: Email address - type: string - format: email - maxLength: 254 - roles: - description: Return a list of roles of the given user in this organisation. - type: array - items: - type: string - minLength: 1 - readOnly: true - OrganisationUserRolePatch: - required: - - roles - type: object - properties: - roles: - type: array - items: - type: string - Repository: - required: - - slug - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - id: - title: ID - type: integer - readOnly: true - organisation: - title: Organisation.unique_id - type: string - description: The unique_id of an organisation - slug: - title: Slug - description: do not change - type: string - format: slug - pattern: ^[-a-zA-Z0-9_]+$ - maxLength: 255 - minLength: 1 - revision: - type: array - items: - type: string - readOnly: true - uniqueItems: true - Revision: - required: - - repository - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - id: - title: ID - type: integer - readOnly: true - repository: - title: Repository - type: string - format: uri - number: - title: Number - type: integer - maximum: 2147483647 - minimum: -2147483648 - hash: - title: Hash - description: unique identifier for changeset - type: string - maxLength: 200 - x-nullable: true - commit_date: - title: Commit date - type: string - format: date-time - x-nullable: true - user: - title: User - description: user that committed the changeset for this revision - type: string - maxLength: 128 - x-nullable: true - is_pinned: - title: Is pinned - type: boolean - x-nullable: true - ThreediModel: - required: - - revision - - slug - - inpy_version - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - id: - title: ID - type: integer - readOnly: true - user: - title: User.username - type: string - readOnly: true - description: The username of a user - threedi_version: - title: Threedi version - description: The 3Di API version that created this threedimodel. - type: string - readOnly: true - minLength: 1 - breach_count: - title: Breach count - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - revision: - title: Revision - type: string - format: uri - revision_id: - title: Revision id - type: integer - readOnly: true - revision_hash: - title: Revision hash - type: string - readOnly: true - revision_number: - title: Revision number - type: string - readOnly: true - revision_commit_date: - title: Revision commit date - type: string - readOnly: true - schematisation_id: - title: Schematisation id - type: integer - readOnly: true - schematisation_name: - title: Schematisation name - type: string - readOnly: true - repository_slug: - title: Repository slug - type: string - readOnly: true - name: - title: Name - type: string - minLength: 1 - slug: - title: Slug - type: string - format: slug - pattern: ^[-a-zA-Z0-9_]+$ - maxLength: 512 - minLength: 1 - disabled: - title: Disabled - description: Disable the model. - type: boolean - is_valid: - title: Is valid - description: True if the threedimodel was generated without errors. - type: boolean - x-nullable: true - epsg: - title: Epsg - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - description: - title: Description - description: Please describe the model here... - type: string - x-nullable: true - storage_space: - title: Storage space - description: Automatically filled after threedimodel generation. - type: integer - maximum: 9223372036854775807 - minimum: -9223372036854775808 - storage_space_humanized: - title: Storage space humanized - type: string - readOnly: true - model_ini: - title: Model ini - type: string - maxLength: 512 - x-nullable: true - extent_two_d: - title: Extent - type: object - description: Extent specified either in geojson, wkt or ewkt. Coordinates - in longitude, latitude order. - required: - - type - - coordinates - properties: - type: - title: type - description: Type should always be 'Linestring' - type: string - default: Linestring - coordinates: - title: coordinates - description: Exactly 2 coordinates, specifying the bottom left (longitude, - latitude order)and upper right respectively - type: array - items: - type: array - items: - type: number - minItems: 2 - maxItems: 2 - minItems: 2 - maxItems: 2 - minItems: 2 - maxItems: 2 - example: - type: LineString - coordinates: - - - 4.668275805499175 - - 52.619558913867856 - - - 4.73849433310911 - - 52.66453976184968 - extent_one_d: - title: Extent - type: object - description: Extent specified either in geojson, wkt or ewkt. Coordinates - in longitude, latitude order. - required: - - type - - coordinates - properties: - type: - title: type - description: Type should always be 'Linestring' - type: string - default: Linestring - coordinates: - title: coordinates - description: Exactly 2 coordinates, specifying the bottom left (longitude, - latitude order)and upper right respectively - type: array - items: - type: array - items: - type: number - minItems: 2 - maxItems: 2 - minItems: 2 - maxItems: 2 - minItems: 2 - maxItems: 2 - example: - type: LineString - coordinates: - - - 4.668275805499175 - - 52.619558913867856 - - - 4.73849433310911 - - 52.66453976184968 - extent_zero_d: - title: Extent - type: object - description: Extent specified either in geojson, wkt or ewkt. Coordinates - in longitude, latitude order. - required: - - type - - coordinates - properties: - type: - title: type - description: Type should always be 'Linestring' - type: string - default: Linestring - coordinates: - title: coordinates - description: Exactly 2 coordinates, specifying the bottom left (longitude, - latitude order)and upper right respectively - type: array - items: - type: array - items: - type: number - minItems: 2 - maxItems: 2 - minItems: 2 - maxItems: 2 - minItems: 2 - maxItems: 2 - example: - type: LineString - coordinates: - - - 4.668275805499175 - - 52.619558913867856 - - - 4.73849433310911 - - 52.66453976184968 - nodes_count: - title: Nodes count - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - lines_count: - title: Lines count - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - inpy_version: - title: Inpy version - type: string - inp_success: - title: Inp success - type: boolean - Role: - required: - - name - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - name: - title: Name - type: string - maxLength: 255 - minLength: 1 - Schematisation: - required: - - name - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - id: - title: ID - type: integer - readOnly: true - owner: - title: Organisation.unique_id - type: string - description: The unique_id of an organisation - name: - title: Name - type: string - maxLength: 256 - minLength: 1 - slug: - title: Slug - description: The internal name (only superusers can modify) - type: string - format: slug - pattern: ^[-a-zA-Z0-9_]+$ - maxLength: 256 - minLength: 1 - tags: - title: tags - type: array - description: tags provided as a list of strings - items: - type: string - example: - - tag_1 - - tag_2 - meta: - title: Meta - type: object - x-nullable: true - created_by: - title: User.username - description: The username of a user - type: string - pattern: ^[\w.@+-]+$ - created_by_first_name: - title: Created by first name - type: string - readOnly: true - created_by_last_name: - title: Created by last name - type: string - readOnly: true - created: - title: Created - description: The creation date and time (only superusers can modify) - type: string - format: date-time - archived: - title: Archived - type: string - format: date-time - readOnly: true - last_updated: - title: Last updated - type: string - format: date-time - readOnly: true - storage_usage: - title: Storage usage - description: Automatically calculated. - type: integer - readOnly: true - threedimodel_limit: - title: Threedimodel limit - description: Maximum amount of ThreediModels per Schematisation - type: integer - maximum: 32767 - minimum: 0 - FileReadOnly: - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - filename: - title: Filename - type: string - readOnly: true - minLength: 1 - state: - title: State - type: string - enum: - - created - - uploaded - - processed - - error - - removed - readOnly: true - state_description: - title: State description - type: string - maxLength: 512 - x-nullable: true - type: - title: Type - type: string - enum: - - timeseries - - rastertimeseries - - savedstate - - results - - rasters - - gridadmin - - geopackage - - geojson - - initialwaterlevel - - bulklateral - - bulkcontrol - - bulk_boundaryconditions - - sqlite - - tables - readOnly: true - size: - title: Size - description: Filesize in bytes - type: integer - readOnly: true - etag: - title: Etag - description: Optional eTag (md5sum) - type: string - maxLength: 256 - x-nullable: true - expiry_date: - title: Expiry date - type: string - format: date - readOnly: true - id: - title: ID - type: integer - readOnly: true - meta: - title: Meta - type: object - readOnly: true - Sqlite: - type: object - properties: - id: - title: ID - type: integer - readOnly: true - file: - $ref: '#/definitions/FileReadOnly' - revision_id: - title: Revision id - type: integer - readOnly: true - RevisionRaster: - required: - - type - - name - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - type: - title: Type - type: string - enum: - - dem_file - - equilibrium_infiltration_rate_file - - frict_coef_file - - initial_groundwater_level_file - - initial_waterlevel_file - - groundwater_hydro_connectivity_file - - groundwater_impervious_layer_level_file - - infiltration_decay_period_file - - initial_infiltration_rate_file - - leakage_file - - phreatic_storage_capacity_file - - hydraulic_conductivity_file - - porosity_file - - infiltration_rate_file - - max_infiltration_capacity_file - - interception_file - - vegetation_height_file - - vegetation_drag_coefficient_file - - vegetation_stem_count_file - - vegetation_stem_diameter_file - name: - title: Name - type: string - maxLength: 60 - minLength: 1 - file: - $ref: '#/definitions/FileReadOnly' - id: - title: ID - type: integer - readOnly: true - epsg_code: - title: Epsg code - type: integer - readOnly: true - extent: - title: Extent - type: object - readOnly: true - description: Extent specified either in geojson, wkt or ewkt. Coordinates - in longitude, latitude order. - required: - - type - - coordinates - properties: - type: - title: type - description: Type should always be 'Linestring' - type: string - default: Linestring - coordinates: - title: coordinates - description: Exactly 2 coordinates, specifying the bottom left (longitude, - latitude order)and upper right respectively - type: array - items: - type: array - items: - type: number - minItems: 2 - maxItems: 2 - minItems: 2 - maxItems: 2 - minItems: 2 - maxItems: 2 - example: - type: LineString - coordinates: - - - 4.668275805499175 - - 52.619558913867856 - - - 4.73849433310911 - - 52.66453976184968 - geotransform: - type: array - items: - title: Geotransform - type: number - readOnly: true - unit: - title: Unit - type: string - enum: - - meters - x-nullable: true - SchematisationRevision: - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - id: - title: ID - type: integer - readOnly: true - created: - title: Created - type: string - format: date-time - readOnly: true - schematisation: - title: Schematisation - type: string - format: uri - readOnly: true - schematisation_id: - title: Schematisation id - type: integer - readOnly: true - number: - title: Number - type: integer - readOnly: true - sqlite: - $ref: '#/definitions/Sqlite' - rasters: - type: array - items: - $ref: '#/definitions/RevisionRaster' - readOnly: true - archived: - title: Archived - type: string - format: date-time - readOnly: true - commit_date: - title: Commit date - type: string - format: date-time - readOnly: true - commit_user: - title: User.username - description: The username of a user - type: string - pattern: ^[\w.@+-]+$ - readOnly: true - commit_first_name: - title: Commit first name - type: string - readOnly: true - commit_last_name: - title: Commit last name - type: string - readOnly: true - commit_message: - title: Commit message - type: string - readOnly: true - minLength: 1 - is_valid: - title: Is valid - type: boolean - readOnly: true - has_threedimodel: - title: Has threedimodel - type: boolean - readOnly: true - CreateRevision: - type: object - properties: - empty: - title: Empty - description: Create an empty revision - type: boolean - default: false - number: - title: Number - description: An optional revision number (only superusers can modify) - type: integer - created: - title: Created - description: An optional creation datetime (only superusers can modify) - type: string - format: date-time - UpdateRevision: - type: object - properties: - commit_message: - title: Commit message - type: string - minLength: 1 - x-nullable: true - DestroyRevision: - required: - - number - type: object - properties: - number: - title: Number - description: Provide revision number as verification - type: integer - RevisionTask: - required: - - name - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - name: - title: Name - type: string - enum: - - modelchecker - params: - title: Params - type: object - x-nullable: true - created: - title: Created - type: string - format: date-time - readOnly: true - last_updated: - title: Last updated - type: string - format: date-time - readOnly: true - status: - title: Status - type: string - enum: - - pending - - sent - - received - - started - - success - - failure - - revoked - detail: - title: Detail - type: object - revision: - title: Revision - type: string - format: uri - readOnly: true - id: - title: ID - type: integer - readOnly: true - Commit: - type: object - properties: - commit_message: - title: Commit message - type: string - minLength: 1 - x-nullable: true - force_as: - title: Force as - type: string - enum: - - default - - new_revision - - new_schematisation - schematisation_name: - title: Schematisation name - type: string - maxLength: 256 - minLength: 1 - commit_date: - title: Commit date - description: The datetime of the commit (only superusers can modify) - type: string - format: date-time - x-nullable: true - commit_user: - title: User.username - description: The username of a user - type: string - pattern: ^[\w.@+-]+$ - user: - title: User - description: User that committed the revision on models.lizard.net (only superusers - can modify) - type: string - maxLength: 128 - x-nullable: true - CreateThreedimodel: - type: object - properties: - inherit_from_previous_threedimodel: - title: Inherit from previous threedimodel - description: Try to inherit simulation templates from previous threedimodel - (in case of regenerate) - type: boolean - default: true - inherit_from_previous_revision: - title: Inherit from previous revision - description: Try to inherit simulation templates from previous revision - type: boolean - default: false - SqliteFileUpload: - required: - - filename - type: object - properties: - put_url: - title: Put url - type: string - format: uri - readOnly: true - minLength: 1 - filename: - title: Filename - type: string - maxLength: 255 - minLength: 1 - status: - title: Status - type: string - readOnly: true - minLength: 1 - md5sum: - title: md5sum (hash) of the (compressed) sqlite file - type: string - maxLength: 256 - minLength: 1 - Upload: - required: - - filename - type: object - properties: - put_url: - title: Put url - type: string - format: uri - readOnly: true - minLength: 1 - filename: - title: Filename - type: string - maxLength: 255 - minLength: 1 - status: - title: Status - type: string - readOnly: true - minLength: 1 - RasterCreate: - required: - - type - - name - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - type: - title: Type - type: string - enum: - - dem_file - - equilibrium_infiltration_rate_file - - frict_coef_file - - initial_groundwater_level_file - - initial_waterlevel_file - - groundwater_hydro_connectivity_file - - groundwater_impervious_layer_level_file - - infiltration_decay_period_file - - initial_infiltration_rate_file - - leakage_file - - phreatic_storage_capacity_file - - hydraulic_conductivity_file - - porosity_file - - infiltration_rate_file - - max_infiltration_capacity_file - - interception_file - - vegetation_height_file - - vegetation_drag_coefficient_file - - vegetation_stem_count_file - - vegetation_stem_diameter_file - name: - title: Name - type: string - maxLength: 60 - minLength: 1 - id: - title: ID - type: integer - readOnly: true - epsg_code: - title: Epsg code - type: integer - readOnly: true - extent: - title: Extent - type: object - readOnly: true - description: Extent specified either in geojson, wkt or ewkt. Coordinates - in longitude, latitude order. - required: - - type - - coordinates - properties: - type: - title: type - description: Type should always be 'Linestring' - type: string - default: Linestring - coordinates: - title: coordinates - description: Exactly 2 coordinates, specifying the bottom left (longitude, - latitude order)and upper right respectively - type: array - items: - type: array - items: - type: number - minItems: 2 - maxItems: 2 - minItems: 2 - maxItems: 2 - minItems: 2 - maxItems: 2 - example: - type: LineString - coordinates: - - - 4.668275805499175 - - 52.619558913867856 - - - 4.73849433310911 - - 52.66453976184968 - geotransform: - type: array - items: - title: Geotransform - type: number - readOnly: true - unit: - title: Unit - type: string - enum: - - meters - x-nullable: true - md5sum: - title: md5sum (hash) of the geotiff file - type: string - maxLength: 256 - minLength: 1 - Simulation: - required: - - name - - threedimodel - - organisation - - start_datetime - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - slug: - title: Slug - type: string - format: slug - pattern: ^[-a-zA-Z0-9_]+$ - readOnly: true - minLength: 1 - uuid: - title: Uuid - type: string - format: uuid - readOnly: true - name: - title: Name - type: string - maxLength: 128 - minLength: 1 - tags: - title: tags - type: array - description: tags provided as a list of strings - items: - type: string - example: - - tag_1 - - tag_2 - created: - title: Created - type: string - readOnly: true - threedimodel: - title: Threedimodel.id - type: string - format: uri - description: The id of a threedimodel - organisation: - title: Organisation.unique_id - type: string - description: The unique_id of an organisation - organisation_name: - title: Organisation name - type: string - readOnly: true - user: - title: User.username - type: string - pattern: ^[\w.@+-]+$ - readOnly: true - description: The username of a user - start_datetime: - title: Start datetime - type: string - format: date-time - end_datetime: - title: End datetime - type: string - format: date-time - duration: - title: Duration - type: integer - duration_humanized: - title: Duration humanized - type: string - readOnly: true - threedimodel_id: - title: Threedimodel id - type: integer - readOnly: true - id: - title: ID - type: integer - readOnly: true - threedicore_version: - title: Threedicore version - type: string - maxLength: 16 - minLength: 1 - x-nullable: true - cloned_from: - title: Cloned from - type: string - format: uri - readOnly: true - compute_cluster: - title: ComputeCluster.name - type: string - readOnly: true - description: The name of the compute cluster that runs/has run the simulation. - Template: - required: - - name - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - name: - title: Name - type: string - maxLength: 255 - minLength: 1 - id: - title: ID - type: integer - readOnly: true - created: - title: Created - type: string - format: date-time - readOnly: true - simulation: - $ref: '#/definitions/Simulation' - CreateTemplate: - required: - - name - - simulation - type: object - properties: - name: - title: Name - type: string - maxLength: 255 - minLength: 1 - simulation: - title: Simulation - type: string - format: uri - include_events: - title: Include events - type: boolean - default: true - include_initials: - title: Include initials - type: boolean - default: true - include_settings: - title: Include settings - type: boolean - default: true - UpdateTemplate: - required: - - name - type: object - properties: - name: - title: Name - type: string - maxLength: 255 - minLength: 1 - FromTemplate: - required: - - template - - name - - organisation - - start_datetime - type: object - properties: - template: - title: Template - description: source simulation template id - type: string - format: uri - threedimodel: - title: Threedimodel.id - description: The id of a threedimodel - type: string - format: uri - name: - title: Name - type: string - maxLength: 128 - minLength: 1 - tags: - type: array - items: - type: string - x-nullable: true - organisation: - title: Organisation - type: string - minLength: 1 - start_datetime: - title: Start datetime - type: string - format: date-time - end_datetime: - title: End datetime - type: string - format: date-time - duration: - title: Duration - type: integer - clone_events: - title: Clone events - type: boolean - default: true - clone_initials: - title: Clone initials - type: boolean - default: true - clone_settings: - title: Clone settings - type: boolean - default: true - PostProcessingQueue: - required: - - simulation - - status - type: object - properties: - simulation: - title: Simulation - type: integer - status: - title: Status - type: string - enum: - - created - - requested - - archiving - - archiving_failed - - archived - created: - title: Created - type: string - format: date-time - readOnly: true - SimulationUpdate: - required: - - name - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - slug: - title: Slug - type: string - format: slug - pattern: ^[-a-zA-Z0-9_]+$ - readOnly: true - minLength: 1 - uuid: - title: Uuid - type: string - format: uuid - readOnly: true - name: - title: Name - type: string - maxLength: 128 - minLength: 1 - tags: - title: tags - type: array - description: tags provided as a list of strings - items: - type: string - example: - - tag_1 - - tag_2 - created: - title: Created - type: string - readOnly: true - threedimodel: - title: Threedimodel.id - type: string - format: uri - readOnly: true - description: The id of a threedimodel - organisation: - title: Organisation.unique_id - type: string - readOnly: true - description: The unique_id of an organisation - organisation_name: - title: Organisation name - type: string - readOnly: true - user: - title: User.username - type: string - pattern: ^[\w.@+-]+$ - readOnly: true - description: The username of a user - start_datetime: - title: Start datetime - type: string - format: date-time - readOnly: true - end_datetime: - title: End datetime - type: string - format: date-time - duration: - title: Duration - type: integer - duration_humanized: - title: Duration humanized - type: string - readOnly: true - threedimodel_id: - title: Threedimodel id - type: integer - readOnly: true - id: - title: ID - type: integer - readOnly: true - threedicore_version: - title: Threedicore version - type: string - maxLength: 16 - minLength: 1 - x-nullable: true - cloned_from: - title: Cloned from - type: string - format: uri - readOnly: true - compute_cluster: - title: ComputeCluster.name - type: string - readOnly: true - description: The name of the compute cluster that runs/has run the simulation. - LizardRasterRain: - required: - - offset - - reference_uuid - - start_datetime - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - duration: - title: Duration (in seconds) - description: event duration in seconds. -9999 is the 'infinite duration' value - (only allowed in conjunction with infinite simulations - type: integer - maximum: 9223372036854775807 - minimum: -9223372036854775808 - x-nullable: true - units: - title: Units - type: string - enum: - - mm/duration - - mm/h - - m/s - reference_uuid: - title: Reference uuid - type: string - maxLength: 40 - minLength: 1 - start_datetime: - title: Start datetime - type: string - format: date-time - simulation: - title: Simulation - type: string - format: uri - readOnly: true - multiplier: - title: Multiplier - type: number - default: 1.0 - interval: - title: Interval - type: integer - readOnly: true - user: - title: User - type: string - readOnly: true - user_id: - title: User id - type: integer - readOnly: true - origin_offset: - title: Origin offset - type: integer - readOnly: true - store_path: - title: Store path - type: string - readOnly: true - minLength: 1 - id: - title: ID - type: integer - readOnly: true - LizardTimeseriesRain: - required: - - offset - - reference_uuid - - start_datetime - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - duration: - title: Duration (in seconds) - description: event duration in seconds. -9999 is the 'infinite duration' value - (only allowed in conjunction with infinite simulations - type: integer - maximum: 9223372036854775807 - minimum: -9223372036854775808 - x-nullable: true - reference_uuid: - title: Reference uuid - type: string - maxLength: 40 - minLength: 1 - start_datetime: - title: Start datetime - type: string - format: date-time - interpolate: - title: Interpolate - type: boolean - values: - type: array - items: - type: array - items: - type: number - description: Timestamp + value pair - example: - - 100 - - 0.5 - maxItems: 2 - minItems: 2 - readOnly: true - maxItems: 300 - title: Timeseries - description: 'Timeseries provided as a nested list. The inner list consists - of exactly 2 values: timestamp, value' - example: - - - 0 - - 0.1 - - - 100 - - 0.5 - - - 200 - - 0 - minItems: 1 - units: - title: Units - type: string - enum: - - mm/duration - - mm/h - - m/s - id: - title: ID - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - TimeseriesRainOverview: - required: - - offset - - values - - units - type: object - properties: - url: - title: Url - type: string - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - duration: - title: Duration (in seconds) - description: event duration in seconds. -9999 is the 'infinite duration' value - (only allowed in conjunction with infinite simulations - type: integer - readOnly: true - interpolate: - title: Interpolate - type: boolean - values: - type: array - items: - type: array - items: - type: number - description: Timestamp + value pair - example: - - 100 - - 0.5 - maxItems: 2 - minItems: 2 - maxItems: 300 - title: Timeseries - description: 'Timeseries provided as a nested list. The inner list consists - of exactly 2 values: timestamp, value' - example: - - - 0 - - 0.1 - - - 100 - - 0.5 - - - 200 - - 0 - minItems: 1 - units: - title: Units - description: m/s is only option for now - type: string - enum: - - m/s - constant: - title: Constant - type: boolean - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - Breach: - required: - - duration_till_max_depth - - initial_width - - offset - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - potential_breach: - title: Potential breach - type: string - format: uri - line_id: - title: Line id - description: The id of the flowline ('levl' in the geojson) - type: integer - maximum: 2147483647 - minimum: 0 - duration_till_max_depth: - title: Duration till max depth - description: Duration till maximum depth, in seconds - type: integer - maximum: 2147483647 - minimum: 0 - maximum_breach_depth: - title: Maximum breach depth - description: The maximum breach depth relative to the crest level, in meters - type: number - levee_material: - title: Levee material - type: string - enum: - - sand - - clay - initial_width: - title: Initial width - description: initial width in meters - type: number - discharge_coefficient_positive: - title: Discharge coefficient positive - type: number - x-nullable: true - discharge_coefficient_negative: - title: Discharge coefficient negative - type: number - x-nullable: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - id: - title: ID - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - LizardRasterSourcesSinks: - required: - - offset - - reference_uuid - - start_datetime - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - duration: - title: Duration (in seconds) - description: event duration in seconds. -9999 is the 'infinite duration' value - (only allowed in conjunction with infinite simulations - type: integer - maximum: 9223372036854775807 - minimum: -9223372036854775808 - x-nullable: true - reference_uuid: - title: Reference uuid - type: string - maxLength: 40 - minLength: 1 - start_datetime: - title: Start datetime - type: string - format: date-time - simulation: - title: Simulation - type: string - format: uri - readOnly: true - interval: - title: Interval - type: integer - readOnly: true - origin_offset: - title: Origin offset - type: integer - readOnly: true - store_path: - title: Store path - type: string - readOnly: true - minLength: 1 - id: - title: ID - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - user: - title: User - type: string - readOnly: true - user_id: - title: User id - type: integer - readOnly: true - LizardTimeseriesSourcesSinks: - required: - - offset - - reference_uuid - - start_datetime - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - duration: - title: Duration (in seconds) - description: event duration in seconds. -9999 is the 'infinite duration' value - (only allowed in conjunction with infinite simulations - type: integer - maximum: 9223372036854775807 - minimum: -9223372036854775808 - x-nullable: true - reference_uuid: - title: Reference uuid - type: string - maxLength: 40 - minLength: 1 - start_datetime: - title: Start datetime - type: string - format: date-time - interpolate: - title: Interpolate - type: boolean - values: - type: array - items: - type: array - items: - type: number - description: Timestamp + value pair - example: - - 100 - - 0.5 - maxItems: 2 - minItems: 2 - readOnly: true - maxItems: 300 - title: Timeseries - description: 'Timeseries provided as a nested list. The inner list consists - of exactly 2 values: timestamp, value' - example: - - - 0 - - 0.1 - - - 100 - - 0.5 - - - 200 - - 0 - minItems: 1 - uid: - title: Uid - type: string - format: uuid - readOnly: true - FileRasterSourcesSinks: - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - multiplier: - title: Multiplier - type: number - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - duration: - title: Duration - description: Duration of event in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - timestamps: - description: in simulation in seconds - type: array - items: - title: Timestamps - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - interval: - title: Interval - description: interval in seconds - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - values_reference: - title: Values reference - type: string - maxLength: 255 - x-nullable: true - fill_value: - title: Fill value - type: string - maxLength: 128 - minLength: 1 - units: - title: Units - type: string - enum: - - m/s - - mm - - mm/h - - mm/hr - x-nullable: true - geotransform: - type: array - items: - title: Geotransform - type: number - maxItems: 6 - epsg_code: - title: Epsg code - type: integer - maximum: 2147483647 - minimum: -2147483648 - file: - $ref: '#/definitions/FileReadOnly' - type: - title: Type - type: string - enum: - - netcdf4 - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - FileTimeseriesSourcesSinks: - required: - - units - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - multiplier: - title: Multiplier - type: number - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - duration: - title: Duration - description: Duration of event in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - timestamps: - description: in simulation in seconds - type: array - items: - title: Timestamps - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - interval: - title: Interval - description: interval in seconds - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - values_reference: - title: Values reference - type: string - maxLength: 255 - x-nullable: true - fill_value: - title: Fill value - type: string - maxLength: 128 - minLength: 1 - type: - title: Type - type: string - enum: - - netcdf4 - readOnly: true - units: - title: Units - type: string - enum: - - mm - - mm/h - file: - $ref: '#/definitions/FileReadOnly' - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - TimeseriesSourcesSinksOverview: - required: - - offset - - values - - units - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - interpolate: - title: Interpolate - type: boolean - values: - type: array - items: - type: array - items: - type: number - description: Timestamp + value pair - example: - - 100 - - 0.5 - maxItems: 2 - minItems: 2 - maxItems: 300 - title: Timeseries - description: 'Timeseries provided as a nested list. The inner list consists - of exactly 2 values: timestamp, value' - example: - - - 0 - - 0.1 - - - 100 - - 0.5 - - - 200 - - 0 - minItems: 1 - units: - title: Units - description: "'m/s' (only option for now)" - type: string - enum: - - m/s - constant: - title: Constant - type: boolean - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - TimeseriesLeakageOverview: - required: - - offset - - values - - units - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - interpolate: - title: Interpolate - type: boolean - values: - type: array - items: - type: array - items: - type: number - description: Timestamp + value pair - example: - - 100 - - 0.5 - maxItems: 2 - minItems: 2 - maxItems: 300 - title: Timeseries - description: 'Timeseries provided as a nested list. The inner list consists - of exactly 2 values: timestamp, value' - example: - - - 0 - - 0.1 - - - 100 - - 0.5 - - - 200 - - 0 - minItems: 1 - units: - title: Units - description: "'m/s' (only option for now)" - type: string - enum: - - m/s - constant: - title: Constant - type: boolean - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - FileTimeseriesLeakage: - required: - - units - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - multiplier: - title: Multiplier - type: number - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - duration: - title: Duration - description: Duration of event in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - timestamps: - description: in simulation in seconds - type: array - items: - title: Timestamps - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - interval: - title: Interval - description: interval in seconds - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - values_reference: - title: Values reference - type: string - maxLength: 255 - x-nullable: true - fill_value: - title: Fill value - type: string - maxLength: 128 - minLength: 1 - type: - title: Type - type: string - enum: - - netcdf4 - readOnly: true - units: - title: Units - type: string - enum: - - mm - - mm/h - file: - $ref: '#/definitions/FileReadOnly' - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - FileRasterLeakage: - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - multiplier: - title: Multiplier - type: number - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - duration: - title: Duration - description: Duration of event in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - timestamps: - description: in simulation in seconds - type: array - items: - title: Timestamps - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - interval: - title: Interval - description: interval in seconds - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - values_reference: - title: Values reference - type: string - maxLength: 255 - x-nullable: true - fill_value: - title: Fill value - type: string - maxLength: 128 - minLength: 1 - units: - title: Units - type: string - enum: - - m/s - - mm - - mm/h - - mm/hr - x-nullable: true - geotransform: - type: array - items: - title: Geotransform - type: number - maxItems: 6 - epsg_code: - title: Epsg code - type: integer - maximum: 2147483647 - minimum: -2147483648 - file: - $ref: '#/definitions/FileReadOnly' - type: - title: Type - type: string - enum: - - netcdf4 - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - TwoDWaterLevel: - required: - - value - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - value: - title: Value - type: number - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - OneDWaterLevelPredefined: - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - GroundWaterLevel: - required: - - value - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - value: - title: Value - type: number - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - GroundWaterRaster: - required: - - aggregation_method - - initial_waterlevel - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - aggregation_method: - title: Aggregation method - type: string - enum: - - mean - - max - - min - initial_waterlevel: - title: Initial waterlevel - type: string - format: uri - initial_waterlevel_id: - title: Initial waterlevel id - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - OneDWaterLevel: - required: - - value - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - value: - title: Value - type: number - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - OneDWaterLevelFile: - required: - - initial_waterlevel - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - initial_waterlevel: - title: Initial waterlevel - type: string - format: uri - initial_waterlevel_id: - title: Initial waterlevel id - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - TwoDWaterRaster: - required: - - aggregation_method - - initial_waterlevel - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - aggregation_method: - title: Aggregation method - type: string - enum: - - mean - - max - - min - initial_waterlevel: - title: Initial waterlevel - type: string - format: uri - initial_waterlevel_id: - title: Initial waterlevel id - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - FileRasterRain: - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - multiplier: - title: Multiplier - type: number - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - duration: - title: Duration - description: Duration of event in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - timestamps: - description: in simulation in seconds - type: array - items: - title: Timestamps - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - interval: - title: Interval - description: interval in seconds - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - values_reference: - title: Values reference - type: string - maxLength: 255 - x-nullable: true - fill_value: - title: Fill value - type: string - maxLength: 128 - minLength: 1 - units: - title: Units - type: string - enum: - - m/s - - mm - - mm/h - - mm/hr - x-nullable: true - geotransform: - type: array - items: - title: Geotransform - type: number - maxItems: 6 - epsg_code: - title: Epsg code - type: integer - maximum: 2147483647 - minimum: -2147483648 - file: - $ref: '#/definitions/FileReadOnly' - type: - title: Type - type: string - enum: - - netcdf4 - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - FileTimeseriesRain: - required: - - units - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - multiplier: - title: Multiplier - type: number - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - duration: - title: Duration - description: Duration of event in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - timestamps: - description: in simulation in seconds - type: array - items: - title: Timestamps - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - interval: - title: Interval - description: interval in seconds - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - values_reference: - title: Values reference - type: string - maxLength: 255 - x-nullable: true - fill_value: - title: Fill value - type: string - maxLength: 128 - minLength: 1 - type: - title: Type - type: string - enum: - - netcdf4 - readOnly: true - units: - title: Units - type: string - enum: - - mm - - mm/h - file: - $ref: '#/definitions/FileReadOnly' - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - Threshold: - required: - - variable - - value - type: object - properties: - variable: - title: Variable - type: string - enum: - - s1 - - u1 - value: - title: Value - type: number - SavedStateOverview: - required: - - type - - thresholds - type: object - properties: - name: - title: Name - type: string - maxLength: 80 - minLength: 1 - type: - title: Type - type: string - enum: - - stable_threshold - - timed - created: - title: Created - type: string - format: date-time - x-nullable: true - created_time: - title: Time in simulation (in seconds) - description: Time in simulation the savedstate has been created - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - tags: - title: tags - type: array - description: tags provided as a list of strings - items: - type: string - example: - - tag_1 - - tag_2 - expiry: - title: Expiry - type: string - format: date-time - x-nullable: true - time: - title: Time in simulation (in seconds) - description: Time in simulation to create savedstate - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - thresholds: - type: array - items: - $ref: '#/definitions/Threshold' - file: - $ref: '#/definitions/FileReadOnly' - id: - title: ID - type: integer - readOnly: true - uuid: - title: Uuid - type: string - format: uuid - InitialSavedStateOverview: - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - saved_state: - $ref: '#/definitions/SavedStateOverview' - id: - title: ID - type: integer - readOnly: true - uuid: - title: Uuid - type: string - readOnly: true - Lateral: - required: - - offset - - values - - units - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - duration: - title: Duration (in seconds) - description: event duration in seconds. -9999 is the 'infinite duration' value - (only allowed in conjunction with infinite simulations - type: integer - maximum: 9223372036854775807 - minimum: -9223372036854775808 - x-nullable: true - interpolate: - title: Interpolate - type: boolean - values: - type: array - items: - type: array - items: - type: number - description: Timestamp + value pair - example: - - 100 - - 0.5 - maxItems: 2 - minItems: 2 - maxItems: 300 - title: Timeseries - description: 'Timeseries provided as a nested list. The inner list consists - of exactly 2 values: timestamp, value' - example: - - - 0 - - 0.1 - - - 100 - - 0.5 - - - 200 - - 0 - minItems: 1 - units: - title: Units - description: "'m3/s' (only option for now)" - type: string - enum: - - m3/s - constant: - title: Constant - type: boolean - point: - title: Point - type: object - description: Point specified in wkt or geojson. Coordinates in longitude, - latitude order. - required: - - type - - coordinates - properties: - type: - title: type - description: Type should always be 'Point' - type: string - default: Point - coordinates: - title: coordinates - description: List of exactly one coordinate (longitude, latitude order) - type: array - items: - type: number - minItems: 2 - maxItems: 2 - example: - type: Point - coordinates: - - 4.695281 - - 52.656047 - connection_node: - title: Connection node - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - state: - title: State - type: string - enum: - - processing - - valid - - invalid - readOnly: true - state_detail: - title: State detail - type: object - readOnly: true - grid_id: - title: Grid id - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - FileLateral: - required: - - offset - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - id: - title: ID - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - file: - $ref: '#/definitions/File' - state: - title: State - type: string - enum: - - processing - - valid - - invalid - readOnly: true - state_detail: - title: State detail - type: object - readOnly: true - periodic: - title: Periodic - type: string - enum: - - daily - readOnly: true - FileBoundaryCondition: - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - id: - title: ID - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - file: - $ref: '#/definitions/File' - state: - title: State - type: string - enum: - - processing - - valid - - invalid - readOnly: true - state_detail: - title: State detail - type: object - readOnly: true - MeasureLocation: - required: - - weight - - content_type - - content_pk - type: object - properties: - id: - title: ID - type: integer - readOnly: true - weight: - title: Weight - type: string - format: decimal - content_type: - title: Content type - description: 'e.g. ' - type: string - enum: - - v2_connection_node - - v2_pipe - - v2_orifice - - v2_culvert - - v2_channel - - v2_weir - content_pk: - title: Content pk - type: integer - maximum: 2147483647 - minimum: -2147483648 - grid_id: - title: Grid id - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - state: - title: State - type: string - enum: - - processing - - valid - - invalid - readOnly: true - state_detail: - title: State detail - type: object - readOnly: true - MeasureSpecification: - required: - - locations - - variable - - operator - type: object - properties: - id: - title: ID - type: integer - readOnly: true - name: - title: Name - type: string - maxLength: 50 - locations: - type: array - items: - $ref: '#/definitions/MeasureLocation' - variable: - title: Variable - description: | - measurement variable, one of the following options: - s1 (waterlevel) - vol1 (volume) - q (discharge) - u1 (velocity) - type: string - enum: - - s1 - - vol1 - - q - - u1 - operator: - title: Operator - description: e.g. >, <, >=, <= - type: string - enum: - - '>' - - '>=' - - < - - <= - TableStructureControl: - required: - - offset - - duration - - measure_specification - - structure_type - - type - - values - type: object - properties: - id: - title: ID - type: integer - readOnly: true - url: - title: Url - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - duration: - title: Duration (in seconds) - description: event duration in seconds. -9999 is the 'infinite duration' value - (only allowed in conjunction with infinite simulations - type: integer - maximum: 9223372036854775807 - minimum: -9223372036854775808 - x-nullable: true - measure_specification: - $ref: '#/definitions/MeasureSpecification' - structure_id: - title: Structure id - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - structure_type: - title: Structure type - type: string - enum: - - v2_pumpstation - - v2_pipe - - v2_orifice - - v2_culvert - - v2_weir - - v2_channel - type: - title: Type - type: string - enum: - - set_discharge_coefficients - - set_crest_level - - set_pump_capacity - - set_gate_level - values: - type: array - items: - type: array - items: - title: Values - type: number - maxItems: 3 - maxItems: 150 - state: - title: State - type: string - enum: - - processing - - valid - - invalid - readOnly: true - state_detail: - title: State detail - type: object - readOnly: true - grid_id: - title: Grid id - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - MemoryStructureControl: - required: - - offset - - duration - - measure_specification - - structure_type - - type - - value - type: object - properties: - id: - title: ID - type: integer - readOnly: true - url: - title: Url - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - duration: - title: Duration (in seconds) - description: event duration in seconds. -9999 is the 'infinite duration' value - (only allowed in conjunction with infinite simulations - type: integer - maximum: 9223372036854775807 - minimum: -9223372036854775808 - x-nullable: true - measure_specification: - $ref: '#/definitions/MeasureSpecification' - structure_id: - title: Structure id - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - structure_type: - title: Structure type - type: string - enum: - - v2_pumpstation - - v2_pipe - - v2_orifice - - v2_culvert - - v2_weir - - v2_channel - type: - title: Type - type: string - enum: - - set_discharge_coefficients - - set_crest_level - - set_pump_capacity - - set_gate_level - value: - description: 'list containing a single action values, e.g. [*action_value*]. - For type set_discharge_coefficients two action values need to be provided, - e.g. [*action_value*, *action_value*]. ' - type: array - items: - title: Value - type: number - maxItems: 2 - state: - title: State - type: string - enum: - - processing - - valid - - invalid - readOnly: true - state_detail: - title: State detail - type: object - readOnly: true - grid_id: - title: Grid id - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - upper_threshold: - title: Upper threshold - description: e.g. 0.3 - type: number - x-nullable: true - lower_threshold: - title: Lower threshold - description: e.g. 0.3 - type: number - x-nullable: true - is_active: - title: Is active - description: when True the initial state of the target is active - type: boolean - is_inverse: - title: Is inverse - description: when True the target will become active when the lower threshold - has been reached - type: boolean - TimedStructureControl: - required: - - offset - - duration - - value - - type - - structure_type - type: object - properties: - id: - title: ID - type: integer - readOnly: true - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - duration: - title: Duration - type: integer - minimum: 1 - value: - type: array - items: - title: Value - type: number - maxItems: 2 - type: - title: Type - type: string - enum: - - set_discharge_coefficients - - set_crest_level - - set_pump_capacity - - set_gate_level - structure_id: - title: Structure id - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - structure_type: - title: Structure type - type: string - enum: - - v2_pumpstation - - v2_pipe - - v2_orifice - - v2_culvert - - v2_weir - - v2_channel - state: - title: State - type: string - enum: - - processing - - valid - - invalid - readOnly: true - state_detail: - title: State detail - type: object - readOnly: true - grid_id: - title: Grid id - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - FileStructureControl: - required: - - offset - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - id: - title: ID - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - file: - $ref: '#/definitions/File' - state: - title: State - type: string - enum: - - processing - - valid - - invalid - readOnly: true - state_detail: - title: State detail - type: object - readOnly: true - RasterEdit: - required: - - raster - - offset - - value - - polygon - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - raster: - title: Raster - type: string - format: uri - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - value: - title: Value - description: Absolute or relative height (in meters) to use for the polygon - type: number - polygon: - title: Polygon - type: object - description: Polygon specified in wkt or geojson, interior rings are not allowed. - Coordinates in longitude, latitude order. - required: - - type - - coordinates - properties: - type: - title: type - description: Type should always be 'Polygon' - type: string - default: Polygon - coordinates: - title: coordinates - description: List of coordinates (longitude, latitude order) - type: array - items: - type: array - items: - type: array - items: - type: number - minItems: 2 - maxItems: 2 - minItems: 3 - minItems: 1 - maxItems: 1 - example: - type: Polygon - coordinates: - - - - 4.695281 - - 52.656047 - - - 4.683754 - - 52.655824 - - - 4.683253 - - 52.639063 - - - 4.695281 - - 52.656047 - relative: - title: Relative - description: Process the value as a relative height, default is absolute - type: boolean - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - LocalRain: - required: - - offset - - values - - point - - diameter - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - duration: - title: Duration (in seconds) - description: event duration in seconds. -9999 is the 'infinite duration' value - (only allowed in conjunction with infinite simulations - type: integer - maximum: 9223372036854775807 - minimum: -9223372036854775808 - x-nullable: true - interpolate: - title: Interpolate - type: boolean - values: - type: array - items: - type: array - items: - type: number - description: Timestamp + value pair - example: - - 100 - - 0.5 - maxItems: 2 - minItems: 2 - maxItems: 300 - title: Timeseries - description: 'Timeseries provided as a nested list. The inner list consists - of exactly 2 values: timestamp, value' - example: - - - 0 - - 0.1 - - - 100 - - 0.5 - - - 200 - - 0 - minItems: 1 - units: - title: Units - description: m/s is only option for now - type: string - enum: - - m/s - - mm/h - - mm/min - constant: - title: Constant - type: boolean - point: - title: Point - type: object - description: Point specified in wkt or geojson. Coordinates in longitude, - latitude order. - required: - - type - - coordinates - properties: - type: - title: type - description: Type should always be 'Point' - type: string - default: Point - coordinates: - title: coordinates - description: List of exactly one coordinate (longitude, latitude order) - type: array - items: - type: number - minItems: 2 - maxItems: 2 - example: - type: Point - coordinates: - - 4.695281 - - 52.656047 - diameter: - title: Diameter - type: integer - maximum: 2147483647 - minimum: -2147483648 - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - Wind: - required: - - offset - type: object - properties: - id: - title: ID - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - values: - description: '[time, speed, direction]' - type: array - items: - type: array - items: - title: Values - type: number - maxItems: 300 - units: - title: Units - description: wind speed unit (default 'm/s') - type: string - enum: - - m/s - - km/h - speed_interpolate: - title: Speed interpolate - description: interpolate wind speed - type: boolean - readOnly: true - speed_constant: - title: Speed constant - description: constant wind speed - type: boolean - readOnly: true - direction_interpolate: - title: Direction interpolate - description: interpolate wind direction - type: boolean - readOnly: true - direction_constant: - title: Direction constant - description: constant wind direction - type: boolean - readOnly: true - WindDragCoefficient: - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - value: - title: Value - description: global drag coefficient (0-100) - type: number - maximum: 100 - minimum: 0 - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - Event: - type: object - properties: - lizardrasterrain: - type: array - items: - $ref: '#/definitions/LizardRasterRain' - readOnly: true - lizardtimeseriesrain: - type: array - items: - $ref: '#/definitions/LizardTimeseriesRain' - readOnly: true - timeseriesrain: - type: array - items: - $ref: '#/definitions/TimeseriesRainOverview' - readOnly: true - breach: - type: array - items: - $ref: '#/definitions/Breach' - readOnly: true - lizardrastersourcessinks: - type: array - items: - $ref: '#/definitions/LizardRasterSourcesSinks' - readOnly: true - lizardtimeseriessourcessinks: - type: array - items: - $ref: '#/definitions/LizardTimeseriesSourcesSinks' - readOnly: true - filerastersourcessinks: - type: array - items: - $ref: '#/definitions/FileRasterSourcesSinks' - readOnly: true - filetimeseriessourcessinks: - type: array - items: - $ref: '#/definitions/FileTimeseriesSourcesSinks' - readOnly: true - timeseriessourcessinks: - type: array - items: - $ref: '#/definitions/TimeseriesSourcesSinksOverview' - readOnly: true - leakage: - type: array - items: - $ref: '#/definitions/TimeseriesLeakageOverview' - readOnly: true - filetimeseriesleakage: - type: array - items: - $ref: '#/definitions/FileTimeseriesLeakage' - readOnly: true - filerasterleakage: - type: array - items: - $ref: '#/definitions/FileRasterLeakage' - readOnly: true - initial_twodwaterlevel: - $ref: '#/definitions/TwoDWaterLevel' - initial_onedwaterlevelpredefined: - $ref: '#/definitions/OneDWaterLevelPredefined' - initial_groundwaterlevel: - $ref: '#/definitions/GroundWaterLevel' - initial_groundwaterraster: - $ref: '#/definitions/GroundWaterRaster' - initial_onedwaterlevel: - $ref: '#/definitions/OneDWaterLevel' - initial_onedwaterlevelfile: - $ref: '#/definitions/OneDWaterLevelFile' - initial_twodwaterraster: - $ref: '#/definitions/TwoDWaterRaster' - filerasterrain: - type: array - items: - $ref: '#/definitions/FileRasterRain' - readOnly: true - filetimeseriesrain: - type: array - items: - $ref: '#/definitions/FileTimeseriesRain' - readOnly: true - initial_savedstate: - $ref: '#/definitions/InitialSavedStateOverview' - savedstates: - type: array - items: - $ref: '#/definitions/SavedStateOverview' - readOnly: true - laterals: - type: array - items: - $ref: '#/definitions/Lateral' - readOnly: true - filelaterals: - type: array - items: - $ref: '#/definitions/FileLateral' - readOnly: true - fileboundaryconditions: - $ref: '#/definitions/FileBoundaryCondition' - tablestructurecontrols: - type: array - items: - $ref: '#/definitions/TableStructureControl' - readOnly: true - memorystructurecontrols: - type: array - items: - $ref: '#/definitions/MemoryStructureControl' - readOnly: true - timedstructurecontrols: - type: array - items: - $ref: '#/definitions/TimedStructureControl' - readOnly: true - filestructurecontrols: - type: array - items: - $ref: '#/definitions/FileStructureControl' - readOnly: true - rasteredits: - type: array - items: - $ref: '#/definitions/RasterEdit' - readOnly: true - obstacleedits: - type: array - items: - $ref: '#/definitions/ObstacleEdit' - readOnly: true - localrain: - type: array - items: - $ref: '#/definitions/LocalRain' - readOnly: true - wind: - type: array - items: - $ref: '#/definitions/Wind' - readOnly: true - initial_winddragcoefficient: - $ref: '#/definitions/WindDragCoefficient' - Action: - required: - - name - type: object - properties: - name: - title: Name - type: string - enum: - - initialize - - start - - pause - - shutdown - - queue - - dequeue - duration: - title: Duration - description: Only valid for name='start'. Run simulation for given duration - (in seconds) and pause - type: integer - minimum: 1 - timeout: - title: Timeout - description: Only valid for name='pause'. Remove simulation after given timeout - (in seconds). Defaults to 300 seconds - type: integer - default: 300 - minimum: 30 - max_rate: - title: Max rate - description: "Only valid for name='start'. Limit maximum speed of the simulation.\ - \ The max_rate is a multiplier relative to real time For example max_rate\ - \ '60' means max 60 simulation seconds in 1 real second " - type: number - minimum: 1 - compute_cluster: - title: ComputeCluster.name - description: The name of the compute cluster that runs/has run the simulation. - type: string - simulation_runner: - title: Simulation runner - description: "Only allowed for name values: 'start', 'initialize' or 'queue\ - \ Simulation runner version used to execute the simulation. If not filled\ - \ in the default version is used. (Note: used for testing new calccore releases\ - \ on the staging environment. On production only the default version can\ - \ be picked)" - type: string - enum: - - 3.2.65-3.2.1 - Timeout: - required: - - timeout - type: object - properties: - timeout: - title: Timeout - description: Only valid for when the simulation is paused. Reset the simulation - timeout to the given value. Defaults to 300 seconds - type: integer - minimum: 30 - StableThresholdSavedState: - required: - - thresholds - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - name: - title: Name - type: string - maxLength: 80 - minLength: 1 - simulation: - title: Simulation - type: string - format: uri - readOnly: true - created: - title: Created - type: string - format: date-time - readOnly: true - tags: - title: tags - type: array - description: tags provided as a list of strings - items: - type: string - example: - - tag_1 - - tag_2 - expiry: - title: Expiry - type: string - format: date-time - x-nullable: true - thresholds: - type: array - items: - $ref: '#/definitions/Threshold' - file: - $ref: '#/definitions/FileReadOnly' - uuid: - title: Uuid - type: string - format: uuid - TimedSavedStateUpdate: - required: - - time - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - name: - title: Name - type: string - maxLength: 80 - minLength: 1 - simulation: - title: Simulation - type: string - format: uri - readOnly: true - created: - title: Created - type: string - format: date-time - x-nullable: true - created_time: - title: Time in simulation (in seconds) - description: Time in simulation the savedstate has been created - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - tags: - title: tags - type: array - description: tags provided as a list of strings - items: - type: string - example: - - tag_1 - - tag_2 - expiry: - title: Expiry - type: string - format: date-time - x-nullable: true - time: - title: Time in simulation (in seconds) - description: Time in simulation to create savedstate - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - file: - $ref: '#/definitions/FileReadOnly' - id: - title: ID - type: integer - readOnly: true - uuid: - title: Uuid - type: string - format: uuid - ConstantLateral: - required: - - offset - - duration - - value - - units - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - duration: - title: Duration (in seconds) - description: event duration in seconds. -9999 is the 'infinite duration' value - (only allowed in conjunction with infinite simulations - type: integer - maximum: 9223372036854775807 - minimum: -9223372036854775808 - x-nullable: true - value: - title: Value - type: number - units: - title: Units - description: "'m3/s' (only option for now)" - type: string - enum: - - m3/s - point: - title: Point - type: object - description: Point specified in wkt or geojson. Coordinates in longitude, - latitude order. - required: - - type - - coordinates - properties: - type: - title: type - description: Type should always be 'Point' - type: string - default: Point - coordinates: - title: coordinates - description: List of exactly one coordinate (longitude, latitude order) - type: array - items: - type: number - minItems: 2 - maxItems: 2 - example: - type: Point - coordinates: - - 4.695281 - - 52.656047 - connection_node: - title: Connection node - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - state: - title: State - type: string - enum: - - processing - - valid - - invalid - readOnly: true - state_detail: - title: State detail - type: object - readOnly: true - grid_id: - title: Grid id - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - GridEventState: - required: - - state - - state_detail - type: object - properties: - state: - title: State - type: string - enum: - - processing - - valid - - invalid - state_detail: - title: State detail - type: object - grid_id: - title: Grid id - type: integer - x-nullable: true - UploadEventFile: - required: - - filename - - offset - type: object - properties: - put_url: - title: Put url - type: string - format: uri - readOnly: true - minLength: 1 - filename: - title: Filename - type: string - maxLength: 255 - minLength: 1 - status: - title: Status - type: string - readOnly: true - minLength: 1 - offset: - title: Offset - type: integer - minimum: 0 - periodic: - title: Periodic - type: string - enum: - - daily - TimeseriesLateral: - required: - - offset - - values - - units - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - interpolate: - title: Interpolate - type: boolean - values: - type: array - items: - type: array - items: - type: number - description: Timestamp + value pair - example: - - 100 - - 0.5 - maxItems: 2 - minItems: 2 - maxItems: 300 - title: Timeseries - description: 'Timeseries provided as a nested list. The inner list consists - of exactly 2 values: timestamp, value' - example: - - - 0 - - 0.1 - - - 100 - - 0.5 - - - 200 - - 0 - minItems: 1 - units: - title: Units - description: "'m3/s' (only option for now)" - type: string - enum: - - m3/s - point: - title: Point - type: object - description: Point specified in wkt or geojson. Coordinates in longitude, - latitude order. - required: - - type - - coordinates - properties: - type: - title: type - description: Type should always be 'Point' - type: string - default: Point - coordinates: - title: coordinates - description: List of exactly one coordinate (longitude, latitude order) - type: array - items: - type: number - minItems: 2 - maxItems: 2 - example: - type: Point - coordinates: - - 4.695281 - - 52.656047 - connection_node: - title: Connection node - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - state: - title: State - type: string - enum: - - processing - - valid - - invalid - readOnly: true - state_detail: - title: State detail - type: object - readOnly: true - grid_id: - title: Grid id - type: integer - readOnly: true - id: - title: ID - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - ConstantLeakage: - required: - - offset - - duration - - value - - units - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - duration: - title: Duration - type: number - value: - title: Value - type: number - units: - title: Units - description: "'m/s' (only option for now)" - type: string - enum: - - m/s - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - NetCDFRasterLeakage: - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - multiplier: - title: Multiplier - type: number - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - duration: - title: Duration - description: Duration of event in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - timestamps: - description: in simulation in seconds - type: array - items: - title: Timestamps - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - interval: - title: Interval - description: interval in seconds - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - values_reference: - title: Values reference - type: string - maxLength: 255 - x-nullable: true - units: - title: Units - type: string - enum: - - m/s - - mm - - mm/h - - mm/hr - x-nullable: true - geotransform: - type: array - items: - title: Geotransform - type: number - maxItems: 6 - epsg_code: - title: Epsg code - type: integer - maximum: 2147483647 - minimum: -2147483648 - file: - $ref: '#/definitions/FileReadOnly' - fill_value: - title: Fill value - type: string - maxLength: 128 - minLength: 1 - id: - title: ID - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - TimeseriesLeakage: - required: - - offset - - values - - units - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - interpolate: - title: Interpolate - type: boolean - values: - type: array - items: - type: array - items: - type: number - description: Timestamp + value pair - example: - - 100 - - 0.5 - maxItems: 2 - minItems: 2 - maxItems: 300 - title: Timeseries - description: 'Timeseries provided as a nested list. The inner list consists - of exactly 2 values: timestamp, value' - example: - - - 0 - - 0.1 - - - 100 - - 0.5 - - - 200 - - 0 - minItems: 1 - units: - title: Units - description: "'m/s' (only option for now)" - type: string - enum: - - m/s - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - NetCDFTimeseriesLeakage: - required: - - units - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - multiplier: - title: Multiplier - type: number - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - duration: - title: Duration - description: Duration of event in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - timestamps: - description: in simulation in seconds - type: array - items: - title: Timestamps - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - interval: - title: Interval - description: interval in seconds - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - values_reference: - title: Values reference - type: string - maxLength: 255 - x-nullable: true - units: - title: Units - type: string - enum: - - mm - - mm/h - file: - $ref: '#/definitions/FileReadOnly' - fill_value: - title: Fill value - type: string - maxLength: 128 - minLength: 1 - id: - title: ID - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - ConstantRain: - required: - - offset - - duration - - value - - units - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - duration: - title: Duration (in seconds) - description: event duration in seconds. -9999 is the 'infinite duration' value - (only allowed in conjunction with infinite simulations - type: integer - maximum: 9223372036854775807 - minimum: -9223372036854775808 - x-nullable: true - value: - title: Value - description: Rain intensity - type: number - units: - title: Units - description: m/s is only option for now - type: string - enum: - - m/s - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - ConstantLocalRain: - required: - - offset - - value - - diameter - - point - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - value: - title: Value - type: number - units: - title: Units - description: m/s is only option for now - type: string - enum: - - m/s - - mm/h - - mm/min - duration: - title: Duration (in seconds) - description: event duration in seconds. -9999 is the 'infinite duration' value - (only allowed in conjunction with infinite simulations - type: integer - maximum: 9223372036854775807 - minimum: -9223372036854775808 - x-nullable: true - interpolate: - title: Interpolate - type: boolean - diameter: - title: Diameter - type: integer - maximum: 2147483647 - minimum: -2147483648 - point: - title: Point - type: object - description: Point specified in wkt or geojson. Coordinates in longitude, - latitude order. - required: - - type - - coordinates - properties: - type: - title: type - description: Type should always be 'Point' - type: string - default: Point - coordinates: - title: coordinates - description: List of exactly one coordinate (longitude, latitude order) - type: array - items: - type: number - minItems: 2 - maxItems: 2 - example: - type: Point - coordinates: - - 4.695281 - - 52.656047 - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - TimeseriesLocalRain: - required: - - offset - - values - - diameter - - point - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - values: - type: array - items: - type: array - items: - type: number - description: Timestamp + value pair - example: - - 100 - - 0.5 - maxItems: 2 - minItems: 2 - maxItems: 300 - title: Timeseries - description: 'Timeseries provided as a nested list. The inner list consists - of exactly 2 values: timestamp, value' - example: - - - 0 - - 0.1 - - - 100 - - 0.5 - - - 200 - - 0 - minItems: 1 - interpolate: - title: Interpolate - type: boolean - units: - title: Units - description: m/s is only option for now - type: string - enum: - - m/s - - mm/h - - mm/min - diameter: - title: Diameter - type: integer - maximum: 2147483647 - minimum: -2147483648 - point: - title: Point - type: object - description: Point specified in wkt or geojson. Coordinates in longitude, - latitude order. - required: - - type - - coordinates - properties: - type: - title: type - description: Type should always be 'Point' - type: string - default: Point - coordinates: - title: coordinates - description: List of exactly one coordinate (longitude, latitude order) - type: array - items: - type: number - minItems: 2 - maxItems: 2 - example: - type: Point - coordinates: - - 4.695281 - - 52.656047 - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - NetCDFRasterRain: - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - multiplier: - title: Multiplier - type: number - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - duration: - title: Duration - description: Duration of event in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - timestamps: - description: in simulation in seconds - type: array - items: - title: Timestamps - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - interval: - title: Interval - description: interval in seconds - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - values_reference: - title: Values reference - type: string - maxLength: 255 - x-nullable: true - fill_value: - title: Fill value - type: string - maxLength: 128 - minLength: 1 - units: - title: Units - type: string - enum: - - m/s - - mm - - mm/h - - mm/hr - x-nullable: true - geotransform: - type: array - items: - title: Geotransform - type: number - maxItems: 6 - epsg_code: - title: Epsg code - type: integer - maximum: 2147483647 - minimum: -2147483648 - file: - $ref: '#/definitions/FileReadOnly' - uid: - title: Uid - type: string - format: uuid - readOnly: true - TimeseriesRain: - required: - - offset - - values - - units - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - duration: - title: Duration (in seconds) - description: event duration in seconds. -9999 is the 'infinite duration' value - (only allowed in conjunction with infinite simulations - type: integer - readOnly: true - interpolate: - title: Interpolate - type: boolean - values: - type: array - items: - type: array - items: - type: number - description: Timestamp + value pair - example: - - 100 - - 0.5 - maxItems: 2 - minItems: 2 - maxItems: 300 - title: Timeseries - description: 'Timeseries provided as a nested list. The inner list consists - of exactly 2 values: timestamp, value' - example: - - - 0 - - 0.1 - - - 100 - - 0.5 - - - 200 - - 0 - minItems: 1 - units: - title: Units - description: m/s is only option for now - type: string - enum: - - m/s - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - NetCDFTimeseriesRain: - required: - - units - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - multiplier: - title: Multiplier - type: number - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - duration: - title: Duration - description: Duration of event in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - timestamps: - description: in simulation in seconds - type: array - items: - title: Timestamps - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - interval: - title: Interval - description: interval in seconds - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - values_reference: - title: Values reference - type: string - maxLength: 255 - x-nullable: true - fill_value: - title: Fill value - type: string - maxLength: 128 - minLength: 1 - units: - title: Units - type: string - enum: - - mm - - mm/h - file: - $ref: '#/definitions/FileReadOnly' - uid: - title: Uid - type: string - format: uuid - readOnly: true - ConstantSourcesSinks: - required: - - offset - - duration - - value - - units - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - duration: - title: Duration - type: number - value: - title: Value - type: number - units: - title: Units - description: "'m/s' (only option for now)" - type: string - enum: - - m/s - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - NetCDFRasterSourcesSinks: - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - multiplier: - title: Multiplier - type: number - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - duration: - title: Duration - description: Duration of event in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - timestamps: - description: in simulation in seconds - type: array - items: - title: Timestamps - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - interval: - title: Interval - description: interval in seconds - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - values_reference: - title: Values reference - type: string - maxLength: 255 - x-nullable: true - units: - title: Units - type: string - enum: - - m/s - - mm - - mm/h - - mm/hr - x-nullable: true - geotransform: - type: array - items: - title: Geotransform - type: number - maxItems: 6 - epsg_code: - title: Epsg code - type: integer - maximum: 2147483647 - minimum: -2147483648 - file: - $ref: '#/definitions/FileReadOnly' - fill_value: - title: Fill value - type: string - maxLength: 128 - minLength: 1 - id: - title: ID - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - TimeseriesSourcesSinks: - required: - - offset - - values - - units - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - interpolate: - title: Interpolate - type: boolean - values: - type: array - items: - type: array - items: - type: number - description: Timestamp + value pair - example: - - 100 - - 0.5 - maxItems: 2 - minItems: 2 - maxItems: 300 - title: Timeseries - description: 'Timeseries provided as a nested list. The inner list consists - of exactly 2 values: timestamp, value' - example: - - - 0 - - 0.1 - - - 100 - - 0.5 - - - 200 - - 0 - minItems: 1 - units: - title: Units - description: "'m/s' (only option for now)" - type: string - enum: - - m/s - uid: - title: Uid - type: string - format: uuid - readOnly: true - id: - title: ID - type: integer - readOnly: true - NetCDFTimeseriesSourcesSinks: - required: - - units - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - multiplier: - title: Multiplier - type: number - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - duration: - title: Duration - description: Duration of event in seconds - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - timestamps: - description: in simulation in seconds - type: array - items: - title: Timestamps - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - interval: - title: Interval - description: interval in seconds - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - values_reference: - title: Values reference - type: string - maxLength: 255 - x-nullable: true - units: - title: Units - type: string - enum: - - mm - - mm/h - file: - $ref: '#/definitions/FileReadOnly' - fill_value: - title: Fill value - type: string - maxLength: 128 - minLength: 1 - id: - title: ID - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - MeasureLocationGridEventState: - required: - - state - - state_detail - type: object - properties: - state: - title: State - type: string - enum: - - processing - - valid - - invalid - state_detail: - title: State detail - type: object - grid_id: - title: Grid id - type: integer - x-nullable: true - location_grid_ids: - type: array - items: - type: integer - x-nullable: true - x-nullable: true - location_resource_ids: - type: array - items: - type: integer - x-nullable: true - x-nullable: true - location_resource_states: - type: array - items: - type: string - minLength: 1 - x-nullable: true - x-nullable: true - location_resource_state_details: - type: array - items: - type: object - x-nullable: true - x-nullable: true - ConstantWind: - required: - - offset - type: object - properties: - id: - title: ID - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - duration: - title: Duration (in seconds) - description: event duration in seconds. -9999 is the 'infinite duration' value - (only allowed in conjunction with infinite simulations - type: integer - maximum: 9223372036854775807 - minimum: -9223372036854775808 - x-nullable: true - values: - description: '[time, speed, direction]' - type: array - items: - type: array - items: - title: Values - type: number - readOnly: true - units: - title: Units - description: wind speed unit (default 'm/s') - type: string - enum: - - m/s - - km/h - speed_interpolate: - title: Speed interpolate - description: interpolate wind speed - type: boolean - readOnly: true - speed_constant: - title: Speed constant - description: constant wind speed - type: boolean - readOnly: true - direction_interpolate: - title: Direction interpolate - description: interpolate wind direction - type: boolean - readOnly: true - direction_constant: - title: Direction constant - description: constant wind direction - type: boolean - readOnly: true - speed_value: - title: Speed value - description: constant wind speed - type: number - minimum: 0 - direction_value: - title: Direction value - description: constant wind direction in degrees (0-360) from north - meteorological - standard (thus, 180 is a southern wind) - type: integer - maximum: 360 - minimum: 0 - TimeseriesWind: - required: - - offset - type: object - properties: - id: - title: ID - type: integer - readOnly: true - uid: - title: Uid - type: string - format: uuid - readOnly: true - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - offset: - title: Offset - description: offset of event in simulation in seconds - type: integer - maximum: 2147483647 - minimum: 0 - values: - description: '[time, speed, direction]' - type: array - items: - type: array - items: - title: Values - type: number - maxItems: 300 - units: - title: Units - description: wind speed unit (default 'm/s') - type: string - enum: - - m/s - - km/h - speed_interpolate: - title: Speed interpolate - description: interpolate wind speed - type: boolean - speed_constant: - title: Speed constant - description: constant wind speed - type: boolean - readOnly: true - direction_interpolate: - title: Direction interpolate - description: interpolate wind direction - type: boolean - direction_constant: - title: Direction constant - description: constant wind direction - type: boolean - readOnly: true - InitialSavedState: - required: - - saved_state - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - saved_state: - title: Saved state - type: string - format: uri - id: - title: ID - type: integer - readOnly: true - uuid: - title: Uuid - type: string - readOnly: true - Progress: - required: - - time - - percentage - type: object - properties: - time: - title: Time - type: number - percentage: - title: Percentage - type: integer - ResultFile: - required: - - filename - - created - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - filename: - title: Filename - type: string - maxLength: 255 - minLength: 1 - description: - title: Description - type: string - x-nullable: true - created: - title: Created - type: string - format: date-time - file: - $ref: '#/definitions/FileReadOnly' - id: - title: ID - type: integer - readOnly: true - ArrivalTimePostProcessing: - type: object - properties: - basic_post_processing: - title: Basic post processing - type: integer - readOnly: true - BasicPostProcessing: - type: object - properties: - simulation: - title: Simulation - type: string - format: uri - readOnly: true - scenario_name: - title: Scenario name - description: Scenario name for saving the results - type: string - maxLength: 128 - minLength: 1 - process_basic_results: - title: Process basic results - type: boolean - result_uuid: - title: Result uuid - type: string - format: uuid - DamagePostProcessing: - required: - - cost_type - - flood_month - - inundation_period - - repair_time_infrastructure - - repair_time_buildings - type: object - properties: - basic_post_processing: - title: Basic post processing - type: integer - readOnly: true - cost_type: - title: Cost type - description: "'min', 'avg', or 'max'" - type: string - enum: - - min - - avg - - max - flood_month: - title: Flood month - type: string - enum: - - jan - - feb - - mar - - apr - - may - - jun - - jul - - aug - - sep - - oct - - nov - - dec - inundation_period: - title: Inundation period - description: time in hours - type: number - minimum: 1.0 - repair_time_infrastructure: - title: Repair time infrastructure - description: time in hours - type: integer - maximum: 240 - minimum: 1 - repair_time_buildings: - title: Repair time buildings - description: time in hours - type: integer - maximum: 240 - minimum: 1 - Result: - required: - - basic - - damage_estimation - - arrival_time - type: object - properties: - basic: - title: Basic - type: boolean - damage_estimation: - title: Damage estimation - type: boolean - arrival_time: - title: Arrival time - type: boolean - DamageEstimation: - type: object - properties: - damage_table: - title: Damage table - type: string - readOnly: true - default: 3Di-V1 - elevation_raster_uuid: - title: Elevation raster uuid - type: string - readOnly: true - default: 36588275-f3e3-4120-8c1e-602f7ae85386 - landcover_raster_uuid: - title: Landcover raster uuid - type: string - readOnly: true - default: 717478ef-099d-41d8-971d-8b4309e59d92 - road_rail_raster_uuid: - title: Road rail raster uuid - type: string - readOnly: true - default: e40c1b96-e71f-462c-8acb-59a3a8b7db89 - cost_type: - title: Cost type - type: integer - readOnly: true - flood_month: - title: Flood month - type: integer - readOnly: true - inundation_period: - title: Inundation period - type: integer - readOnly: true - repair_time_infrastructure: - title: Repair time infrastructure - type: integer - readOnly: true - repair_time_buildings: - title: Repair time buildings - type: integer - readOnly: true - Settings: - type: object - properties: - damage_estimation: - $ref: '#/definitions/DamageEstimation' - PostProcessingOverview: - required: - - results - - settings - type: object - properties: - username: - title: Username - type: string - readOnly: true - external_user_id: - title: External user id - type: string - readOnly: true - metadata_version: - title: Metadata version - type: string - readOnly: true - default: 1.2 - start_time_sim: - title: Start time sim - type: string - readOnly: true - end_time_sim: - title: End time sim - type: string - readOnly: true - results: - $ref: '#/definitions/Result' - settings: - $ref: '#/definitions/Settings' - model_name: - title: Model name - type: string - readOnly: true - simulation_name: - title: Simulation name - type: string - readOnly: true - scenario_name: - title: Scenario name - description: Scenario name for saving the results - type: string - readOnly: true - minLength: 1 - model_id: - title: Model id - type: integer - readOnly: true - model_revision_id: - title: Model revision id - type: string - readOnly: true - email: - title: Email - type: string - readOnly: true - result_uuid: - title: Result uuid - type: string - format: uuid - readOnly: true - organisation_uuid: - title: Organisation uuid - type: string - readOnly: true - simulation: - title: Simulation - type: integer - readOnly: true - PostProcessingStart: - type: object - properties: {} - PostProcessingStatus: - required: - - status - type: object - properties: - simulation: - title: Simulation - type: string - format: uri - readOnly: true - status: - title: Status - type: string - enum: - - created - - requested - - archiving - - archiving_failed - - archived - created: - title: Created - type: string - format: date-time - readOnly: true - AggregationSettings: - required: - - flow_variable - - method - - interval - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - name: - title: Name - description: Give your aggregation setting a name to be able to find it back - in the results file. - type: string - maxLength: 120 - x-nullable: true - flow_variable: - title: Flow variable - description: | - Options: - water_level = Water Level - flow_velocity = Flow Velocity - discharge = Discharge - volume = Volume - pump_discharge = Pump Discharge - wet_cross_section = Wet Cross Section - lateral_discharge = Lateral Discharge - wet_surface = Wet Surface - rain = Rain - simple_infiltration = Simple Infiltration - leakage = Leakage - interception = Interception - surface_source_sink_discharge = Surface Source Sink Discharge - type: string - enum: - - water_level - - flow_velocity - - discharge - - volume - - pump_discharge - - wet_cross_section - - lateral_discharge - - wet_surface - - rain - - simple_infiltration - - leakage - - interception - - surface_source_sink_discharge - method: - title: Method - description: |- - Options: - min = minimum value of the variable in the configured interval - max = maximum value of the variable in the configured interval - avg = average value of the variable in the configured interval - cum = variable integration over time [dt * variable] - cum_positive = variable integration over time [dt * variable] in positive direction - cum_negative = variable integration over time [dt * variable] in negative direction - current = current value of a variable - sum = variable summation over configured interval - - Note: 'current' is required in case one checks the water balance for variables that are the result of the processes. Only valid for flow_variable 'volume' and 'intercepted_volume' - type: string - enum: - - min - - max - - avg - - cum - - cum_positive - - cum_negative - - current - - sum - interval: - title: Interval - description: aggregation interval in seconds - type: number - NumericalSettings: - required: - - pump_implicit_ratio - - cfl_strictness_factor_1d - - cfl_strictness_factor_2d - - convergence_eps - - convergence_cg - - flow_direction_threshold - - friction_shallow_water_depth_correction - - general_numerical_threshold - - limiter_waterlevel_gradient_1d - - limiter_waterlevel_gradient_2d - - limiter_slope_crossectional_area_2d - - limiter_slope_friction_2d - - max_non_linear_newton_iterations - - max_degree_gauss_seidel - - min_friction_velocity - - min_surface_area - - use_preconditioner_cg - - preissmann_slot - - limiter_slope_thin_water_layer - - use_of_cg - - use_nested_newton - - flooding_threshold - type: object - properties: - id: - title: ID - type: integer - readOnly: true - simulation_id: - title: Simulation id - type: integer - readOnly: true - pump_implicit_ratio: - title: Pump implicit ratio - type: number - maximum: 1.0 - minimum: 0.0 - cfl_strictness_factor_1d: - title: Cfl strictness factor 1d - description: "Strictness of CFL (Courant\u2013Friedrichs\u2013Lewy) condition\ - \ for 1D." - type: number - minimum: 1e-14 - cfl_strictness_factor_2d: - title: Cfl strictness factor 2d - description: "Strictness of CFL (Courant\u2013Friedrichs\u2013Lewy) condition\ - \ for 2D." - type: number - minimum: 1e-14 - convergence_eps: - title: Convergence eps - description: Minimal convergence criterion for Newton's method, suitable default - is 1.0e-5, due to numerical precision. - type: number - maximum: 0.0001 - minimum: 1e-07 - convergence_cg: - title: Convergence cg - description: Convergence criterion of cg-method, suitable default is 1.0e-9, - due to numerical precision. - type: number - maximum: 1e-07 - minimum: 1e-12 - flow_direction_threshold: - title: Flow direction threshold - description: Threshold value for upwind scheme based on flow velocity, suitable - default is 1e-06. - type: number - maximum: 0.01 - minimum: 1e-13 - friction_shallow_water_depth_correction: - title: Friction shallow water depth correction - description: |- - In case the friction assumptions based on the dominant friction balance gives a structurally underestimation of the friction, you can switch this setting on. - Options: - 0 = off - 1 = max between avg and divided channel based friction - 2 = always linearized - 3 = linearizes the depth based on a weighed averaged - - If options 3 is used the maximum depth of a thin layer needs to be defined. Do not use in combination with interflow. Suitable default is 0 (OFF). - type: integer - enum: - - 0 - - 1 - - 2 - - 3 - general_numerical_threshold: - title: General numerical threshold - description: Suitable default is 1.0e-8 - type: number - maximum: 1e-07 - minimum: 1e-13 - time_integration_method: - title: Time integration method - description: | - There are various methods to discretize the equations. At the moment only the first-order, semi-implicit method is supported and tested. - Options: - 0 = euler implicit - type: integer - enum: - - 0 - limiter_waterlevel_gradient_1d: - title: Limiter waterlevel gradient 1d - description: The limiter on the water level gradient allows the model to deal - with unrealistically steep gradients. Suitable default is 1. - type: integer - enum: - - 0 - - 1 - limiter_waterlevel_gradient_2d: - title: Limiter waterlevel gradient 2d - description: The limiter on the water level gradient allows the model to deal - with unrealistically steep gradients. Suitable default is 1. - type: integer - enum: - - 0 - - 1 - limiter_slope_crossectional_area_2d: - title: Limiter slope crossectional area 2d - description: |- - This limiter starts working in case the depth based on the downstream water level is zero and may be useful in sloping areas. - Options: - 0 = off - 1 = higher order scheme (might be sensitive to instabilities) - 2 = cross-sections treated as upwind method volume/surface area - 3 = combination traditional method thin layer approach - If option 3 is used the maximum depth of a thin layer needs to be defined. Do not use in combination with interflow. - type: integer - enum: - - 0 - - 1 - - 2 - - 3 - limiter_slope_friction_2d: - title: Limiter slope friction 2d - description: | - This limiter starts working in case the depth based on the downstream water level is zero and may be useful in sloping areas. This limiter is mandatory if the limiter_slope_crossectional_area_2d setting is greater than 0. Do not use in combination with interflow. Suitable default is 0 (OFF) - Options: - 0 = off - 1 = standard - type: integer - enum: - - 0 - - 1 - max_non_linear_newton_iterations: - title: Max non linear newton iterations - description: Maximum number of non-linear newton iterations in single time - step. Suitable default is 20. - type: integer - maximum: 2147483647 - minimum: 1 - max_degree_gauss_seidel: - title: Max degree gauss seidel - description: |- - Values below are advised for different model types: - 700 for 1D flow - 7 for 1D and 2D flow - 5 for surface 2D flow only - 7 for surface and groundwater flow - 70 for 1D, 2D surface and groundwater flow or higher. - Play around with this value, can speed up your model significantly, especially in case of ground water flow. Suitable default is 0. - type: integer - maximum: 2147483647 - minimum: 1 - min_friction_velocity: - title: Min friction velocity - description: To guarantee some initial friction only in flooded areas and - for large time steps, it is wise to assume a minimum velocity for computing - the friction. Suitable default is 0.01. - type: number - maximum: 1 - minimum: 0 - min_surface_area: - title: Min surface area - description: Suitable default is 1.0e-8. - type: number - maximum: 1e-07 - minimum: 1e-13 - use_preconditioner_cg: - title: Use preconditioner cg - description: |- - Use pre-conditioner for matrix solver. Increases simulation speed in most cases. - Options: - 0 = off - 1 = standard - . Suitable default is 1 (STANDARD). - type: integer - enum: - - 0 - - 1 - preissmann_slot: - title: Preissmann slot - description: 'A conceptual vertical narrow slot providing a conceptual free - surface condition for the flow when the water level is above the top of - a closed conduit. Often used to guarantee stability. Not necessary in 3Di - even for pressurized pipe flow. Note: Works only for circular profiles. - Suitable default is 0.0. Unit: m2.' - type: number - minimum: 0 - limiter_slope_thin_water_layer: - title: Limiter slope thin water layer - description: 'Mandatory when using friction_shallow_water_depth_correction - option 3 or limiter_slope_crossectional_area_2d option 3. Unit: m' - type: number - minimum: 0 - use_of_cg: - title: Use of cg - description: Number of conjugate gradient method iterations, before switching - to another method. Suitable default is 20. - type: integer - maximum: 2147483647 - minimum: 1 - use_nested_newton: - title: Use nested newton - description: Set to 'True' for 1D calculations with closed profiles to handle - non-linearity in volume-water level relation. When set to 'False' it will - be used if calculations become non-linear. For sewerage systems it is advised - to set this setting to 'True'. Otherwise a suitable default is 'False' - type: boolean - flooding_threshold: - title: Flooding threshold - description: Water depth threshold for flow between 2D cells. Depth relative - to lowest bathymetry pixel at the edge between two 2D cells. Suitable default - is 0.000001. - type: number - maximum: 0.05 - minimum: 0 - PhysicalSettings: - required: - - use_advection_1d - - use_advection_2d - type: object - properties: - id: - title: ID - type: integer - readOnly: true - simulation_id: - title: Simulation id - type: integer - readOnly: true - use_advection_1d: - title: Use advection 1d - description: | - Options: - 0 = off - 1 = standard - type: integer - enum: - - 0 - - 1 - use_advection_2d: - title: Use advection 2d - description: | - Options: - 0 = off - 1 = standard - type: integer - enum: - - 0 - - 1 - TimeStepSettings: - required: - - time_step - - min_time_step - - use_time_step_stretch - - output_time_step - type: object - properties: - id: - title: ID - type: integer - readOnly: true - simulation_id: - title: Simulation id - type: integer - readOnly: true - time_step: - title: Time step - description: Size of the simulation time step in seconds. - type: number - minimum: 1e-14 - min_time_step: - title: Min time step - description: Minimum size of the simulation time step in seconds. Suitable - default is 0.001. - type: number - minimum: 1e-14 - max_time_step: - title: Max time step - description: Only in combination with use_time_step_stretch=True. - type: number - minimum: 1e-14 - x-nullable: true - use_time_step_stretch: - title: Use time step stretch - description: Permit the time step to increase automatically, when the flow - allows it. - type: boolean - output_time_step: - title: Output time step - description: The interval in seconds in which results are saved to disk. - type: number - minimum: 1e-14 - SimulationSettingsOverview: - type: object - properties: - physical_settings: - $ref: '#/definitions/PhysicalSettings' - numerical_settings: - $ref: '#/definitions/NumericalSettings' - time_step_settings: - $ref: '#/definitions/TimeStepSettings' - aggregation_settings: - type: array - items: - $ref: '#/definitions/AggregationSettings' - readOnly: true - CurrentStatus: - required: - - id - - name - - created - type: object - properties: - id: - title: Id - type: integer - name: - title: Name - type: string - minLength: 1 - created: - title: Created - type: string - format: date-time - time: - title: Time - type: number - paused: - title: Paused - type: boolean - exit_code: - title: Exit code - type: string - readOnly: true - SimulationStatus: - required: - - name - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - name: - title: Name - type: string - enum: - - created - - starting - - initialized - - queued - - ended - - postprocessing - - finished - - crashed - simulation: - title: Simulation - type: string - format: uri - readOnly: true - simulation_id: - title: Simulation id - type: integer - readOnly: true - simulation_name: - title: Simulation name - type: string - readOnly: true - simulation_user_email: - title: Simulation user email - type: string - readOnly: true - simulation_organisation_unique_id: - title: Simulation organisation unique id - type: string - readOnly: true - simulation_tags: - type: array - items: - type: string - x-nullable: true - readOnly: true - simulation_user_first_name: - title: Simulation user first name - type: string - readOnly: true - simulation_user_last_name: - title: Simulation user last name - type: string - readOnly: true - threedimodel_slug: - title: Threedimodel slug - type: string - readOnly: true - threedimodel_id: - title: Threedimodel id - type: integer - readOnly: true - has_results: - title: Has results - type: boolean - readOnly: true - x-nullable: true - created: - title: Created - type: string - format: date-time - readOnly: true - expiry: - title: Expiry - type: string - format: date-time - readOnly: true - x-nullable: true - time: - title: Time (in seconds) - description: simulation time in seconds - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - paused: - title: True if simulation is paused, only valid in initialized state - type: boolean - x-nullable: true - detail: - title: Detail - type: object - x-nullable: true - exit_code: - title: Exit code - description: only available for final statuses like 'finished' or 'crashed'. - Gives detailed insight to the application state when the simulation finished - type: integer - enum: - - 1110 - - 1210 - - 1240 - - 4161 - - 4262 - - 4263 - - 4264 - - 4265 - - 4120 - - 4220 - - 4150 - - 4280 - - 4240 - - 4270 - - 4230 - - 4231 - - 4232 - - 2150 - - 2110 - - 2210 - - 2120 - - 2220 - - 2230 - - 2240 - x-nullable: true - id: - title: ID - type: integer - readOnly: true - BreachGraphRequest: - required: - - start_time - - subscribe - - line_id - type: object - properties: - start_time: - title: Start time - description: simulation time in seconds - type: integer - minimum: 0 - history_points_limit: - title: History points limit - description: Maximum number of points of history to return - type: integer - default: 200 - maximum: 500 - minimum: 1 - subscribe: - title: Subscribe - description: Subscribe for new results during simulation - type: boolean - subscribe_rate_limit: - title: Subscribe rate limit - description: Max number of items per second for subscription - type: number - default: 0.5 - maximum: 2 - minimum: 0.25 - line_id: - title: Line id - type: integer - minimum: 1 - BreachGraph: - required: - - url - type: object - properties: - url: - title: Url - type: string - format: uri - minLength: 1 - PumpDischargeGraphRequest: - required: - - start_time - - subscribe - - pump_id - type: object - properties: - start_time: - title: Start time - description: simulation time in seconds - type: integer - minimum: 0 - history_points_limit: - title: History points limit - description: Maximum number of points of history to return - type: integer - default: 200 - maximum: 500 - minimum: 1 - subscribe: - title: Subscribe - description: Subscribe for new results during simulation - type: boolean - subscribe_rate_limit: - title: Subscribe rate limit - description: Max number of items per second for subscription - type: number - default: 0.5 - maximum: 2 - minimum: 0.25 - pump_id: - title: Pump id - type: integer - minimum: 1 - PumpDischargeGraph: - required: - - url - type: object - properties: - url: - title: Url - type: string - format: uri - minLength: 1 - RainGraphRequest: - required: - - start_time - - subscribe - - node_id - type: object - properties: - start_time: - title: Start time - description: simulation time in seconds - type: integer - minimum: 0 - history_points_limit: - title: History points limit - description: Maximum number of points of history to return - type: integer - default: 200 - maximum: 500 - minimum: 1 - subscribe: - title: Subscribe - description: Subscribe for new results during simulation - type: boolean - subscribe_rate_limit: - title: Subscribe rate limit - description: Max number of items per second for subscription - type: number - default: 0.5 - maximum: 2 - minimum: 0.25 - node_id: - title: Node id - type: integer - minimum: 1 - RainGraph: - required: - - url - type: object - properties: - url: - title: Url - type: string - format: uri - minLength: 1 - WaterFlowGraphRequest: - required: - - start_time - - subscribe - - line_id - type: object - properties: - start_time: - title: Start time - description: simulation time in seconds - type: integer - minimum: 0 - history_points_limit: - title: History points limit - description: Maximum number of points of history to return - type: integer - default: 200 - maximum: 500 - minimum: 1 - subscribe: - title: Subscribe - description: Subscribe for new results during simulation - type: boolean - subscribe_rate_limit: - title: Subscribe rate limit - description: Max number of items per second for subscription - type: number - default: 0.5 - maximum: 2 - minimum: 0.25 - line_id: - title: Line id - type: integer - minimum: 1 - WaterGraph: - required: - - url - type: object - properties: - url: - title: Url - type: string - format: uri - minLength: 1 - WaterLevelGraphRequest: - required: - - start_time - - subscribe - - node_id - type: object - properties: - start_time: - title: Start time - description: simulation time in seconds - type: integer - minimum: 0 - history_points_limit: - title: History points limit - description: Maximum number of points of history to return - type: integer - default: 200 - maximum: 500 - minimum: 1 - subscribe: - title: Subscribe - description: Subscribe for new results during simulation - type: boolean - subscribe_rate_limit: - title: Subscribe rate limit - description: Max number of items per second for subscription - type: number - default: 0.5 - maximum: 2 - minimum: 0.25 - node_id: - title: Node id - type: integer - minimum: 1 - WaterLevelProfileRequest: - required: - - geometry - - subscribe - type: object - properties: - geometry: - title: Linestring - description: Linestring (epsg:4326) specified in wkt or geojson. Coordinates - in longitude, latitude order. - type: object - required: - - type - - coordinates - properties: - type: - title: type - description: Type should always be 'linestring' or 'LINESTRING' - type: string - default: Linestring - coordinates: - title: coordinates - description: List of coordinates. (longitude, latitude order) - type: array - items: - type: array - items: - type: number - minItems: 2 - maxItems: 2 - minItems: 2 - example: - type: LineString - coordinates: - - - 4.668275805499175 - - 52.619558913867856 - - - 4.73849433310911 - - 52.66453976184968 - points_limit: - title: Points limit - description: Maximum number of points to return - type: integer - default: 100 - maximum: 200 - minimum: 1 - subscribe: - title: Subscribe - description: Subscribe for new results during simulation - type: boolean - subscribe_rate_limit: - title: Subscribe rate limit - description: Max number of items per second for subscription - type: number - default: 0.5 - maximum: 1 - minimum: 0.25 - WaterLevelProfile: - required: - - url - type: object - properties: - url: - title: Url - type: string - format: uri - minLength: 1 - Waterdepth: - required: - - websocket_url - type: object - properties: - websocket_url: - title: Websocket url - type: string - format: uri - minLength: 1 - Profile: - required: - - url - type: object - properties: - url: - title: Url - type: string - format: uri - minLength: 1 - TMS: - required: - - tms_url - - minmax_url - type: object - properties: - tms_url: - title: Tms url - type: string - format: uri - minLength: 1 - minmax_url: - title: Minmax url - type: string - format: uri - minLength: 1 - SimulationChannel: - type: object - properties: - id: - title: ID - type: integer - readOnly: true - simulation: - title: Simulation - type: string - format: uri - readOnly: true - channel_name: - title: Channel name - type: string - readOnly: true - minLength: 1 - created: - title: Created - type: string - format: date-time - readOnly: true - state: - title: State - type: string - enum: - - pending - - confirmed - - timeout - readOnly: true - SimulationStatusStatistics: - required: - - name - - total - type: object - properties: - name: - title: Name - type: string - minLength: 1 - total: - title: Total - type: integer - RasterOptions: - type: object - properties: - dem_file: - title: Dem file - type: string - maxLength: 80 - minLength: 1 - dem_raw_file: - title: Dem raw file - type: string - maxLength: 80 - minLength: 1 - equilibrium_infiltration_rate_file: - title: Equilibrium infiltration rate file - type: string - maxLength: 80 - minLength: 1 - frict_coef_file: - title: Frict coef file - type: string - maxLength: 80 - minLength: 1 - initial_groundwater_level_file: - title: Initial groundwater level file - type: string - maxLength: 80 - minLength: 1 - initial_waterlevel_file: - title: Initial waterlevel file - type: string - maxLength: 80 - minLength: 1 - groundwater_hydro_connectivity_file: - title: Groundwater hydro connectivity file - type: string - maxLength: 80 - minLength: 1 - groundwater_impervious_layer_level_file: - title: Groundwater impervious layer level file - type: string - maxLength: 80 - minLength: 1 - infiltration_decay_period_file: - title: Infiltration decay period file - type: string - maxLength: 80 - minLength: 1 - initial_infiltration_rate_file: - title: Initial infiltration rate file - type: string - maxLength: 80 - minLength: 1 - leakage_file: - title: Leakage file - type: string - maxLength: 80 - minLength: 1 - phreatic_storage_capacity_file: - title: Phreatic storage capacity file - type: string - maxLength: 80 - minLength: 1 - hydraulic_conductivity_file: - title: Hydraulic conductivity file - type: string - maxLength: 80 - minLength: 1 - porosity_file: - title: Porosity file - type: string - maxLength: 80 - minLength: 1 - infiltration_rate_file: - title: Infiltration rate file - type: string - maxLength: 80 - minLength: 1 - max_infiltration_capacity_file: - title: Max infiltration capacity file - type: string - maxLength: 80 - minLength: 1 - interception_file: - title: Interception file - type: string - maxLength: 80 - minLength: 1 - vegetation_height_file: - title: Vegetation height file - type: string - maxLength: 80 - minLength: 1 - vegetation_drag_coefficient_file: - title: Vegetation drag coefficient file - type: string - maxLength: 80 - minLength: 1 - vegetation_stem_count_file: - title: Vegetation stem count file - type: string - maxLength: 80 - minLength: 1 - vegetation_stem_diameter_file: - title: Vegetation stem diameter file - type: string - maxLength: 80 - minLength: 1 - BoundaryCondition: - required: - - boundary_id - - type - - dimension - type: object - properties: - id: - title: ID - type: integer - readOnly: true - url: - title: Url - type: string - format: uri - readOnly: true - boundary_id: - title: Boundary id - type: integer - maximum: 2147483647 - minimum: -2147483648 - threedimodel: - title: Threedimodel - type: string - format: uri - readOnly: true - type: - title: Type - type: string - enum: - - velocity - - sommerfeldt - - riemann - - water_level - - discharge - dimension: - title: Dimension - type: string - enum: - - one_d - - two_d - Raster: - required: - - type - - name - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - type: - title: Type - type: string - enum: - - dem_file - - dem_raw_file - - equilibrium_infiltration_rate_file - - frict_coef_file - - initial_groundwater_level_file - - initial_waterlevel_file - - groundwater_hydro_connectivity_file - - groundwater_impervious_layer_level_file - - infiltration_decay_period_file - - initial_infiltration_rate_file - - leakage_file - - phreatic_storage_capacity_file - - hydraulic_conductivity_file - - porosity_file - - infiltration_rate_file - - max_infiltration_capacity_file - - interception_file - - vegetation_height_file - - vegetation_drag_coefficient_file - - vegetation_stem_count_file - - vegetation_stem_diameter_file - threedimodel: - title: Threedimodel - type: string - format: uri - readOnly: true - name: - title: Name - type: string - maxLength: 60 - minLength: 1 - file: - $ref: '#/definitions/FileReadOnly' - id: - title: ID - type: integer - readOnly: true - epsg_code: - title: Epsg code - type: integer - maximum: 2147483647 - minimum: -2147483648 - x-nullable: true - extent: - title: Extent - type: object - description: Extent specified either in geojson, wkt or ewkt. Coordinates - in longitude, latitude order. - required: - - type - - coordinates - properties: - type: - title: type - description: Type should always be 'Linestring' - type: string - default: Linestring - coordinates: - title: coordinates - description: Exactly 2 coordinates, specifying the bottom left (longitude, - latitude order)and upper right respectively - type: array - items: - type: array - items: - type: number - minItems: 2 - maxItems: 2 - minItems: 2 - maxItems: 2 - minItems: 2 - maxItems: 2 - example: - type: LineString - coordinates: - - - 4.668275805499175 - - 52.619558913867856 - - - 4.73849433310911 - - 52.66453976184968 - geotransform: - type: array - items: - title: Geotransform - type: number - maxItems: 6 - x-nullable: true - unit: - title: Unit - type: string - enum: - - meters - x-nullable: true - InitialWaterlevel: - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - threedimodel: - title: Threedimodel - type: string - format: uri - readOnly: true - user_generated: - title: User generated - type: boolean - file: - $ref: '#/definitions/FileReadOnly' - source_raster: - title: Source raster - type: string - format: uri - state: - title: State - type: string - enum: - - processing - - valid - - invalid - readOnly: true - state_detail: - title: State detail - type: object - readOnly: true - id: - title: ID - type: integer - readOnly: true - source_raster_id: - title: Source raster id - type: integer - readOnly: true - dimension: - title: Dimension - type: string - enum: - - one_d - - two_d - PotentialBreach: - required: - - connected_pnt_id - - levee_material - - line_id - - maximum_breach_depth - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - connected_pnt_id: - title: Connected pnt id - type: integer - maximum: 2147483647 - minimum: -2147483648 - levee_material: - title: Levee material - type: string - enum: - - sand - - clay - line_id: - title: Line id - type: integer - maximum: 2147483647 - minimum: -2147483648 - maximum_breach_depth: - title: Maximum breach depth - type: number - threedimodel: - title: Threedimodel - type: string - format: uri - readOnly: true - id: - title: ID - type: integer - readOnly: true - ThreediModelSavedState: - required: - - name - - type - type: object - properties: - id: - title: ID - type: integer - readOnly: true - url: - title: Url - type: string - format: uri - readOnly: true - name: - title: Name - type: string - maxLength: 80 - minLength: 1 - created: - title: Created - type: string - format: date-time - x-nullable: true - type: - title: Type - type: string - enum: - - stable_threshold - - timed - tags: - title: tags - type: array - description: tags provided as a list of strings - items: - type: string - example: - - tag_1 - - tag_2 - used_in_simulation: - title: Used in simulation - type: string - readOnly: true - expiry: - title: Expiry - type: string - format: date-time - x-nullable: true - time: - title: Time in simulation (in seconds) - description: Time in simulation to create savedstate - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - variables: - type: array - items: - title: Variables - type: string - enum: - - s1 - - u1 - maxItems: 2 - x-nullable: true - thresholds: - type: array - items: - title: Thresholds - type: number - maxItems: 2 - x-nullable: true - ThreediModelTask: - required: - - name - type: object - properties: - url: - title: Url - type: string - format: uri - readOnly: true - name: - title: Name - type: string - enum: - - make_gridadmin - - make_tables - - make_cog - - make_geojson - - make_simulation_templates - - inherit_simulation_templates - - make_aggregations - params: - title: Params - type: object - x-nullable: true - created: - title: Created - type: string - format: date-time - readOnly: true - last_updated: - title: Last updated - type: string - format: date-time - readOnly: true - status: - title: Status - type: string - enum: - - created - - pending - - sent - - received - - started - - success - - failure - - revoked - detail: - title: Detail - type: object - threedimodel: - title: Threedimodel - type: string - format: uri - readOnly: true - id: - title: ID - type: integer - readOnly: true - Usage: - type: object - properties: - id: - title: ID - type: integer - readOnly: true - simulation: - $ref: '#/definitions/Simulation' - started: - title: Started - type: string - format: date-time - x-nullable: true - finished: - title: Finished - type: string - format: date-time - x-nullable: true - total_time: - title: Total time - type: integer - maximum: 2147483647 - minimum: 0 - x-nullable: true - status: - title: Status - type: string - readOnly: true - simulation_type: - title: Simulation type - type: string - readOnly: true - user_name: - title: User name - type: string - readOnly: true - organisation_uuid: - title: Organisation uuid - type: string - readOnly: true - UsageStatistics: - required: - - total_sessions - - total_duration - - avg_duration - - min_duration - - max_duration - - duration_humanized - - min_started - - max_started - type: object - properties: - total_sessions: - title: Total sessions - type: integer - total_duration: - title: Total duration - type: integer - avg_duration: - title: Avg duration - type: number - min_duration: - title: Min duration - type: integer - max_duration: - title: Max duration - type: integer - duration_humanized: - title: Duration humanized - type: string - minLength: 1 - min_started: - title: Min started - type: string - format: date-time - x-nullable: true - max_started: - title: Max started - type: string - format: date-time - x-nullable: true +swagger: '2.0' +info: + title: 3Di API + description: |- + 3Di simulation API (latest stable version: v3) + Framework release: 3.3.4 + 3Di core release: 3.3.1 + deployed on: 08:44AM (UTC) on December 14, 2023 + termsOfService: '' + contact: + email: info@nelen-schuurmans.nl + license: + name: BSD License + version: v3 +host: null +schemes: + - http +basePath: / +consumes: + - application/json +produces: + - application/json +securityDefinitions: + Basic: + type: basic + description: This scheme is for Personal API Keys. Use the key as password. The + username must be '__key__' (the word 'key' enclosed in double underscores). + Bearer: + type: apiKey + name: Authorization + in: header + description: This scheme is for tokens generated by 3Di. A token can be retrieved + from auth/tokens. + OAuth2: + type: oauth2 + name: Authorization + flow: accessCode + authorizationUrl: https://auth.lizard.net/oauth2/authorize + tokenUrl: https://auth.lizard.net/oauth2/token + description: This scheme is for OAuth2 Bearer tokens. By default, a public client_id + is set. Optionally supply another client id / secret (for testing). +security: + - Basic: [] + - Bearer: [] + - OAuth2: [] +paths: + /v3-beta/personalapikeys/: + get: + operationId: personalapikeys_list + description: Personal API keys are used for authentication without password. + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/PersonalAPIKey' + tags: + - v3-beta + post: + operationId: personalapikeys_create + description: Personal API keys are used for authentication without password. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/PersonalAPIKey' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/PersonalAPIKeyWithSecret' + tags: + - v3-beta + parameters: [] + /v3-beta/personalapikeys/{prefix}/: + get: + operationId: personalapikeys_read + description: Personal API keys are used for authentication without password. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/PersonalAPIKey' + tags: + - v3-beta + delete: + operationId: personalapikeys_delete + description: Personal API keys are used for authentication without password. + parameters: [] + responses: + '204': + description: '' + tags: + - v3-beta + parameters: + - name: prefix + in: path + required: true + type: string + /v3-beta/personalapikeys/{prefix}/revoke/: + post: + operationId: personalapikeys_revoke + description: Revoke an API key and return the status. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/PersonalAPIKey' + tags: + - v3-beta + parameters: + - name: prefix + in: path + required: true + type: string + /v3-beta/simulation-templates/{id}/copy-to-threedimodel/: + post: + operationId: simulation-templates_copy_to_threedimodel + summary: Copy simulation template to a threedimodel. + description: |- + { + "threedimodel": ThreediModel id + "name": name for the new template + "tags": extra tags, added to existing simulation template tags + "clone_events": clone events like rain/sources & sinks etc + "clone_initials": clone initial waterlevels + "clone_settings": clone simulation settings, like physical settings etc + } + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/CopyToThreediModel' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/CopyToThreediModel' + '400': + description: validation errors + tags: + - v3-beta + parameters: + - name: id + in: path + required: true + type: string + /v3-beta/simulations/{simulation_pk}/events/obstacle-edits/: + get: + operationId: simulations_events_obstacle-edits_list + description: A simple ViewSet for viewing obstacle edits + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/ObstacleEdit' + tags: + - v3-beta + post: + operationId: simulations_events_obstacle-edits_create + description: Create an obstacle edit + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ObstacleEdit' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/ObstacleEdit' + tags: + - v3-beta + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3-beta/simulations/{simulation_pk}/events/obstacle-edits/{id}/: + get: + operationId: simulations_events_obstacle-edits_read + description: A simple ViewSet for viewing obstacle edits + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ObstacleEdit' + tags: + - v3-beta + put: + operationId: simulations_events_obstacle-edits_update + description: A simple ViewSet for viewing obstacle edits + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ObstacleEdit' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ObstacleEdit' + tags: + - v3-beta + patch: + operationId: simulations_events_obstacle-edits_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ObstacleEdit' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3-beta + delete: + operationId: simulations_events_obstacle-edits_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3-beta + parameters: + - name: id + in: path + description: A unique integer value identifying this obstacle edit. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3-beta/simulations/{simulation_pk}/events/obstacle-edits/{id}/processed/: + put: + operationId: simulations_events_obstacle-edits_processed + description: A simple ViewSet for viewing obstacle edits + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/BaseEventState' + responses: + '200': + description: OK + tags: + - v3-beta + parameters: + - name: id + in: path + description: A unique integer value identifying this obstacle edit. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3-beta/simulations/{simulation_pk}/events/obstacle-edits/{id}/register_related_rasters/: + get: + operationId: simulations_events_obstacle-edits_register_related_rasters + summary: |- + Register all related rasters in the results-api and return + read_bbox urls of the registered rasters + description: |- + Skips registering of related rasters when the simulation is not in the + state 'starting' or 'initialized'. In this case the urls will be empty + parameters: [] + responses: + '200': + description: '' + schema: + type: array + items: + $ref: '#/definitions/RasterEditUrls' + tags: + - v3-beta + parameters: + - name: id + in: path + description: A unique integer value identifying this obstacle edit. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3-beta/simulations/{simulation_pk}/initial/1d_substance_concentrations/: + get: + operationId: simulations_initial_1d_substance_concentrations_list + description: Initial 1D substance concentration + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/OneDSubstanceConcentration' + tags: + - v3-beta + post: + operationId: simulations_initial_1d_substance_concentrations_create + description: |- + Start the simulation with a 1D (water quality) concentrations from a file. Applies the + given values to the predefined nodes subset "1D" + as described in the [threedigrid documentation] [ref] + + [ref]: https://threedigrid.readthedocs.io/en/latest/api.html#subsets + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/OneDSubstanceConcentration' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/OneDSubstanceConcentration' + tags: + - v3-beta + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3-beta/simulations/{simulation_pk}/initial/1d_substance_concentrations/{id}/: + get: + operationId: simulations_initial_1d_substance_concentrations_read + description: Initial 1D substance concentration + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/OneDSubstanceConcentration' + tags: + - v3-beta + put: + operationId: simulations_initial_1d_substance_concentrations_update + description: Initial 1D substance concentration + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/OneDSubstanceConcentration' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/OneDSubstanceConcentration' + tags: + - v3-beta + patch: + operationId: simulations_initial_1d_substance_concentrations_partial_update + description: Initial 1D substance concentration + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/OneDSubstanceConcentration' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/OneDSubstanceConcentration' + tags: + - v3-beta + delete: + operationId: simulations_initial_1d_substance_concentrations_delete + description: Initial 1D substance concentration + parameters: [] + responses: + '204': + description: '' + tags: + - v3-beta + parameters: + - name: id + in: path + description: A unique integer value identifying this one d substance concentration. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3-beta/simulations/{simulation_pk}/initial/2d_substance_concentrations/: + get: + operationId: simulations_initial_2d_substance_concentrations_list + description: Initial 2D substance concentration + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/TwoDSubstanceConcentration' + tags: + - v3-beta + post: + operationId: simulations_initial_2d_substance_concentrations_create + description: |- + Start the simulation with 2D (water quality) concentrations derived from the raster by + using the aggregation method. Applies the resulting levels + to the predefined nodes subset "2D_OPEN_WATER" + as described in the [threedigrid documentation] [ref] + + [ref]: https://threedigrid.readthedocs.io/en/latest/api.html#subsets + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TwoDSubstanceConcentration' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/TwoDSubstanceConcentration' + tags: + - v3-beta + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3-beta/simulations/{simulation_pk}/initial/2d_substance_concentrations/{id}/: + get: + operationId: simulations_initial_2d_substance_concentrations_read + description: Initial 2D substance concentration + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TwoDSubstanceConcentration' + tags: + - v3-beta + put: + operationId: simulations_initial_2d_substance_concentrations_update + description: Initial 2D substance concentration + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TwoDSubstanceConcentration' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TwoDSubstanceConcentration' + tags: + - v3-beta + patch: + operationId: simulations_initial_2d_substance_concentrations_partial_update + description: Initial 2D substance concentration + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TwoDSubstanceConcentration' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TwoDSubstanceConcentration' + tags: + - v3-beta + delete: + operationId: simulations_initial_2d_substance_concentrations_delete + description: Initial 2D substance concentration + parameters: [] + responses: + '204': + description: '' + tags: + - v3-beta + parameters: + - name: id + in: path + description: A unique integer value identifying this two d substance concentration. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3-beta/simulations/{simulation_pk}/substances/: + get: + operationId: simulations_substances_list + description: Water quality substances + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/Substance' + tags: + - v3-beta + post: + operationId: simulations_substances_create + description: Water quality substances + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Substance' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Substance' + tags: + - v3-beta + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3-beta/simulations/{simulation_pk}/substances/{id}/: + get: + operationId: simulations_substances_read + description: Water quality substances + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Substance' + tags: + - v3-beta + put: + operationId: simulations_substances_update + description: Water quality substances + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Substance' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Substance' + tags: + - v3-beta + patch: + operationId: simulations_substances_partial_update + description: Water quality substances + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Substance' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Substance' + tags: + - v3-beta + delete: + operationId: simulations_substances_delete + description: Water quality substances + parameters: [] + responses: + '204': + description: '' + tags: + - v3-beta + parameters: + - name: id + in: path + description: A unique integer value identifying this substance. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3-beta/status/: + get: + operationId: status_list + description: '' + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Status' + tags: + - v3-beta + parameters: [] + /v3-beta/status/current-version/: + get: + operationId: status_current_version + description: '' + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/CurrentVersion' + tags: + - v3-beta + parameters: [] + /v3-beta/threedimodels/{threedimodel_pk}/initial_concentrations/: + get: + operationId: threedimodels_initial_concentrations_list + description: |- + ## Description + Initial substance concentrations on threedimodels can be used in a simulation to + specify the initial substance concentration on the 1D and/or 2D domain. + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/InitialConcentration' + tags: + - v3-beta + post: + operationId: threedimodels_initial_concentrations_create + summary: Add new initial concentrations + description: |- + ### Adding (extra) 1D initial concentrations + Extra 1D initial concentrations can be added by posting: + + {"dimension": "one_d"} + + Using the 'id' value from the response, a JSON file needs to be uploaded via the + PUT_URL retrieved from `initial_concentrations/{id}/upload/` in the following + JSON format: + + Python code: + + import json + file_contents = json.dumps({ + "node_ids": [node_id_1, node_id2, ....], + "values" : [value_for_node_id_1, value_for_node_id_2, ...] + }) + + # Notes: + # - Omitted values are considered dry. + # - `node_ids` need to be sorted and unique + # - Make sure that the positions of the node_id's and values match. + + ### Adding (extra) 2D initial substance concentrations + 2D initial concentrations can be added by uploading an + 'initial_concentration_file' Geotiff raster via `rasters/{id}/upload/` + . This automatically triggers the creation of a 2D initial + concentration. The source raster is linked as 'source_raster'. The values in the + `source_raster` are aggregated per node using max, min and mean operators. The + resulting values are stored in a file linked under `file`. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/InitialConcentration' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/InitialConcentration' + tags: + - v3-beta + parameters: + - name: threedimodel_pk + in: path + required: true + type: string + /v3-beta/threedimodels/{threedimodel_pk}/initial_concentrations/{id}/: + get: + operationId: threedimodels_initial_concentrations_read + description: |- + ## Description + Initial substance concentrations on threedimodels can be used in a simulation to + specify the initial substance concentration on the 1D and/or 2D domain. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/InitialConcentration' + tags: + - v3-beta + put: + operationId: threedimodels_initial_concentrations_update + description: |- + ## Description + Initial substance concentrations on threedimodels can be used in a simulation to + specify the initial substance concentration on the 1D and/or 2D domain. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/InitialConcentration' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/InitialConcentration' + tags: + - v3-beta + patch: + operationId: threedimodels_initial_concentrations_partial_update + description: |- + ## Description + Initial substance concentrations on threedimodels can be used in a simulation to + specify the initial substance concentration on the 1D and/or 2D domain. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/InitialConcentration' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/InitialConcentration' + tags: + - v3-beta + delete: + operationId: threedimodels_initial_concentrations_delete + description: Delete initial substance concentration + parameters: [] + responses: + '204': + description: '' + tags: + - v3-beta + parameters: + - name: id + in: path + description: A unique integer value identifying this initial concentration. + required: true + type: integer + - name: threedimodel_pk + in: path + required: true + type: string + /v3-beta/threedimodels/{threedimodel_pk}/initial_concentrations/{id}/download/: + get: + operationId: threedimodels_initial_concentrations_download + description: Endpoint for downloading files. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3-beta + parameters: + - name: id + in: path + description: A unique integer value identifying this initial concentration. + required: true + type: integer + - name: threedimodel_pk + in: path + required: true + type: string + /v3-beta/threedimodels/{threedimodel_pk}/initial_concentrations/{id}/processed/: + put: + operationId: threedimodels_initial_concentrations_processed + description: |- + ## Description + Initial substance concentrations on threedimodels can be used in a simulation to + specify the initial substance concentration on the 1D and/or 2D domain. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/BaseEventState' + responses: + '200': + description: OK + tags: + - v3-beta + parameters: + - name: id + in: path + description: A unique integer value identifying this initial concentration. + required: true + type: integer + - name: threedimodel_pk + in: path + required: true + type: string + /v3-beta/threedimodels/{threedimodel_pk}/initial_concentrations/{id}/upload/: + post: + operationId: threedimodels_initial_concentrations_upload + description: |- + Endpoint for uploading an initial substance concentration file, see the POST + endpoint for documentation about the file format. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3-beta + parameters: + - name: id + in: path + description: A unique integer value identifying this initial concentration. + required: true + type: integer + - name: threedimodel_pk + in: path + required: true + type: string + /v3/auth/profile/: + get: + operationId: auth_profile_list + description: Read-only API endpoint for viewing user details for current user + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + $ref: '#/definitions/User' + tags: + - v3 + parameters: [] + /v3/auth/refresh-token/: + post: + operationId: auth_refresh-token_create + summary: Refresh API authentication token by refresh_token. + description: |- + Post "refresh" token as "refresh". + + The return "access" token needs to be sent as HTTP authentication header + with every request with 'Bearer ' prefix (case-sensitive). + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Refresh' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Tokens' + tags: + - v3 + parameters: [] + /v3/auth/token/: + post: + operationId: auth_token_create + summary: Retrieve tokens for API authentication. + description: |- + There are two ways for retrieving a tokens. The preferred way is attaching + a Personal API Key to the request and leave the request body empty. For + backwards compatibility, you can also supply your username and password + in the request body directly. + + The response will contain an "access" and "refresh" JWT token. + + The "access" token needs to be sent as HTTP authentication header + with every request with a 'Bearer ' prefix (case-sensitive). + + Note that the "access" token expires after some time. + + The "refresh" token can be used to get a new access token + via the "refresh" endpoint. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Authenticate' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Tokens' + tags: + - v3 + parameters: [] + /v3/auth/users/: + get: + operationId: auth_users_list + summary: Read-only API endpoint for viewing user details. + description: |- + - superusers and staff users might view all users + - user with a manager role might view all users for the + organisations they have the manager role for + - regular users might view their user details + parameters: + - name: username + in: query + description: '' + required: false + type: string + - name: username__iexact + in: query + description: '' + required: false + type: string + - name: username__contains + in: query + description: '' + required: false + type: string + - name: username__icontains + in: query + description: '' + required: false + type: string + - name: username__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: username__startswith + in: query + description: '' + required: false + type: string + - name: username__istartswith + in: query + description: '' + required: false + type: string + - name: username__endswith + in: query + description: '' + required: false + type: string + - name: username__regex + in: query + description: '' + required: false + type: string + - name: email + in: query + description: '' + required: false + type: string + - name: email__iexact + in: query + description: '' + required: false + type: string + - name: email__contains + in: query + description: '' + required: false + type: string + - name: email__icontains + in: query + description: '' + required: false + type: string + - name: email__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: email__startswith + in: query + description: '' + required: false + type: string + - name: email__istartswith + in: query + description: '' + required: false + type: string + - name: email__endswith + in: query + description: '' + required: false + type: string + - name: email__regex + in: query + description: '' + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/User' + tags: + - v3 + parameters: [] + /v3/auth/users/{id}/: + get: + operationId: auth_users_read + description: '' + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/User' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this user. + required: true + type: integer + /v3/auth/users/{id}/tokens/: + get: + operationId: auth_users_tokens + description: '' + parameters: + - name: required_scopes + in: query + required: false + type: array + items: + type: string + minLength: 1 + default: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/UserTokens' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this user. + required: true + type: integer + /v3/contracts/: + get: + operationId: contracts_list + summary: Overview of organisations that have a valid 3Di contract. + description: |- + List all organisations that already have used some fraction + of their calculation quota (for the current year - the `hours_used` + property is based on the current calender year) + ``` + ?hours_used__gt=0 + ``` + parameters: + - name: organisation__id + in: query + description: '' + required: false + type: number + - name: organisation__id__gt + in: query + description: '' + required: false + type: number + - name: organisation__id__gte + in: query + description: '' + required: false + type: number + - name: organisation__id__lt + in: query + description: '' + required: false + type: number + - name: organisation__id__lte + in: query + description: '' + required: false + type: number + - name: organisation__id__isnull + in: query + description: '' + required: false + type: string + - name: organisation__name + in: query + description: '' + required: false + type: string + - name: organisation__name__iexact + in: query + description: '' + required: false + type: string + - name: organisation__name__contains + in: query + description: '' + required: false + type: string + - name: organisation__name__icontains + in: query + description: '' + required: false + type: string + - name: organisation__name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: organisation__name__startswith + in: query + description: '' + required: false + type: string + - name: organisation__name__istartswith + in: query + description: '' + required: false + type: string + - name: organisation__name__endswith + in: query + description: '' + required: false + type: string + - name: organisation__name__regex + in: query + description: '' + required: false + type: string + - name: organisation__unique_id + in: query + description: '' + required: false + type: string + - name: organisation__unique_id__iexact + in: query + description: '' + required: false + type: string + - name: organisation__unique_id__contains + in: query + description: '' + required: false + type: string + - name: organisation__unique_id__icontains + in: query + description: '' + required: false + type: string + - name: organisation__unique_id__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: organisation__unique_id__startswith + in: query + description: '' + required: false + type: string + - name: organisation__unique_id__istartswith + in: query + description: '' + required: false + type: string + - name: organisation__unique_id__endswith + in: query + description: '' + required: false + type: string + - name: organisation__unique_id__regex + in: query + description: '' + required: false + type: string + - name: hours_used__gt + in: query + description: '' + required: false + type: number + - name: hours_used__lt + in: query + description: '' + required: false + type: number + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/Contract' + tags: + - v3 + post: + operationId: contracts_create + description: API endpoint for interacting with contracts. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Contract' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Contract' + tags: + - v3 + parameters: [] + /v3/contracts/{id}/: + get: + operationId: contracts_read + description: API endpoint for interacting with contracts. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Contract' + tags: + - v3 + put: + operationId: contracts_update + description: API endpoint for interacting with contracts. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Contract' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Contract' + tags: + - v3 + patch: + operationId: contracts_partial_update + description: API endpoint for interacting with contracts. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Contract' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Contract' + tags: + - v3 + delete: + operationId: contracts_delete + description: API endpoint for interacting with contracts. + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this contract. + required: true + type: integer + /v3/files/: + get: + operationId: files_list + description: A simple ViewSet for viewing files + parameters: + - name: filename + in: query + description: '' + required: false + type: string + - name: filename__icontains + in: query + description: '' + required: false + type: string + - name: etag + in: query + description: '' + required: false + type: string + - name: expiry_date + in: query + description: '' + required: false + type: string + - name: expiry_date__lte + in: query + description: '' + required: false + type: string + - name: expiry_date__lt + in: query + description: '' + required: false + type: string + - name: expiry_date__gte + in: query + description: '' + required: false + type: string + - name: expiry_date__gt + in: query + description: '' + required: false + type: string + - name: state + in: query + description: '' + required: false + type: string + - name: state__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: type + in: query + description: '' + required: false + type: string + - name: type__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: meta + in: query + description: '' + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/File' + tags: + - v3 + parameters: [] + /v3/files/{id}/: + get: + operationId: files_read + description: A simple ViewSet for viewing files + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/File' + tags: + - v3 + put: + operationId: files_update + description: A simple ViewSet for viewing files + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/File' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/File' + tags: + - v3 + patch: + operationId: files_partial_update + description: A simple ViewSet for viewing files + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/File' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/File' + tags: + - v3 + delete: + operationId: files_delete + description: A simple ViewSet for viewing files + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this file. + required: true + type: integer + /v3/files/{id}/destroy_file/: + delete: + operationId: files_destroy_file + description: A simple ViewSet for viewing files + parameters: [] + responses: + '204': + description: '' + schema: + $ref: '#/definitions/File' + '405': + description: "types that are allowed to be destroyed: ['timeseries', 'rastertimeseries',\ + \ 'savedstate', 'results', 'bulklateral', 'bulkcontrol']" + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this file. + required: true + type: integer + /v3/files/{id}/download/: + get: + operationId: files_download + description: A simple ViewSet for viewing files + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this file. + required: true + type: integer + /v3/files/{id}/processed/: + put: + operationId: files_processed + summary: |- + Endpoint to which the upload-processor can enrich file objects + (and their related objects) with metadata. + description: For example the geotransform of raster files. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/FileMeta' + responses: + '200': + description: OK + '400': + description: Upload is already processed + '404': + description: upload not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this file. + required: true + type: integer + /v3/inpy-versions/: + get: + operationId: inpy-versions_list + description: |- + Inpy was the service for preparing user-supplied schematisations into 3Di + models (threedimodels) usable by the 3Di calculation core. + + Currently, this route is pending deprecation: most newly generated + 3Di models will carry an empty inpy_version. + parameters: + - name: threedi_version + in: query + description: '' + required: false + type: string + - name: threedi_version__iexact + in: query + description: '' + required: false + type: string + - name: threedi_version__contains + in: query + description: '' + required: false + type: string + - name: threedi_version__icontains + in: query + description: '' + required: false + type: string + - name: threedi_version__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: threedi_version__startswith + in: query + description: '' + required: false + type: string + - name: threedi_version__istartswith + in: query + description: '' + required: false + type: string + - name: threedi_version__endswith + in: query + description: '' + required: false + type: string + - name: threedi_version__regex + in: query + description: '' + required: false + type: string + - name: threedicore_version + in: query + description: '' + required: false + type: string + - name: threedicore_version__iexact + in: query + description: '' + required: false + type: string + - name: threedicore_version__contains + in: query + description: '' + required: false + type: string + - name: threedicore_version__icontains + in: query + description: '' + required: false + type: string + - name: threedicore_version__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: threedicore_version__startswith + in: query + description: '' + required: false + type: string + - name: threedicore_version__istartswith + in: query + description: '' + required: false + type: string + - name: threedicore_version__endswith + in: query + description: '' + required: false + type: string + - name: threedicore_version__regex + in: query + description: '' + required: false + type: string + - name: slug + in: query + description: '' + required: false + type: string + - name: slug__iexact + in: query + description: '' + required: false + type: string + - name: slug__contains + in: query + description: '' + required: false + type: string + - name: slug__icontains + in: query + description: '' + required: false + type: string + - name: slug__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: slug__startswith + in: query + description: '' + required: false + type: string + - name: slug__istartswith + in: query + description: '' + required: false + type: string + - name: slug__endswith + in: query + description: '' + required: false + type: string + - name: slug__regex + in: query + description: '' + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/InpyVersion' + tags: + - v3 + post: + operationId: inpy-versions_create + description: |- + Inpy was the service for preparing user-supplied schematisations into 3Di + models (threedimodels) usable by the 3Di calculation core. + + Currently, this route is pending deprecation: most newly generated + 3Di models will carry an empty inpy_version. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/InpyVersion' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/InpyVersion' + tags: + - v3 + parameters: [] + /v3/inpy-versions/{id}/: + get: + operationId: inpy-versions_read + description: |- + Inpy was the service for preparing user-supplied schematisations into 3Di + models (threedimodels) usable by the 3Di calculation core. + + Currently, this route is pending deprecation: most newly generated + 3Di models will carry an empty inpy_version. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/InpyVersion' + tags: + - v3 + put: + operationId: inpy-versions_update + description: |- + Inpy was the service for preparing user-supplied schematisations into 3Di + models (threedimodels) usable by the 3Di calculation core. + + Currently, this route is pending deprecation: most newly generated + 3Di models will carry an empty inpy_version. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/InpyVersion' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/InpyVersion' + tags: + - v3 + patch: + operationId: inpy-versions_partial_update + description: |- + Inpy was the service for preparing user-supplied schematisations into 3Di + models (threedimodels) usable by the 3Di calculation core. + + Currently, this route is pending deprecation: most newly generated + 3Di models will carry an empty inpy_version. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/InpyVersion' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/InpyVersion' + tags: + - v3 + delete: + operationId: inpy-versions_delete + description: |- + Inpy was the service for preparing user-supplied schematisations into 3Di + models (threedimodels) usable by the 3Di calculation core. + + Currently, this route is pending deprecation: most newly generated + 3Di models will carry an empty inpy_version. + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this inpy version. + required: true + type: integer + /v3/organisations/: + get: + operationId: organisations_list + description: Read-only API endpoint for interacting with organisations. + parameters: + - name: name + in: query + description: '' + required: false + type: string + - name: name__iexact + in: query + description: '' + required: false + type: string + - name: name__contains + in: query + description: '' + required: false + type: string + - name: name__icontains + in: query + description: '' + required: false + type: string + - name: name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: name__startswith + in: query + description: '' + required: false + type: string + - name: name__istartswith + in: query + description: '' + required: false + type: string + - name: name__endswith + in: query + description: '' + required: false + type: string + - name: name__regex + in: query + description: '' + required: false + type: string + - name: unique_id + in: query + description: '' + required: false + type: string + - name: unique_id__iexact + in: query + description: '' + required: false + type: string + - name: unique_id__contains + in: query + description: '' + required: false + type: string + - name: unique_id__icontains + in: query + description: '' + required: false + type: string + - name: unique_id__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: unique_id__startswith + in: query + description: '' + required: false + type: string + - name: unique_id__istartswith + in: query + description: '' + required: false + type: string + - name: unique_id__endswith + in: query + description: '' + required: false + type: string + - name: unique_id__regex + in: query + description: '' + required: false + type: string + - name: valid_contracts_only + in: query + description: '' + required: false + type: string + - name: logged_in_user_has_role + in: query + description: '' + required: false + type: string + - name: contract__scope__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/Organisation' + tags: + - v3 + parameters: [] + /v3/organisations/{unique_id}/: + get: + operationId: organisations_read + description: Read-only API endpoint for interacting with organisations. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Organisation' + tags: + - v3 + parameters: + - name: unique_id + in: path + required: true + type: string + /v3/organisations/{unique_id}/permissions/: + get: + operationId: organisations_permissions + description: Read-only API endpoint for interacting with organisations. + parameters: [] + responses: + '200': + description: '' + schema: + type: array + items: + $ref: '#/definitions/OrganisationRole' + tags: + - v3 + parameters: + - name: unique_id + in: path + required: true + type: string + /v3/organisations/{unique_id}/users/: + get: + operationId: organisations_users_list + description: Endpoint for interacting with users in an organisation. + parameters: + - name: username + in: query + description: '' + required: false + type: string + - name: username__iexact + in: query + description: '' + required: false + type: string + - name: username__contains + in: query + description: '' + required: false + type: string + - name: username__icontains + in: query + description: '' + required: false + type: string + - name: username__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: username__startswith + in: query + description: '' + required: false + type: string + - name: username__istartswith + in: query + description: '' + required: false + type: string + - name: username__endswith + in: query + description: '' + required: false + type: string + - name: username__regex + in: query + description: '' + required: false + type: string + - name: email + in: query + description: '' + required: false + type: string + - name: email__iexact + in: query + description: '' + required: false + type: string + - name: email__contains + in: query + description: '' + required: false + type: string + - name: email__icontains + in: query + description: '' + required: false + type: string + - name: email__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: email__startswith + in: query + description: '' + required: false + type: string + - name: email__istartswith + in: query + description: '' + required: false + type: string + - name: email__endswith + in: query + description: '' + required: false + type: string + - name: email__regex + in: query + description: '' + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/OrganisationUser' + tags: + - v3 + parameters: + - name: unique_id + in: path + required: true + type: string + /v3/organisations/{unique_id}/users/{id}/: + get: + operationId: organisations_users_read + description: Endpoint for interacting with users in an organisation. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/OrganisationUser' + tags: + - v3 + patch: + operationId: organisations_users_partial_update + description: Patch the roles of a user in this organisation. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/OrganisationUserRolePatch' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/OrganisationUser' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this user. + required: true + type: integer + - name: unique_id + in: path + required: true + type: string + /v3/permissions/: + get: + operationId: permissions_list + description: Permissions management endpoints. + parameters: + - name: user__username + in: query + description: '' + required: false + type: string + - name: user__username__iexact + in: query + description: '' + required: false + type: string + - name: user__username__contains + in: query + description: '' + required: false + type: string + - name: user__username__icontains + in: query + description: '' + required: false + type: string + - name: user__username__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: user__username__startswith + in: query + description: '' + required: false + type: string + - name: user__username__istartswith + in: query + description: '' + required: false + type: string + - name: user__username__endswith + in: query + description: '' + required: false + type: string + - name: user__username__regex + in: query + description: '' + required: false + type: string + - name: role__name + in: query + description: '' + required: false + type: string + - name: role__name__iexact + in: query + description: '' + required: false + type: string + - name: role__name__contains + in: query + description: '' + required: false + type: string + - name: role__name__icontains + in: query + description: '' + required: false + type: string + - name: role__name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: role__name__startswith + in: query + description: '' + required: false + type: string + - name: role__name__istartswith + in: query + description: '' + required: false + type: string + - name: role__name__endswith + in: query + description: '' + required: false + type: string + - name: role__name__regex + in: query + description: '' + required: false + type: string + - name: organisation__name + in: query + description: '' + required: false + type: string + - name: organisation__name__iexact + in: query + description: '' + required: false + type: string + - name: organisation__name__contains + in: query + description: '' + required: false + type: string + - name: organisation__name__icontains + in: query + description: '' + required: false + type: string + - name: organisation__name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: organisation__name__startswith + in: query + description: '' + required: false + type: string + - name: organisation__name__istartswith + in: query + description: '' + required: false + type: string + - name: organisation__name__endswith + in: query + description: '' + required: false + type: string + - name: organisation__name__regex + in: query + description: '' + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/OrganisationRole' + tags: + - v3 + post: + operationId: permissions_create + summary: create a role for an existing user in an existing organisation + description: |- + Example payload: + + { + "user": "chuck.norris", # user name + "role": "simulation_runner", # role name + "organisation": "48dac75bef8a42ebbb52e8f89bbdb9f2" # unique id + } + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/OrganisationRole' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/OrganisationRole' + tags: + - v3 + parameters: [] + /v3/permissions/{id}/: + get: + operationId: permissions_read + description: Permissions management endpoints. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/OrganisationRole' + tags: + - v3 + delete: + operationId: permissions_delete + description: Permissions management endpoints. + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this user organisation role. + required: true + type: integer + /v3/repositories/: + get: + operationId: repositories_list + description: A simple ViewSet for viewing modelmeta + parameters: + - name: slug + in: query + description: '' + required: false + type: string + - name: slug__iexact + in: query + description: '' + required: false + type: string + - name: slug__contains + in: query + description: '' + required: false + type: string + - name: slug__icontains + in: query + description: '' + required: false + type: string + - name: slug__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: slug__startswith + in: query + description: '' + required: false + type: string + - name: slug__istartswith + in: query + description: '' + required: false + type: string + - name: slug__endswith + in: query + description: '' + required: false + type: string + - name: slug__regex + in: query + description: '' + required: false + type: string + - name: organisation__id + in: query + description: '' + required: false + type: number + - name: organisation__id__gt + in: query + description: '' + required: false + type: number + - name: organisation__id__gte + in: query + description: '' + required: false + type: number + - name: organisation__id__lt + in: query + description: '' + required: false + type: number + - name: organisation__id__lte + in: query + description: '' + required: false + type: number + - name: organisation__id__isnull + in: query + description: '' + required: false + type: string + - name: organisation__name + in: query + description: '' + required: false + type: string + - name: organisation__name__iexact + in: query + description: '' + required: false + type: string + - name: organisation__name__contains + in: query + description: '' + required: false + type: string + - name: organisation__name__icontains + in: query + description: '' + required: false + type: string + - name: organisation__name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: organisation__name__startswith + in: query + description: '' + required: false + type: string + - name: organisation__name__istartswith + in: query + description: '' + required: false + type: string + - name: organisation__name__endswith + in: query + description: '' + required: false + type: string + - name: organisation__name__regex + in: query + description: '' + required: false + type: string + - name: organisation__unique_id + in: query + description: '' + required: false + type: string + - name: organisation__unique_id__iexact + in: query + description: '' + required: false + type: string + - name: organisation__unique_id__contains + in: query + description: '' + required: false + type: string + - name: organisation__unique_id__icontains + in: query + description: '' + required: false + type: string + - name: organisation__unique_id__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: organisation__unique_id__startswith + in: query + description: '' + required: false + type: string + - name: organisation__unique_id__istartswith + in: query + description: '' + required: false + type: string + - name: organisation__unique_id__endswith + in: query + description: '' + required: false + type: string + - name: organisation__unique_id__regex + in: query + description: '' + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/Repository' + tags: + - v3 + post: + operationId: repositories_create + description: A simple ViewSet for viewing modelmeta + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Repository' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Repository' + tags: + - v3 + parameters: [] + /v3/repositories/{id}/: + get: + operationId: repositories_read + description: A simple ViewSet for viewing modelmeta + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Repository' + tags: + - v3 + put: + operationId: repositories_update + description: A simple ViewSet for viewing modelmeta + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Repository' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Repository' + tags: + - v3 + patch: + operationId: repositories_partial_update + description: A simple ViewSet for viewing modelmeta + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Repository' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Repository' + tags: + - v3 + delete: + operationId: repositories_delete + description: A simple ViewSet for viewing modelmeta + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this repository. + required: true + type: integer + /v3/repositories/{id}/revisions/: + get: + operationId: repositories_revisions + description: A simple ViewSet for viewing modelmeta + parameters: [] + responses: + '200': + description: '' + schema: + type: array + items: + $ref: '#/definitions/Revision' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this repository. + required: true + type: integer + /v3/repositories/{id}/threedimodels/: + get: + operationId: repositories_threedimodels + description: A simple ViewSet for viewing modelmeta + parameters: [] + responses: + '200': + description: '' + schema: + type: array + items: + $ref: '#/definitions/ThreediModel' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this repository. + required: true + type: integer + /v3/revisions/: + get: + operationId: revisions_list + description: A simple ViewSet for viewing modelmeta + parameters: + - name: number + in: query + description: '' + required: false + type: number + - name: number__gt + in: query + description: '' + required: false + type: number + - name: number__gte + in: query + description: '' + required: false + type: number + - name: number__lt + in: query + description: '' + required: false + type: number + - name: number__lte + in: query + description: '' + required: false + type: number + - name: number__isnull + in: query + description: '' + required: false + type: string + - name: hash + in: query + description: '' + required: false + type: string + - name: hash__iexact + in: query + description: '' + required: false + type: string + - name: hash__contains + in: query + description: '' + required: false + type: string + - name: hash__icontains + in: query + description: '' + required: false + type: string + - name: hash__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: hash__startswith + in: query + description: '' + required: false + type: string + - name: hash__istartswith + in: query + description: '' + required: false + type: string + - name: hash__endswith + in: query + description: '' + required: false + type: string + - name: hash__regex + in: query + description: '' + required: false + type: string + - name: repository__id + in: query + description: '' + required: false + type: number + - name: repository__id__gt + in: query + description: '' + required: false + type: number + - name: repository__id__gte + in: query + description: '' + required: false + type: number + - name: repository__id__lt + in: query + description: '' + required: false + type: number + - name: repository__id__lte + in: query + description: '' + required: false + type: number + - name: repository__id__isnull + in: query + description: '' + required: false + type: string + - name: repository__slug + in: query + description: '' + required: false + type: string + - name: repository__slug__iexact + in: query + description: '' + required: false + type: string + - name: repository__slug__contains + in: query + description: '' + required: false + type: string + - name: repository__slug__icontains + in: query + description: '' + required: false + type: string + - name: repository__slug__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: repository__slug__startswith + in: query + description: '' + required: false + type: string + - name: repository__slug__istartswith + in: query + description: '' + required: false + type: string + - name: repository__slug__endswith + in: query + description: '' + required: false + type: string + - name: repository__slug__regex + in: query + description: '' + required: false + type: string + - name: repository__organisation__name + in: query + description: '' + required: false + type: string + - name: repository__organisation__name__iexact + in: query + description: '' + required: false + type: string + - name: repository__organisation__name__contains + in: query + description: '' + required: false + type: string + - name: repository__organisation__name__icontains + in: query + description: '' + required: false + type: string + - name: repository__organisation__name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: repository__organisation__name__startswith + in: query + description: '' + required: false + type: string + - name: repository__organisation__name__istartswith + in: query + description: '' + required: false + type: string + - name: repository__organisation__name__endswith + in: query + description: '' + required: false + type: string + - name: repository__organisation__name__regex + in: query + description: '' + required: false + type: string + - name: repository__organisation__unique_id + in: query + description: '' + required: false + type: string + - name: repository__organisation__unique_id__iexact + in: query + description: '' + required: false + type: string + - name: repository__organisation__unique_id__contains + in: query + description: '' + required: false + type: string + - name: repository__organisation__unique_id__icontains + in: query + description: '' + required: false + type: string + - name: repository__organisation__unique_id__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: repository__organisation__unique_id__startswith + in: query + description: '' + required: false + type: string + - name: repository__organisation__unique_id__istartswith + in: query + description: '' + required: false + type: string + - name: repository__organisation__unique_id__endswith + in: query + description: '' + required: false + type: string + - name: repository__organisation__unique_id__regex + in: query + description: '' + required: false + type: string + - name: is_pinned + in: query + description: '' + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/Revision' + tags: + - v3 + post: + operationId: revisions_create + description: A simple ViewSet for viewing modelmeta + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Revision' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Revision' + tags: + - v3 + parameters: [] + /v3/revisions/{id}/: + get: + operationId: revisions_read + description: A simple ViewSet for viewing modelmeta + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Revision' + tags: + - v3 + put: + operationId: revisions_update + description: A simple ViewSet for viewing modelmeta + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Revision' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Revision' + tags: + - v3 + patch: + operationId: revisions_partial_update + description: A simple ViewSet for viewing modelmeta + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Revision' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Revision' + tags: + - v3 + delete: + operationId: revisions_delete + description: A simple ViewSet for viewing modelmeta + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this revision. + required: true + type: integer + /v3/revisions/{id}/threedimodels/: + get: + operationId: revisions_threedimodels + description: A simple ViewSet for viewing modelmeta + parameters: [] + responses: + '200': + description: '' + schema: + type: array + items: + $ref: '#/definitions/ThreediModel' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this revision. + required: true + type: integer + /v3/roles/: + get: + operationId: roles_list + description: Read-only API endpoint for viewing roles + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/Role' + tags: + - v3 + parameters: [] + /v3/roles/{id}/: + get: + operationId: roles_read + description: Read-only API endpoint for viewing roles + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Role' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this role. + required: true + type: integer + /v3/schematisations/: + get: + operationId: schematisations_list + description: Manage schematisations + parameters: + - name: created__range + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: created__date + in: query + description: '' + required: false + type: string + - name: created__date__gt + in: query + description: '' + required: false + type: string + - name: created__date__gte + in: query + description: '' + required: false + type: string + - name: created__date__lt + in: query + description: '' + required: false + type: string + - name: created__date__lte + in: query + description: '' + required: false + type: string + - name: created__year + in: query + description: '' + required: false + type: number + - name: created__year__gt + in: query + description: '' + required: false + type: number + - name: created__year__gte + in: query + description: '' + required: false + type: number + - name: created__year__lt + in: query + description: '' + required: false + type: number + - name: created__year__lte + in: query + description: '' + required: false + type: number + - name: created__month + in: query + description: '' + required: false + type: number + - name: created__month__lte + in: query + description: '' + required: false + type: number + - name: created__day + in: query + description: '' + required: false + type: number + - name: created__day__lt + in: query + description: '' + required: false + type: number + - name: created__week + in: query + description: '' + required: false + type: number + - name: created__week_day + in: query + description: '' + required: false + type: number + - name: created__quarter + in: query + description: '' + required: false + type: number + - name: created__time + in: query + description: '' + required: false + type: string + - name: created__hour + in: query + description: '' + required: false + type: number + - name: created__minute + in: query + description: '' + required: false + type: number + - name: created__second + in: query + description: '' + required: false + type: number + - name: created__isnull + in: query + description: '' + required: false + type: string + - name: last_updated__range + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: last_updated__date + in: query + description: '' + required: false + type: string + - name: last_updated__date__gt + in: query + description: '' + required: false + type: string + - name: last_updated__date__gte + in: query + description: '' + required: false + type: string + - name: last_updated__date__lt + in: query + description: '' + required: false + type: string + - name: last_updated__date__lte + in: query + description: '' + required: false + type: string + - name: last_updated__year + in: query + description: '' + required: false + type: number + - name: last_updated__year__gt + in: query + description: '' + required: false + type: number + - name: last_updated__year__gte + in: query + description: '' + required: false + type: number + - name: last_updated__year__lt + in: query + description: '' + required: false + type: number + - name: last_updated__year__lte + in: query + description: '' + required: false + type: number + - name: last_updated__month + in: query + description: '' + required: false + type: number + - name: last_updated__month__lte + in: query + description: '' + required: false + type: number + - name: last_updated__day + in: query + description: '' + required: false + type: number + - name: last_updated__day__lt + in: query + description: '' + required: false + type: number + - name: last_updated__week + in: query + description: '' + required: false + type: number + - name: last_updated__week_day + in: query + description: '' + required: false + type: number + - name: last_updated__quarter + in: query + description: '' + required: false + type: number + - name: last_updated__time + in: query + description: '' + required: false + type: string + - name: last_updated__hour + in: query + description: '' + required: false + type: number + - name: last_updated__minute + in: query + description: '' + required: false + type: number + - name: last_updated__second + in: query + description: '' + required: false + type: number + - name: last_updated__isnull + in: query + description: '' + required: false + type: string + - name: created_by__username + in: query + description: '' + required: false + type: string + - name: created_by__username__iexact + in: query + description: '' + required: false + type: string + - name: created_by__username__contains + in: query + description: '' + required: false + type: string + - name: created_by__username__icontains + in: query + description: '' + required: false + type: string + - name: created_by__username__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: created_by__username__startswith + in: query + description: '' + required: false + type: string + - name: created_by__username__istartswith + in: query + description: '' + required: false + type: string + - name: created_by__username__endswith + in: query + description: '' + required: false + type: string + - name: created_by__username__regex + in: query + description: '' + required: false + type: string + - name: name + in: query + description: '' + required: false + type: string + - name: name__iexact + in: query + description: '' + required: false + type: string + - name: name__contains + in: query + description: '' + required: false + type: string + - name: name__icontains + in: query + description: '' + required: false + type: string + - name: name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: name__startswith + in: query + description: '' + required: false + type: string + - name: name__istartswith + in: query + description: '' + required: false + type: string + - name: name__endswith + in: query + description: '' + required: false + type: string + - name: name__regex + in: query + description: '' + required: false + type: string + - name: slug + in: query + description: '' + required: false + type: string + - name: slug__iexact + in: query + description: '' + required: false + type: string + - name: slug__contains + in: query + description: '' + required: false + type: string + - name: slug__icontains + in: query + description: '' + required: false + type: string + - name: slug__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: slug__startswith + in: query + description: '' + required: false + type: string + - name: slug__istartswith + in: query + description: '' + required: false + type: string + - name: slug__endswith + in: query + description: '' + required: false + type: string + - name: slug__regex + in: query + description: '' + required: false + type: string + - name: owner__name + in: query + description: '' + required: false + type: string + - name: owner__name__iexact + in: query + description: '' + required: false + type: string + - name: owner__name__contains + in: query + description: '' + required: false + type: string + - name: owner__name__icontains + in: query + description: '' + required: false + type: string + - name: owner__name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: owner__name__startswith + in: query + description: '' + required: false + type: string + - name: owner__name__istartswith + in: query + description: '' + required: false + type: string + - name: owner__name__endswith + in: query + description: '' + required: false + type: string + - name: owner__name__regex + in: query + description: '' + required: false + type: string + - name: owner__unique_id + in: query + description: '' + required: false + type: string + - name: owner__unique_id__iexact + in: query + description: '' + required: false + type: string + - name: owner__unique_id__contains + in: query + description: '' + required: false + type: string + - name: owner__unique_id__icontains + in: query + description: '' + required: false + type: string + - name: owner__unique_id__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: owner__unique_id__startswith + in: query + description: '' + required: false + type: string + - name: owner__unique_id__istartswith + in: query + description: '' + required: false + type: string + - name: owner__unique_id__endswith + in: query + description: '' + required: false + type: string + - name: owner__unique_id__regex + in: query + description: '' + required: false + type: string + - name: tags__in + in: query + description: '' + required: false + type: string + - name: archived + in: query + description: '' + required: false + type: string + - name: ordering + in: query + description: Which field to use when ordering the results. + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/Schematisation' + tags: + - v3 + post: + operationId: schematisations_create + description: Manage schematisations + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Schematisation' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Schematisation' + tags: + - v3 + parameters: [] + /v3/schematisations/{id}/: + get: + operationId: schematisations_read + description: Manage schematisations + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Schematisation' + tags: + - v3 + put: + operationId: schematisations_update + description: Manage schematisations + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Schematisation' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Schematisation' + tags: + - v3 + patch: + operationId: schematisations_partial_update + description: Manage schematisations + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Schematisation' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Schematisation' + tags: + - v3 + delete: + operationId: schematisations_delete + description: Archive schematisation. + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this schematisation. + required: true + type: integer + /v3/schematisations/{id}/latest-revision/: + get: + operationId: schematisations_latest_revision + summary: Get the latest committed revision. + description: 'For retrieving all revisions use: `/schematisations/{id}/revisions`' + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/SchematisationRevision' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this schematisation. + required: true + type: integer + /v3/schematisations/{schematisation_pk}/revisions/: + get: + operationId: schematisations_revisions_list + description: Manage revisions of schematisations. + parameters: + - name: number + in: query + description: '' + required: false + type: number + - name: commit_message + in: query + description: '' + required: false + type: string + - name: commit_message__iexact + in: query + description: '' + required: false + type: string + - name: commit_message__contains + in: query + description: '' + required: false + type: string + - name: commit_message__icontains + in: query + description: '' + required: false + type: string + - name: commit_message__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: commit_message__startswith + in: query + description: '' + required: false + type: string + - name: commit_message__istartswith + in: query + description: '' + required: false + type: string + - name: commit_message__endswith + in: query + description: '' + required: false + type: string + - name: commit_message__regex + in: query + description: '' + required: false + type: string + - name: schematisation__id + in: query + description: '' + required: false + type: number + - name: schematisation__slug + in: query + description: '' + required: false + type: string + - name: schematisation__slug__iexact + in: query + description: '' + required: false + type: string + - name: schematisation__slug__contains + in: query + description: '' + required: false + type: string + - name: schematisation__slug__icontains + in: query + description: '' + required: false + type: string + - name: schematisation__slug__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: schematisation__slug__startswith + in: query + description: '' + required: false + type: string + - name: schematisation__slug__istartswith + in: query + description: '' + required: false + type: string + - name: schematisation__slug__endswith + in: query + description: '' + required: false + type: string + - name: schematisation__slug__regex + in: query + description: '' + required: false + type: string + - name: schematisation__owner__name + in: query + description: '' + required: false + type: string + - name: schematisation__owner__name__iexact + in: query + description: '' + required: false + type: string + - name: schematisation__owner__name__contains + in: query + description: '' + required: false + type: string + - name: schematisation__owner__name__icontains + in: query + description: '' + required: false + type: string + - name: schematisation__owner__name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: schematisation__owner__name__startswith + in: query + description: '' + required: false + type: string + - name: schematisation__owner__name__istartswith + in: query + description: '' + required: false + type: string + - name: schematisation__owner__name__endswith + in: query + description: '' + required: false + type: string + - name: schematisation__owner__name__regex + in: query + description: '' + required: false + type: string + - name: schematisation__owner__unique_id + in: query + description: '' + required: false + type: string + - name: schematisation__owner__unique_id__iexact + in: query + description: '' + required: false + type: string + - name: schematisation__owner__unique_id__contains + in: query + description: '' + required: false + type: string + - name: schematisation__owner__unique_id__icontains + in: query + description: '' + required: false + type: string + - name: schematisation__owner__unique_id__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: schematisation__owner__unique_id__startswith + in: query + description: '' + required: false + type: string + - name: schematisation__owner__unique_id__istartswith + in: query + description: '' + required: false + type: string + - name: schematisation__owner__unique_id__endswith + in: query + description: '' + required: false + type: string + - name: schematisation__owner__unique_id__regex + in: query + description: '' + required: false + type: string + - name: commit_user__username + in: query + description: '' + required: false + type: string + - name: commit_user__username__iexact + in: query + description: '' + required: false + type: string + - name: commit_user__username__contains + in: query + description: '' + required: false + type: string + - name: commit_user__username__icontains + in: query + description: '' + required: false + type: string + - name: commit_user__username__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: commit_user__username__startswith + in: query + description: '' + required: false + type: string + - name: commit_user__username__istartswith + in: query + description: '' + required: false + type: string + - name: commit_user__username__endswith + in: query + description: '' + required: false + type: string + - name: commit_user__username__regex + in: query + description: '' + required: false + type: string + - name: commit_date + in: query + description: '' + required: false + type: string + - name: commit_date__gt + in: query + description: '' + required: false + type: string + - name: commit_date__gte + in: query + description: '' + required: false + type: string + - name: commit_date__lt + in: query + description: '' + required: false + type: string + - name: commit_date__lte + in: query + description: '' + required: false + type: string + - name: commit_date__date + in: query + description: '' + required: false + type: string + - name: commit_date__date__gt + in: query + description: '' + required: false + type: string + - name: commit_date__date__gte + in: query + description: '' + required: false + type: string + - name: commit_date__date__lt + in: query + description: '' + required: false + type: string + - name: commit_date__date__lte + in: query + description: '' + required: false + type: string + - name: commit_date__year + in: query + description: '' + required: false + type: number + - name: commit_date__year__gt + in: query + description: '' + required: false + type: number + - name: commit_date__year__gte + in: query + description: '' + required: false + type: number + - name: commit_date__year__lt + in: query + description: '' + required: false + type: number + - name: commit_date__year__lte + in: query + description: '' + required: false + type: number + - name: commit_date__month + in: query + description: '' + required: false + type: number + - name: commit_date__month__lte + in: query + description: '' + required: false + type: number + - name: commit_date__day + in: query + description: '' + required: false + type: number + - name: commit_date__day__lt + in: query + description: '' + required: false + type: number + - name: commit_date__week + in: query + description: '' + required: false + type: number + - name: commit_date__week_day + in: query + description: '' + required: false + type: number + - name: committed + in: query + description: '' + required: false + type: string + - name: archived + in: query + description: '' + required: false + type: string + - name: is_valid + in: query + description: '' + required: false + type: string + - name: has_threedimodel + in: query + description: '' + required: false + type: string + - name: ordering + in: query + description: Which field to use when ordering the results. + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/SchematisationRevision' + tags: + - v3 + post: + operationId: schematisations_revisions_create + summary: Create a new revision + description: |- + Creates a clone of the last committed revision (if present) + by default except when empty=true is passed in the data. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/CreateRevision' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/SchematisationRevision' + tags: + - v3 + parameters: + - name: schematisation_pk + in: path + required: true + type: string + /v3/schematisations/{schematisation_pk}/revisions/{id}/: + get: + operationId: schematisations_revisions_read + description: Manage revisions of schematisations. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/SchematisationRevision' + tags: + - v3 + patch: + operationId: schematisations_revisions_partial_update + description: Manage revisions of schematisations. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/UpdateRevision' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/UpdateRevision' + tags: + - v3 + delete: + operationId: schematisations_revisions_delete + description: Provide the revision id to delete the revision + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/DestroyRevision' + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this revision. + required: true + type: integer + - name: schematisation_pk + in: path + required: true + type: string + /v3/schematisations/{schematisation_pk}/revisions/{id}/check/: + post: + operationId: schematisations_revisions_check + description: Manage revisions of schematisations. + parameters: [] + responses: + '201': + description: '' + schema: + $ref: '#/definitions/RevisionTask' + '409': + description: Conflict with other task already pending + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this revision. + required: true + type: integer + - name: schematisation_pk + in: path + required: true + type: string + /v3/schematisations/{schematisation_pk}/revisions/{id}/commit/: + post: + operationId: schematisations_revisions_commit + summary: Commit the revision + description: |- + The `commit_message` can be used to describe the changes. + + The `force_as` parameter allows to override the default behaviour + of committing the revision with the already assigned revision number. + + In case another user has already committed a revision with the same + number, an HTTP 409 status code is returned. + + In this case you can either: + 1) Save the revision with a higher revision number using + `force_as` = `new_revision`, effectively overwriting changes + from the other user. + 2) Save the revision under a new schematisation using + `force_as` = `new_schematisation` and specifying + a `schematisation_name`. + + If you want to merge your changes with the changes from the + other user, you need to download his/hers revision locally and merge + it yourselves. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Commit' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/SchematisationRevision' + '409': + description: Conflict with other revision already committed + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this revision. + required: true + type: integer + - name: schematisation_pk + in: path + required: true + type: string + /v3/schematisations/{schematisation_pk}/revisions/{id}/create-threedimodel/: + post: + operationId: schematisations_revisions_create_threedimodel + description: Manage revisions of schematisations. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/CreateThreedimodel' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ThreediModel' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this revision. + required: true + type: integer + - name: schematisation_pk + in: path + required: true + type: string + /v3/schematisations/{schematisation_pk}/revisions/{id}/sqlite/delete/: + delete: + operationId: schematisations_revisions_sqlite_delete + description: Manage revisions of schematisations. + parameters: [] + responses: + '204': + description: Deleted + '404': + description: sqlite not found + '400': + description: Not allowed after commit + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this revision. + required: true + type: integer + - name: schematisation_pk + in: path + required: true + type: string + /v3/schematisations/{schematisation_pk}/revisions/{id}/sqlite/download/: + get: + operationId: schematisations_revisions_sqlite_download + description: Endpoint for downloading files. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this revision. + required: true + type: integer + - name: schematisation_pk + in: path + required: true + type: string + /v3/schematisations/{schematisation_pk}/revisions/{id}/sqlite/upload/: + post: + operationId: schematisations_revisions_sqlite_upload + summary: Endpoint for uploading the sqlite file. + description: |- + The file should preferably be zipped (deflate). + + Replaces the present sqlite file if there already exists one. + + Optional md5sum can be added to detect if the file already + has been uploaded and perform de-duplication. + (md5sum of the compressed sqlite file) + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/SqliteFileUpload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + '200': + description: '' + schema: + $ref: '#/definitions/Upload' + '400': + description: Any validation errors + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this revision. + required: true + type: integer + - name: schematisation_pk + in: path + required: true + type: string + /v3/schematisations/{schematisation_pk}/revisions/{id}/threedimodels/: + get: + operationId: schematisations_revisions_threedimodels + description: Manage revisions of schematisations. + parameters: [] + responses: + '200': + description: '' + schema: + type: array + items: + $ref: '#/definitions/ThreediModel' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this revision. + required: true + type: integer + - name: schematisation_pk + in: path + required: true + type: string + /v3/schematisations/{schematisation_pk}/revisions/{revision_pk}/rasters/: + get: + operationId: schematisations_revisions_rasters_list + description: '' + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/RevisionRaster' + tags: + - v3 + post: + operationId: schematisations_revisions_rasters_create + summary: Endpoint for creating a raster linked to a revision. + description: |- + Every raster type can be created/uploaded only once. + + Optional md5sum can be added to detect if the file already + has been uploaded and automatically perform de-duplication. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/RasterCreate' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/RevisionRaster' + tags: + - v3 + parameters: + - name: revision_pk + in: path + required: true + type: string + - name: schematisation_pk + in: path + required: true + type: string + /v3/schematisations/{schematisation_pk}/revisions/{revision_pk}/rasters/{id}/: + get: + operationId: schematisations_revisions_rasters_read + description: '' + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/RevisionRaster' + tags: + - v3 + put: + operationId: schematisations_revisions_rasters_update + description: '' + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/RevisionRaster' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/RevisionRaster' + tags: + - v3 + patch: + operationId: schematisations_revisions_rasters_partial_update + description: '' + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/RevisionRaster' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/RevisionRaster' + tags: + - v3 + delete: + operationId: schematisations_revisions_rasters_delete + description: '' + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this revision raster. + required: true + type: integer + - name: revision_pk + in: path + required: true + type: string + - name: schematisation_pk + in: path + required: true + type: string + /v3/schematisations/{schematisation_pk}/revisions/{revision_pk}/rasters/{id}/download/: + get: + operationId: schematisations_revisions_rasters_download + description: Endpoint for downloading files. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this revision raster. + required: true + type: integer + - name: revision_pk + in: path + required: true + type: string + - name: schematisation_pk + in: path + required: true + type: string + /v3/schematisations/{schematisation_pk}/revisions/{revision_pk}/rasters/{id}/upload/: + post: + operationId: schematisations_revisions_rasters_upload + description: Endpoint for uploading a raster. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this revision raster. + required: true + type: integer + - name: revision_pk + in: path + required: true + type: string + - name: schematisation_pk + in: path + required: true + type: string + /v3/schematisations/{schematisation_pk}/revisions/{revision_pk}/tasks/: + get: + operationId: schematisations_revisions_tasks_list + description: View revision tasks + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/RevisionTask' + tags: + - v3 + post: + operationId: schematisations_revisions_tasks_create + description: View revision tasks + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/RevisionTask' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/RevisionTask' + tags: + - v3 + parameters: + - name: revision_pk + in: path + required: true + type: string + - name: schematisation_pk + in: path + required: true + type: string + /v3/schematisations/{schematisation_pk}/revisions/{revision_pk}/tasks/{id}/: + get: + operationId: schematisations_revisions_tasks_read + description: View revision tasks + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/RevisionTask' + tags: + - v3 + put: + operationId: schematisations_revisions_tasks_update + description: View revision tasks + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/RevisionTask' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/RevisionTask' + tags: + - v3 + patch: + operationId: schematisations_revisions_tasks_partial_update + description: View revision tasks + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/RevisionTask' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/RevisionTask' + tags: + - v3 + delete: + operationId: schematisations_revisions_tasks_delete + description: View revision tasks + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this revision task. + required: true + type: integer + - name: revision_pk + in: path + required: true + type: string + - name: schematisation_pk + in: path + required: true + type: string + /v3/simulation-templates/: + get: + operationId: simulation-templates_list + description: '' + parameters: + - name: name + in: query + description: '' + required: false + type: string + - name: name__iexact + in: query + description: '' + required: false + type: string + - name: name__contains + in: query + description: '' + required: false + type: string + - name: name__icontains + in: query + description: '' + required: false + type: string + - name: name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: name__startswith + in: query + description: '' + required: false + type: string + - name: name__istartswith + in: query + description: '' + required: false + type: string + - name: name__endswith + in: query + description: '' + required: false + type: string + - name: name__regex + in: query + description: '' + required: false + type: string + - name: uuid + in: query + description: '' + required: false + type: string + - name: uuid__iexact + in: query + description: '' + required: false + type: string + - name: uuid__contains + in: query + description: '' + required: false + type: string + - name: uuid__icontains + in: query + description: '' + required: false + type: string + - name: uuid__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: uuid__startswith + in: query + description: '' + required: false + type: string + - name: uuid__istartswith + in: query + description: '' + required: false + type: string + - name: uuid__endswith + in: query + description: '' + required: false + type: string + - name: uuid__regex + in: query + description: '' + required: false + type: string + - name: created__date + in: query + description: '' + required: false + type: string + - name: created__date__gt + in: query + description: '' + required: false + type: string + - name: created__date__gte + in: query + description: '' + required: false + type: string + - name: created__date__lt + in: query + description: '' + required: false + type: string + - name: created__date__lte + in: query + description: '' + required: false + type: string + - name: created__year + in: query + description: '' + required: false + type: number + - name: created__year__gt + in: query + description: '' + required: false + type: number + - name: created__year__gte + in: query + description: '' + required: false + type: number + - name: created__year__lt + in: query + description: '' + required: false + type: number + - name: created__year__lte + in: query + description: '' + required: false + type: number + - name: created__month + in: query + description: '' + required: false + type: number + - name: created__month__lte + in: query + description: '' + required: false + type: number + - name: created__day + in: query + description: '' + required: false + type: number + - name: created__day__lt + in: query + description: '' + required: false + type: number + - name: simulation__threedimodel__id + in: query + description: '' + required: false + type: number + - name: simulation__threedimodel__id__range + in: query + description: Multiple values may be separated by commas. + required: false + type: number + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/Template' + tags: + - v3 + post: + operationId: simulation-templates_create + summary: Create a (optionally cloned) simulation template from the given simulation. + description: |- + A simulation template is actually nothing more than a simulation with a special status. + It's immutable after creation and only can be used to create new simulations. + + Simulations 'upgraded' to simulations templates can't be directly run. The 'from_template' endpoint + allows to create a new simulation from a template in a runnable state. + + A simulation template can be changed by first creating a simulation from it with 'from_template'. + Changing that simulation and use this endpoint to 'upgrade' it to a simulation template. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/CreateTemplate' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Template' + '400': + description: validation errors + tags: + - v3 + parameters: [] + /v3/simulation-templates/{id}/: + get: + operationId: simulation-templates_read + description: '' + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Template' + tags: + - v3 + patch: + operationId: simulation-templates_partial_update + description: '' + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/UpdateTemplate' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/UpdateTemplate' + tags: + - v3 + delete: + operationId: simulation-templates_delete + description: '' + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this template. + required: true + type: integer + /v3/simulations/: + get: + operationId: simulations_list + summary: |- + List all simulations resources. + By default the results are sorted from newest to oldest. + description: |- + The reverse this order + + ``` + ?created + ``` + In general it is possible to specify reverse orderings by prefixing + the field name with '-', like so: + + ``` + ?-id + ``` + Other fields that can be used to order the results are `name` and `id`. + + Several filter are available, for instance the creation date of + the resource. Some usage examples: + + To get all simulation resources that have been created on + Guido van Rossum's birthday + + ``` + ?created__date=1956-01-31 + ``` + + To get all simulation resources that have been created during the + 1988 UEFA European Football Championship + ``` + ?created__date__gte=1988-06-10&created__date__lte=1988-06-25 + ``` + + To get all simulation resources that have been created in the month of + the Carnation Revolution + ``` + ?created__year=1974&created__month=04 + ``` + parameters: + - name: id__contains + in: query + description: '' + required: false + type: number + - name: name + in: query + description: '' + required: false + type: string + - name: name__iexact + in: query + description: '' + required: false + type: string + - name: name__contains + in: query + description: '' + required: false + type: string + - name: name__icontains + in: query + description: '' + required: false + type: string + - name: name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: name__startswith + in: query + description: '' + required: false + type: string + - name: name__istartswith + in: query + description: '' + required: false + type: string + - name: name__endswith + in: query + description: '' + required: false + type: string + - name: name__regex + in: query + description: '' + required: false + type: string + - name: uuid + in: query + description: '' + required: false + type: string + - name: uuid__iexact + in: query + description: '' + required: false + type: string + - name: uuid__contains + in: query + description: '' + required: false + type: string + - name: uuid__icontains + in: query + description: '' + required: false + type: string + - name: uuid__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: uuid__startswith + in: query + description: '' + required: false + type: string + - name: uuid__istartswith + in: query + description: '' + required: false + type: string + - name: uuid__endswith + in: query + description: '' + required: false + type: string + - name: uuid__regex + in: query + description: '' + required: false + type: string + - name: created__date + in: query + description: '' + required: false + type: string + - name: created__date__gt + in: query + description: '' + required: false + type: string + - name: created__date__gte + in: query + description: '' + required: false + type: string + - name: created__date__lt + in: query + description: '' + required: false + type: string + - name: created__date__lte + in: query + description: '' + required: false + type: string + - name: created__year + in: query + description: '' + required: false + type: number + - name: created__year__gt + in: query + description: '' + required: false + type: number + - name: created__year__gte + in: query + description: '' + required: false + type: number + - name: created__year__lt + in: query + description: '' + required: false + type: number + - name: created__year__lte + in: query + description: '' + required: false + type: number + - name: created__month + in: query + description: '' + required: false + type: number + - name: created__month__lte + in: query + description: '' + required: false + type: number + - name: created__day + in: query + description: '' + required: false + type: number + - name: created__day__lt + in: query + description: '' + required: false + type: number + - name: user__username + in: query + description: '' + required: false + type: string + - name: user__username__istartswith + in: query + description: '' + required: false + type: string + - name: threedimodel__id + in: query + description: '' + required: false + type: number + - name: threedimodel__revision__id + in: query + description: '' + required: false + type: number + - name: organisation__unique_id + in: query + description: '' + required: false + type: string + - name: tags__in + in: query + description: '' + required: false + type: string + - name: is_template + in: query + description: '' + required: false + type: string + - name: ordering + in: query + description: Which field to use when ordering the results. + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/Simulation' + tags: + - v3 + post: + operationId: simulations_create + summary: Create a simulation resource + description: |- + There are two options to specify the desired duration for the + simulation, either by using the ``end_datetime`` **or** the + ``duration`` parameter. + + ``` + { + "name": # give the simulation a name + "tags": # add as many tags as you like: handy to find your simulation back later! + "threedimodel": # The model schema to use for the simulation by + referring to the id of the threedimodel resource + "organisation": # uuid of the organisation for which the + simulation is run + "start_datetime": # datetime (in ISO 8601 (UTC) format) for the + simulation start, e.g. "YYYY-MM-DDThh:mm:ss" + "end_datetime": # datetime (in ISO 8601 (UTC) format) for the + simulation end, e.g. "YYYY-MM-DDThh:mm:ss" + "duration": # in seconds, can be used instead of end_datetime + } + ``` + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Simulation' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Simulation' + tags: + - v3 + parameters: [] + /v3/simulations/from-template/: + post: + operationId: simulations_from_template + summary: Create a (new/cloned) simulation from a simulation template. + description: |- + There are two options to specify the desired duration for the + new simulation, either by using the ``end_datetime`` **or** the + ``duration`` parameter. + + { + "template": # source simulation template resource id + "name": # name for the new simulation. + "tags": # extra tags, added to existing simulation template tags. + "organisation": # uuid of the organisation for which the + simulation is run + "start_datetime": # datetime (in ISO 8601 (UTC) format) for the + simulation start, e.g. "YYYY-MM-DDThh:mm:ss" + "end_datetime": # datetime (in ISO 8601 (UTC) format) for the + simulation end, e.g. "YYYY-MM-DDThh:mm:ss" + "duration": # in seconds, can be used instead of end_datetime + "clone_events": # if true, clone events like rain/sources & sinks etc. + "clone_initials": # if true, clone initial waterlevels + "clone_settings": # if true, clone simulation settings, like physical settings etc. + "threedimodel_id": # copy simulation template to threedimodel + } + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/FromTemplate' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Simulation' + '400': + description: validation errors + tags: + - v3 + parameters: [] + /v3/simulations/post_processing/lizard/queue/: + get: + operationId: simulations_post_processing_lizard_queue_list + description: |- + Read-only API endpoint for viewing simulations that need to be + post-processed by Lizard (post-processing status is 'requested'). + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/PostProcessingQueue' + tags: + - v3 + parameters: [] + /v3/simulations/{id}/: + get: + operationId: simulations_read + description: '' + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Simulation' + tags: + - v3 + put: + operationId: simulations_update + description: '' + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/SimulationUpdate' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/SimulationUpdate' + tags: + - v3 + patch: + operationId: simulations_partial_update + description: '' + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/SimulationUpdate' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/SimulationUpdate' + tags: + - v3 + delete: + operationId: simulations_delete + description: '' + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this simulation. + required: true + type: integer + /v3/simulations/{id}/clone/: + post: + operationId: simulations_clone + summary: Clone the simulation. + description: Clones the simulation in a runnable state, only events & initials. + parameters: [] + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Simulation' + '400': + description: validation errors + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this simulation. + required: true + type: integer + /v3/simulations/{id}/events/: + get: + operationId: simulations_events + description: '' + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Event' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this simulation. + required: true + type: integer + /v3/simulations/{simulation_pk}/actions/: + post: + operationId: simulations_actions_create + summary: Post an action to the simulation to start, pause or end it. + description: |- + Example usage: + + To initialize a simulation (and pause) + ``` + {"name": "initialize"} + ``` + + To initialize and directly run a simulation + ``` + {"name": "start"} + ``` + Also use "start" to resume a paused simulation. + + If you want to pause the simulation automatically after a given + duration use the duration parameter + ``` + { + "name": "start", + "duration": 2500 + } + ``` + + To pause a simulation + ``` + {"name": "pause"} + ``` + Please note: The simulation will automatically be shut down after the + default timeout of 300 seconds has been reached. You can customize + this value by specifying the timeout parameter + ``` + { + "name": "pause", + "timeout": 999 + } + ``` + + To end a simulation + ``` + {"name": "shutdown"} + ``` + + To queue a simulation + ``` + {"name": "queue"} + ``` + Queued simulations will be started as soon as a session spot becomes + available. If a session spot is directly is available the simulation + will also be started immediately. The response body will then contain + `{"name": "start"}` + ``` + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Action' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Action' + '202': + description: '' + schema: + $ref: '#/definitions/Action' + '400': + description: Bad request + '429': + description: No available/free sessions + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/actions/reset_pause_timeout/: + post: + operationId: simulations_actions_reset_pause_timeout + summary: Reset the pause timeout with the new specified timeout value + description: |- + You can only reset the pause timeout when the SimulationStatus.name is + 'initialized' and SimulationStatus.paused is True. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Timeout' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Action' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/create-saved-states/stable-threshold/: + get: + operationId: simulations_create-saved-states_stable-threshold_list + description: Stable threshold SavedState + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/StableThresholdSavedState' + tags: + - v3 + post: + operationId: simulations_create-saved-states_stable-threshold_create + summary: |- + Save the state of the simulation to file when a given (set of) + variable(s) becomes stable + description: |- + Example + ``` + { + "expiry": "2020-08-15T13:02:30.317Z", + "thresholds": [ + { + "variable": "s1", + "value": 0.005 + } + ] + } + ``` + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/StableThresholdSavedState' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/StableThresholdSavedState' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/create-saved-states/stable-threshold/{id}/: + get: + operationId: simulations_create-saved-states_stable-threshold_read + description: Stable threshold SavedState + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/StableThresholdSavedState' + tags: + - v3 + put: + operationId: simulations_create-saved-states_stable-threshold_update + description: Stable threshold SavedState + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/StableThresholdSavedState' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/StableThresholdSavedState' + tags: + - v3 + patch: + operationId: simulations_create-saved-states_stable-threshold_partial_update + description: When the simulation has started this resource can not be patched. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/StableThresholdSavedState' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_create-saved-states_stable-threshold_delete + description: Stable threshold SavedState + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this saved state. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/create-saved-states/stable-threshold/{id}/upload/: + post: + operationId: simulations_create-saved-states_stable-threshold_upload + description: Stable threshold SavedState + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + '404': + description: Simulation not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this saved state. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/create-saved-states/timed/: + get: + operationId: simulations_create-saved-states_timed_list + description: Timed SavedState + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/TimedSavedStateUpdate' + tags: + - v3 + post: + operationId: simulations_create-saved-states_timed_create + summary: Save the state at a given time of the simulation to file + description: |- + ``` + { + "name": # custom name for the saved state (optional) + "tags": # add tags to the resource. Either space or comma + separated (optional) + "expiry": # datetime (in ISO 8601 (UTC) format) until the saved + state file will be kept + "time": # the state at this given time of the simulation will + be saved to file + } + ``` + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimedSavedStateUpdate' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/TimedSavedStateUpdate' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/create-saved-states/timed/{id}/: + get: + operationId: simulations_create-saved-states_timed_read + description: Timed SavedState + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TimedSavedStateUpdate' + tags: + - v3 + put: + operationId: simulations_create-saved-states_timed_update + description: Timed SavedState + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimedSavedStateUpdate' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TimedSavedStateUpdate' + tags: + - v3 + patch: + operationId: simulations_create-saved-states_timed_partial_update + description: Timed SavedState + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimedSavedStateUpdate' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_create-saved-states_timed_delete + description: Timed SavedState + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this saved state. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/create-saved-states/timed/{id}/upload/: + post: + operationId: simulations_create-saved-states_timed_upload + description: Timed SavedState + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + '404': + description: Simulation not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this saved state. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/boundaryconditions/file/: + get: + operationId: simulations_events_boundaryconditions_file_list + description: '' + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/FileBoundaryCondition' + tags: + - v3 + post: + operationId: simulations_events_boundaryconditions_file_create + summary: Endpoint for uploading a boundary-conditions file. + description: |- + The format of the filename should be ., e.g. + + `boundary_conditions_bergermeer.json` + + Every leading and trailing spaces will be removed. Other spaces are + converted to underscores and anything that is not an alphanumeric, dash, + underscore, or dot will be removed as well. + + The response provides a put_url which allows you to upload a file containing one + or more boundary-conditions. + + The uploaded file should be a JSON-file containing an array of + boundary-conditions timeseries. + + The file must contain a timeseries for each boundary condition in the + threedimodel. This is validated after upload. + + Boundary-conditions need to be added before initializing/starting + the simulation and cannot be changed once the simulation is + initialized. + + Example + ------- + + **Notes** + The ordering of the boundaries does not matter. + + ``` + [ + { + "id": 1, # sqlite boundary_1d table id + "type": "1D", # "1D" for 1d boundaries + "interpolate": false, + "values": [ + [0, 0.5], + [500, 0,8], + [1000, 0] + ] + }, + { + "id": 2, # sqlite boundary_2d table id + "type": "2D", # "2D" for 2d boundaries + "interpolate": false, + "values": [ + [0, 0,3], + [400, 0.1] + ] + }, + { + "id": 3, + "type": "2D", + "interpolate": false, + "values": [ + [0, -2.4], + [1300, 0,3], + [3000, 1.2], + [3600, 0] + ] + } + ] + ``` + + Example with (water quality) substances. **Note**, the substance concentrations + timesteps need to exactly match the boundary values timesteps + (0, 500, 1000 in example below). + ``` + [ + { + "id": 1, # sqlite boundary_1d table id + "type": "1D", # "1D" for 1d boundaries + "interpolate": false, + "values": [ + [0, 0.5], + [500, 0,8], + [1000, 0] + ] + "substances": [ + { + "substance": 1, + "concentrations": [ + [0, 0.1], + [500, 0.2], + [1000, 0] + ] + } + ] + } + ] + ``` + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/boundaryconditions/file/{id}/: + get: + operationId: simulations_events_boundaryconditions_file_read + description: '' + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/FileBoundaryCondition' + tags: + - v3 + put: + operationId: simulations_events_boundaryconditions_file_update + description: '' + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/FileBoundaryCondition' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/FileBoundaryCondition' + tags: + - v3 + patch: + operationId: simulations_events_boundaryconditions_file_partial_update + description: '' + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/FileBoundaryCondition' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/FileBoundaryCondition' + tags: + - v3 + delete: + operationId: simulations_events_boundaryconditions_file_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this bulk boundary condition. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/boundaryconditions/file/{id}/download/: + get: + operationId: simulations_events_boundaryconditions_file_download + description: Endpoint for downloading files. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this bulk boundary condition. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/boundaryconditions/file/{id}/processed/: + put: + operationId: simulations_events_boundaryconditions_file_processed + description: '' + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/BaseEventState' + responses: + '200': + description: OK + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this bulk boundary condition. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/breaches/: + get: + operationId: simulations_events_breaches_list + description: A simple ViewSet for viewing Breaches + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/Breach' + tags: + - v3 + post: + operationId: simulations_events_breaches_create + description: |- + Create a breach during a given simulation. The `potential_breach` + parameter refers to the id of a potential location associated with the + threedimodel. A list of these locations can be retrieved at the uri + `/threedimodels/{id}/potentialbreaches/` + + The `duration_till_max_depth` parameter describes the time it takes until + the deepest point of the breach is reached. [seconds] + + `maximum_breach_depth` specifies the maximum depth of the breach + relative to the top of the levee [meters] + + `initial_width` of the breach [meters] + + `discharge_coefficient_positive` and `discharge_coefficient_negative` + are dimensionless parameters to deal with behaviour of energy loss + around a breach. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Breach' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Breach' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/breaches/{id}/: + get: + operationId: simulations_events_breaches_read + description: A simple ViewSet for viewing Breaches + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Breach' + tags: + - v3 + put: + operationId: simulations_events_breaches_update + description: A simple ViewSet for viewing Breaches + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Breach' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Breach' + tags: + - v3 + patch: + operationId: simulations_events_breaches_partial_update + description: |- + Please note: **Breach resources are not allowed to be patched after the + simulation has started** + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Breach' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_breaches_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this breach. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/lateral/constant/: + get: + operationId: simulations_events_lateral_constant_list + description: A simple ViewSet for viewing ConstantLateral + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/ConstantLateral' + tags: + - v3 + post: + operationId: simulations_events_lateral_constant_create + description: A simple ViewSet for viewing ConstantLateral + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantLateral' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/ConstantLateral' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/lateral/constant/{id}/: + get: + operationId: simulations_events_lateral_constant_read + description: A simple ViewSet for viewing ConstantLateral + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ConstantLateral' + tags: + - v3 + put: + operationId: simulations_events_lateral_constant_update + description: A simple ViewSet for viewing ConstantLateral + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantLateral' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ConstantLateral' + tags: + - v3 + patch: + operationId: simulations_events_lateral_constant_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantLateral' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_lateral_constant_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this lateral. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/lateral/constant/{id}/processed/: + put: + operationId: simulations_events_lateral_constant_processed + description: A simple ViewSet for viewing ConstantLateral + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/GridEventState' + responses: + '200': + description: OK + '400': + description: Event is already processed + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this lateral. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/lateral/file/: + get: + operationId: simulations_events_lateral_file_list + description: '' + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/FileLateral' + tags: + - v3 + post: + operationId: simulations_events_lateral_file_create + summary: Endpoint for uploading a file with one or more laterals. + description: |- + The format of the filename should be ., e.g. + + `laterals_bergermeer.json` + + Every leading and trailing spaces will be removed. Other spaces are + converted to underscores and anything that is not an alphanumeric, dash, + underscore, or dot will be removed as well. + + The response provides a put_url which allows you to upload a file containing one + or more laterals. These laterals should either be a constant- or a + timeseries-lateral, or a combination of both. See their respective endpoint for + the required fields of these laterals. + + The uploaded file should be a JSON-file containing an array of laterals. Example + of the content of such a file: + ``` + [ + { + "offset": 100, + "value": 0.05, + "duration": 300, + "units": "m3/s", + "connection_node": 5 + }, + { + "offset": 180, + "interpolate": false, + "values": [ + [0.0, 0.0002], + [900.0, 0.0], + [1200.0, 0.0001], + [1620.0, 0.0] + ], + "units": "m3/s", + "connection_node": 4 + }, + { + "offset": 0, + "value": 0.03, + "duration": 500, + "units": "m3/s", + "point": { + "type": "Point", + "coordinates": [4.70184629, 52.62586862] # longitude, latitude + } + } + ] + ``` + + The `offset` of this file-lateral-event will be applied to each individual + lateral offset in the uploaded file + + If the `periodic` field is set to `daily` the values given are used for every hour of + every day in the simulation. Exactly 25 (0-24) timeseries per entry are required like such: + "values": [ + [0.0, 0.0002], + [3600, 0.01], + ..... + + ..... + [82800, 0.15] # 3600.0 * 23 + [86400, 0.0] # 3600.0 * 24 + ] + + Only laterals with 'values' are allowed in this case. + + The **hour** (not minutes or seconds) of the simulation `start_datetime` (UTC) is taken into consideration for the first timeseries value to use. + Periodic laterals are intended for dry weather flow. + + Example with (water quality) substances. **Note**: the substance concentrations + timesteps need to exactly match the lateral values timesteps + (0, 300 in example below). + ``` + [ + { + "offset": 100, + "values": [[0, 0.05], [300, 0]], + "units": "m3/s", + "connection_node": 5, + "substances": [ + {"substance": 1, "concentrations": [[0, 0.1], [300, 0]]} + ] + } + ] + ``` + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/UploadEventFile' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/UploadEventFile' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/lateral/file/{id}/: + get: + operationId: simulations_events_lateral_file_read + description: '' + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/FileLateral' + tags: + - v3 + put: + operationId: simulations_events_lateral_file_update + description: '' + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/FileLateral' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/FileLateral' + tags: + - v3 + patch: + operationId: simulations_events_lateral_file_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/FileLateral' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_lateral_file_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this bulk lateral. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/lateral/file/{id}/download/: + get: + operationId: simulations_events_lateral_file_download + description: Endpoint for downloading files. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this bulk lateral. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/lateral/file/{id}/processed/: + put: + operationId: simulations_events_lateral_file_processed + description: '' + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/BaseEventState' + responses: + '200': + description: OK + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this bulk lateral. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/lateral/timeseries/: + get: + operationId: simulations_events_lateral_timeseries_list + description: A simple ViewSet for viewing TimeseriesLateral + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/TimeseriesLateral' + tags: + - v3 + post: + operationId: simulations_events_lateral_timeseries_create + description: A simple ViewSet for viewing TimeseriesLateral + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesLateral' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/TimeseriesLateral' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/lateral/timeseries/{id}/: + get: + operationId: simulations_events_lateral_timeseries_read + description: A simple ViewSet for viewing TimeseriesLateral + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TimeseriesLateral' + tags: + - v3 + put: + operationId: simulations_events_lateral_timeseries_update + description: A simple ViewSet for viewing TimeseriesLateral + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesLateral' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TimeseriesLateral' + tags: + - v3 + patch: + operationId: simulations_events_lateral_timeseries_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesLateral' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_lateral_timeseries_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this lateral. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/lateral/timeseries/{id}/processed/: + put: + operationId: simulations_events_lateral_timeseries_processed + description: A simple ViewSet for viewing TimeseriesLateral + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/GridEventState' + responses: + '200': + description: OK + '400': + description: Event is already processed + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this lateral. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/leakage/constant/: + get: + operationId: simulations_events_leakage_constant_list + description: A simple ViewSet for viewing ConstantLeakage + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/ConstantLeakage' + tags: + - v3 + post: + operationId: simulations_events_leakage_constant_create + description: A simple ViewSet for viewing ConstantLeakage + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantLeakage' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/ConstantLeakage' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/leakage/constant/{id}/: + get: + operationId: simulations_events_leakage_constant_read + description: A simple ViewSet for viewing ConstantLeakage + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ConstantLeakage' + tags: + - v3 + put: + operationId: simulations_events_leakage_constant_update + description: A simple ViewSet for viewing ConstantLeakage + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantLeakage' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ConstantLeakage' + tags: + - v3 + patch: + operationId: simulations_events_leakage_constant_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantLeakage' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_leakage_constant_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this timeseries leakage. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/leakage/rasters/netcdf/: + get: + operationId: simulations_events_leakage_rasters_netcdf_list + description: NetCDF 4 raster leakage + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/NetCDFRasterLeakage' + tags: + - v3 + post: + operationId: simulations_events_leakage_rasters_netcdf_create + description: NetCDF 4 raster leakage + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/leakage/rasters/netcdf/{id}/: + get: + operationId: simulations_events_leakage_rasters_netcdf_read + description: NetCDF 4 raster leakage + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/NetCDFRasterLeakage' + tags: + - v3 + delete: + operationId: simulations_events_leakage_rasters_netcdf_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this file raster leakage. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/leakage/timeseries/: + get: + operationId: simulations_events_leakage_timeseries_list + description: A simple ViewSet for viewing TimeseriesLeakage + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/TimeseriesLeakage' + tags: + - v3 + post: + operationId: simulations_events_leakage_timeseries_create + description: '' + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesLeakage' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/TimeseriesLeakage' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/leakage/timeseries/netcdf/: + get: + operationId: simulations_events_leakage_timeseries_netcdf_list + description: NetCDF 4 timeseries leakage + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/NetCDFTimeseriesLeakage' + tags: + - v3 + post: + operationId: simulations_events_leakage_timeseries_netcdf_create + description: NetCDF 4 timeseries leakage + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/leakage/timeseries/netcdf/{id}/: + get: + operationId: simulations_events_leakage_timeseries_netcdf_read + description: NetCDF 4 timeseries leakage + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/NetCDFTimeseriesLeakage' + tags: + - v3 + delete: + operationId: simulations_events_leakage_timeseries_netcdf_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this file timeseries leakage. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/leakage/timeseries/{id}/: + get: + operationId: simulations_events_leakage_timeseries_read + description: A simple ViewSet for viewing TimeseriesLeakage + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TimeseriesLeakage' + tags: + - v3 + put: + operationId: simulations_events_leakage_timeseries_update + description: A simple ViewSet for viewing TimeseriesLeakage + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesLeakage' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TimeseriesLeakage' + tags: + - v3 + patch: + operationId: simulations_events_leakage_timeseries_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesLeakage' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_leakage_timeseries_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this timeseries leakage. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/rain/constant/: + get: + operationId: simulations_events_rain_constant_list + description: A simple ViewSet for viewing TimeseriesRain + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/ConstantRain' + tags: + - v3 + post: + operationId: simulations_events_rain_constant_create + description: A simple ViewSet for viewing TimeseriesRain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantRain' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/ConstantRain' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/rain/constant/{id}/: + get: + operationId: simulations_events_rain_constant_read + description: A simple ViewSet for viewing TimeseriesRain + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ConstantRain' + tags: + - v3 + put: + operationId: simulations_events_rain_constant_update + description: A simple ViewSet for viewing TimeseriesRain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantRain' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ConstantRain' + tags: + - v3 + patch: + operationId: simulations_events_rain_constant_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantRain' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_rain_constant_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this timeseries rain. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/rain/local/constant/: + get: + operationId: simulations_events_rain_local_constant_list + description: A simple ViewSet for viewing TimeseriesRain + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/ConstantLocalRain' + tags: + - v3 + post: + operationId: simulations_events_rain_local_constant_create + description: A simple ViewSet for viewing TimeseriesRain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantLocalRain' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/ConstantLocalRain' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/rain/local/constant/{id}/: + get: + operationId: simulations_events_rain_local_constant_read + description: A simple ViewSet for viewing TimeseriesRain + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ConstantLocalRain' + tags: + - v3 + put: + operationId: simulations_events_rain_local_constant_update + description: A simple ViewSet for viewing TimeseriesRain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantLocalRain' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ConstantLocalRain' + tags: + - v3 + patch: + operationId: simulations_events_rain_local_constant_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantLocalRain' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_rain_local_constant_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this local rain. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/rain/local/timeseries/: + get: + operationId: simulations_events_rain_local_timeseries_list + description: A simple ViewSet for viewing TimeseriesLateral + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/TimeseriesLocalRain' + tags: + - v3 + post: + operationId: simulations_events_rain_local_timeseries_create + description: A simple ViewSet for viewing TimeseriesLateral + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesLocalRain' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/TimeseriesLocalRain' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/rain/local/timeseries/{id}/: + get: + operationId: simulations_events_rain_local_timeseries_read + description: A simple ViewSet for viewing TimeseriesLateral + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TimeseriesLocalRain' + tags: + - v3 + put: + operationId: simulations_events_rain_local_timeseries_update + description: A simple ViewSet for viewing TimeseriesLateral + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesLocalRain' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TimeseriesLocalRain' + tags: + - v3 + patch: + operationId: simulations_events_rain_local_timeseries_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesLocalRain' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_rain_local_timeseries_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this local rain. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/rain/rasters/lizard/: + get: + operationId: simulations_events_rain_rasters_lizard_list + description: A simple ViewSet for viewing lizardRasterRain + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/LizardRasterRain' + tags: + - v3 + post: + operationId: simulations_events_rain_rasters_lizard_create + description: A simple ViewSet for viewing lizardRasterRain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/LizardRasterRain' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/LizardRasterRain' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/rain/rasters/lizard/{id}/: + get: + operationId: simulations_events_rain_rasters_lizard_read + description: A simple ViewSet for viewing lizardRasterRain + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/LizardRasterRain' + tags: + - v3 + put: + operationId: simulations_events_rain_rasters_lizard_update + description: A simple ViewSet for viewing lizardRasterRain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/LizardRasterRain' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/LizardRasterRain' + tags: + - v3 + patch: + operationId: simulations_events_rain_rasters_lizard_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/LizardRasterRain' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_rain_rasters_lizard_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this lizard raster rain. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/rain/rasters/netcdf/: + get: + operationId: simulations_events_rain_rasters_netcdf_list + description: NetCDF 4 raster rain + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/NetCDFRasterRain' + tags: + - v3 + post: + operationId: simulations_events_rain_rasters_netcdf_create + description: NetCDF 4 raster rain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/UploadWithSubstances' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/UploadWithSubstances' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/rain/rasters/netcdf/{id}/: + get: + operationId: simulations_events_rain_rasters_netcdf_read + description: NetCDF 4 raster rain + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/NetCDFRasterRain' + tags: + - v3 + put: + operationId: simulations_events_rain_rasters_netcdf_update + description: NetCDF 4 raster rain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/NetCDFRasterRain' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/NetCDFRasterRain' + tags: + - v3 + patch: + operationId: simulations_events_rain_rasters_netcdf_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/NetCDFRasterRain' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_rain_rasters_netcdf_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this file raster rain. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/rain/timeseries/: + get: + operationId: simulations_events_rain_timeseries_list + description: A simple ViewSet for viewing TimeseriesRain + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/TimeseriesRain' + tags: + - v3 + post: + operationId: simulations_events_rain_timeseries_create + description: A simple ViewSet for viewing TimeseriesRain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesRain' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/TimeseriesRain' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/rain/timeseries/lizard/: + get: + operationId: simulations_events_rain_timeseries_lizard_list + description: A simple ViewSet for viewing LizardTimeseriesRain + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/LizardTimeseriesRain' + tags: + - v3 + post: + operationId: simulations_events_rain_timeseries_lizard_create + description: A simple ViewSet for viewing LizardTimeseriesRain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/LizardTimeseriesRain' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/LizardTimeseriesRain' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/rain/timeseries/lizard/{id}/: + get: + operationId: simulations_events_rain_timeseries_lizard_read + description: A simple ViewSet for viewing LizardTimeseriesRain + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/LizardTimeseriesRain' + tags: + - v3 + put: + operationId: simulations_events_rain_timeseries_lizard_update + description: A simple ViewSet for viewing LizardTimeseriesRain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/LizardTimeseriesRain' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/LizardTimeseriesRain' + tags: + - v3 + patch: + operationId: simulations_events_rain_timeseries_lizard_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/LizardTimeseriesRain' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_rain_timeseries_lizard_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this lizard timeseries rain. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/rain/timeseries/netcdf/: + get: + operationId: simulations_events_rain_timeseries_netcdf_list + description: NetCDF 4 timeseries rain + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/NetCDFTimeseriesRain' + tags: + - v3 + post: + operationId: simulations_events_rain_timeseries_netcdf_create + description: NetCDF 4 timeseries rain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/UploadWithSubstances' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/UploadWithSubstances' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/rain/timeseries/netcdf/{id}/: + get: + operationId: simulations_events_rain_timeseries_netcdf_read + description: NetCDF 4 timeseries rain + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/NetCDFTimeseriesRain' + tags: + - v3 + put: + operationId: simulations_events_rain_timeseries_netcdf_update + description: NetCDF 4 timeseries rain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/NetCDFTimeseriesRain' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/NetCDFTimeseriesRain' + tags: + - v3 + patch: + operationId: simulations_events_rain_timeseries_netcdf_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/NetCDFTimeseriesRain' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_rain_timeseries_netcdf_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this file timeseries rain. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/rain/timeseries/{id}/: + get: + operationId: simulations_events_rain_timeseries_read + description: A simple ViewSet for viewing TimeseriesRain + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TimeseriesRain' + tags: + - v3 + put: + operationId: simulations_events_rain_timeseries_update + description: A simple ViewSet for viewing TimeseriesRain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesRain' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TimeseriesRain' + tags: + - v3 + patch: + operationId: simulations_events_rain_timeseries_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesRain' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_rain_timeseries_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this timeseries rain. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/raster-edits/: + get: + operationId: simulations_events_raster-edits_list + description: A simple ViewSet for viewing raster edits + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/RasterEdit' + tags: + - v3 + post: + operationId: simulations_events_raster-edits_create + description: A simple ViewSet for viewing raster edits + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/RasterEdit' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/RasterEdit' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/raster-edits/{id}/: + get: + operationId: simulations_events_raster-edits_read + description: A simple ViewSet for viewing raster edits + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/RasterEdit' + tags: + - v3 + put: + operationId: simulations_events_raster-edits_update + description: A simple ViewSet for viewing raster edits + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/RasterEdit' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/RasterEdit' + tags: + - v3 + patch: + operationId: simulations_events_raster-edits_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/RasterEdit' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_raster-edits_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this raster edit. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/raster-edits/{id}/register_related_rasters/: + get: + operationId: simulations_events_raster-edits_register_related_rasters + summary: |- + Register all related rasters in the results-api and return + read_bbox urls of the registered rasters + description: |- + Skips registering of related rasters when the simulation is not in the + state 'starting' or 'initialized'. In this case the urls will be empty + parameters: [] + responses: + '200': + description: '' + schema: + type: array + items: + $ref: '#/definitions/RasterEditUrls' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this raster edit. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/sources-sinks/constant/: + get: + operationId: simulations_events_sources-sinks_constant_list + description: A simple ViewSet for viewing ConstantSourcesSinks + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/ConstantSourcesSinks' + tags: + - v3 + post: + operationId: simulations_events_sources-sinks_constant_create + description: A simple ViewSet for viewing ConstantSourcesSinks + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantSourcesSinks' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/ConstantSourcesSinks' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/sources-sinks/constant/{id}/: + get: + operationId: simulations_events_sources-sinks_constant_read + description: A simple ViewSet for viewing ConstantSourcesSinks + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ConstantSourcesSinks' + tags: + - v3 + put: + operationId: simulations_events_sources-sinks_constant_update + description: A simple ViewSet for viewing ConstantSourcesSinks + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantSourcesSinks' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ConstantSourcesSinks' + tags: + - v3 + patch: + operationId: simulations_events_sources-sinks_constant_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantSourcesSinks' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_sources-sinks_constant_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this timeseries sources sinks. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/sources-sinks/rasters/lizard/: + get: + operationId: simulations_events_sources-sinks_rasters_lizard_list + description: A simple ViewSet for viewing lizardRasterRain + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/LizardRasterSourcesSinks' + tags: + - v3 + post: + operationId: simulations_events_sources-sinks_rasters_lizard_create + description: A simple ViewSet for viewing lizardRasterRain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/LizardRasterSourcesSinks' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/LizardRasterSourcesSinks' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/sources-sinks/rasters/lizard/{id}/: + get: + operationId: simulations_events_sources-sinks_rasters_lizard_read + description: A simple ViewSet for viewing lizardRasterRain + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/LizardRasterSourcesSinks' + tags: + - v3 + put: + operationId: simulations_events_sources-sinks_rasters_lizard_update + description: A simple ViewSet for viewing lizardRasterRain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/LizardRasterSourcesSinks' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/LizardRasterSourcesSinks' + tags: + - v3 + patch: + operationId: simulations_events_sources-sinks_rasters_lizard_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/LizardRasterSourcesSinks' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_sources-sinks_rasters_lizard_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this lizard raster sources + sinks. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/sources-sinks/rasters/netcdf/: + get: + operationId: simulations_events_sources-sinks_rasters_netcdf_list + description: NetCDF 4 raster sources & sinks + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/NetCDFRasterSourcesSinks' + tags: + - v3 + post: + operationId: simulations_events_sources-sinks_rasters_netcdf_create + description: NetCDF 4 raster sources & sinks + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/sources-sinks/rasters/netcdf/{id}/: + get: + operationId: simulations_events_sources-sinks_rasters_netcdf_read + description: NetCDF 4 raster sources & sinks + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/NetCDFRasterSourcesSinks' + tags: + - v3 + put: + operationId: simulations_events_sources-sinks_rasters_netcdf_update + description: NetCDF 4 raster sources & sinks + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/NetCDFRasterSourcesSinks' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/NetCDFRasterSourcesSinks' + tags: + - v3 + patch: + operationId: simulations_events_sources-sinks_rasters_netcdf_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/NetCDFRasterSourcesSinks' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_sources-sinks_rasters_netcdf_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this file raster sources sinks. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/sources-sinks/timeseries/: + get: + operationId: simulations_events_sources-sinks_timeseries_list + description: A simple ViewSet for viewing TimeseriesSourcesSinks + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/TimeseriesSourcesSinks' + tags: + - v3 + post: + operationId: simulations_events_sources-sinks_timeseries_create + description: |- + Example payload: + ``` + { + "offset": 0, + "values": [ + [ + 0, + 0.0005 + ], + [ + 300, + 0.0002 + ] + ], + "units": "m/s" + } + ``` + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesSourcesSinks' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/TimeseriesSourcesSinks' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/sources-sinks/timeseries/lizard/: + get: + operationId: simulations_events_sources-sinks_timeseries_lizard_list + description: A simple ViewSet for viewing LizardTimeseriesRain + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/LizardTimeseriesSourcesSinks' + tags: + - v3 + post: + operationId: simulations_events_sources-sinks_timeseries_lizard_create + description: A simple ViewSet for viewing LizardTimeseriesRain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/LizardTimeseriesSourcesSinks' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/LizardTimeseriesSourcesSinks' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/sources-sinks/timeseries/lizard/{id}/: + get: + operationId: simulations_events_sources-sinks_timeseries_lizard_read + description: A simple ViewSet for viewing LizardTimeseriesRain + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/LizardTimeseriesSourcesSinks' + tags: + - v3 + put: + operationId: simulations_events_sources-sinks_timeseries_lizard_update + description: A simple ViewSet for viewing LizardTimeseriesRain + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/LizardTimeseriesSourcesSinks' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/LizardTimeseriesSourcesSinks' + tags: + - v3 + patch: + operationId: simulations_events_sources-sinks_timeseries_lizard_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/LizardTimeseriesSourcesSinks' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_sources-sinks_timeseries_lizard_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this lizard timeseries sources + sinks. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/sources-sinks/timeseries/netcdf/: + get: + operationId: simulations_events_sources-sinks_timeseries_netcdf_list + description: NetCDF 4 timeseries sources & sinks + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/NetCDFTimeseriesSourcesSinks' + tags: + - v3 + post: + operationId: simulations_events_sources-sinks_timeseries_netcdf_create + description: NetCDF 4 timeseries sources & sinks + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/sources-sinks/timeseries/netcdf/{id}/: + get: + operationId: simulations_events_sources-sinks_timeseries_netcdf_read + description: NetCDF 4 timeseries sources & sinks + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/NetCDFTimeseriesSourcesSinks' + tags: + - v3 + delete: + operationId: simulations_events_sources-sinks_timeseries_netcdf_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this file timeseries sources + sinks. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/sources-sinks/timeseries/{id}/: + get: + operationId: simulations_events_sources-sinks_timeseries_read + description: A simple ViewSet for viewing TimeseriesSourcesSinks + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TimeseriesSourcesSinks' + tags: + - v3 + put: + operationId: simulations_events_sources-sinks_timeseries_update + description: A simple ViewSet for viewing TimeseriesSourcesSinks + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesSourcesSinks' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TimeseriesSourcesSinks' + tags: + - v3 + patch: + operationId: simulations_events_sources-sinks_timeseries_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesSourcesSinks' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_sources-sinks_timeseries_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this timeseries sources sinks. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/structure-control/file/: + get: + operationId: simulations_events_structure-control_file_list + description: '' + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/FileStructureControl' + tags: + - v3 + post: + operationId: simulations_events_structure-control_file_create + summary: Endpoint for uploading a file with one or more structure controls. + description: |- + The supplied filename should be include the extension, for example "bergermeer_controls.json". + + `bergermeer_controls.json` + + The response provides a put_url which may be used to upload a file containing one + or more controls. These controls are divided in memory, table and timed + structure controls. See the respective endpoints for + the required fields of these controls. + + The uploaded file should be a JSON-file containing an array of controls per control type. Example + of the content of such a file: + ``` + { + "timed": [ + { + "offset": 0, + "duration": 100, + "value": [ + 0.4, 0.8 + ], + "type": "set_discharge_coefficients", + "structure_id": 21, + "structure_type": "v2_weir" + } + ], + "memory": [ + { + "offset": 0, + "duration": 3600, + "measure_specification": { + "name": "Measurement location", + "locations": [ + { + "weight": "1.00", + "content_type": "v2_connection_node", + "content_pk": 356, + } + ], + "variable": "s1", + "operator": "<" + }, + "structure_id": 10250, + "structure_type": "v2_weir", + "type": "set_crest_level", + "value": [ + 9.05 + ], + "upper_threshold": 0.3, + "lower_threshold": 0.1, + "is_active": false, + "is_inverse": false + } + ], + "table": [ + { + "offset": 0, + "duration": 3600, + "measure_specification": { + "name": "Measurement location", + "locations": [ + { + "weight": "1.00", + "content_type": "v2_connection_node", + "content_pk": 356, + } + ], + "variable": "s1", + "operator": "<" + }, + "structure_id": 10249, + "structure_type": "v2_weir", + "type": "set_crest_level", + "values": [ + [ + 9.05, + -1.45 + ], + ] + } + ] + } + ``` + + If there are only controls of one category, the other arrays can be omitted, like for example: + ``` + { + "timed": [ + { + "offset": 0, + "duration": 100, + "value": [ + 0.4, 0.8 + ], + "type": "set_discharge_coefficients", + "structure_id": 21, + "structure_type": "v2_weir" + } + ] + } + ``` + + The `offset` supplied in the request body will be applied on top of each individual + structure control offset in the uploaded file. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/UploadEventFile' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/UploadEventFile' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/structure-control/file/{id}/: + get: + operationId: simulations_events_structure-control_file_read + description: '' + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/FileStructureControl' + tags: + - v3 + put: + operationId: simulations_events_structure-control_file_update + description: '' + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/FileStructureControl' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/FileStructureControl' + tags: + - v3 + patch: + operationId: simulations_events_structure-control_file_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/FileStructureControl' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_structure-control_file_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this bulk control. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/structure-control/file/{id}/download/: + get: + operationId: simulations_events_structure-control_file_download + description: Endpoint for downloading files. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this bulk control. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/structure-control/file/{id}/processed/: + put: + operationId: simulations_events_structure-control_file_processed + description: '' + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/BaseEventState' + responses: + '200': + description: OK + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this bulk control. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/structure-control/memory/: + get: + operationId: simulations_events_structure-control_memory_list + description: ViewSet for viewing MemoryStructureControls + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/MemoryStructureControl' + tags: + - v3 + post: + operationId: simulations_events_structure-control_memory_create + description: See tables structure endpoint for more information. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/MemoryStructureControl' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/MemoryStructureControl' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/structure-control/memory/{id}/: + get: + operationId: simulations_events_structure-control_memory_read + description: ViewSet for viewing MemoryStructureControls + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/MemoryStructureControl' + tags: + - v3 + put: + operationId: simulations_events_structure-control_memory_update + description: ViewSet for viewing MemoryStructureControls + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/MemoryStructureControl' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/MemoryStructureControl' + tags: + - v3 + patch: + operationId: simulations_events_structure-control_memory_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/MemoryStructureControl' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_structure-control_memory_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this memory structure control. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/structure-control/memory/{id}/processed/: + put: + operationId: simulations_events_structure-control_memory_processed + description: ViewSet for viewing MemoryStructureControls + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/MeasureLocationGridEventState' + responses: + '200': + description: OK + '400': + description: Event is already processed + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this memory structure control. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/structure-control/table/: + get: + operationId: simulations_events_structure-control_table_list + description: ViewSet for viewing TableStructureControls + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/TableStructureControl' + tags: + - v3 + post: + operationId: simulations_events_structure-control_table_create + description: |- + A table structure control can used to apply a certain action, e.g + increase the pump capacity of a pump station, based on the measured + values of one or more locations. + + **type** + + *for weirs and orifices* + + - set_crest_level + - set_discharge_coefficients + + *for culverts, channels and pipes* + + - set_discharge_coefficients + + *for pumps* + + - set_pump_capacity (m3/s) + + **values** + + The action table consists of one or more value pairs (threshold, action_value) + + To close/open or partially close/open a structure using the `set_discharge_coefficients` type + the values must contain **three** values. For example `[[1.2, 0.5, 0.7]]`, where + 1.2 is the threshold value + 0.5 the action value for the left flow direction + 0.7 action value for the right flow direction + + Please note: action values for `set_discharge_coefficients` type must be > 0. + + For ALL operators threshold values must be ascending, + + In most cases the measure location will be of type `v2_connection_node`. + For this location type only the variables `s1` and `vol1` apply. If your + measure location, however, is of any other type the variable must either + be `q` or `u1`. + + + For both the target structure as well as for the measure location it is + allowed to use a grid id as input directly. In this case we will check + if the structure type associated with the given id matches with the grid + administration data. + + Nonetheless, we encourage you to use the structure id (that is the id of the + structure in the model sqlite database) as input data. We will look up the + corresponding grid id for you. If the validation holds, the state of the + resource will be updated from `processing` to `valid`. Using the structure id + will enable you to re-use the structure control resource after a model revision + as a grid id will most likely change with every new grid generation. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TableStructureControl' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/TableStructureControl' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/structure-control/table/{id}/: + get: + operationId: simulations_events_structure-control_table_read + description: ViewSet for viewing TableStructureControls + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TableStructureControl' + tags: + - v3 + put: + operationId: simulations_events_structure-control_table_update + description: ViewSet for viewing TableStructureControls + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TableStructureControl' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TableStructureControl' + tags: + - v3 + patch: + operationId: simulations_events_structure-control_table_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TableStructureControl' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_structure-control_table_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this table structure control. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/structure-control/table/{id}/processed/: + put: + operationId: simulations_events_structure-control_table_processed + description: ViewSet for viewing TableStructureControls + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/MeasureLocationGridEventState' + responses: + '200': + description: OK + '400': + description: Event is already processed + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this table structure control. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/structure-control/timed/: + get: + operationId: simulations_events_structure-control_timed_list + description: A simple ViewSet for viewing TimedStructureControls + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/TimedStructureControl' + tags: + - v3 + post: + operationId: simulations_events_structure-control_timed_create + description: |- + A timed structure control allows for actively altering parameters of + structures at a given point in time of the simulation for a given + period of time. + The ``type`` parameter specifies which action should be applied to + the structure. Not all valid action types can be applied to every + structure. An overview of valid combinations: + + set_discharge_coefficients: v2_orifice, v2_weir, v2_pipe, + v2_channel, v2_culvert + set_crest_level: v2_orifice, v2_weir + set_pump_capacity: v2_pumpstation + + The value parameter must contain 1 value, except for the + ``set_discharge_coefficients``action that expects a value for + both flow directions. + + Example payload: + + ``` + { + "offset": 0, + "duration": 100, + "value": [ + 0.4, 0.8 + ], + "type": "set_discharge_coefficients", + "structure_id": 21, + "structure_type": "v2_weir" + } + ``` + + **v2_channel and v2_pipe are for internal use only. They expect a + grid_id instead of a structure_id!** + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimedStructureControl' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/TimedStructureControl' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/structure-control/timed/{id}/: + get: + operationId: simulations_events_structure-control_timed_read + description: A simple ViewSet for viewing TimedStructureControls + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TimedStructureControl' + tags: + - v3 + put: + operationId: simulations_events_structure-control_timed_update + description: A simple ViewSet for viewing TimedStructureControls + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimedStructureControl' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TimedStructureControl' + tags: + - v3 + patch: + operationId: simulations_events_structure-control_timed_partial_update + description: |- + when the simulation has started only the duration parameter might + be patched + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimedStructureControl' + responses: + '200': + description: Successfully patched the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + delete: + operationId: simulations_events_structure-control_timed_delete + description: |- + destroy resource only if the event has not yet been applied to + the associated simulation + parameters: [] + responses: + '204': + description: Successfully deleted the resource + '409': + description: Conflict with the current simulation status + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this timed structure control. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/structure-control/timed/{id}/processed/: + put: + operationId: simulations_events_structure-control_timed_processed + description: A simple ViewSet for viewing TimedStructureControls + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/GridEventState' + responses: + '200': + description: OK + '400': + description: Event is already processed + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this timed structure control. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/wind/constant/: + get: + operationId: simulations_events_wind_constant_list + description: A simple ViewSet for viewing Wind. + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/ConstantWind' + tags: + - v3 + post: + operationId: simulations_events_wind_constant_create + description: |- + A constant wind event allows for wind forcing at a given point in + time of the simulation for a given period of time. + No distinction is made (yet) between the 1D and 2D model domain. + + The ``units`` parameter is the wind speed unit ('m/s' or 'km/h'). + + The ``direction_value`` parameter is the wind direction in + degrees (0-360) from the north - meteorological standard. + Thus, a direction_value of 180 represents a south wind (which + comes from the south and blows your hat towards the north. + + The ``speed_value`` parameter as well as the ``direction_value`` + must contain 1 value. Behind the the scenes these are converted + into nested array [time, speed_value, direction_value]. + This means that this payload (example): + + ``` + { + "offset": 100, + "duration": 400, + "units": "m/s", + "speed_value": 80, + "direction_value": 220 + } + ``` + + becomes an Timeseries object with values: + + ``` + { + "values": [ + [ 0, 80, 220], # time, speed, direction + [ 400, 0, 0] # time, speed, direction + ], + } + ``` + + Note that the (dimensionless) ``drag-coefficient`` is not part + of a simulation event, but part of simulation initial condition. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantWind' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/ConstantWind' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/wind/constant/{id}/: + get: + operationId: simulations_events_wind_constant_read + description: A simple ViewSet for viewing Wind. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ConstantWind' + tags: + - v3 + put: + operationId: simulations_events_wind_constant_update + description: A simple ViewSet for viewing Wind. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantWind' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ConstantWind' + tags: + - v3 + patch: + operationId: simulations_events_wind_constant_partial_update + description: A simple ViewSet for viewing Wind. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ConstantWind' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ConstantWind' + tags: + - v3 + delete: + operationId: simulations_events_wind_constant_delete + description: A simple ViewSet for viewing Wind. + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this wind. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/wind/timeseries/: + get: + operationId: simulations_events_wind_timeseries_list + description: A simple ViewSet for viewig Wind. + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/TimeseriesWind' + tags: + - v3 + post: + operationId: simulations_events_wind_timeseries_create + description: |- + Same as constant wind event but now without separate fields + for ``speed_value`` and ``direction_value``. + Instead - to avoid time-mapping issues - the field ``values`` + holds the speed and direction values: + ``` + [ + [time, speed1, direction1], + [time, speed2, direction2], + ] + ``` + + example payload: + ``` + { + "offset": 2, + "values": [ + [0, 40, 180], + [60, 35, 181] + ], + "units": "m/s", + } + ``` + + becomes an Timeseries object with values: + ``` + { + "values": [ + [ 0, 40, 180 ], + [60, 35, 181 ] + ] + } + ``` + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesWind' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/TimeseriesWind' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/events/wind/timeseries/{id}/: + get: + operationId: simulations_events_wind_timeseries_read + description: A simple ViewSet for viewig Wind. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TimeseriesWind' + tags: + - v3 + put: + operationId: simulations_events_wind_timeseries_update + description: A simple ViewSet for viewig Wind. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesWind' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TimeseriesWind' + tags: + - v3 + patch: + operationId: simulations_events_wind_timeseries_partial_update + description: A simple ViewSet for viewig Wind. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeseriesWind' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TimeseriesWind' + tags: + - v3 + delete: + operationId: simulations_events_wind_timeseries_delete + description: A simple ViewSet for viewig Wind. + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this wind. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/1d_water_level/constant/: + get: + operationId: simulations_initial_1d_water_level_constant_list + description: Initial 1D water levels + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/OneDWaterLevel' + tags: + - v3 + post: + operationId: simulations_initial_1d_water_level_constant_create + description: Start the simulation with a global 1D water level + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/OneDWaterLevel' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/OneDWaterLevel' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/1d_water_level/constant/{id}/: + get: + operationId: simulations_initial_1d_water_level_constant_read + description: Initial 1D water levels + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/OneDWaterLevel' + tags: + - v3 + put: + operationId: simulations_initial_1d_water_level_constant_update + description: Initial 1D water levels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/OneDWaterLevel' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/OneDWaterLevel' + tags: + - v3 + patch: + operationId: simulations_initial_1d_water_level_constant_partial_update + description: Initial 1D water levels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/OneDWaterLevel' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/OneDWaterLevel' + tags: + - v3 + delete: + operationId: simulations_initial_1d_water_level_constant_delete + description: Initial 1D water levels + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this one d water level. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/1d_water_level/file/: + get: + operationId: simulations_initial_1d_water_level_file_list + description: Initial 1D water levels + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/OneDWaterLevelFile' + tags: + - v3 + post: + operationId: simulations_initial_1d_water_level_file_create + description: |- + Start the simulation with a 1D water levels from a file. Applies the + given values to the predefined nodes subset "1D" + as described in the [threedigrid documentation] [ref] + + [ref]: https://threedigrid.readthedocs.io/en/latest/api.html#subsets + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/OneDWaterLevelFile' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/OneDWaterLevelFile' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/1d_water_level/file/{id}/: + get: + operationId: simulations_initial_1d_water_level_file_read + description: Initial 1D water levels + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/OneDWaterLevelFile' + tags: + - v3 + put: + operationId: simulations_initial_1d_water_level_file_update + description: Initial 1D water levels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/OneDWaterLevelFile' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/OneDWaterLevelFile' + tags: + - v3 + patch: + operationId: simulations_initial_1d_water_level_file_partial_update + description: Initial 1D water levels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/OneDWaterLevelFile' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/OneDWaterLevelFile' + tags: + - v3 + delete: + operationId: simulations_initial_1d_water_level_file_delete + description: Initial 1D water levels + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this one d water level file. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/1d_water_level/predefined/: + get: + operationId: simulations_initial_1d_water_level_predefined_list + description: initial predefined 1D water levels + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/OneDWaterLevelPredefined' + tags: + - v3 + post: + operationId: simulations_initial_1d_water_level_predefined_create + summary: This endpoint is pending deprecation. + description: |- + For threedimodels that came from a repository on models.lizard.net: + Start the simulation with predefined 1D water levels. That is, + use the initial water levels that have been specified in the + ``v2_connection_nodes`` schema. + + For threedimodels that came from a schematisation in this API, there + might be a threedimodels/{}/initial_waterlevels 1D resource. If such + a resource exists, there will also be a /file initial condition + created. The /predefined resource will still be created but is + ignored by the simulation. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/OneDWaterLevelPredefined' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/OneDWaterLevelPredefined' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/1d_water_level/predefined/{id}/: + get: + operationId: simulations_initial_1d_water_level_predefined_read + description: initial predefined 1D water levels + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/OneDWaterLevelPredefined' + tags: + - v3 + put: + operationId: simulations_initial_1d_water_level_predefined_update + description: initial predefined 1D water levels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/OneDWaterLevelPredefined' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/OneDWaterLevelPredefined' + tags: + - v3 + patch: + operationId: simulations_initial_1d_water_level_predefined_partial_update + description: initial predefined 1D water levels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/OneDWaterLevelPredefined' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/OneDWaterLevelPredefined' + tags: + - v3 + delete: + operationId: simulations_initial_1d_water_level_predefined_delete + description: initial predefined 1D water levels + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this one d water level predefined. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/2d_water_level/constant/: + get: + operationId: simulations_initial_2d_water_level_constant_list + description: Initial 2D water levels + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/TwoDWaterLevel' + tags: + - v3 + post: + operationId: simulations_initial_2d_water_level_constant_create + description: |- + Start the simulation with a global 2D water level. Applies the + given value to the predefined nodes subset "2D_OPEN_WATER" + as described in the [threedigrid documentation] [ref] + + [ref]: https://threedigrid.readthedocs.io/en/latest/api.html#subsets + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TwoDWaterLevel' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/TwoDWaterLevel' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/2d_water_level/constant/{id}/: + get: + operationId: simulations_initial_2d_water_level_constant_read + description: Initial 2D water levels + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TwoDWaterLevel' + tags: + - v3 + put: + operationId: simulations_initial_2d_water_level_constant_update + description: Initial 2D water levels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TwoDWaterLevel' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TwoDWaterLevel' + tags: + - v3 + patch: + operationId: simulations_initial_2d_water_level_constant_partial_update + description: Initial 2D water levels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TwoDWaterLevel' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TwoDWaterLevel' + tags: + - v3 + delete: + operationId: simulations_initial_2d_water_level_constant_delete + description: Initial 2D water levels + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this two d water level. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/2d_water_level/raster/: + get: + operationId: simulations_initial_2d_water_level_raster_list + description: Initial 2D water raster + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/TwoDWaterRaster' + tags: + - v3 + post: + operationId: simulations_initial_2d_water_level_raster_create + description: |- + Start the simulation with 2D water levels derived from the raster by + using the aggregation method. Applies the resulting levels + to the predefined nodes subset "2D_OPEN_WATER" + as described in the [threedigrid documentation] [ref] + + [ref]: https://threedigrid.readthedocs.io/en/latest/api.html#subsets + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TwoDWaterRaster' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/TwoDWaterRaster' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/2d_water_level/raster/{id}/: + get: + operationId: simulations_initial_2d_water_level_raster_read + description: Initial 2D water raster + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TwoDWaterRaster' + tags: + - v3 + put: + operationId: simulations_initial_2d_water_level_raster_update + description: Initial 2D water raster + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TwoDWaterRaster' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TwoDWaterRaster' + tags: + - v3 + patch: + operationId: simulations_initial_2d_water_level_raster_partial_update + description: Initial 2D water raster + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TwoDWaterRaster' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TwoDWaterRaster' + tags: + - v3 + delete: + operationId: simulations_initial_2d_water_level_raster_delete + description: Initial 2D water raster + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this two d water raster. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/groundwater_level/constant/: + get: + operationId: simulations_initial_groundwater_level_constant_list + description: Initial groundwater levels. + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/GroundWaterLevel' + tags: + - v3 + post: + operationId: simulations_initial_groundwater_level_constant_create + description: |- + Start the simulation with a global 2D groundwater level. Applies the + given value to the predefined nodes subset "2D_GROUNDWATER" + as described in the [threedigrid documentation] [ref] + + [ref]: https://threedigrid.readthedocs.io/en/latest/api.html#subsets + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/GroundWaterLevel' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/GroundWaterLevel' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/groundwater_level/constant/{id}/: + get: + operationId: simulations_initial_groundwater_level_constant_read + description: Initial groundwater levels. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/GroundWaterLevel' + tags: + - v3 + put: + operationId: simulations_initial_groundwater_level_constant_update + description: Initial groundwater levels. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/GroundWaterLevel' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/GroundWaterLevel' + tags: + - v3 + patch: + operationId: simulations_initial_groundwater_level_constant_partial_update + description: Initial groundwater levels. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/GroundWaterLevel' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/GroundWaterLevel' + tags: + - v3 + delete: + operationId: simulations_initial_groundwater_level_constant_delete + description: Initial groundwater levels. + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this ground water level. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/groundwater_level/raster/: + get: + operationId: simulations_initial_groundwater_level_raster_list + description: Initial 2D water raster + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/GroundWaterRaster' + tags: + - v3 + post: + operationId: simulations_initial_groundwater_level_raster_create + description: |- + Start the simulation with groundwaterlevels derived from the raster by + using the aggregation method. Applies the + given value to the predefined nodes subset "2D_GROUNDWATER" + as described in the [threedigrid documentation] [ref] + + [ref]: https://threedigrid.readthedocs.io/en/latest/api.html#subsets + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/GroundWaterRaster' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/GroundWaterRaster' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/groundwater_level/raster/{id}/: + get: + operationId: simulations_initial_groundwater_level_raster_read + description: Initial 2D water raster + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/GroundWaterRaster' + tags: + - v3 + put: + operationId: simulations_initial_groundwater_level_raster_update + description: Initial 2D water raster + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/GroundWaterRaster' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/GroundWaterRaster' + tags: + - v3 + patch: + operationId: simulations_initial_groundwater_level_raster_partial_update + description: Initial 2D water raster + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/GroundWaterRaster' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/GroundWaterRaster' + tags: + - v3 + delete: + operationId: simulations_initial_groundwater_level_raster_delete + description: Initial 2D water raster + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this ground water raster. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/saved_state/: + get: + operationId: simulations_initial_saved_state_list + description: A simple ViewSet for initial SavedState's + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/InitialSavedState' + tags: + - v3 + post: + operationId: simulations_initial_saved_state_create + description: A simple ViewSet for initial SavedState's + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/InitialSavedState' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/InitialSavedState' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/saved_state/{id}/: + get: + operationId: simulations_initial_saved_state_read + description: A simple ViewSet for initial SavedState's + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/InitialSavedState' + tags: + - v3 + put: + operationId: simulations_initial_saved_state_update + description: A simple ViewSet for initial SavedState's + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/InitialSavedState' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/InitialSavedState' + tags: + - v3 + patch: + operationId: simulations_initial_saved_state_partial_update + description: A simple ViewSet for initial SavedState's + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/InitialSavedState' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/InitialSavedState' + tags: + - v3 + delete: + operationId: simulations_initial_saved_state_delete + description: A simple ViewSet for initial SavedState's + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this initial saved state. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/wind_drag-coefficient/: + get: + operationId: simulations_initial_wind_drag-coefficient_list + description: A simple ViewSet for initial Wind drag coefficient + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/WindDragCoefficient' + tags: + - v3 + post: + operationId: simulations_initial_wind_drag-coefficient_create + description: |- + Start the simulation with a global wind drag-coefficient. This + (dimensionless) ``drag-coefficient`` translates the wind speed + on a 10 m elevation to the speed on the ground (default=0.005). + Currently the drag-coefficient works as a global factor for + the entire model: 1D lines and 2D lines if exists + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/WindDragCoefficient' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/WindDragCoefficient' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/initial/wind_drag-coefficient/{id}/: + get: + operationId: simulations_initial_wind_drag-coefficient_read + description: A simple ViewSet for initial Wind drag coefficient + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/WindDragCoefficient' + tags: + - v3 + put: + operationId: simulations_initial_wind_drag-coefficient_update + description: A simple ViewSet for initial Wind drag coefficient + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/WindDragCoefficient' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/WindDragCoefficient' + tags: + - v3 + patch: + operationId: simulations_initial_wind_drag-coefficient_partial_update + description: A simple ViewSet for initial Wind drag coefficient + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/WindDragCoefficient' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/WindDragCoefficient' + tags: + - v3 + delete: + operationId: simulations_initial_wind_drag-coefficient_delete + description: A simple ViewSet for initial Wind drag coefficient + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this wind drag coefficient. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/progress/: + get: + operationId: simulations_progress_list + description: A simple ViewSet for viewing simulations + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Progress' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/results/files/: + get: + operationId: simulations_results_files_list + description: Retrieve simulation results + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/ResultFile' + tags: + - v3 + post: + operationId: simulations_results_files_create + description: Retrieve simulation results + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ResultFile' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/ResultFile' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/results/files/{id}/: + get: + operationId: simulations_results_files_read + description: Retrieve simulation results + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ResultFile' + tags: + - v3 + put: + operationId: simulations_results_files_update + description: Retrieve simulation results + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ResultFile' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ResultFile' + tags: + - v3 + patch: + operationId: simulations_results_files_partial_update + description: Retrieve simulation results + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ResultFile' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ResultFile' + tags: + - v3 + delete: + operationId: simulations_results_files_delete + description: Retrieve simulation results + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this result file. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/results/files/{id}/download/: + get: + operationId: simulations_results_files_download + description: Endpoint for downloading files. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this result file. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/results/files/{id}/upload/: + post: + operationId: simulations_results_files_upload + description: Endpoint for uploading a result file + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + '404': + description: Simulation not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this result file. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/results/post_processing/lizard/arrival/: + get: + operationId: simulations_results_post_processing_lizard_arrival_list + description: |- + A Custom ViewSet for creating, listing or deleting an + ArrivalTimePostProcessing resource. It includes a custom destroy + action (with detail=False) as a BasicPostProcessing object can + have only one ArrivalTimePostProcessing object. An + ArrivalTimePostProcessing resource is created with an empty POST. + + Three conditions are validated when creating an resource: + - The simulation may not already have an ArrivalTimePostProcessing resource. + - The simulation must have a BasicPostProcessing resource with 'process_basic_results'=True. + - Lizard may not already have been triggered to processing this simulation. + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '404': + description: resource arrival time not found + '200': + description: '' + schema: + $ref: '#/definitions/ArrivalTimePostProcessing' + tags: + - v3 + post: + operationId: simulations_results_post_processing_lizard_arrival_create + description: |- + A Custom ViewSet for creating, listing or deleting an + ArrivalTimePostProcessing resource. It includes a custom destroy + action (with detail=False) as a BasicPostProcessing object can + have only one ArrivalTimePostProcessing object. An + ArrivalTimePostProcessing resource is created with an empty POST. + + Three conditions are validated when creating an resource: + - The simulation may not already have an ArrivalTimePostProcessing resource. + - The simulation must have a BasicPostProcessing resource with 'process_basic_results'=True. + - Lizard may not already have been triggered to processing this simulation. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ArrivalTimePostProcessing' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/ArrivalTimePostProcessing' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/results/post_processing/lizard/arrival/delete/: + delete: + operationId: simulations_results_post_processing_lizard_arrival_delete + description: |- + A Custom ViewSet for creating, listing or deleting an + ArrivalTimePostProcessing resource. It includes a custom destroy + action (with detail=False) as a BasicPostProcessing object can + have only one ArrivalTimePostProcessing object. An + ArrivalTimePostProcessing resource is created with an empty POST. + + Three conditions are validated when creating an resource: + - The simulation may not already have an ArrivalTimePostProcessing resource. + - The simulation must have a BasicPostProcessing resource with 'process_basic_results'=True. + - Lizard may not already have been triggered to processing this simulation. + parameters: [] + responses: + '404': + description: resource arrival_time not found + '400': + description: not allowed, Lizard already started post-processing + '204': + description: deleted resource arrival_time + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/results/post_processing/lizard/basic/: + get: + operationId: simulations_results_post_processing_lizard_basic_list + description: |- + A Custom ViewSet for creating, listing or deleting + a BasicPostProcessing resource. It includes a custom + destroy action (with detail=False) as a BasicPostProcessing + object can have only one DamagePostProcessing object. + + Three conditions are validated when creating an resource: + - The simulation may not already have a BasicPostProcessing resource. + - Lizard may not already have been triggered to processing this simulation. + - The Simulation must hold a 'dem_raw_file' in case parameter 'process_basic_results' is True. + + The ``scenario_name`` parameter is optional (max 50 chars). If not + provided it becomes an empty string. + + THe ``result_uuid`` can be defined for e.g. operational models. Defaults to + an uuid4 if not provided. + + If ``process_basic_results`` (boolean) is False then: + - It is not possible to have ArrivalTimePostProcessing and DamagePostProcessing. + - Only raw_results (.nc, .log, etc) are uploaded to Lizard. + + If ``process_basic_results`` (boolean) is True then: + - It is possible to have ArrivalTimePostProcessing and DamagePostProcessing. + - raw_results are uploaded to Lizard and additional WMS layers are available on Lizard. + + Payload example + ``` + { + "scenario_name": "my_scenario_name", + "process_basic_results": True, + } + ``` + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '404': + description: resource basic postprocessing not found + '200': + description: '' + schema: + $ref: '#/definitions/BasicPostProcessing' + tags: + - v3 + post: + operationId: simulations_results_post_processing_lizard_basic_create + description: |- + A Custom ViewSet for creating, listing or deleting + a BasicPostProcessing resource. It includes a custom + destroy action (with detail=False) as a BasicPostProcessing + object can have only one DamagePostProcessing object. + + Three conditions are validated when creating an resource: + - The simulation may not already have a BasicPostProcessing resource. + - Lizard may not already have been triggered to processing this simulation. + - The Simulation must hold a 'dem_raw_file' in case parameter 'process_basic_results' is True. + + The ``scenario_name`` parameter is optional (max 50 chars). If not + provided it becomes an empty string. + + THe ``result_uuid`` can be defined for e.g. operational models. Defaults to + an uuid4 if not provided. + + If ``process_basic_results`` (boolean) is False then: + - It is not possible to have ArrivalTimePostProcessing and DamagePostProcessing. + - Only raw_results (.nc, .log, etc) are uploaded to Lizard. + + If ``process_basic_results`` (boolean) is True then: + - It is possible to have ArrivalTimePostProcessing and DamagePostProcessing. + - raw_results are uploaded to Lizard and additional WMS layers are available on Lizard. + + Payload example + ``` + { + "scenario_name": "my_scenario_name", + "process_basic_results": True, + } + ``` + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/BasicPostProcessing' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/BasicPostProcessing' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/results/post_processing/lizard/basic/delete/: + delete: + operationId: simulations_results_post_processing_lizard_basic_delete + description: |- + A Custom ViewSet for creating, listing or deleting + a BasicPostProcessing resource. It includes a custom + destroy action (with detail=False) as a BasicPostProcessing + object can have only one DamagePostProcessing object. + + Three conditions are validated when creating an resource: + - The simulation may not already have a BasicPostProcessing resource. + - Lizard may not already have been triggered to processing this simulation. + - The Simulation must hold a 'dem_raw_file' in case parameter 'process_basic_results' is True. + + The ``scenario_name`` parameter is optional (max 50 chars). If not + provided it becomes an empty string. + + THe ``result_uuid`` can be defined for e.g. operational models. Defaults to + an uuid4 if not provided. + + If ``process_basic_results`` (boolean) is False then: + - It is not possible to have ArrivalTimePostProcessing and DamagePostProcessing. + - Only raw_results (.nc, .log, etc) are uploaded to Lizard. + + If ``process_basic_results`` (boolean) is True then: + - It is possible to have ArrivalTimePostProcessing and DamagePostProcessing. + - raw_results are uploaded to Lizard and additional WMS layers are available on Lizard. + + Payload example + ``` + { + "scenario_name": "my_scenario_name", + "process_basic_results": True, + } + ``` + parameters: [] + responses: + '404': + description: resource basic_post_processing not found + '400': + description: not allowed, Lizard already started post-processing + '204': + description: deleted resource basic_post_processing + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/results/post_processing/lizard/damage/: + get: + operationId: simulations_results_post_processing_lizard_damage_list + description: |- + A Custom ViewSet for creating, listing or deleting + a DamagePostProcessing resource. It includes a custom + destroy action (with detail=False) as a BasicPostProcessing + object can have only one DamagePostProcessing object. + + Three conditions are validated when creating an resource: + - The simulation may not already have a DamagePostProcessing resource. + - The simulation must have a BasicPostProcessing resource with 'process_basic_results'=True. + - Lizard may not already have been triggered to processing this simulation. + + The ``cost_type`` parameter choices are: 'min', 'avg', 'max'. + + The ``flood_month`` parameter choices are: 'jan', 'feb', etc + + The ``inundation_period`` parameter is ime in hours (float), + min_value=1.0 + + The ``repair_time_infrastructure`` parameter is time in + hours (integer), min_value=1, max_value=240 + + The ``repair_time_buildings`` parameter is time in hours (integer), + min_value=1, max_value=240 + + Payload example + ``` + { + "cost_type": "min", + "flood_month": "jan", + "inundation_period": 12.0, + "repair_time_infrastructure": 120, + "repair_time_buildings": 240 + } + ``` + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '404': + description: resource damage_estimation not found + '200': + description: '' + schema: + $ref: '#/definitions/DamagePostProcessing' + tags: + - v3 + post: + operationId: simulations_results_post_processing_lizard_damage_create + description: |- + A Custom ViewSet for creating, listing or deleting + a DamagePostProcessing resource. It includes a custom + destroy action (with detail=False) as a BasicPostProcessing + object can have only one DamagePostProcessing object. + + Three conditions are validated when creating an resource: + - The simulation may not already have a DamagePostProcessing resource. + - The simulation must have a BasicPostProcessing resource with 'process_basic_results'=True. + - Lizard may not already have been triggered to processing this simulation. + + The ``cost_type`` parameter choices are: 'min', 'avg', 'max'. + + The ``flood_month`` parameter choices are: 'jan', 'feb', etc + + The ``inundation_period`` parameter is ime in hours (float), + min_value=1.0 + + The ``repair_time_infrastructure`` parameter is time in + hours (integer), min_value=1, max_value=240 + + The ``repair_time_buildings`` parameter is time in hours (integer), + min_value=1, max_value=240 + + Payload example + ``` + { + "cost_type": "min", + "flood_month": "jan", + "inundation_period": 12.0, + "repair_time_infrastructure": 120, + "repair_time_buildings": 240 + } + ``` + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/DamagePostProcessing' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/DamagePostProcessing' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/results/post_processing/lizard/damage/delete/: + delete: + operationId: simulations_results_post_processing_lizard_damage_delete + description: |- + A Custom ViewSet for creating, listing or deleting + a DamagePostProcessing resource. It includes a custom + destroy action (with detail=False) as a BasicPostProcessing + object can have only one DamagePostProcessing object. + + Three conditions are validated when creating an resource: + - The simulation may not already have a DamagePostProcessing resource. + - The simulation must have a BasicPostProcessing resource with 'process_basic_results'=True. + - Lizard may not already have been triggered to processing this simulation. + + The ``cost_type`` parameter choices are: 'min', 'avg', 'max'. + + The ``flood_month`` parameter choices are: 'jan', 'feb', etc + + The ``inundation_period`` parameter is ime in hours (float), + min_value=1.0 + + The ``repair_time_infrastructure`` parameter is time in + hours (integer), min_value=1, max_value=240 + + The ``repair_time_buildings`` parameter is time in hours (integer), + min_value=1, max_value=240 + + Payload example + ``` + { + "cost_type": "min", + "flood_month": "jan", + "inundation_period": 12.0, + "repair_time_infrastructure": 120, + "repair_time_buildings": 240 + } + ``` + parameters: [] + responses: + '404': + description: resource damage_estimation not found + '401': + description: not allowed, Lizard already started post-processing + '204': + description: deleted resource damage_estimation + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/results/post_processing/lizard/overview/: + get: + operationId: simulations_results_post_processing_lizard_overview_list + description: |- + Custom list that provides overview of post-processing configuration. + Below a format specification is provided. All keys always exists, + regardless post-processing config: + + ``` + { + "username": str, + "external_user_id": Optional[str], + "metadata_version": float, + "start_time_sim": datetime (UTC), + "end_time_sim": datetime (UTC), + "results": { + "basic": bool, + "damage_estimation": bool, + "arrival_time": bool + }, + "settings": { + "damage_estimation": { + "damage_table": str, + "elevation_raster_uuid": str, + "landcover_raster_uuid": str, + "road_rail_raster_uuid": str, + "cost_type": int, + "flood_month": int, + "inundation_period": int, + "repair_time_infrastructure": int, + "repair_time_buildings": int + }, + }, + "model_name": str, (=threedimodel_slug) + "simulation_name": str, (=simulation_slug) + "scenario_name": str, + "model_id": int, + "model_revision_id": str, + "email": str, + "result_uuid": str, + "organisation_uuid": str, + "simulation": int + } + ``` + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + $ref: '#/definitions/PostProcessingOverview' + '404': + description: No basic post-processing resource found + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/results/post_processing/lizard/start/: + post: + operationId: simulations_results_post_processing_lizard_start_create + description: Empty post to start Lizard post-processing for one Simulation result. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/PostProcessingStart' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/PostProcessingStart' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/results/post_processing/lizard/start/retry/: + post: + operationId: simulations_results_post_processing_lizard_start_retry + summary: Retry the Lizard post-processing + description: |- + Will only re-trigger the post-processing if the post-processing status is in + `archiving_failed`. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/PostProcessingStart' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/PostProcessingStart' + '400': + description: Bad request + '403': + description: Forbidden + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/results/post_processing/lizard/status/: + get: + operationId: simulations_results_post_processing_lizard_status_list + description: Show the latest post-processing status of one simulation. + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '404': + description: resource post_processing_status not found + '200': + description: '' + schema: + $ref: '#/definitions/PostProcessingStatus' + tags: + - v3 + post: + operationId: simulations_results_post_processing_lizard_status_create + description: |- + Endpoint to keep track of post-processing status (done by Lizard) + per Simulation result. Status is updated internal by 3Di, and once + processing starts it is updated by Lizard backend. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/PostProcessingStatus' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/PostProcessingStatus' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/results/post_processing/lizard/status/delete/: + delete: + operationId: simulations_results_post_processing_lizard_status_delete + description: |- + Endpoint to keep track of post-processing status (done by Lizard) + per Simulation result. Status is updated internal by 3Di, and once + processing starts it is updated by Lizard backend. + parameters: [] + responses: + '404': + description: resource post_processing_status not found + '204': + description: post_processing_status deleted + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/results/post_processing/lizard/status/history/: + get: + operationId: simulations_results_post_processing_lizard_status_history_list + description: '' + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/PostProcessingStatus' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/settings/aggregation/: + get: + operationId: simulations_settings_aggregation_list + summary: Simulation aggregation settings. + description: |- + For a consistent water balance often the results of various snap shots - + as provided by the results_3di.nc file - are not enough. Especially in case + of an time step setting that is larger than the computational time step. + For this purpose, an aggregated results file is available called + aggregate_results_3di.nc. The structure of the file is very similar to the + other result file. Each Mesh variable (s1, u1, etc.) described in the results + section can be aggregated. + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/AggregationSettings' + tags: + - v3 + post: + operationId: simulations_settings_aggregation_create + summary: Simulation aggregation settings. + description: |- + For a consistent water balance often the results of various snap shots - + as provided by the results_3di.nc file - are not enough. Especially in case + of an time step setting that is larger than the computational time step. + For this purpose, an aggregated results file is available called + aggregate_results_3di.nc. The structure of the file is very similar to the + other result file. Each Mesh variable (s1, u1, etc.) described in the results + section can be aggregated. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/AggregationSettings' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/AggregationSettings' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/settings/aggregation/{id}/: + get: + operationId: simulations_settings_aggregation_read + summary: Simulation aggregation settings. + description: |- + For a consistent water balance often the results of various snap shots - + as provided by the results_3di.nc file - are not enough. Especially in case + of an time step setting that is larger than the computational time step. + For this purpose, an aggregated results file is available called + aggregate_results_3di.nc. The structure of the file is very similar to the + other result file. Each Mesh variable (s1, u1, etc.) described in the results + section can be aggregated. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/AggregationSettings' + tags: + - v3 + put: + operationId: simulations_settings_aggregation_update + summary: Simulation aggregation settings. + description: |- + For a consistent water balance often the results of various snap shots - + as provided by the results_3di.nc file - are not enough. Especially in case + of an time step setting that is larger than the computational time step. + For this purpose, an aggregated results file is available called + aggregate_results_3di.nc. The structure of the file is very similar to the + other result file. Each Mesh variable (s1, u1, etc.) described in the results + section can be aggregated. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/AggregationSettings' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/AggregationSettings' + tags: + - v3 + patch: + operationId: simulations_settings_aggregation_partial_update + summary: Simulation aggregation settings. + description: |- + For a consistent water balance often the results of various snap shots - + as provided by the results_3di.nc file - are not enough. Especially in case + of an time step setting that is larger than the computational time step. + For this purpose, an aggregated results file is available called + aggregate_results_3di.nc. The structure of the file is very similar to the + other result file. Each Mesh variable (s1, u1, etc.) described in the results + section can be aggregated. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/AggregationSettings' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/AggregationSettings' + tags: + - v3 + delete: + operationId: simulations_settings_aggregation_delete + summary: Simulation aggregation settings. + description: |- + For a consistent water balance often the results of various snap shots - + as provided by the results_3di.nc file - are not enough. Especially in case + of an time step setting that is larger than the computational time step. + For this purpose, an aggregated results file is available called + aggregate_results_3di.nc. The structure of the file is very similar to the + other result file. Each Mesh variable (s1, u1, etc.) described in the results + section can be aggregated. + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this aggregation settings. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/settings/numerical/: + post: + operationId: simulations_settings_numerical_create + description: create a numerical settings resource + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/NumericalSettings' + responses: + '200': + description: OK + '400': + description: Bad request + '404': + description: Resource not found + '409': + description: Conflict with current state + tags: + - v3 + put: + operationId: simulations_settings_numerical_update + description: update the numerical settings resource + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/NumericalSettings' + responses: + '200': + description: OK + '404': + description: Resource not found + '409': + description: Conflict with current state + tags: + - v3 + patch: + operationId: simulations_settings_numerical_partial_update + description: update the numerical settings resource + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/NumericalSettings' + responses: + '200': + description: OK + '404': + description: Resource not found + '409': + description: Conflict with current state + tags: + - v3 + delete: + operationId: simulations_settings_numerical_delete + description: delete the numerical settings resource + parameters: [] + responses: + '204': + description: Resource deleted successfully + '404': + description: Resource not found + '409': + description: Conflict with current state + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/settings/overview/: + get: + operationId: simulations_settings_overview + description: Overview of the the simulation settings. + parameters: [] + responses: + '200': + description: OK + schema: + $ref: '#/definitions/SimulationSettingsOverview' + '404': + description: Resource not found + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/settings/physical/: + post: + operationId: simulations_settings_physical_create + description: Create a general settings resource. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/PhysicalSettings' + responses: + '200': + description: OK + '400': + description: Bad request + '404': + description: Resource not found + '409': + description: Conflict with current state + tags: + - v3 + put: + operationId: simulations_settings_physical_update + description: Update the general settings resource. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/PhysicalSettings' + responses: + '200': + description: OK + '404': + description: Resource not found + '409': + description: Conflict with current state + tags: + - v3 + patch: + operationId: simulations_settings_physical_partial_update + description: Update the general settings resource. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/PhysicalSettings' + responses: + '200': + description: OK + '404': + description: Resource not found + '409': + description: Conflict with current state + tags: + - v3 + delete: + operationId: simulations_settings_physical_delete + description: Delete the general settings resource. + parameters: [] + responses: + '204': + description: Resource deleted successfully + '404': + description: Resource not found + '409': + description: Conflict with current state + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/settings/time_step/: + post: + operationId: simulations_settings_time_step_create + description: create a time step settings resource + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeStepSettings' + responses: + '200': + description: OK + '400': + description: Bad request + '404': + description: Resource not found + '409': + description: Conflict with current state + tags: + - v3 + put: + operationId: simulations_settings_time_step_update + description: update the time step settings resource + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeStepSettings' + responses: + '200': + description: OK + '404': + description: Resource not found + '409': + description: Conflict with current state + tags: + - v3 + patch: + operationId: simulations_settings_time_step_partial_update + description: update the time step settings resource + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/TimeStepSettings' + responses: + '200': + description: OK + '404': + description: Resource not found + '409': + description: Conflict with current state + tags: + - v3 + delete: + operationId: simulations_settings_time_step_delete + description: delete the time step settings resource + parameters: [] + responses: + '204': + description: Resource deleted successfully + '404': + description: Resource not found + '409': + description: Conflict with current state + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/status/: + get: + operationId: simulations_status_list + description: A simple ViewSet for viewing simulations + parameters: + - name: ordering + in: query + description: Which field to use when ordering the results. + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + $ref: '#/definitions/CurrentStatus' + tags: + - v3 + post: + operationId: simulations_status_create + description: A simple ViewSet for viewing simulations + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/SimulationStatus' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/SimulationStatus' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/status/history/: + get: + operationId: simulations_status_history_list + description: '' + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/SimulationStatus' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/status/history/{id}/: + get: + operationId: simulations_status_history_read + description: '' + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/SimulationStatus' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this simulation status. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/status/patch/: + patch: + operationId: simulations_status_patch + description: A simple ViewSet for viewing simulations + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/SimulationStatus' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/SimulationStatus' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/status/{id}/: + put: + operationId: simulations_status_update + description: A simple ViewSet for viewing simulations + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/SimulationStatus' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/SimulationStatus' + tags: + - v3 + patch: + operationId: simulations_status_partial_update + description: A simple ViewSet for viewing simulations + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/SimulationStatus' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/SimulationStatus' + tags: + - v3 + delete: + operationId: simulations_status_delete + description: A simple ViewSet for viewing simulations + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this simulation status. + required: true + type: integer + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/visualisations/breach_graph/: + post: + operationId: simulations_visualisations_breach_graph_create + summary: Get a websocket URL returning breaches (graph) data + description: |- + The websocket-url in the response returns binary data + messages consisting of timestamp, breach_width, + breach_depth, q (discharge), au (wet cross-sectional area) + as float32 data. + + The values are alternated like: + [timestamp, breach_width, breach_depth, q, au ... + timestamp_N, breach_width_N, breach_depth_N, q_N, au_N] + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/BreachGraphRequest' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/BreachGraph' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/visualisations/pump_discharge_graph/: + post: + operationId: simulations_visualisations_pump_discharge_graph_create + summary: Get a websocket URL returning pump discharge (graph) data + description: |- + The websocket-url in the response returns binary data + messages consisting of timestamp, q_pump (discharge) + float32 data. The values are alternated like: + [timestamp, q_pump, timestamp_2, q_pump_2... timestamp_N, q_pump_N] + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/PumpDischargeGraphRequest' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/PumpDischargeGraph' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/visualisations/rain_graph/: + post: + operationId: simulations_visualisations_rain_graph_create + summary: Get a websocket URL returning node rain (graph) data. + description: |- + The websocket-url in the response returns binary data + messages consisting of timestamp and rain float32 data. + The values are alternated like: + [timestamp, rain, timestamp_2, rain_2... timestamp_N, rain_N] + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/RainGraphRequest' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/RainGraph' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/visualisations/water_flow_graph/: + post: + operationId: simulations_visualisations_water_flow_graph_create + summary: Get a websocket URL returning line flow (graph) data. + description: |- + The websocket-url in the response returns binary data + messages consisting of timestamp, u1 (velocity), q (discharge) + float32 data. The values are alternated like: + [timestamp, u1, q, timestamp_2, u1_2, q_2... timestamp_N, u1_N, q_N] + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/WaterFlowGraphRequest' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/WaterGraph' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/visualisations/water_level_graph/: + post: + operationId: simulations_visualisations_water_level_graph_create + summary: Get a websocket URL returning node waterlevel (graph) data. + description: |- + The websocket-url in the response returns binary data + messages consisting of timestamp and waterlevel float32 data. + The values are alternated like: + [timestamp, s1, timestamp_2, s1_2... timestamp_N, s1_N] + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/WaterLevelGraphRequest' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/WaterGraph' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/visualisations/water_level_profile/: + post: + operationId: simulations_visualisations_water_level_profile_create + summary: Get a websocket URL returning waterlevel profile data. + description: |- + The websocket returns binary data messages consisting of + timestep and waterlevel float32 values in one message like: + timestep, waterlevel, waterlevel, waterlevel, waterlevel + + Groundwater waterlevel values are automatically added + (after open water) if groundwater is present. The returned + waterlevel values have length 'points_limit' * 2 in this case. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/WaterLevelProfileRequest' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/WaterLevelProfile' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/visualisations/waterdepth/: + get: + operationId: simulations_visualisations_waterdepth_list + description: '' + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Waterdepth' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/visualisations/{layer}/profile/: + get: + operationId: simulations_visualisations_profile_list + description: '' + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Profile' + tags: + - v3 + parameters: + - name: layer + in: path + required: true + type: string + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/visualisations/{layer}/tms/: + get: + operationId: simulations_visualisations_tms_list + description: '' + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + $ref: '#/definitions/TMS' + tags: + - v3 + parameters: + - name: layer + in: path + required: true + type: string + - name: simulation_pk + in: path + required: true + type: string + /v3/simulations/{simulation_pk}/websockets/: + get: + operationId: simulations_websockets_list + description: List active websocket connections for a given simulation + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/SimulationChannel' + tags: + - v3 + parameters: + - name: simulation_pk + in: path + required: true + type: string + /v3/statuses/: + get: + operationId: statuses_list + summary: Show the latest status off all simulations. + description: |- + List all simulations that ever have finished successfully + + ``` + ?name=finished + ``` + + List all simulations that have finished successfully during the week + of the 1988 UEFA European Football Championship + ``` + ?name=finished&created__date__gte=1988-06-10&created__date__lte=1988-06-25 + ``` + + The `created` field is of type date-time in ISO 8601 (UTC) format. To + get all crashed simulations since St Nicolas 2018 + + ``` + ?name=crashed&created__gte=2018-12-05T00:00:00Z + ``` + parameters: + - name: name + in: query + description: '' + required: false + type: string + - name: name__iexact + in: query + description: '' + required: false + type: string + - name: name__contains + in: query + description: '' + required: false + type: string + - name: name__icontains + in: query + description: '' + required: false + type: string + - name: name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: name__startswith + in: query + description: '' + required: false + type: string + - name: name__istartswith + in: query + description: '' + required: false + type: string + - name: name__endswith + in: query + description: '' + required: false + type: string + - name: name__regex + in: query + description: '' + required: false + type: string + - name: simulation__name + in: query + description: '' + required: false + type: string + - name: simulation__name__iexact + in: query + description: '' + required: false + type: string + - name: simulation__name__contains + in: query + description: '' + required: false + type: string + - name: simulation__name__icontains + in: query + description: '' + required: false + type: string + - name: simulation__name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: simulation__name__startswith + in: query + description: '' + required: false + type: string + - name: simulation__name__istartswith + in: query + description: '' + required: false + type: string + - name: simulation__name__endswith + in: query + description: '' + required: false + type: string + - name: simulation__name__regex + in: query + description: '' + required: false + type: string + - name: simulation__compute_cluster__name + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__slug + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__slug__iexact + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__slug__contains + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__slug__icontains + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__slug__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: simulation__threedimodel__slug__startswith + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__slug__istartswith + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__slug__endswith + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__slug__regex + in: query + description: '' + required: false + type: string + - name: created + in: query + description: '' + required: false + type: string + - name: created__gt + in: query + description: '' + required: false + type: string + - name: created__gte + in: query + description: '' + required: false + type: string + - name: created__lt + in: query + description: '' + required: false + type: string + - name: created__lte + in: query + description: '' + required: false + type: string + - name: created__date + in: query + description: '' + required: false + type: string + - name: created__date__gt + in: query + description: '' + required: false + type: string + - name: created__date__gte + in: query + description: '' + required: false + type: string + - name: created__date__lt + in: query + description: '' + required: false + type: string + - name: created__date__lte + in: query + description: '' + required: false + type: string + - name: created__year + in: query + description: '' + required: false + type: number + - name: created__year__gt + in: query + description: '' + required: false + type: number + - name: created__year__gte + in: query + description: '' + required: false + type: number + - name: created__year__lt + in: query + description: '' + required: false + type: number + - name: created__year__lte + in: query + description: '' + required: false + type: number + - name: created__month + in: query + description: '' + required: false + type: number + - name: created__month__lte + in: query + description: '' + required: false + type: number + - name: created__day + in: query + description: '' + required: false + type: number + - name: created__day__lt + in: query + description: '' + required: false + type: number + - name: created__week + in: query + description: '' + required: false + type: number + - name: created__week_day + in: query + description: '' + required: false + type: number + - name: id + in: query + description: '' + required: false + type: number + - name: id__gt + in: query + description: '' + required: false + type: number + - name: id__gte + in: query + description: '' + required: false + type: number + - name: id__lt + in: query + description: '' + required: false + type: number + - name: id__lte + in: query + description: '' + required: false + type: number + - name: id__isnull + in: query + description: '' + required: false + type: string + - name: exit_code + in: query + description: '' + required: false + type: string + - name: exit_code__gt + in: query + description: '' + required: false + type: number + - name: exit_code__gte + in: query + description: '' + required: false + type: number + - name: exit_code__lt + in: query + description: '' + required: false + type: number + - name: exit_code__lte + in: query + description: '' + required: false + type: number + - name: exit_code__isnull + in: query + description: '' + required: false + type: string + - name: simulation_id__in + in: query + description: Multiple values may be separated by commas. + required: false + type: number + - name: simulation__user__username + in: query + description: '' + required: false + type: string + - name: simulation__type__live + in: query + description: '' + required: false + type: string + - name: simulation__tags__contains + in: query + description: '' + required: false + type: string + - name: simulation__organisation__name__istartswith + in: query + description: '' + required: false + type: string + - name: simulation__organisation__unique_id + in: query + description: '' + required: false + type: string + - name: ordering + in: query + description: Which field to use when ordering the results. + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/SimulationStatus' + tags: + - v3 + parameters: [] + /v3/statuses/statistics/: + get: + operationId: statuses_statistics + summary: |- + Count of (latest/final) simulation statuses. Combine with filters to + get your weekly/monthly etc statistics + description: |- + For example, to get a count of finished simulations in 2020 + + ``` + ?name=finished&created__year=2020 + parameters: + - name: name + in: query + description: '' + required: false + type: string + - name: name__iexact + in: query + description: '' + required: false + type: string + - name: name__contains + in: query + description: '' + required: false + type: string + - name: name__icontains + in: query + description: '' + required: false + type: string + - name: name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: name__startswith + in: query + description: '' + required: false + type: string + - name: name__istartswith + in: query + description: '' + required: false + type: string + - name: name__endswith + in: query + description: '' + required: false + type: string + - name: name__regex + in: query + description: '' + required: false + type: string + - name: simulation__name + in: query + description: '' + required: false + type: string + - name: simulation__name__iexact + in: query + description: '' + required: false + type: string + - name: simulation__name__contains + in: query + description: '' + required: false + type: string + - name: simulation__name__icontains + in: query + description: '' + required: false + type: string + - name: simulation__name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: simulation__name__startswith + in: query + description: '' + required: false + type: string + - name: simulation__name__istartswith + in: query + description: '' + required: false + type: string + - name: simulation__name__endswith + in: query + description: '' + required: false + type: string + - name: simulation__name__regex + in: query + description: '' + required: false + type: string + - name: simulation__compute_cluster__name + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__slug + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__slug__iexact + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__slug__contains + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__slug__icontains + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__slug__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: simulation__threedimodel__slug__startswith + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__slug__istartswith + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__slug__endswith + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__slug__regex + in: query + description: '' + required: false + type: string + - name: created + in: query + description: '' + required: false + type: string + - name: created__gt + in: query + description: '' + required: false + type: string + - name: created__gte + in: query + description: '' + required: false + type: string + - name: created__lt + in: query + description: '' + required: false + type: string + - name: created__lte + in: query + description: '' + required: false + type: string + - name: created__date + in: query + description: '' + required: false + type: string + - name: created__date__gt + in: query + description: '' + required: false + type: string + - name: created__date__gte + in: query + description: '' + required: false + type: string + - name: created__date__lt + in: query + description: '' + required: false + type: string + - name: created__date__lte + in: query + description: '' + required: false + type: string + - name: created__year + in: query + description: '' + required: false + type: number + - name: created__year__gt + in: query + description: '' + required: false + type: number + - name: created__year__gte + in: query + description: '' + required: false + type: number + - name: created__year__lt + in: query + description: '' + required: false + type: number + - name: created__year__lte + in: query + description: '' + required: false + type: number + - name: created__month + in: query + description: '' + required: false + type: number + - name: created__month__lte + in: query + description: '' + required: false + type: number + - name: created__day + in: query + description: '' + required: false + type: number + - name: created__day__lt + in: query + description: '' + required: false + type: number + - name: created__week + in: query + description: '' + required: false + type: number + - name: created__week_day + in: query + description: '' + required: false + type: number + - name: id + in: query + description: '' + required: false + type: number + - name: id__gt + in: query + description: '' + required: false + type: number + - name: id__gte + in: query + description: '' + required: false + type: number + - name: id__lt + in: query + description: '' + required: false + type: number + - name: id__lte + in: query + description: '' + required: false + type: number + - name: id__isnull + in: query + description: '' + required: false + type: string + - name: exit_code + in: query + description: '' + required: false + type: string + - name: exit_code__gt + in: query + description: '' + required: false + type: number + - name: exit_code__gte + in: query + description: '' + required: false + type: number + - name: exit_code__lt + in: query + description: '' + required: false + type: number + - name: exit_code__lte + in: query + description: '' + required: false + type: number + - name: exit_code__isnull + in: query + description: '' + required: false + type: string + - name: simulation_id__in + in: query + description: Multiple values may be separated by commas. + required: false + type: number + - name: simulation__user__username + in: query + description: '' + required: false + type: string + - name: simulation__type__live + in: query + description: '' + required: false + type: string + - name: simulation__tags__contains + in: query + description: '' + required: false + type: string + - name: simulation__organisation__name__istartswith + in: query + description: '' + required: false + type: string + - name: simulation__organisation__unique_id + in: query + description: '' + required: false + type: string + - name: ordering + in: query + description: Which field to use when ordering the results. + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + type: array + items: + $ref: '#/definitions/SimulationStatusStatistics' + tags: + - v3 + parameters: [] + /v3/statuses/{id}/: + get: + operationId: statuses_read + description: '' + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/SimulationStatus' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this simulation status. + required: true + type: integer + /v3/threedimodels/: + get: + operationId: threedimodels_list + description: A simple ViewSet for viewing threedimodels + parameters: + - name: name + in: query + description: '' + required: false + type: string + - name: name__iexact + in: query + description: '' + required: false + type: string + - name: name__contains + in: query + description: '' + required: false + type: string + - name: name__icontains + in: query + description: '' + required: false + type: string + - name: name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: name__startswith + in: query + description: '' + required: false + type: string + - name: name__istartswith + in: query + description: '' + required: false + type: string + - name: name__endswith + in: query + description: '' + required: false + type: string + - name: name__regex + in: query + description: '' + required: false + type: string + - name: slug + in: query + description: '' + required: false + type: string + - name: slug__iexact + in: query + description: '' + required: false + type: string + - name: slug__contains + in: query + description: '' + required: false + type: string + - name: slug__icontains + in: query + description: '' + required: false + type: string + - name: slug__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: slug__startswith + in: query + description: '' + required: false + type: string + - name: slug__istartswith + in: query + description: '' + required: false + type: string + - name: slug__endswith + in: query + description: '' + required: false + type: string + - name: slug__regex + in: query + description: '' + required: false + type: string + - name: epsg + in: query + description: '' + required: false + type: number + - name: id + in: query + description: '' + required: false + type: number + - name: is_valid + in: query + description: '' + required: false + type: string + - name: inpy_version__slug + in: query + description: '' + required: false + type: string + - name: inpy_version__slug__iexact + in: query + description: '' + required: false + type: string + - name: inpy_version__slug__contains + in: query + description: '' + required: false + type: string + - name: inpy_version__slug__icontains + in: query + description: '' + required: false + type: string + - name: inpy_version__slug__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: inpy_version__slug__startswith + in: query + description: '' + required: false + type: string + - name: inpy_version__slug__istartswith + in: query + description: '' + required: false + type: string + - name: inpy_version__slug__endswith + in: query + description: '' + required: false + type: string + - name: inpy_version__slug__regex + in: query + description: '' + required: false + type: string + - name: inpy_version__threedi_version + in: query + description: '' + required: false + type: string + - name: inpy_version__threedi_version__iexact + in: query + description: '' + required: false + type: string + - name: inpy_version__threedi_version__contains + in: query + description: '' + required: false + type: string + - name: inpy_version__threedi_version__icontains + in: query + description: '' + required: false + type: string + - name: inpy_version__threedi_version__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: inpy_version__threedi_version__startswith + in: query + description: '' + required: false + type: string + - name: inpy_version__threedi_version__istartswith + in: query + description: '' + required: false + type: string + - name: inpy_version__threedi_version__endswith + in: query + description: '' + required: false + type: string + - name: inpy_version__threedi_version__regex + in: query + description: '' + required: false + type: string + - name: inpy_version__threedicore_version + in: query + description: '' + required: false + type: string + - name: inpy_version__threedicore_version__iexact + in: query + description: '' + required: false + type: string + - name: inpy_version__threedicore_version__contains + in: query + description: '' + required: false + type: string + - name: inpy_version__threedicore_version__icontains + in: query + description: '' + required: false + type: string + - name: inpy_version__threedicore_version__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: inpy_version__threedicore_version__startswith + in: query + description: '' + required: false + type: string + - name: inpy_version__threedicore_version__istartswith + in: query + description: '' + required: false + type: string + - name: inpy_version__threedicore_version__endswith + in: query + description: '' + required: false + type: string + - name: inpy_version__threedicore_version__regex + in: query + description: '' + required: false + type: string + - name: revision__commit_user__username + in: query + description: '' + required: false + type: string + - name: revision__commit_user__username__istartswith + in: query + description: '' + required: false + type: string + - name: revision__id + in: query + description: '' + required: false + type: number + - name: revision__number + in: query + description: '' + required: false + type: number + - name: revision__number__gt + in: query + description: '' + required: false + type: number + - name: revision__number__gte + in: query + description: '' + required: false + type: number + - name: revision__number__lt + in: query + description: '' + required: false + type: number + - name: revision__number__lte + in: query + description: '' + required: false + type: number + - name: revision__number__isnull + in: query + description: '' + required: false + type: string + - name: revision__hash + in: query + description: '' + required: false + type: string + - name: revision__hash__iexact + in: query + description: '' + required: false + type: string + - name: revision__hash__contains + in: query + description: '' + required: false + type: string + - name: revision__hash__icontains + in: query + description: '' + required: false + type: string + - name: revision__hash__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: revision__hash__startswith + in: query + description: '' + required: false + type: string + - name: revision__hash__istartswith + in: query + description: '' + required: false + type: string + - name: revision__hash__endswith + in: query + description: '' + required: false + type: string + - name: revision__hash__regex + in: query + description: '' + required: false + type: string + - name: revision__schematisation__isnull + in: query + description: '' + required: false + type: string + - name: revision__schematisation__name + in: query + description: '' + required: false + type: string + - name: revision__schematisation__name__iexact + in: query + description: '' + required: false + type: string + - name: revision__schematisation__name__contains + in: query + description: '' + required: false + type: string + - name: revision__schematisation__name__icontains + in: query + description: '' + required: false + type: string + - name: revision__schematisation__name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: revision__schematisation__name__startswith + in: query + description: '' + required: false + type: string + - name: revision__schematisation__name__istartswith + in: query + description: '' + required: false + type: string + - name: revision__schematisation__name__endswith + in: query + description: '' + required: false + type: string + - name: revision__schematisation__name__regex + in: query + description: '' + required: false + type: string + - name: revision__repository__organisation__unique_id + in: query + description: '' + required: false + type: string + - name: revision__repository__organisation__unique_id__iexact + in: query + description: '' + required: false + type: string + - name: revision__repository__organisation__unique_id__contains + in: query + description: '' + required: false + type: string + - name: revision__repository__organisation__unique_id__icontains + in: query + description: '' + required: false + type: string + - name: revision__repository__organisation__unique_id__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: revision__repository__organisation__unique_id__startswith + in: query + description: '' + required: false + type: string + - name: revision__repository__organisation__unique_id__istartswith + in: query + description: '' + required: false + type: string + - name: revision__repository__organisation__unique_id__endswith + in: query + description: '' + required: false + type: string + - name: revision__repository__organisation__unique_id__regex + in: query + description: '' + required: false + type: string + - name: revision__schematisation__owner__unique_id + in: query + description: '' + required: false + type: string + - name: revision__schematisation__id + in: query + description: '' + required: false + type: number + - name: revision__is_pinned + in: query + description: '' + required: false + type: string + - name: revision__schematisation__tags__in + in: query + description: '' + required: false + type: string + - name: disabled + in: query + description: '' + required: false + type: string + - name: inp_success + in: query + description: '' + required: false + type: string + - name: inpy_version__active + in: query + description: '' + required: false + type: string + - name: is_generating + in: query + description: '' + required: false + type: string + - name: ordering + in: query + description: Which field to use when ordering the results. + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/ThreediModel' + tags: + - v3 + post: + operationId: threedimodels_create + description: A simple ViewSet for viewing threedimodels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ThreediModel' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/ThreediModel' + tags: + - v3 + parameters: [] + /v3/threedimodels/{id}/: + get: + operationId: threedimodels_read + description: A simple ViewSet for viewing threedimodels + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ThreediModel' + tags: + - v3 + put: + operationId: threedimodels_update + description: A simple ViewSet for viewing threedimodels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ThreediModel' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ThreediModel' + tags: + - v3 + patch: + operationId: threedimodels_partial_update + description: A simple ViewSet for viewing threedimodels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ThreediModel' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ThreediModel' + tags: + - v3 + delete: + operationId: threedimodels_delete + summary: Soft-delete the threedimodel (sets disabled to True) + description: |- + If the model is already disabled and the user is a superuser, delete + the threedimodel. + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/all/download/: + get: + operationId: threedimodels_geojson_download + description: Endpoint for downloading geojson file. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/all/upload/: + post: + operationId: threedimodels_geojson_upload + description: |- + Endpoint for uploading the geojson file + Replaces the geojson file if there already exists one. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/breaches/download/: + get: + operationId: threedimodels_geojson_breaches_download + description: A simple ViewSet for viewing threedimodels + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/breaches/upload/: + post: + operationId: threedimodels_breaches_geojson_upload + description: A simple ViewSet for viewing threedimodels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/cells/download/: + get: + operationId: threedimodels_geojson_cells_download + description: Note that this is the subset of 2d open_water cells + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/cells/upload/: + post: + operationId: threedimodels_cells_geojson_upload + description: A simple ViewSet for viewing threedimodels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/channels/download/: + get: + operationId: threedimodels_geojson_channels_download + description: A simple ViewSet for viewing threedimodels + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/channels/upload/: + post: + operationId: threedimodels_channels_geojson_upload + description: A simple ViewSet for viewing threedimodels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/culverts/download/: + get: + operationId: threedimodels_geojson_culverts_download + description: A simple ViewSet for viewing threedimodels + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/culverts/upload/: + post: + operationId: threedimodels_culverts_geojson_upload + description: A simple ViewSet for viewing threedimodels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/flowlines/download/: + get: + operationId: threedimodels_geojson_flowlines_download + description: Note that this is a subset of all lines + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/flowlines/upload/: + post: + operationId: threedimodels_flowlines_geojson_upload + description: A simple ViewSet for viewing threedimodels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/levees/download/: + get: + operationId: threedimodels_geojson_levees_download + description: A simple ViewSet for viewing threedimodels + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/levees/upload/: + post: + operationId: threedimodels_levees_geojson_upload + description: A simple ViewSet for viewing threedimodels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/manholes/download/: + get: + operationId: threedimodels_geojson_manholes_download + description: A simple ViewSet for viewing threedimodels + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/manholes/upload/: + post: + operationId: threedimodels_manholes_geojson_upload + description: A simple ViewSet for viewing threedimodels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/orifices/download/: + get: + operationId: threedimodels_geojson_orifices_download + description: A simple ViewSet for viewing threedimodels + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/orifices/upload/: + post: + operationId: threedimodels_orifices_geojson_upload + description: A simple ViewSet for viewing threedimodels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/pipes/download/: + get: + operationId: threedimodels_geojson_pipes_download + description: A simple ViewSet for viewing threedimodels + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/pipes/upload/: + post: + operationId: threedimodels_pipes_geojson_upload + description: A simple ViewSet for viewing threedimodels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/pumps/download/: + get: + operationId: threedimodels_geojson_pumps_download + description: A simple ViewSet for viewing threedimodels + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/pumps/upload/: + post: + operationId: threedimodels_pumps_geojson_upload + description: A simple ViewSet for viewing threedimodels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/weirs/download/: + get: + operationId: threedimodels_geojson_weirs_download + description: A simple ViewSet for viewing threedimodels + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geojson/weirs/upload/: + post: + operationId: threedimodels_weirs_geojson_upload + description: A simple ViewSet for viewing threedimodels + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geopackage/download/: + get: + operationId: threedimodels_geopackage_download + description: Endpoint for downloading geopackage file. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/geopackage/upload/: + post: + operationId: threedimodels_geopackage_upload + summary: Endpoint for uploading the gridadmin file + description: Replaces the gridadmin if there already exists one. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/gridadmin/download/: + get: + operationId: threedimodels_gridadmin_download + description: Endpoint for downloading files. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/gridadmin/upload/: + post: + operationId: threedimodels_gridadmin_upload + summary: Endpoint for uploading the gridadmin file + description: Replaces the gridadmin if there already exists one. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/raster_options/: + get: + operationId: threedimodels_raster_options + description: A simple ViewSet for viewing threedimodels + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/RasterOptions' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/tables/download/: + get: + operationId: threedimodels_tables_download + description: Endpoint for downloading tables files. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{id}/tables/upload/: + post: + operationId: threedimodels_tables_upload + summary: Endpoint for uploading the tables.h5 file + description: Replaces the tables file if there already exists one. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model. + required: true + type: integer + /v3/threedimodels/{threedimodel_pk}/boundaryconditions/: + get: + operationId: threedimodels_boundaryconditions_list + description: A simple ViewSet for viewing boundary conditions + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/BoundaryCondition' + tags: + - v3 + post: + operationId: threedimodels_boundaryconditions_create + description: A simple ViewSet for viewing boundary conditions + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/BoundaryCondition' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/BoundaryCondition' + tags: + - v3 + parameters: + - name: threedimodel_pk + in: path + required: true + type: string + /v3/threedimodels/{threedimodel_pk}/boundaryconditions/{id}/: + get: + operationId: threedimodels_boundaryconditions_read + description: A simple ViewSet for viewing boundary conditions + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/BoundaryCondition' + tags: + - v3 + put: + operationId: threedimodels_boundaryconditions_update + description: A simple ViewSet for viewing boundary conditions + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/BoundaryCondition' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/BoundaryCondition' + tags: + - v3 + patch: + operationId: threedimodels_boundaryconditions_partial_update + description: A simple ViewSet for viewing boundary conditions + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/BoundaryCondition' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/BoundaryCondition' + tags: + - v3 + delete: + operationId: threedimodels_boundaryconditions_delete + description: A simple ViewSet for viewing boundary conditions + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this boundary condition. + required: true + type: integer + - name: threedimodel_pk + in: path + required: true + type: string + /v3/threedimodels/{threedimodel_pk}/bulk_rasters/: + post: + operationId: threedimodels_bulk_rasters_create + description: '' + parameters: + - name: data + in: body + required: true + schema: + type: array + items: + $ref: '#/definitions/Raster' + responses: + '201': + description: '' + schema: + type: array + items: + $ref: '#/definitions/Raster' + tags: + - v3 + parameters: + - name: threedimodel_pk + in: path + required: true + type: string + /v3/threedimodels/{threedimodel_pk}/initial_waterlevels/: + get: + operationId: threedimodels_initial_waterlevels_list + description: |- + ## Description + Initial waterlevels on threedimodels can be used in a simulation to specify the initial + waterlevels on the 1D and/or 2D domain. + + ### Initial waterlevels from schematisation + 1D and 2D initial waterlevels in the schematisation are automatically picked up + during the creation of the threedimodel. + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/InitialWaterlevel' + tags: + - v3 + post: + operationId: threedimodels_initial_waterlevels_create + summary: Add new initial waterlevels + description: |- + ### Adding (extra) 1D initial waterlevels + Extra 1D initial waterlevels can be added by posting: + + {"dimension": "one_d"} + + Using the 'id' value from the response, a JSON file needs to be uploaded via the PUT_URL retrieved from + `initial_waterlevels/{id}/upload/` in the following JSON format: + + Python code: + + import json + file_contents = json.dumps({ + "node_ids": [node_id_1, node_id2, ....], + "values" : [value_for_node_id_1, value_for_node_id_2, ...] + }) + + # Notes: + # - Omitted values are considered dry. + # - `node_ids` need to be sorted and unique + # - Make sure that the positions of the node_id's and values match. + + ### Adding (extra) 2D initial waterlevels + 2D initial waterlevels can be added by uploading an 'initial_waterlevel_file' Geotiff raster via `rasters/{id}/upload/`. + This automatically triggers the creation of a 2D initial waterlevel. The source raster is + linked as 'source_raster'. The values in the `source_raster` are aggregated per node using + max, min and mean operators. The resulting values are stored in a file linked under `file`. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/InitialWaterlevel' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/InitialWaterlevel' + tags: + - v3 + parameters: + - name: threedimodel_pk + in: path + required: true + type: string + /v3/threedimodels/{threedimodel_pk}/initial_waterlevels/{id}/: + get: + operationId: threedimodels_initial_waterlevels_read + description: |- + ## Description + Initial waterlevels on threedimodels can be used in a simulation to specify the initial + waterlevels on the 1D and/or 2D domain. + + ### Initial waterlevels from schematisation + 1D and 2D initial waterlevels in the schematisation are automatically picked up + during the creation of the threedimodel. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/InitialWaterlevel' + tags: + - v3 + put: + operationId: threedimodels_initial_waterlevels_update + description: |- + ## Description + Initial waterlevels on threedimodels can be used in a simulation to specify the initial + waterlevels on the 1D and/or 2D domain. + + ### Initial waterlevels from schematisation + 1D and 2D initial waterlevels in the schematisation are automatically picked up + during the creation of the threedimodel. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/InitialWaterlevel' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/InitialWaterlevel' + tags: + - v3 + patch: + operationId: threedimodels_initial_waterlevels_partial_update + description: |- + ## Description + Initial waterlevels on threedimodels can be used in a simulation to specify the initial + waterlevels on the 1D and/or 2D domain. + + ### Initial waterlevels from schematisation + 1D and 2D initial waterlevels in the schematisation are automatically picked up + during the creation of the threedimodel. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/InitialWaterlevel' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/InitialWaterlevel' + tags: + - v3 + delete: + operationId: threedimodels_initial_waterlevels_delete + description: Delete initial waterlevel + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this initial waterlevel. + required: true + type: integer + - name: threedimodel_pk + in: path + required: true + type: string + /v3/threedimodels/{threedimodel_pk}/initial_waterlevels/{id}/download/: + get: + operationId: threedimodels_initial_waterlevels_download + description: Endpoint for downloading files. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this initial waterlevel. + required: true + type: integer + - name: threedimodel_pk + in: path + required: true + type: string + /v3/threedimodels/{threedimodel_pk}/initial_waterlevels/{id}/processed/: + put: + operationId: threedimodels_initial_waterlevels_processed + description: |- + ## Description + Initial waterlevels on threedimodels can be used in a simulation to specify the initial + waterlevels on the 1D and/or 2D domain. + + ### Initial waterlevels from schematisation + 1D and 2D initial waterlevels in the schematisation are automatically picked up + during the creation of the threedimodel. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/BaseEventState' + responses: + '200': + description: OK + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this initial waterlevel. + required: true + type: integer + - name: threedimodel_pk + in: path + required: true + type: string + /v3/threedimodels/{threedimodel_pk}/initial_waterlevels/{id}/upload/: + post: + operationId: threedimodels_initial_waterlevels_upload + description: |- + Endpoint for uploading an initial waterlevel file, see the POST + endpoint for documentation about the file format. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this initial waterlevel. + required: true + type: integer + - name: threedimodel_pk + in: path + required: true + type: string + /v3/threedimodels/{threedimodel_pk}/potentialbreaches/: + get: + operationId: threedimodels_potentialbreaches_list + description: A simple ViewSet for viewing breaches + parameters: + - name: connected_pnt_id + in: query + description: '' + required: false + type: number + - name: connected_pnt_id__gt + in: query + description: '' + required: false + type: number + - name: connected_pnt_id__gte + in: query + description: '' + required: false + type: number + - name: connected_pnt_id__lt + in: query + description: '' + required: false + type: number + - name: connected_pnt_id__lte + in: query + description: '' + required: false + type: number + - name: connected_pnt_id__isnull + in: query + description: '' + required: false + type: string + - name: threedimodel__id + in: query + description: '' + required: false + type: number + - name: threedimodel__id__gt + in: query + description: '' + required: false + type: number + - name: threedimodel__id__gte + in: query + description: '' + required: false + type: number + - name: threedimodel__id__lt + in: query + description: '' + required: false + type: number + - name: threedimodel__id__lte + in: query + description: '' + required: false + type: number + - name: threedimodel__id__isnull + in: query + description: '' + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/PotentialBreach' + tags: + - v3 + post: + operationId: threedimodels_potentialbreaches_create + description: A simple ViewSet for viewing breaches + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/PotentialBreach' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/PotentialBreach' + tags: + - v3 + parameters: + - name: threedimodel_pk + in: path + required: true + type: string + /v3/threedimodels/{threedimodel_pk}/potentialbreaches/{id}/: + get: + operationId: threedimodels_potentialbreaches_read + description: A simple ViewSet for viewing breaches + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/PotentialBreach' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this potential breach. + required: true + type: integer + - name: threedimodel_pk + in: path + required: true + type: string + /v3/threedimodels/{threedimodel_pk}/rasters/: + get: + operationId: threedimodels_rasters_list + description: View rasters for threedimodel + parameters: + - name: type + in: query + description: '' + required: false + type: string + - name: type__iexact + in: query + description: '' + required: false + type: string + - name: type__contains + in: query + description: '' + required: false + type: string + - name: type__icontains + in: query + description: '' + required: false + type: string + - name: type__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: type__startswith + in: query + description: '' + required: false + type: string + - name: type__istartswith + in: query + description: '' + required: false + type: string + - name: type__endswith + in: query + description: '' + required: false + type: string + - name: type__regex + in: query + description: '' + required: false + type: string + - name: name + in: query + description: '' + required: false + type: string + - name: name__iexact + in: query + description: '' + required: false + type: string + - name: name__contains + in: query + description: '' + required: false + type: string + - name: name__icontains + in: query + description: '' + required: false + type: string + - name: name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: name__startswith + in: query + description: '' + required: false + type: string + - name: name__istartswith + in: query + description: '' + required: false + type: string + - name: name__endswith + in: query + description: '' + required: false + type: string + - name: name__regex + in: query + description: '' + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/Raster' + tags: + - v3 + post: + operationId: threedimodels_rasters_create + description: View rasters for threedimodel + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Raster' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Raster' + tags: + - v3 + parameters: + - name: threedimodel_pk + in: path + required: true + type: string + /v3/threedimodels/{threedimodel_pk}/rasters/{id}/: + get: + operationId: threedimodels_rasters_read + description: View rasters for threedimodel + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Raster' + tags: + - v3 + put: + operationId: threedimodels_rasters_update + description: View rasters for threedimodel + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Raster' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Raster' + tags: + - v3 + patch: + operationId: threedimodels_rasters_partial_update + description: View rasters for threedimodel + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Raster' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Raster' + tags: + - v3 + delete: + operationId: threedimodels_rasters_delete + description: View rasters for threedimodel + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this raster. + required: true + type: integer + - name: threedimodel_pk + in: path + required: true + type: string + /v3/threedimodels/{threedimodel_pk}/rasters/{id}/download/: + get: + operationId: threedimodels_rasters_download + description: Endpoint for downloading files. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Download' + '400': + description: File is not uploaded yet or has been removed + '404': + description: File not found + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this raster. + required: true + type: integer + - name: threedimodel_pk + in: path + required: true + type: string + /v3/threedimodels/{threedimodel_pk}/rasters/{id}/upload/: + post: + operationId: threedimodels_rasters_upload + description: Endpoint for uploading a raster. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Upload' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/Upload' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this raster. + required: true + type: integer + - name: threedimodel_pk + in: path + required: true + type: string + /v3/threedimodels/{threedimodel_pk}/saved_states/: + get: + operationId: threedimodels_saved_states_list + description: View saved states created for this 3Di model + parameters: + - name: ordering + in: query + description: Which field to use when ordering the results. + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/ThreediModelSavedState' + tags: + - v3 + parameters: + - name: threedimodel_pk + in: path + required: true + type: string + /v3/threedimodels/{threedimodel_pk}/saved_states/{id}/: + get: + operationId: threedimodels_saved_states_read + description: View saved states created for this 3Di model + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ThreediModelSavedState' + tags: + - v3 + delete: + operationId: threedimodels_saved_states_delete + description: View saved states created for this 3Di model + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this saved state. + required: true + type: integer + - name: threedimodel_pk + in: path + required: true + type: string + /v3/threedimodels/{threedimodel_pk}/tasks/: + get: + operationId: threedimodels_tasks_list + description: View threedimodel tasks + parameters: + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/ThreediModelTask' + tags: + - v3 + post: + operationId: threedimodels_tasks_create + description: View threedimodel tasks + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ThreediModelTask' + responses: + '201': + description: '' + schema: + $ref: '#/definitions/ThreediModelTask' + tags: + - v3 + parameters: + - name: threedimodel_pk + in: path + required: true + type: string + /v3/threedimodels/{threedimodel_pk}/tasks/{id}/: + get: + operationId: threedimodels_tasks_read + description: View threedimodel tasks + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ThreediModelTask' + tags: + - v3 + put: + operationId: threedimodels_tasks_update + description: View threedimodel tasks + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ThreediModelTask' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ThreediModelTask' + tags: + - v3 + patch: + operationId: threedimodels_tasks_partial_update + description: View threedimodel tasks + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/ThreediModelTask' + responses: + '200': + description: '' + schema: + $ref: '#/definitions/ThreediModelTask' + tags: + - v3 + delete: + operationId: threedimodels_tasks_delete + description: View threedimodel tasks + parameters: [] + responses: + '204': + description: '' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this threedi model task. + required: true + type: integer + - name: threedimodel_pk + in: path + required: true + type: string + /v3/usage/: + get: + operationId: usage_list + summary: View to display overview of ran simulations. + description: Only displays finished/crashed simulations. + parameters: + - name: started__gt + in: query + description: '' + required: false + type: string + - name: started__gte + in: query + description: '' + required: false + type: string + - name: started__lt + in: query + description: '' + required: false + type: string + - name: started__lte + in: query + description: '' + required: false + type: string + - name: started__date + in: query + description: '' + required: false + type: string + - name: started__date__gt + in: query + description: '' + required: false + type: string + - name: started__date__gte + in: query + description: '' + required: false + type: string + - name: started__date__lt + in: query + description: '' + required: false + type: string + - name: started__date__lte + in: query + description: '' + required: false + type: string + - name: started__year + in: query + description: '' + required: false + type: number + - name: started__year__gt + in: query + description: '' + required: false + type: number + - name: started__year__gte + in: query + description: '' + required: false + type: number + - name: started__year__lt + in: query + description: '' + required: false + type: number + - name: started__year__lte + in: query + description: '' + required: false + type: number + - name: started__month + in: query + description: '' + required: false + type: number + - name: started__month__lte + in: query + description: '' + required: false + type: number + - name: finished__gt + in: query + description: '' + required: false + type: string + - name: finished__gte + in: query + description: '' + required: false + type: string + - name: finished__lt + in: query + description: '' + required: false + type: string + - name: finished__lte + in: query + description: '' + required: false + type: string + - name: finished__date + in: query + description: '' + required: false + type: string + - name: finished__date__gt + in: query + description: '' + required: false + type: string + - name: finished__date__gte + in: query + description: '' + required: false + type: string + - name: finished__date__lt + in: query + description: '' + required: false + type: string + - name: finished__date__lte + in: query + description: '' + required: false + type: string + - name: finished__year + in: query + description: '' + required: false + type: number + - name: finished__year__gt + in: query + description: '' + required: false + type: number + - name: finished__year__gte + in: query + description: '' + required: false + type: number + - name: finished__year__lt + in: query + description: '' + required: false + type: number + - name: finished__year__lte + in: query + description: '' + required: false + type: number + - name: finished__month + in: query + description: '' + required: false + type: number + - name: finished__month__lte + in: query + description: '' + required: false + type: number + - name: total_time + in: query + description: '' + required: false + type: number + - name: total_time__gt + in: query + description: '' + required: false + type: number + - name: total_time__gte + in: query + description: '' + required: false + type: number + - name: total_time__lt + in: query + description: '' + required: false + type: number + - name: total_time__lte + in: query + description: '' + required: false + type: number + - name: total_time__isnull + in: query + description: '' + required: false + type: string + - name: simulation__id + in: query + description: '' + required: false + type: number + - name: simulation__name + in: query + description: '' + required: false + type: string + - name: simulation__name__iexact + in: query + description: '' + required: false + type: string + - name: simulation__name__contains + in: query + description: '' + required: false + type: string + - name: simulation__name__icontains + in: query + description: '' + required: false + type: string + - name: simulation__name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: simulation__name__startswith + in: query + description: '' + required: false + type: string + - name: simulation__name__istartswith + in: query + description: '' + required: false + type: string + - name: simulation__name__endswith + in: query + description: '' + required: false + type: string + - name: simulation__name__regex + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__id + in: query + description: '' + required: false + type: number + - name: simulation__threedimodel__id__gt + in: query + description: '' + required: false + type: number + - name: simulation__threedimodel__id__gte + in: query + description: '' + required: false + type: number + - name: simulation__threedimodel__id__lt + in: query + description: '' + required: false + type: number + - name: simulation__threedimodel__id__lte + in: query + description: '' + required: false + type: number + - name: simulation__threedimodel__id__isnull + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__name + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__name__iexact + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__name__contains + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__name__icontains + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: simulation__threedimodel__name__startswith + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__name__istartswith + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__name__endswith + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__name__regex + in: query + description: '' + required: false + type: string + - name: simulation__user__username + in: query + description: '' + required: false + type: string + - name: simulation__user__username__iexact + in: query + description: '' + required: false + type: string + - name: simulation__user__username__contains + in: query + description: '' + required: false + type: string + - name: simulation__user__username__icontains + in: query + description: '' + required: false + type: string + - name: simulation__user__username__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: simulation__user__username__startswith + in: query + description: '' + required: false + type: string + - name: simulation__user__username__istartswith + in: query + description: '' + required: false + type: string + - name: simulation__user__username__endswith + in: query + description: '' + required: false + type: string + - name: simulation__user__username__regex + in: query + description: '' + required: false + type: string + - name: simulation__active_status__name + in: query + description: '' + required: false + type: string + - name: simulation__active_status__name__iexact + in: query + description: '' + required: false + type: string + - name: simulation__active_status__name__contains + in: query + description: '' + required: false + type: string + - name: simulation__active_status__name__icontains + in: query + description: '' + required: false + type: string + - name: simulation__active_status__name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: simulation__active_status__name__startswith + in: query + description: '' + required: false + type: string + - name: simulation__active_status__name__istartswith + in: query + description: '' + required: false + type: string + - name: simulation__active_status__name__endswith + in: query + description: '' + required: false + type: string + - name: simulation__active_status__name__regex + in: query + description: '' + required: false + type: string + - name: simulation__type__live + in: query + description: '' + required: false + type: string + - name: simulation__organisation__name__istartswith + in: query + description: '' + required: false + type: string + - name: simulation__organisation__unique_id + in: query + description: '' + required: false + type: string + - name: simulation__status + in: query + description: '' + required: false + type: string + - name: simulation__tags__in + in: query + description: '' + required: false + type: string + - name: ordering + in: query + description: Which field to use when ordering the results. + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + required: + - count + - results + type: object + properties: + count: + type: integer + next: + type: string + format: uri + x-nullable: true + previous: + type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/Usage' + tags: + - v3 + parameters: [] + /v3/usage/statistics/: + get: + operationId: usage_statistics + summary: |- + Usage statistics like total session count, average session + duration and such. + description: |- + This endpoint comes in handy if you want to aggregate usage + number over a certain period of time, for a given user or organisation. + + It is also possible to limit the result to a certain simulation type, + e.g. to "live" sessions. Use the `simulation__type__live` filter with + either `true` or `false` as input values. + parameters: + - name: started__gt + in: query + description: '' + required: false + type: string + - name: started__gte + in: query + description: '' + required: false + type: string + - name: started__lt + in: query + description: '' + required: false + type: string + - name: started__lte + in: query + description: '' + required: false + type: string + - name: started__date + in: query + description: '' + required: false + type: string + - name: started__date__gt + in: query + description: '' + required: false + type: string + - name: started__date__gte + in: query + description: '' + required: false + type: string + - name: started__date__lt + in: query + description: '' + required: false + type: string + - name: started__date__lte + in: query + description: '' + required: false + type: string + - name: started__year + in: query + description: '' + required: false + type: number + - name: started__year__gt + in: query + description: '' + required: false + type: number + - name: started__year__gte + in: query + description: '' + required: false + type: number + - name: started__year__lt + in: query + description: '' + required: false + type: number + - name: started__year__lte + in: query + description: '' + required: false + type: number + - name: started__month + in: query + description: '' + required: false + type: number + - name: started__month__lte + in: query + description: '' + required: false + type: number + - name: finished__gt + in: query + description: '' + required: false + type: string + - name: finished__gte + in: query + description: '' + required: false + type: string + - name: finished__lt + in: query + description: '' + required: false + type: string + - name: finished__lte + in: query + description: '' + required: false + type: string + - name: finished__date + in: query + description: '' + required: false + type: string + - name: finished__date__gt + in: query + description: '' + required: false + type: string + - name: finished__date__gte + in: query + description: '' + required: false + type: string + - name: finished__date__lt + in: query + description: '' + required: false + type: string + - name: finished__date__lte + in: query + description: '' + required: false + type: string + - name: finished__year + in: query + description: '' + required: false + type: number + - name: finished__year__gt + in: query + description: '' + required: false + type: number + - name: finished__year__gte + in: query + description: '' + required: false + type: number + - name: finished__year__lt + in: query + description: '' + required: false + type: number + - name: finished__year__lte + in: query + description: '' + required: false + type: number + - name: finished__month + in: query + description: '' + required: false + type: number + - name: finished__month__lte + in: query + description: '' + required: false + type: number + - name: total_time + in: query + description: '' + required: false + type: number + - name: total_time__gt + in: query + description: '' + required: false + type: number + - name: total_time__gte + in: query + description: '' + required: false + type: number + - name: total_time__lt + in: query + description: '' + required: false + type: number + - name: total_time__lte + in: query + description: '' + required: false + type: number + - name: total_time__isnull + in: query + description: '' + required: false + type: string + - name: simulation__id + in: query + description: '' + required: false + type: number + - name: simulation__name + in: query + description: '' + required: false + type: string + - name: simulation__name__iexact + in: query + description: '' + required: false + type: string + - name: simulation__name__contains + in: query + description: '' + required: false + type: string + - name: simulation__name__icontains + in: query + description: '' + required: false + type: string + - name: simulation__name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: simulation__name__startswith + in: query + description: '' + required: false + type: string + - name: simulation__name__istartswith + in: query + description: '' + required: false + type: string + - name: simulation__name__endswith + in: query + description: '' + required: false + type: string + - name: simulation__name__regex + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__id + in: query + description: '' + required: false + type: number + - name: simulation__threedimodel__id__gt + in: query + description: '' + required: false + type: number + - name: simulation__threedimodel__id__gte + in: query + description: '' + required: false + type: number + - name: simulation__threedimodel__id__lt + in: query + description: '' + required: false + type: number + - name: simulation__threedimodel__id__lte + in: query + description: '' + required: false + type: number + - name: simulation__threedimodel__id__isnull + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__name + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__name__iexact + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__name__contains + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__name__icontains + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: simulation__threedimodel__name__startswith + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__name__istartswith + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__name__endswith + in: query + description: '' + required: false + type: string + - name: simulation__threedimodel__name__regex + in: query + description: '' + required: false + type: string + - name: simulation__user__username + in: query + description: '' + required: false + type: string + - name: simulation__user__username__iexact + in: query + description: '' + required: false + type: string + - name: simulation__user__username__contains + in: query + description: '' + required: false + type: string + - name: simulation__user__username__icontains + in: query + description: '' + required: false + type: string + - name: simulation__user__username__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: simulation__user__username__startswith + in: query + description: '' + required: false + type: string + - name: simulation__user__username__istartswith + in: query + description: '' + required: false + type: string + - name: simulation__user__username__endswith + in: query + description: '' + required: false + type: string + - name: simulation__user__username__regex + in: query + description: '' + required: false + type: string + - name: simulation__active_status__name + in: query + description: '' + required: false + type: string + - name: simulation__active_status__name__iexact + in: query + description: '' + required: false + type: string + - name: simulation__active_status__name__contains + in: query + description: '' + required: false + type: string + - name: simulation__active_status__name__icontains + in: query + description: '' + required: false + type: string + - name: simulation__active_status__name__in + in: query + description: Multiple values may be separated by commas. + required: false + type: string + - name: simulation__active_status__name__startswith + in: query + description: '' + required: false + type: string + - name: simulation__active_status__name__istartswith + in: query + description: '' + required: false + type: string + - name: simulation__active_status__name__endswith + in: query + description: '' + required: false + type: string + - name: simulation__active_status__name__regex + in: query + description: '' + required: false + type: string + - name: simulation__type__live + in: query + description: '' + required: false + type: string + - name: simulation__organisation__name__istartswith + in: query + description: '' + required: false + type: string + - name: simulation__organisation__unique_id + in: query + description: '' + required: false + type: string + - name: simulation__status + in: query + description: '' + required: false + type: string + - name: simulation__tags__in + in: query + description: '' + required: false + type: string + - name: ordering + in: query + description: Which field to use when ordering the results. + required: false + type: string + - name: limit + in: query + description: Number of results to return per page. + required: false + type: integer + - name: offset + in: query + description: The initial index from which to return the results. + required: false + type: integer + responses: + '200': + description: '' + schema: + $ref: '#/definitions/UsageStatistics' + tags: + - v3 + parameters: [] + /v3/usage/{id}/: + get: + operationId: usage_read + summary: View to display overview of ran simulations. + description: Only displays finished/crashed simulations. + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/Usage' + tags: + - v3 + parameters: + - name: id + in: path + description: A unique integer value identifying this usage. + required: true + type: integer +definitions: + PersonalAPIKey: + required: + - scope + - name + type: object + properties: + prefix: + title: Prefix + type: string + readOnly: true + minLength: 1 + scope: + title: Scope + description: "A space-separated list of scopes (options: basic simulate create\ + \ lizardrain lizardprocess manageusers managecontracts test livesite). Alternatively,\ + \ use '*:readwrite' for all scopes." + type: string + minLength: 1 + name: + title: Name + description: A free-form name for the API key. Need not be unique. 50 characters + max. + type: string + maxLength: 50 + minLength: 1 + expiry_date: + title: Expires + description: Once API key expires, clients cannot use it anymore. + type: string + format: date-time + x-nullable: true + created: + title: Created + type: string + format: date-time + readOnly: true + revoked: + title: Revoked + description: If the API key is revoked, clients cannot use it anymore. (This + cannot be undone.) + type: boolean + last_used: + title: Last used + description: Last time the API key was used. + type: string + format: date + readOnly: true + x-nullable: true + PersonalAPIKeyWithSecret: + required: + - scope + - name + type: object + properties: + prefix: + title: Prefix + type: string + readOnly: true + minLength: 1 + scope: + title: Scope + description: "A space-separated list of scopes (options: basic simulate create\ + \ lizardrain lizardprocess manageusers managecontracts test livesite). Alternatively,\ + \ use '*:readwrite' for all scopes." + type: string + minLength: 1 + name: + title: Name + description: A free-form name for the API key. Need not be unique. 50 characters + max. + type: string + maxLength: 50 + minLength: 1 + expiry_date: + title: Expires + description: Once API key expires, clients cannot use it anymore. + type: string + format: date-time + x-nullable: true + created: + title: Created + type: string + format: date-time + readOnly: true + revoked: + title: Revoked + description: If the API key is revoked, clients cannot use it anymore. (This + cannot be undone.) + type: boolean + last_used: + title: Last used + description: Last time the API key was used. + type: string + format: date + readOnly: true + x-nullable: true + key: + title: Key + description: The API key. Please store the key somewhere safe, you will not + be able to see it again. + type: string + readOnly: true + minLength: 1 + message: + title: Message + type: string + readOnly: true + minLength: 1 + CopyToThreediModel: + required: + - threedimodel + type: object + properties: + threedimodel: + title: Threedimodel + type: integer + name: + title: Name + type: string + maxLength: 128 + minLength: 1 + tags: + type: array + items: + type: string + x-nullable: true + clone_events: + title: Clone events + type: boolean + default: true + clone_initials: + title: Clone initials + type: boolean + default: true + clone_settings: + title: Clone settings + type: boolean + default: true + ObstacleEdit: + required: + - offset + - value + - linestring + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + value: + title: Value + description: Absolute or relative height (in meters) to use for the linestring + type: number + linestring: + title: Linestring + type: object + description: Linestring (epsg:4326) specified in wkt or geojson. Coordinates + in longitude, latitude order. + required: + - type + - coordinates + properties: + type: + title: type + description: Type should always be 'linestring' or 'LINESTRING' + type: string + default: Linestring + coordinates: + title: coordinates + description: List of coordinates. (longitude, latitude order) + type: array + items: + type: array + items: + type: number + minItems: 2 + maxItems: 2 + minItems: 2 + example: + type: LineString + coordinates: + - - 4.668275805499175 + - 52.619558913867856 + - - 4.73849433310911 + - 52.66453976184968 + state: + title: State + type: string + enum: + - processing + - valid + - invalid + readOnly: true + state_detail: + title: State detail + type: object + readOnly: true + x-nullable: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + BaseEventState: + required: + - state + - state_detail + type: object + properties: + state: + title: State + type: string + enum: + - processing + - valid + - invalid + state_detail: + title: State detail + type: object + RasterEditUrls: + required: + - raster_type + - url + type: object + properties: + raster_type: + title: Raster type + type: string + minLength: 1 + url: + title: Url + type: string + OneDSubstanceConcentration: + required: + - substance + - initial_concentration + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + substance: + title: Substance + type: string + format: uri + substance_id: + title: Substance id + type: integer + readOnly: true + substance_name: + title: Substance name + type: string + readOnly: true + initial_concentration: + title: Initial concentration + type: string + format: uri + initial_concentration_id: + title: Initial concentration id + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + TwoDSubstanceConcentration: + required: + - aggregation_method + - substance + - initial_concentration + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + aggregation_method: + title: Aggregation method + type: string + enum: + - mean + - max + - min + substance: + title: Substance + type: string + format: uri + substance_id: + title: Substance id + type: integer + readOnly: true + substance_name: + title: Substance name + type: string + readOnly: true + initial_concentration: + title: Initial concentration + type: string + format: uri + initial_concentration_id: + title: Initial concentration id + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + Substance: + required: + - name + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + name: + title: Name + type: string + maxLength: 1024 + minLength: 1 + id: + title: ID + type: integer + readOnly: true + Status: + type: object + properties: + status: + title: Status + type: string + readOnly: true + CurrentVersion: + type: object + properties: + threedi_version: + title: Threedi version + type: string + readOnly: true + threedicore_version: + title: Threedicore version + type: string + readOnly: true + FileReadOnly: + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + filename: + title: Filename + type: string + readOnly: true + minLength: 1 + state: + title: State + type: string + enum: + - created + - uploaded + - processed + - error + - removed + readOnly: true + state_description: + title: State description + type: string + maxLength: 512 + x-nullable: true + type: + title: Type + type: string + enum: + - timeseries + - rastertimeseries + - savedstate + - results + - rasters + - gridadmin + - geopackage + - geojson + - initialwaterlevel + - initial_substance_concentration + - bulklateral + - bulkcontrol + - bulk_boundaryconditions + - sqlite + - tables + readOnly: true + size: + title: Size + description: Filesize in bytes + type: integer + readOnly: true + x-nullable: true + etag: + title: Etag + description: Optional eTag (md5sum) + type: string + maxLength: 256 + x-nullable: true + expiry_date: + title: Expiry date + type: string + format: date + readOnly: true + id: + title: ID + type: integer + readOnly: true + meta: + title: Meta + type: object + readOnly: true + x-nullable: true + InitialConcentration: + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + threedimodel: + title: Threedimodel + type: string + format: uri + readOnly: true + user_generated: + title: User generated + type: boolean + file: + $ref: '#/definitions/FileReadOnly' + source_raster: + title: Source raster + type: string + format: uri + state: + title: State + type: string + enum: + - processing + - valid + - invalid + readOnly: true + state_detail: + title: State detail + type: object + readOnly: true + x-nullable: true + id: + title: ID + type: integer + readOnly: true + source_raster_id: + title: Source raster id + type: integer + readOnly: true + dimension: + title: Dimension + type: string + enum: + - one_d + - two_d + Download: + type: object + properties: + get_url: + title: Get url + type: string + readOnly: true + is_internal: + title: Is internal + type: boolean + default: true + etag: + title: Etag + description: Optional eTag (md5sum) + type: string + readOnly: true + minLength: 1 + x-nullable: true + size: + title: Size + description: Filesize in bytes + type: integer + readOnly: true + x-nullable: true + Upload: + required: + - filename + type: object + properties: + put_url: + title: Put url + type: string + format: uri + readOnly: true + minLength: 1 + filename: + title: Filename + type: string + maxLength: 255 + minLength: 1 + status: + title: Status + type: string + readOnly: true + minLength: 1 + User: + required: + - username + type: object + properties: + id: + title: ID + type: integer + readOnly: true + username: + title: Username + description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ + only. + type: string + pattern: ^[\w.@+-]+$ + maxLength: 150 + minLength: 1 + first_name: + title: First name + type: string + maxLength: 150 + last_name: + title: Last name + type: string + maxLength: 150 + email: + title: Email address + type: string + format: email + maxLength: 254 + Refresh: + required: + - refresh + type: object + properties: + refresh: + title: Refresh + type: string + minLength: 1 + access: + title: Access + type: string + readOnly: true + minLength: 1 + Tokens: + type: object + properties: + access: + title: Access + type: string + minLength: 1 + refresh: + title: Refresh + type: string + minLength: 1 + Authenticate: + type: object + properties: + username: + title: Username + type: string + minLength: 1 + password: + title: Password + type: string + minLength: 1 + UserTokens: + required: + - user + - external_user_id + type: object + properties: + user: + title: User + type: integer + external_user_id: + title: External user id + description: The user ID in the external identity provider, which is present + as the 'sub' field in tokens. + type: string + maxLength: 255 + minLength: 1 + created: + title: Created + type: string + format: date-time + readOnly: true + last_modified: + title: Last modified + description: The last time this remote user logged in. + type: string + format: date-time + readOnly: true + id_token: + title: Id token + description: The most recent ID token provided by the external identity provider. + type: string + access_token: + title: Access token + description: The most recent access token provided by the external identity + provider. + type: string + refresh_token: + title: Refresh token + description: The most recent refresh token provided by the external identity + provider. + type: string + Contract: + required: + - organisation + - hours_bought + - session_limit + - created_by + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + id: + title: ID + type: integer + readOnly: true + organisation: + title: Organisation.unique_id + type: string + description: The unique_id of an organisation + organisation_name: + title: Organisation name + type: string + readOnly: true + scope: + title: Scope + description: 'A space-separated list of scopes (options: basic simulate create + lizardrain lizardprocess manageusers managecontracts test livesite)' + type: string + readOnly: true + minLength: 1 + start_date: + title: Start date + type: string + format: date + x-nullable: true + hours_bought: + title: Hours bought + type: integer + hours_used: + title: Hours used + type: number + format: decimal + readOnly: true + session_limit: + title: Session limit + type: integer + maximum: 2147483647 + minimum: -2147483648 + current_sessions: + title: Current sessions + type: string + readOnly: true + threedimodel_limit: + title: Threedimodel limit + description: Maximum amount of ThreediModels per Organisation + type: integer + maximum: 32767 + minimum: 0 + created_by: + title: Organisation.unique_id + type: string + description: The unique_id of an organisation + File: + required: + - filename + - bucket + - type + - state + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + storage_name: + title: Storage name + type: string + readOnly: true + minLength: 1 + filename: + title: Filename + type: string + maxLength: 256 + minLength: 1 + bucket: + title: Bucket + type: string + maxLength: 256 + minLength: 1 + prefix: + title: Prefix + type: string + maxLength: 256 + x-nullable: true + etag: + title: Etag + description: Optional eTag (md5sum) + type: string + maxLength: 256 + x-nullable: true + size: + title: Size + description: Filesize in bytes + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + x-nullable: true + expiry_date: + title: Expiry date + type: string + format: date + related_object: + title: Related object + type: string + format: uri + readOnly: true + type: + title: Type + type: string + enum: + - timeseries + - rastertimeseries + - savedstate + - results + - rasters + - gridadmin + - geopackage + - geojson + - initialwaterlevel + - initial_substance_concentration + - bulklateral + - bulkcontrol + - bulk_boundaryconditions + - sqlite + - tables + state: + title: State + type: string + enum: + - created + - uploaded + - processed + - error + - removed + state_description: + title: State description + type: string + maxLength: 512 + x-nullable: true + meta: + title: Meta + type: object + x-nullable: true + id: + title: ID + type: integer + readOnly: true + FileMeta: + type: object + properties: + values_reference: + title: Values reference + type: string + maxLength: 255 + minLength: 1 + units: + title: Units + type: string + maxLength: 64 + minLength: 1 + timestamps: + description: seconds in the simulation + type: array + items: + type: integer + minimum: 0 + offset: + title: Offset + description: seconds in the simulation + type: integer + minimum: 0 + duration: + title: Duration + description: seconds + type: integer + minimum: 0 + geotransform: + type: array + items: + type: number + epsg_code: + title: Epsg code + type: integer + interval: + title: Interval + type: integer + error: + title: Error + type: string + maxLength: 512 + minLength: 1 + fill_value: + title: Fill value + type: string + maxLength: 128 + minLength: 1 + InpyVersion: + required: + - threedi_version + - threedicore_version + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + threedi_version: + title: Threedi version + type: string + maxLength: 80 + minLength: 1 + threedicore_version: + title: Threedicore version + type: string + maxLength: 80 + minLength: 1 + slug: + title: Slug + type: string + readOnly: true + minLength: 1 + id: + title: ID + type: integer + readOnly: true + active: + title: Active + type: boolean + Organisation: + required: + - unique_id + - name + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + unique_id: + title: Unique id + type: string + maxLength: 32 + minLength: 1 + name: + title: Name + type: string + maxLength: 255 + minLength: 1 + OrganisationRole: + required: + - user + - role + - organisation + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + user: + title: User.username + type: string + pattern: ^[\w.@+-]+$ + description: The username of a user + role: + title: Role + type: string + organisation: + title: Organisation.unique_id + type: string + description: The unique_id of an organisation + organisation_name: + title: Organisation name + type: string + readOnly: true + OrganisationUser: + required: + - username + type: object + properties: + id: + title: ID + type: integer + readOnly: true + first_name: + title: First name + type: string + maxLength: 150 + last_name: + title: Last name + type: string + maxLength: 150 + username: + title: Username + description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ + only. + type: string + pattern: ^[\w.@+-]+$ + maxLength: 150 + minLength: 1 + email: + title: Email address + type: string + format: email + maxLength: 254 + roles: + description: Return a list of roles of the given user in this organisation. + type: array + items: + type: string + minLength: 1 + readOnly: true + OrganisationUserRolePatch: + required: + - roles + type: object + properties: + roles: + type: array + items: + type: string + Repository: + required: + - slug + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + id: + title: ID + type: integer + readOnly: true + organisation: + title: Organisation.unique_id + type: string + description: The unique_id of an organisation + slug: + title: Slug + description: do not change + type: string + format: slug + pattern: ^[-a-zA-Z0-9_]+$ + maxLength: 255 + minLength: 1 + revision: + type: array + items: + type: string + readOnly: true + uniqueItems: true + Revision: + required: + - repository + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + id: + title: ID + type: integer + readOnly: true + repository: + title: Repository + type: string + format: uri + number: + title: Number + type: integer + maximum: 2147483647 + minimum: -2147483648 + hash: + title: Hash + description: unique identifier for changeset + type: string + maxLength: 200 + x-nullable: true + commit_date: + title: Commit date + type: string + format: date-time + x-nullable: true + user: + title: User + description: user that committed the changeset for this revision + type: string + maxLength: 128 + x-nullable: true + is_pinned: + title: Is pinned + type: boolean + x-nullable: true + ThreediModel: + required: + - revision + - slug + - inpy_version + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + id: + title: ID + type: integer + readOnly: true + user: + title: User.username + type: string + readOnly: true + description: The username of a user + threedi_version: + title: Threedi version + description: The 3Di API version that created this threedimodel. + type: string + readOnly: true + minLength: 1 + x-nullable: true + breach_count: + title: Breach count + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + revision: + title: Revision + type: string + format: uri + revision_id: + title: Revision id + type: integer + readOnly: true + revision_hash: + title: Revision hash + type: string + readOnly: true + revision_number: + title: Revision number + type: string + readOnly: true + revision_commit_date: + title: Revision commit date + type: string + readOnly: true + schematisation_id: + title: Schematisation id + type: integer + readOnly: true + schematisation_name: + title: Schematisation name + type: string + readOnly: true + repository_slug: + title: Repository slug + type: string + readOnly: true + name: + title: Name + type: string + minLength: 1 + slug: + title: Slug + type: string + format: slug + pattern: ^[-a-zA-Z0-9_]+$ + maxLength: 512 + minLength: 1 + disabled: + title: Disabled + description: Disable the model. + type: boolean + is_valid: + title: Is valid + description: True if the threedimodel was generated without errors. + type: boolean + x-nullable: true + epsg: + title: Epsg + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + description: + title: Description + description: Please describe the model here... + type: string + x-nullable: true + storage_space: + title: Storage space + description: Automatically filled after threedimodel generation. + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + storage_space_humanized: + title: Storage space humanized + type: string + readOnly: true + model_ini: + title: Model ini + type: string + maxLength: 512 + x-nullable: true + extent_two_d: + title: Extent + type: object + description: Extent specified either in geojson, wkt or ewkt. Coordinates + in longitude, latitude order. + required: + - type + - coordinates + properties: + type: + title: type + description: Type should always be 'Linestring' + type: string + default: Linestring + coordinates: + title: coordinates + description: Exactly 2 coordinates, specifying the bottom left (longitude, + latitude order)and upper right respectively + type: array + items: + type: array + items: + type: number + minItems: 2 + maxItems: 2 + minItems: 2 + maxItems: 2 + minItems: 2 + maxItems: 2 + example: + type: LineString + coordinates: + - - 4.668275805499175 + - 52.619558913867856 + - - 4.73849433310911 + - 52.66453976184968 + extent_one_d: + title: Extent + type: object + description: Extent specified either in geojson, wkt or ewkt. Coordinates + in longitude, latitude order. + required: + - type + - coordinates + properties: + type: + title: type + description: Type should always be 'Linestring' + type: string + default: Linestring + coordinates: + title: coordinates + description: Exactly 2 coordinates, specifying the bottom left (longitude, + latitude order)and upper right respectively + type: array + items: + type: array + items: + type: number + minItems: 2 + maxItems: 2 + minItems: 2 + maxItems: 2 + minItems: 2 + maxItems: 2 + example: + type: LineString + coordinates: + - - 4.668275805499175 + - 52.619558913867856 + - - 4.73849433310911 + - 52.66453976184968 + extent_zero_d: + title: Extent + type: object + description: Extent specified either in geojson, wkt or ewkt. Coordinates + in longitude, latitude order. + required: + - type + - coordinates + properties: + type: + title: type + description: Type should always be 'Linestring' + type: string + default: Linestring + coordinates: + title: coordinates + description: Exactly 2 coordinates, specifying the bottom left (longitude, + latitude order)and upper right respectively + type: array + items: + type: array + items: + type: number + minItems: 2 + maxItems: 2 + minItems: 2 + maxItems: 2 + minItems: 2 + maxItems: 2 + example: + type: LineString + coordinates: + - - 4.668275805499175 + - 52.619558913867856 + - - 4.73849433310911 + - 52.66453976184968 + nodes_count: + title: Nodes count + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + lines_count: + title: Lines count + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + inpy_version: + title: Inpy version + type: string + inp_success: + title: Inp success + type: boolean + Role: + required: + - name + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + name: + title: Name + type: string + maxLength: 255 + minLength: 1 + Schematisation: + required: + - name + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + id: + title: ID + type: integer + readOnly: true + owner: + title: Organisation.unique_id + type: string + description: The unique_id of an organisation + name: + title: Name + type: string + maxLength: 256 + minLength: 1 + slug: + title: Slug + description: The internal name (only superusers can modify) + type: string + format: slug + pattern: ^[-a-zA-Z0-9_]+$ + maxLength: 256 + minLength: 1 + tags: + title: tags + type: array + description: tags provided as a list of strings + items: + type: string + example: + - tag_1 + - tag_2 + meta: + title: Meta + type: object + x-nullable: true + created_by: + title: User.username + description: The username of a user + type: string + pattern: ^[\w.@+-]+$ + created_by_first_name: + title: Created by first name + type: string + readOnly: true + created_by_last_name: + title: Created by last name + type: string + readOnly: true + created: + title: Created + description: The creation date and time (only superusers can modify) + type: string + format: date-time + archived: + title: Archived + type: string + format: date-time + readOnly: true + x-nullable: true + last_updated: + title: Last updated + type: string + format: date-time + readOnly: true + x-nullable: true + storage_usage: + title: Storage usage + description: Automatically calculated. + type: integer + readOnly: true + threedimodel_limit: + title: Threedimodel limit + description: Maximum amount of ThreediModels per Schematisation + type: integer + maximum: 32767 + minimum: 0 + Sqlite: + type: object + properties: + id: + title: ID + type: integer + readOnly: true + file: + $ref: '#/definitions/FileReadOnly' + revision_id: + title: Revision id + type: integer + readOnly: true + RevisionRaster: + required: + - type + - name + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + type: + title: Type + type: string + enum: + - dem_file + - equilibrium_infiltration_rate_file + - frict_coef_file + - initial_groundwater_level_file + - initial_waterlevel_file + - groundwater_hydro_connectivity_file + - groundwater_impervious_layer_level_file + - infiltration_decay_period_file + - initial_infiltration_rate_file + - leakage_file + - phreatic_storage_capacity_file + - hydraulic_conductivity_file + - porosity_file + - infiltration_rate_file + - max_infiltration_capacity_file + - interception_file + - vegetation_height_file + - vegetation_drag_coefficient_file + - vegetation_stem_count_file + - vegetation_stem_diameter_file + name: + title: Name + type: string + maxLength: 60 + minLength: 1 + file: + $ref: '#/definitions/FileReadOnly' + id: + title: ID + type: integer + readOnly: true + epsg_code: + title: Epsg code + type: integer + readOnly: true + x-nullable: true + extent: + title: Extent + type: object + readOnly: true + description: Extent specified either in geojson, wkt or ewkt. Coordinates + in longitude, latitude order. + required: + - type + - coordinates + properties: + type: + title: type + description: Type should always be 'Linestring' + type: string + default: Linestring + coordinates: + title: coordinates + description: Exactly 2 coordinates, specifying the bottom left (longitude, + latitude order)and upper right respectively + type: array + items: + type: array + items: + type: number + minItems: 2 + maxItems: 2 + minItems: 2 + maxItems: 2 + minItems: 2 + maxItems: 2 + example: + type: LineString + coordinates: + - - 4.668275805499175 + - 52.619558913867856 + - - 4.73849433310911 + - 52.66453976184968 + geotransform: + type: array + items: + title: Geotransform + type: number + readOnly: true + x-nullable: true + unit: + title: Unit + type: string + enum: + - meters + x-nullable: true + SchematisationRevision: + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + id: + title: ID + type: integer + readOnly: true + created: + title: Created + type: string + format: date-time + readOnly: true + x-nullable: true + schematisation: + title: Schematisation + type: string + format: uri + readOnly: true + schematisation_id: + title: Schematisation id + type: integer + readOnly: true + number: + title: Number + type: integer + readOnly: true + sqlite: + $ref: '#/definitions/Sqlite' + rasters: + type: array + items: + $ref: '#/definitions/RevisionRaster' + readOnly: true + archived: + title: Archived + type: string + format: date-time + readOnly: true + x-nullable: true + commit_date: + title: Commit date + type: string + format: date-time + readOnly: true + x-nullable: true + commit_user: + title: User.username + description: The username of a user + type: string + pattern: ^[\w.@+-]+$ + readOnly: true + commit_first_name: + title: Commit first name + type: string + readOnly: true + commit_last_name: + title: Commit last name + type: string + readOnly: true + commit_message: + title: Commit message + type: string + readOnly: true + minLength: 1 + x-nullable: true + is_valid: + title: Is valid + type: boolean + readOnly: true + x-nullable: true + has_threedimodel: + title: Has threedimodel + type: boolean + readOnly: true + CreateRevision: + type: object + properties: + empty: + title: Empty + description: Create an empty revision + type: boolean + default: false + number: + title: Number + description: An optional revision number (only superusers can modify) + type: integer + created: + title: Created + description: An optional creation datetime (only superusers can modify) + type: string + format: date-time + UpdateRevision: + type: object + properties: + commit_message: + title: Commit message + type: string + minLength: 1 + x-nullable: true + DestroyRevision: + required: + - number + type: object + properties: + number: + title: Number + description: Provide revision number as verification + type: integer + RevisionTask: + required: + - name + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + name: + title: Name + type: string + enum: + - modelchecker + params: + title: Params + type: object + x-nullable: true + created: + title: Created + type: string + format: date-time + readOnly: true + last_updated: + title: Last updated + type: string + format: date-time + readOnly: true + status: + title: Status + type: string + enum: + - pending + - sent + - received + - started + - success + - failure + - revoked + detail: + title: Detail + type: object + revision: + title: Revision + type: string + format: uri + readOnly: true + id: + title: ID + type: integer + readOnly: true + Commit: + type: object + properties: + commit_message: + title: Commit message + type: string + minLength: 1 + x-nullable: true + force_as: + title: Force as + type: string + enum: + - default + - new_revision + - new_schematisation + schematisation_name: + title: Schematisation name + type: string + maxLength: 256 + minLength: 1 + commit_date: + title: Commit date + description: The datetime of the commit (only superusers can modify) + type: string + format: date-time + x-nullable: true + commit_user: + title: User.username + description: The username of a user + type: string + pattern: ^[\w.@+-]+$ + user: + title: User + description: User that committed the revision on models.lizard.net (only superusers + can modify) + type: string + maxLength: 128 + x-nullable: true + CreateThreedimodel: + type: object + properties: + inherit_from_previous_threedimodel: + title: Inherit from previous threedimodel + description: Try to inherit simulation templates from previous threedimodel + (in case of regenerate) + type: boolean + default: true + inherit_from_previous_revision: + title: Inherit from previous revision + description: Try to inherit simulation templates from previous revision + type: boolean + default: false + SqliteFileUpload: + required: + - filename + type: object + properties: + put_url: + title: Put url + type: string + format: uri + readOnly: true + minLength: 1 + filename: + title: Filename + type: string + maxLength: 255 + minLength: 1 + status: + title: Status + type: string + readOnly: true + minLength: 1 + md5sum: + title: md5sum (hash) of the (compressed) sqlite file + type: string + maxLength: 256 + minLength: 1 + RasterCreate: + required: + - type + - name + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + type: + title: Type + type: string + enum: + - dem_file + - equilibrium_infiltration_rate_file + - frict_coef_file + - initial_groundwater_level_file + - initial_waterlevel_file + - groundwater_hydro_connectivity_file + - groundwater_impervious_layer_level_file + - infiltration_decay_period_file + - initial_infiltration_rate_file + - leakage_file + - phreatic_storage_capacity_file + - hydraulic_conductivity_file + - porosity_file + - infiltration_rate_file + - max_infiltration_capacity_file + - interception_file + - vegetation_height_file + - vegetation_drag_coefficient_file + - vegetation_stem_count_file + - vegetation_stem_diameter_file + name: + title: Name + type: string + maxLength: 60 + minLength: 1 + id: + title: ID + type: integer + readOnly: true + epsg_code: + title: Epsg code + type: integer + readOnly: true + x-nullable: true + extent: + title: Extent + type: object + readOnly: true + description: Extent specified either in geojson, wkt or ewkt. Coordinates + in longitude, latitude order. + required: + - type + - coordinates + properties: + type: + title: type + description: Type should always be 'Linestring' + type: string + default: Linestring + coordinates: + title: coordinates + description: Exactly 2 coordinates, specifying the bottom left (longitude, + latitude order)and upper right respectively + type: array + items: + type: array + items: + type: number + minItems: 2 + maxItems: 2 + minItems: 2 + maxItems: 2 + minItems: 2 + maxItems: 2 + example: + type: LineString + coordinates: + - - 4.668275805499175 + - 52.619558913867856 + - - 4.73849433310911 + - 52.66453976184968 + geotransform: + type: array + items: + title: Geotransform + type: number + readOnly: true + x-nullable: true + unit: + title: Unit + type: string + enum: + - meters + x-nullable: true + md5sum: + title: md5sum (hash) of the geotiff file + type: string + maxLength: 256 + minLength: 1 + Simulation: + required: + - name + - threedimodel + - organisation + - start_datetime + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + slug: + title: Slug + type: string + format: slug + pattern: ^[-a-zA-Z0-9_]+$ + readOnly: true + minLength: 1 + uuid: + title: Uuid + type: string + format: uuid + readOnly: true + name: + title: Name + type: string + maxLength: 128 + minLength: 1 + tags: + title: tags + type: array + description: tags provided as a list of strings + items: + type: string + example: + - tag_1 + - tag_2 + created: + title: Created + type: string + readOnly: true + threedimodel: + title: Threedimodel.id + type: string + format: uri + description: The id of a threedimodel + organisation: + title: Organisation.unique_id + type: string + description: The unique_id of an organisation + organisation_name: + title: Organisation name + type: string + readOnly: true + user: + title: User.username + type: string + pattern: ^[\w.@+-]+$ + readOnly: true + description: The username of a user + start_datetime: + title: Start datetime + type: string + format: date-time + end_datetime: + title: End datetime + type: string + format: date-time + duration: + title: Duration + type: integer + duration_humanized: + title: Duration humanized + type: string + readOnly: true + threedimodel_id: + title: Threedimodel id + type: integer + readOnly: true + id: + title: ID + type: integer + readOnly: true + threedicore_version: + title: Threedicore version + type: string + maxLength: 16 + minLength: 1 + x-nullable: true + cloned_from: + title: Cloned from + type: string + format: uri + readOnly: true + compute_cluster: + title: ComputeCluster.name + type: string + readOnly: true + description: The name of the compute cluster that runs/has run the simulation. + Template: + required: + - name + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + name: + title: Name + type: string + maxLength: 255 + minLength: 1 + id: + title: ID + type: integer + readOnly: true + created: + title: Created + type: string + format: date-time + readOnly: true + simulation: + $ref: '#/definitions/Simulation' + CreateTemplate: + required: + - name + - simulation + type: object + properties: + name: + title: Name + type: string + maxLength: 255 + minLength: 1 + simulation: + title: Simulation + type: string + format: uri + include_events: + title: Include events + type: boolean + default: true + include_initials: + title: Include initials + type: boolean + default: true + include_settings: + title: Include settings + type: boolean + default: true + UpdateTemplate: + required: + - name + type: object + properties: + name: + title: Name + type: string + maxLength: 255 + minLength: 1 + FromTemplate: + required: + - template + - name + - organisation + - start_datetime + type: object + properties: + template: + title: Template + description: source simulation template id + type: string + format: uri + threedimodel: + title: Threedimodel.id + description: The id of a threedimodel + type: string + format: uri + name: + title: Name + type: string + maxLength: 128 + minLength: 1 + tags: + type: array + items: + type: string + x-nullable: true + organisation: + title: Organisation + type: string + minLength: 1 + start_datetime: + title: Start datetime + type: string + format: date-time + end_datetime: + title: End datetime + type: string + format: date-time + duration: + title: Duration + type: integer + clone_events: + title: Clone events + type: boolean + default: true + clone_initials: + title: Clone initials + type: boolean + default: true + clone_settings: + title: Clone settings + type: boolean + default: true + PostProcessingQueue: + required: + - simulation + - status + type: object + properties: + simulation: + title: Simulation + type: integer + status: + title: Status + type: string + enum: + - created + - requested + - archiving + - archiving_failed + - archived + created: + title: Created + type: string + format: date-time + readOnly: true + SimulationUpdate: + required: + - name + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + slug: + title: Slug + type: string + format: slug + pattern: ^[-a-zA-Z0-9_]+$ + readOnly: true + minLength: 1 + uuid: + title: Uuid + type: string + format: uuid + readOnly: true + name: + title: Name + type: string + maxLength: 128 + minLength: 1 + tags: + title: tags + type: array + description: tags provided as a list of strings + items: + type: string + example: + - tag_1 + - tag_2 + created: + title: Created + type: string + readOnly: true + threedimodel: + title: Threedimodel.id + type: string + format: uri + readOnly: true + description: The id of a threedimodel + organisation: + title: Organisation.unique_id + type: string + readOnly: true + description: The unique_id of an organisation + organisation_name: + title: Organisation name + type: string + readOnly: true + user: + title: User.username + type: string + pattern: ^[\w.@+-]+$ + readOnly: true + description: The username of a user + start_datetime: + title: Start datetime + type: string + format: date-time + readOnly: true + end_datetime: + title: End datetime + type: string + format: date-time + duration: + title: Duration + type: integer + duration_humanized: + title: Duration humanized + type: string + readOnly: true + threedimodel_id: + title: Threedimodel id + type: integer + readOnly: true + id: + title: ID + type: integer + readOnly: true + threedicore_version: + title: Threedicore version + type: string + maxLength: 16 + minLength: 1 + x-nullable: true + cloned_from: + title: Cloned from + type: string + format: uri + readOnly: true + compute_cluster: + title: ComputeCluster.name + type: string + readOnly: true + description: The name of the compute cluster that runs/has run the simulation. + ForcingSubstance: + required: + - substance + - concentrations + type: object + properties: + id: + title: ID + type: integer + readOnly: true + substance: + title: Substance + type: string + format: uri + substance_id: + title: Substance id + type: integer + readOnly: true + substance_name: + title: Substance name + type: string + readOnly: true + concentrations: + type: array + items: + type: array + items: + type: number + description: Timestamp + value pair + example: + - 100 + - 0.5 + maxItems: 2 + minItems: 2 + maxItems: 300 + title: Timeseries + description: 'Timeseries provided as a nested list. The inner list consists + of exactly 2 values: timestamp, value' + example: + - - 0 + - 0.1 + - - 100 + - 0.5 + - - 200 + - 0 + minItems: 1 + LizardRasterRain: + required: + - offset + - reference_uuid + - start_datetime + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + duration: + title: Duration (in seconds) + description: event duration in seconds. -9999 is the 'infinite duration' value + (only allowed in conjunction with infinite simulations + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + x-nullable: true + units: + title: Units + type: string + enum: + - mm/duration + - mm/h + - m/s + reference_uuid: + title: Reference uuid + type: string + maxLength: 40 + minLength: 1 + start_datetime: + title: Start datetime + type: string + format: date-time + simulation: + title: Simulation + type: string + format: uri + readOnly: true + multiplier: + title: Multiplier + type: number + default: 1.0 + interval: + title: Interval + type: integer + readOnly: true + user: + title: User + type: string + readOnly: true + user_id: + title: User id + type: integer + readOnly: true + origin_offset: + title: Origin offset + type: integer + readOnly: true + store_path: + title: Store path + type: string + readOnly: true + minLength: 1 + id: + title: ID + type: integer + readOnly: true + substances: + type: array + items: + $ref: '#/definitions/ForcingSubstance' + LizardTimeseriesRain: + required: + - offset + - reference_uuid + - start_datetime + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + duration: + title: Duration (in seconds) + description: event duration in seconds. -9999 is the 'infinite duration' value + (only allowed in conjunction with infinite simulations + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + x-nullable: true + reference_uuid: + title: Reference uuid + type: string + maxLength: 40 + minLength: 1 + start_datetime: + title: Start datetime + type: string + format: date-time + interpolate: + title: Interpolate + type: boolean + values: + type: array + items: + type: array + items: + type: number + description: Timestamp + value pair + example: + - 100 + - 0.5 + maxItems: 2 + minItems: 2 + readOnly: true + maxItems: 300 + title: Timeseries + description: 'Timeseries provided as a nested list. The inner list consists + of exactly 2 values: timestamp, value' + example: + - - 0 + - 0.1 + - - 100 + - 0.5 + - - 200 + - 0 + minItems: 1 + units: + title: Units + type: string + enum: + - mm/duration + - mm/h + - m/s + id: + title: ID + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + substances: + type: array + items: + $ref: '#/definitions/ForcingSubstance' + TimeseriesRainOverview: + required: + - offset + - values + - units + type: object + properties: + url: + title: Url + type: string + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + duration: + title: Duration (in seconds) + description: event duration in seconds. -9999 is the 'infinite duration' value + (only allowed in conjunction with infinite simulations + type: integer + readOnly: true + x-nullable: true + interpolate: + title: Interpolate + type: boolean + values: + type: array + items: + type: array + items: + type: number + description: Timestamp + value pair + example: + - 100 + - 0.5 + maxItems: 2 + minItems: 2 + maxItems: 300 + title: Timeseries + description: 'Timeseries provided as a nested list. The inner list consists + of exactly 2 values: timestamp, value' + example: + - - 0 + - 0.1 + - - 100 + - 0.5 + - - 200 + - 0 + minItems: 1 + units: + title: Units + description: m/s is only option for now + type: string + enum: + - m/s + constant: + title: Constant + type: boolean + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + substances: + type: array + items: + $ref: '#/definitions/ForcingSubstance' + Breach: + required: + - duration_till_max_depth + - initial_width + - offset + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + potential_breach: + title: Potential breach + type: string + format: uri + line_id: + title: Line id + description: The id of the flowline ('levl' in the geojson) + type: integer + maximum: 2147483647 + minimum: 0 + duration_till_max_depth: + title: Duration till max depth + description: Duration till maximum depth, in seconds + type: integer + maximum: 2147483647 + minimum: 0 + maximum_breach_depth: + title: Maximum breach depth + description: The maximum breach depth relative to the crest level, in meters + type: number + levee_material: + title: Levee material + type: string + enum: + - sand + - clay + initial_width: + title: Initial width + description: initial width in meters + type: number + discharge_coefficient_positive: + title: Discharge coefficient positive + type: number + x-nullable: true + discharge_coefficient_negative: + title: Discharge coefficient negative + type: number + x-nullable: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + id: + title: ID + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + LizardRasterSourcesSinks: + required: + - offset + - reference_uuid + - start_datetime + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + duration: + title: Duration (in seconds) + description: event duration in seconds. -9999 is the 'infinite duration' value + (only allowed in conjunction with infinite simulations + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + x-nullable: true + reference_uuid: + title: Reference uuid + type: string + maxLength: 40 + minLength: 1 + start_datetime: + title: Start datetime + type: string + format: date-time + simulation: + title: Simulation + type: string + format: uri + readOnly: true + interval: + title: Interval + type: integer + readOnly: true + origin_offset: + title: Origin offset + type: integer + readOnly: true + store_path: + title: Store path + type: string + readOnly: true + minLength: 1 + id: + title: ID + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + user: + title: User + type: string + readOnly: true + user_id: + title: User id + type: integer + readOnly: true + LizardTimeseriesSourcesSinks: + required: + - offset + - reference_uuid + - start_datetime + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + duration: + title: Duration (in seconds) + description: event duration in seconds. -9999 is the 'infinite duration' value + (only allowed in conjunction with infinite simulations + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + x-nullable: true + reference_uuid: + title: Reference uuid + type: string + maxLength: 40 + minLength: 1 + start_datetime: + title: Start datetime + type: string + format: date-time + interpolate: + title: Interpolate + type: boolean + values: + type: array + items: + type: array + items: + type: number + description: Timestamp + value pair + example: + - 100 + - 0.5 + maxItems: 2 + minItems: 2 + readOnly: true + maxItems: 300 + title: Timeseries + description: 'Timeseries provided as a nested list. The inner list consists + of exactly 2 values: timestamp, value' + example: + - - 0 + - 0.1 + - - 100 + - 0.5 + - - 200 + - 0 + minItems: 1 + uid: + title: Uid + type: string + format: uuid + readOnly: true + FileRasterSourcesSinks: + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + multiplier: + title: Multiplier + type: number + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + duration: + title: Duration + description: Duration of event in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + timestamps: + description: in simulation in seconds + type: array + items: + title: Timestamps + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + interval: + title: Interval + description: interval in seconds + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + values_reference: + title: Values reference + type: string + maxLength: 255 + x-nullable: true + fill_value: + title: Fill value + type: string + maxLength: 128 + minLength: 1 + units: + title: Units + type: string + enum: + - m/s + - mm + - mm/h + - mm/hr + x-nullable: true + geotransform: + type: array + items: + title: Geotransform + type: number + maxItems: 6 + epsg_code: + title: Epsg code + type: integer + maximum: 2147483647 + minimum: -2147483648 + file: + $ref: '#/definitions/FileReadOnly' + type: + title: Type + type: string + enum: + - netcdf4 + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + FileTimeseriesSourcesSinks: + required: + - units + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + multiplier: + title: Multiplier + type: number + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + duration: + title: Duration + description: Duration of event in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + timestamps: + description: in simulation in seconds + type: array + items: + title: Timestamps + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + interval: + title: Interval + description: interval in seconds + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + values_reference: + title: Values reference + type: string + maxLength: 255 + x-nullable: true + fill_value: + title: Fill value + type: string + maxLength: 128 + minLength: 1 + type: + title: Type + type: string + enum: + - netcdf4 + readOnly: true + units: + title: Units + type: string + enum: + - mm + - mm/h + file: + $ref: '#/definitions/FileReadOnly' + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + TimeseriesSourcesSinksOverview: + required: + - offset + - values + - units + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + interpolate: + title: Interpolate + type: boolean + values: + type: array + items: + type: array + items: + type: number + description: Timestamp + value pair + example: + - 100 + - 0.5 + maxItems: 2 + minItems: 2 + maxItems: 300 + title: Timeseries + description: 'Timeseries provided as a nested list. The inner list consists + of exactly 2 values: timestamp, value' + example: + - - 0 + - 0.1 + - - 100 + - 0.5 + - - 200 + - 0 + minItems: 1 + units: + title: Units + description: "'m/s' (only option for now)" + type: string + enum: + - m/s + constant: + title: Constant + type: boolean + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + TimeseriesLeakageOverview: + required: + - offset + - values + - units + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + interpolate: + title: Interpolate + type: boolean + values: + type: array + items: + type: array + items: + type: number + description: Timestamp + value pair + example: + - 100 + - 0.5 + maxItems: 2 + minItems: 2 + maxItems: 300 + title: Timeseries + description: 'Timeseries provided as a nested list. The inner list consists + of exactly 2 values: timestamp, value' + example: + - - 0 + - 0.1 + - - 100 + - 0.5 + - - 200 + - 0 + minItems: 1 + units: + title: Units + description: "'m/s' (only option for now)" + type: string + enum: + - m/s + constant: + title: Constant + type: boolean + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + FileTimeseriesLeakage: + required: + - units + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + multiplier: + title: Multiplier + type: number + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + duration: + title: Duration + description: Duration of event in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + timestamps: + description: in simulation in seconds + type: array + items: + title: Timestamps + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + interval: + title: Interval + description: interval in seconds + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + values_reference: + title: Values reference + type: string + maxLength: 255 + x-nullable: true + fill_value: + title: Fill value + type: string + maxLength: 128 + minLength: 1 + type: + title: Type + type: string + enum: + - netcdf4 + readOnly: true + units: + title: Units + type: string + enum: + - mm + - mm/h + file: + $ref: '#/definitions/FileReadOnly' + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + FileRasterLeakage: + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + multiplier: + title: Multiplier + type: number + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + duration: + title: Duration + description: Duration of event in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + timestamps: + description: in simulation in seconds + type: array + items: + title: Timestamps + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + interval: + title: Interval + description: interval in seconds + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + values_reference: + title: Values reference + type: string + maxLength: 255 + x-nullable: true + fill_value: + title: Fill value + type: string + maxLength: 128 + minLength: 1 + units: + title: Units + type: string + enum: + - m/s + - mm + - mm/h + - mm/hr + x-nullable: true + geotransform: + type: array + items: + title: Geotransform + type: number + maxItems: 6 + epsg_code: + title: Epsg code + type: integer + maximum: 2147483647 + minimum: -2147483648 + file: + $ref: '#/definitions/FileReadOnly' + type: + title: Type + type: string + enum: + - netcdf4 + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + TwoDWaterLevel: + required: + - value + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + value: + title: Value + type: number + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + OneDWaterLevelPredefined: + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + GroundWaterLevel: + required: + - value + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + value: + title: Value + type: number + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + GroundWaterRaster: + required: + - aggregation_method + - initial_waterlevel + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + aggregation_method: + title: Aggregation method + type: string + enum: + - mean + - max + - min + initial_waterlevel: + title: Initial waterlevel + type: string + format: uri + initial_waterlevel_id: + title: Initial waterlevel id + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + OneDWaterLevel: + required: + - value + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + value: + title: Value + type: number + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + OneDWaterLevelFile: + required: + - initial_waterlevel + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + initial_waterlevel: + title: Initial waterlevel + type: string + format: uri + initial_waterlevel_id: + title: Initial waterlevel id + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + TwoDWaterRaster: + required: + - aggregation_method + - initial_waterlevel + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + aggregation_method: + title: Aggregation method + type: string + enum: + - mean + - max + - min + initial_waterlevel: + title: Initial waterlevel + type: string + format: uri + initial_waterlevel_id: + title: Initial waterlevel id + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + FileRasterRain: + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + multiplier: + title: Multiplier + type: number + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + duration: + title: Duration + description: Duration of event in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + timestamps: + description: in simulation in seconds + type: array + items: + title: Timestamps + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + interval: + title: Interval + description: interval in seconds + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + values_reference: + title: Values reference + type: string + maxLength: 255 + x-nullable: true + fill_value: + title: Fill value + type: string + maxLength: 128 + minLength: 1 + units: + title: Units + type: string + enum: + - m/s + - mm + - mm/h + - mm/hr + x-nullable: true + geotransform: + type: array + items: + title: Geotransform + type: number + maxItems: 6 + epsg_code: + title: Epsg code + type: integer + maximum: 2147483647 + minimum: -2147483648 + file: + $ref: '#/definitions/FileReadOnly' + type: + title: Type + type: string + enum: + - netcdf4 + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + substances: + type: array + items: + $ref: '#/definitions/ForcingSubstance' + FileTimeseriesRain: + required: + - units + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + multiplier: + title: Multiplier + type: number + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + duration: + title: Duration + description: Duration of event in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + timestamps: + description: in simulation in seconds + type: array + items: + title: Timestamps + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + interval: + title: Interval + description: interval in seconds + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + values_reference: + title: Values reference + type: string + maxLength: 255 + x-nullable: true + fill_value: + title: Fill value + type: string + maxLength: 128 + minLength: 1 + type: + title: Type + type: string + enum: + - netcdf4 + readOnly: true + units: + title: Units + type: string + enum: + - mm + - mm/h + file: + $ref: '#/definitions/FileReadOnly' + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + substances: + type: array + items: + $ref: '#/definitions/ForcingSubstance' + Threshold: + required: + - variable + - value + type: object + properties: + variable: + title: Variable + type: string + enum: + - s1 + - u1 + value: + title: Value + type: number + SavedStateOverview: + required: + - type + - thresholds + type: object + properties: + name: + title: Name + type: string + maxLength: 80 + minLength: 1 + type: + title: Type + type: string + enum: + - stable_threshold + - timed + created: + title: Created + type: string + format: date-time + x-nullable: true + created_time: + title: Time in simulation (in seconds) + description: Time in simulation the savedstate has been created + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + tags: + title: tags + type: array + description: tags provided as a list of strings + items: + type: string + example: + - tag_1 + - tag_2 + expiry: + title: Expiry + type: string + format: date-time + x-nullable: true + time: + title: Time in simulation (in seconds) + description: Time in simulation to create savedstate + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + thresholds: + type: array + items: + $ref: '#/definitions/Threshold' + file: + $ref: '#/definitions/FileReadOnly' + id: + title: ID + type: integer + readOnly: true + uuid: + title: Uuid + type: string + format: uuid + InitialSavedStateOverview: + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + saved_state: + $ref: '#/definitions/SavedStateOverview' + id: + title: ID + type: integer + readOnly: true + uuid: + title: Uuid + type: string + readOnly: true + Lateral: + required: + - offset + - values + - units + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + duration: + title: Duration (in seconds) + description: event duration in seconds. -9999 is the 'infinite duration' value + (only allowed in conjunction with infinite simulations + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + x-nullable: true + interpolate: + title: Interpolate + type: boolean + values: + type: array + items: + type: array + items: + type: number + description: Timestamp + value pair + example: + - 100 + - 0.5 + maxItems: 2 + minItems: 2 + maxItems: 300 + title: Timeseries + description: 'Timeseries provided as a nested list. The inner list consists + of exactly 2 values: timestamp, value' + example: + - - 0 + - 0.1 + - - 100 + - 0.5 + - - 200 + - 0 + minItems: 1 + units: + title: Units + description: "'m3/s' (only option for now)" + type: string + enum: + - m3/s + constant: + title: Constant + type: boolean + point: + title: Point + type: object + description: Point specified in wkt or geojson. Coordinates in longitude, + latitude order. + required: + - type + - coordinates + properties: + type: + title: type + description: Type should always be 'Point' + type: string + default: Point + coordinates: + title: coordinates + description: List of exactly one coordinate (longitude, latitude order) + type: array + items: + type: number + minItems: 2 + maxItems: 2 + example: + type: Point + coordinates: + - 4.695281 + - 52.656047 + connection_node: + title: Connection node + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + state: + title: State + type: string + enum: + - processing + - valid + - invalid + readOnly: true + state_detail: + title: State detail + type: object + readOnly: true + x-nullable: true + grid_id: + title: Grid id + type: integer + readOnly: true + x-nullable: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + substances: + type: array + items: + $ref: '#/definitions/ForcingSubstance' + FileLateral: + required: + - offset + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + id: + title: ID + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + file: + $ref: '#/definitions/File' + state: + title: State + type: string + enum: + - processing + - valid + - invalid + readOnly: true + state_detail: + title: State detail + type: object + readOnly: true + x-nullable: true + periodic: + title: Periodic + type: string + enum: + - daily + readOnly: true + x-nullable: true + FileBoundaryCondition: + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + id: + title: ID + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + file: + $ref: '#/definitions/File' + state: + title: State + type: string + enum: + - processing + - valid + - invalid + readOnly: true + state_detail: + title: State detail + type: object + readOnly: true + x-nullable: true + MeasureLocation: + required: + - weight + - content_type + - content_pk + type: object + properties: + id: + title: ID + type: integer + readOnly: true + weight: + title: Weight + type: string + format: decimal + content_type: + title: Content type + description: 'e.g. ' + type: string + enum: + - v2_connection_node + - v2_pipe + - v2_orifice + - v2_culvert + - v2_channel + - v2_weir + content_pk: + title: Content pk + type: integer + maximum: 2147483647 + minimum: -2147483648 + grid_id: + title: Grid id + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + state: + title: State + type: string + enum: + - processing + - valid + - invalid + readOnly: true + state_detail: + title: State detail + type: object + readOnly: true + x-nullable: true + MeasureSpecification: + required: + - locations + - variable + - operator + type: object + properties: + id: + title: ID + type: integer + readOnly: true + name: + title: Name + type: string + maxLength: 50 + locations: + type: array + items: + $ref: '#/definitions/MeasureLocation' + variable: + title: Variable + description: | + measurement variable, one of the following options: + s1 (waterlevel) + vol1 (volume) + q (discharge) + u1 (velocity) + type: string + enum: + - s1 + - vol1 + - q + - u1 + operator: + title: Operator + description: e.g. >, <, >=, <= + type: string + enum: + - '>' + - '>=' + - < + - <= + TableStructureControl: + required: + - offset + - duration + - measure_specification + - structure_type + - type + - values + type: object + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: Url + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + duration: + title: Duration (in seconds) + description: event duration in seconds. -9999 is the 'infinite duration' value + (only allowed in conjunction with infinite simulations + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + x-nullable: true + measure_specification: + $ref: '#/definitions/MeasureSpecification' + structure_id: + title: Structure id + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + structure_type: + title: Structure type + type: string + enum: + - v2_pumpstation + - v2_pipe + - v2_orifice + - v2_culvert + - v2_weir + - v2_channel + type: + title: Type + type: string + enum: + - set_discharge_coefficients + - set_crest_level + - set_pump_capacity + - set_gate_level + values: + type: array + items: + type: array + items: + title: Values + type: number + maxItems: 3 + maxItems: 150 + state: + title: State + type: string + enum: + - processing + - valid + - invalid + readOnly: true + state_detail: + title: State detail + type: object + readOnly: true + x-nullable: true + grid_id: + title: Grid id + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + MemoryStructureControl: + required: + - offset + - duration + - measure_specification + - structure_type + - type + - value + type: object + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: Url + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + duration: + title: Duration (in seconds) + description: event duration in seconds. -9999 is the 'infinite duration' value + (only allowed in conjunction with infinite simulations + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + x-nullable: true + measure_specification: + $ref: '#/definitions/MeasureSpecification' + structure_id: + title: Structure id + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + structure_type: + title: Structure type + type: string + enum: + - v2_pumpstation + - v2_pipe + - v2_orifice + - v2_culvert + - v2_weir + - v2_channel + type: + title: Type + type: string + enum: + - set_discharge_coefficients + - set_crest_level + - set_pump_capacity + - set_gate_level + value: + description: 'list containing a single action values, e.g. [*action_value*]. + For type set_discharge_coefficients two action values need to be provided, + e.g. [*action_value*, *action_value*]. ' + type: array + items: + title: Value + type: number + maxItems: 2 + state: + title: State + type: string + enum: + - processing + - valid + - invalid + readOnly: true + state_detail: + title: State detail + type: object + readOnly: true + x-nullable: true + grid_id: + title: Grid id + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + upper_threshold: + title: Upper threshold + description: e.g. 0.3 + type: number + x-nullable: true + lower_threshold: + title: Lower threshold + description: e.g. 0.3 + type: number + x-nullable: true + is_active: + title: Is active + description: when True the initial state of the target is active + type: boolean + is_inverse: + title: Is inverse + description: when True the target will become active when the lower threshold + has been reached + type: boolean + TimedStructureControl: + required: + - offset + - duration + - value + - type + - structure_type + type: object + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + duration: + title: Duration + type: integer + minimum: 1 + value: + type: array + items: + title: Value + type: number + maxItems: 2 + type: + title: Type + type: string + enum: + - set_discharge_coefficients + - set_crest_level + - set_pump_capacity + - set_gate_level + structure_id: + title: Structure id + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + structure_type: + title: Structure type + type: string + enum: + - v2_pumpstation + - v2_pipe + - v2_orifice + - v2_culvert + - v2_weir + - v2_channel + state: + title: State + type: string + enum: + - processing + - valid + - invalid + readOnly: true + state_detail: + title: State detail + type: object + readOnly: true + x-nullable: true + grid_id: + title: Grid id + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + FileStructureControl: + required: + - offset + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + id: + title: ID + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + file: + $ref: '#/definitions/File' + state: + title: State + type: string + enum: + - processing + - valid + - invalid + readOnly: true + state_detail: + title: State detail + type: object + readOnly: true + x-nullable: true + RasterEdit: + required: + - raster + - offset + - value + - polygon + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + raster: + title: Raster + type: string + format: uri + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + value: + title: Value + description: Absolute or relative height (in meters) to use for the polygon + type: number + polygon: + title: Polygon + type: object + description: Polygon specified in wkt or geojson, interior rings are not allowed. + Coordinates in longitude, latitude order. + required: + - type + - coordinates + properties: + type: + title: type + description: Type should always be 'Polygon' + type: string + default: Polygon + coordinates: + title: coordinates + description: List of coordinates (longitude, latitude order) + type: array + items: + type: array + items: + type: array + items: + type: number + minItems: 2 + maxItems: 2 + minItems: 3 + minItems: 1 + maxItems: 1 + example: + type: Polygon + coordinates: + - - - 4.695281 + - 52.656047 + - - 4.683754 + - 52.655824 + - - 4.683253 + - 52.639063 + - - 4.695281 + - 52.656047 + relative: + title: Relative + description: Process the value as a relative height, default is absolute + type: boolean + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + LocalRain: + required: + - offset + - values + - point + - diameter + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + duration: + title: Duration (in seconds) + description: event duration in seconds. -9999 is the 'infinite duration' value + (only allowed in conjunction with infinite simulations + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + x-nullable: true + interpolate: + title: Interpolate + type: boolean + values: + type: array + items: + type: array + items: + type: number + description: Timestamp + value pair + example: + - 100 + - 0.5 + maxItems: 2 + minItems: 2 + maxItems: 300 + title: Timeseries + description: 'Timeseries provided as a nested list. The inner list consists + of exactly 2 values: timestamp, value' + example: + - - 0 + - 0.1 + - - 100 + - 0.5 + - - 200 + - 0 + minItems: 1 + units: + title: Units + description: m/s is only option for now + type: string + enum: + - m/s + - mm/h + - mm/min + constant: + title: Constant + type: boolean + point: + title: Point + type: object + description: Point specified in wkt or geojson. Coordinates in longitude, + latitude order. + required: + - type + - coordinates + properties: + type: + title: type + description: Type should always be 'Point' + type: string + default: Point + coordinates: + title: coordinates + description: List of exactly one coordinate (longitude, latitude order) + type: array + items: + type: number + minItems: 2 + maxItems: 2 + example: + type: Point + coordinates: + - 4.695281 + - 52.656047 + diameter: + title: Diameter + type: integer + maximum: 2147483647 + minimum: -2147483648 + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + substances: + type: array + items: + $ref: '#/definitions/ForcingSubstance' + Wind: + required: + - offset + type: object + properties: + id: + title: ID + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + values: + description: '[time, speed, direction]' + type: array + items: + type: array + items: + title: Values + type: number + maxItems: 300 + units: + title: Units + description: wind speed unit (default 'm/s') + type: string + enum: + - m/s + - km/h + speed_interpolate: + title: Speed interpolate + description: interpolate wind speed + type: boolean + readOnly: true + speed_constant: + title: Speed constant + description: constant wind speed + type: boolean + readOnly: true + direction_interpolate: + title: Direction interpolate + description: interpolate wind direction + type: boolean + readOnly: true + direction_constant: + title: Direction constant + description: constant wind direction + type: boolean + readOnly: true + WindDragCoefficient: + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + value: + title: Value + description: global drag coefficient (0-100) + type: number + maximum: 100 + minimum: 0 + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + Event: + type: object + properties: + substances: + type: array + items: + $ref: '#/definitions/Substance' + readOnly: true + lizardrasterrain: + type: array + items: + $ref: '#/definitions/LizardRasterRain' + readOnly: true + lizardtimeseriesrain: + type: array + items: + $ref: '#/definitions/LizardTimeseriesRain' + readOnly: true + timeseriesrain: + type: array + items: + $ref: '#/definitions/TimeseriesRainOverview' + readOnly: true + breach: + type: array + items: + $ref: '#/definitions/Breach' + readOnly: true + lizardrastersourcessinks: + type: array + items: + $ref: '#/definitions/LizardRasterSourcesSinks' + readOnly: true + lizardtimeseriessourcessinks: + type: array + items: + $ref: '#/definitions/LizardTimeseriesSourcesSinks' + readOnly: true + filerastersourcessinks: + type: array + items: + $ref: '#/definitions/FileRasterSourcesSinks' + readOnly: true + filetimeseriessourcessinks: + type: array + items: + $ref: '#/definitions/FileTimeseriesSourcesSinks' + readOnly: true + timeseriessourcessinks: + type: array + items: + $ref: '#/definitions/TimeseriesSourcesSinksOverview' + readOnly: true + leakage: + type: array + items: + $ref: '#/definitions/TimeseriesLeakageOverview' + readOnly: true + filetimeseriesleakage: + type: array + items: + $ref: '#/definitions/FileTimeseriesLeakage' + readOnly: true + filerasterleakage: + type: array + items: + $ref: '#/definitions/FileRasterLeakage' + readOnly: true + initial_twodwaterlevel: + $ref: '#/definitions/TwoDWaterLevel' + initial_onedwaterlevelpredefined: + $ref: '#/definitions/OneDWaterLevelPredefined' + initial_groundwaterlevel: + $ref: '#/definitions/GroundWaterLevel' + initial_groundwaterraster: + $ref: '#/definitions/GroundWaterRaster' + initial_onedwaterlevel: + $ref: '#/definitions/OneDWaterLevel' + initial_onedwaterlevelfile: + $ref: '#/definitions/OneDWaterLevelFile' + initial_twodwaterraster: + $ref: '#/definitions/TwoDWaterRaster' + initial_oned_substance_concentrations: + type: array + items: + $ref: '#/definitions/OneDSubstanceConcentration' + readOnly: true + initial_twod_substance_concentrations: + type: array + items: + $ref: '#/definitions/TwoDSubstanceConcentration' + readOnly: true + filerasterrain: + type: array + items: + $ref: '#/definitions/FileRasterRain' + readOnly: true + filetimeseriesrain: + type: array + items: + $ref: '#/definitions/FileTimeseriesRain' + readOnly: true + initial_savedstate: + $ref: '#/definitions/InitialSavedStateOverview' + savedstates: + type: array + items: + $ref: '#/definitions/SavedStateOverview' + readOnly: true + laterals: + type: array + items: + $ref: '#/definitions/Lateral' + readOnly: true + filelaterals: + type: array + items: + $ref: '#/definitions/FileLateral' + readOnly: true + fileboundaryconditions: + $ref: '#/definitions/FileBoundaryCondition' + tablestructurecontrols: + type: array + items: + $ref: '#/definitions/TableStructureControl' + readOnly: true + memorystructurecontrols: + type: array + items: + $ref: '#/definitions/MemoryStructureControl' + readOnly: true + timedstructurecontrols: + type: array + items: + $ref: '#/definitions/TimedStructureControl' + readOnly: true + filestructurecontrols: + type: array + items: + $ref: '#/definitions/FileStructureControl' + readOnly: true + rasteredits: + type: array + items: + $ref: '#/definitions/RasterEdit' + readOnly: true + obstacleedits: + type: array + items: + $ref: '#/definitions/ObstacleEdit' + readOnly: true + localrain: + type: array + items: + $ref: '#/definitions/LocalRain' + readOnly: true + wind: + type: array + items: + $ref: '#/definitions/Wind' + readOnly: true + initial_winddragcoefficient: + $ref: '#/definitions/WindDragCoefficient' + Action: + required: + - name + type: object + properties: + name: + title: Name + type: string + enum: + - initialize + - start + - pause + - shutdown + - queue + - dequeue + duration: + title: Duration + description: Only valid for name='start'. Run simulation for given duration + (in seconds) and pause + type: integer + minimum: 1 + timeout: + title: Timeout + description: Only valid for name='pause'. Remove simulation after given timeout + (in seconds). Defaults to 300 seconds + type: integer + default: 300 + minimum: 30 + max_rate: + title: Max rate + description: "Only valid for name='start'. Limit maximum speed of the simulation.\ + \ The max_rate is a multiplier relative to real time For example max_rate\ + \ '60' means max 60 simulation seconds in 1 real second " + type: number + minimum: 1 + compute_cluster: + title: ComputeCluster.name + description: The name of the compute cluster that runs/has run the simulation. + type: string + simulation_runner: + title: Simulation runner + description: "Only allowed for name values: 'start', 'initialize' or 'queue\ + \ Simulation runner version used to execute the simulation. If not filled\ + \ in the default version is used. (Note: used for testing new calccore releases\ + \ on the staging environment. On production only the default version can\ + \ be picked)" + type: string + enum: + - 3.3.4-3.3.1 + Timeout: + required: + - timeout + type: object + properties: + timeout: + title: Timeout + description: Only valid for when the simulation is paused. Reset the simulation + timeout to the given value. Defaults to 300 seconds + type: integer + minimum: 30 + StableThresholdSavedState: + required: + - thresholds + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + name: + title: Name + type: string + maxLength: 80 + minLength: 1 + simulation: + title: Simulation + type: string + format: uri + readOnly: true + x-nullable: true + created: + title: Created + type: string + format: date-time + readOnly: true + x-nullable: true + tags: + title: tags + type: array + description: tags provided as a list of strings + items: + type: string + example: + - tag_1 + - tag_2 + expiry: + title: Expiry + type: string + format: date-time + x-nullable: true + thresholds: + type: array + items: + $ref: '#/definitions/Threshold' + file: + $ref: '#/definitions/FileReadOnly' + uuid: + title: Uuid + type: string + format: uuid + TimedSavedStateUpdate: + required: + - time + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + name: + title: Name + type: string + maxLength: 80 + minLength: 1 + simulation: + title: Simulation + type: string + format: uri + readOnly: true + x-nullable: true + created: + title: Created + type: string + format: date-time + x-nullable: true + created_time: + title: Time in simulation (in seconds) + description: Time in simulation the savedstate has been created + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + tags: + title: tags + type: array + description: tags provided as a list of strings + items: + type: string + example: + - tag_1 + - tag_2 + expiry: + title: Expiry + type: string + format: date-time + x-nullable: true + time: + title: Time in simulation (in seconds) + description: Time in simulation to create savedstate + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + file: + $ref: '#/definitions/FileReadOnly' + id: + title: ID + type: integer + readOnly: true + uuid: + title: Uuid + type: string + format: uuid + ConstantLateral: + required: + - offset + - duration + - value + - units + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + duration: + title: Duration (in seconds) + description: event duration in seconds. -9999 is the 'infinite duration' value + (only allowed in conjunction with infinite simulations + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + x-nullable: true + value: + title: Value + type: number + units: + title: Units + description: "'m3/s' (only option for now)" + type: string + enum: + - m3/s + point: + title: Point + type: object + description: Point specified in wkt or geojson. Coordinates in longitude, + latitude order. + required: + - type + - coordinates + properties: + type: + title: type + description: Type should always be 'Point' + type: string + default: Point + coordinates: + title: coordinates + description: List of exactly one coordinate (longitude, latitude order) + type: array + items: + type: number + minItems: 2 + maxItems: 2 + example: + type: Point + coordinates: + - 4.695281 + - 52.656047 + connection_node: + title: Connection node + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + state: + title: State + type: string + enum: + - processing + - valid + - invalid + readOnly: true + state_detail: + title: State detail + type: object + readOnly: true + x-nullable: true + grid_id: + title: Grid id + type: integer + readOnly: true + x-nullable: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + substances: + type: array + items: + $ref: '#/definitions/ForcingSubstance' + GridEventState: + required: + - state + - state_detail + type: object + properties: + state: + title: State + type: string + enum: + - processing + - valid + - invalid + state_detail: + title: State detail + type: object + grid_id: + title: Grid id + type: integer + x-nullable: true + UploadEventFile: + required: + - filename + - offset + type: object + properties: + put_url: + title: Put url + type: string + format: uri + readOnly: true + minLength: 1 + filename: + title: Filename + type: string + maxLength: 255 + minLength: 1 + status: + title: Status + type: string + readOnly: true + minLength: 1 + offset: + title: Offset + type: integer + minimum: 0 + periodic: + title: Periodic + type: string + enum: + - daily + TimeseriesLateral: + required: + - offset + - values + - units + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + interpolate: + title: Interpolate + type: boolean + values: + type: array + items: + type: array + items: + type: number + description: Timestamp + value pair + example: + - 100 + - 0.5 + maxItems: 2 + minItems: 2 + maxItems: 300 + title: Timeseries + description: 'Timeseries provided as a nested list. The inner list consists + of exactly 2 values: timestamp, value' + example: + - - 0 + - 0.1 + - - 100 + - 0.5 + - - 200 + - 0 + minItems: 1 + units: + title: Units + description: "'m3/s' (only option for now)" + type: string + enum: + - m3/s + point: + title: Point + type: object + description: Point specified in wkt or geojson. Coordinates in longitude, + latitude order. + required: + - type + - coordinates + properties: + type: + title: type + description: Type should always be 'Point' + type: string + default: Point + coordinates: + title: coordinates + description: List of exactly one coordinate (longitude, latitude order) + type: array + items: + type: number + minItems: 2 + maxItems: 2 + example: + type: Point + coordinates: + - 4.695281 + - 52.656047 + connection_node: + title: Connection node + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + state: + title: State + type: string + enum: + - processing + - valid + - invalid + readOnly: true + state_detail: + title: State detail + type: object + readOnly: true + x-nullable: true + grid_id: + title: Grid id + type: integer + readOnly: true + x-nullable: true + id: + title: ID + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + substances: + type: array + items: + $ref: '#/definitions/ForcingSubstance' + ConstantLeakage: + required: + - offset + - duration + - value + - units + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + duration: + title: Duration + type: number + value: + title: Value + type: number + units: + title: Units + description: "'m/s' (only option for now)" + type: string + enum: + - m/s + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + NetCDFRasterLeakage: + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + multiplier: + title: Multiplier + type: number + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + duration: + title: Duration + description: Duration of event in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + timestamps: + description: in simulation in seconds + type: array + items: + title: Timestamps + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + interval: + title: Interval + description: interval in seconds + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + values_reference: + title: Values reference + type: string + maxLength: 255 + x-nullable: true + units: + title: Units + type: string + enum: + - m/s + - mm + - mm/h + - mm/hr + x-nullable: true + geotransform: + type: array + items: + title: Geotransform + type: number + maxItems: 6 + epsg_code: + title: Epsg code + type: integer + maximum: 2147483647 + minimum: -2147483648 + file: + $ref: '#/definitions/FileReadOnly' + fill_value: + title: Fill value + type: string + maxLength: 128 + minLength: 1 + id: + title: ID + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + TimeseriesLeakage: + required: + - offset + - values + - units + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + interpolate: + title: Interpolate + type: boolean + values: + type: array + items: + type: array + items: + type: number + description: Timestamp + value pair + example: + - 100 + - 0.5 + maxItems: 2 + minItems: 2 + maxItems: 300 + title: Timeseries + description: 'Timeseries provided as a nested list. The inner list consists + of exactly 2 values: timestamp, value' + example: + - - 0 + - 0.1 + - - 100 + - 0.5 + - - 200 + - 0 + minItems: 1 + units: + title: Units + description: "'m/s' (only option for now)" + type: string + enum: + - m/s + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + NetCDFTimeseriesLeakage: + required: + - units + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + multiplier: + title: Multiplier + type: number + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + duration: + title: Duration + description: Duration of event in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + timestamps: + description: in simulation in seconds + type: array + items: + title: Timestamps + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + interval: + title: Interval + description: interval in seconds + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + values_reference: + title: Values reference + type: string + maxLength: 255 + x-nullable: true + units: + title: Units + type: string + enum: + - mm + - mm/h + file: + $ref: '#/definitions/FileReadOnly' + fill_value: + title: Fill value + type: string + maxLength: 128 + minLength: 1 + id: + title: ID + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + ConstantRain: + required: + - offset + - duration + - value + - units + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + duration: + title: Duration (in seconds) + description: event duration in seconds. -9999 is the 'infinite duration' value + (only allowed in conjunction with infinite simulations + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + x-nullable: true + value: + title: Value + description: Rain intensity + type: number + units: + title: Units + description: m/s is only option for now + type: string + enum: + - m/s + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + substances: + type: array + items: + $ref: '#/definitions/ForcingSubstance' + ConstantLocalRain: + required: + - offset + - value + - diameter + - point + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + value: + title: Value + type: number + units: + title: Units + description: m/s is only option for now + type: string + enum: + - m/s + - mm/h + - mm/min + duration: + title: Duration (in seconds) + description: event duration in seconds. -9999 is the 'infinite duration' value + (only allowed in conjunction with infinite simulations + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + x-nullable: true + interpolate: + title: Interpolate + type: boolean + diameter: + title: Diameter + type: integer + maximum: 2147483647 + minimum: -2147483648 + point: + title: Point + type: object + description: Point specified in wkt or geojson. Coordinates in longitude, + latitude order. + required: + - type + - coordinates + properties: + type: + title: type + description: Type should always be 'Point' + type: string + default: Point + coordinates: + title: coordinates + description: List of exactly one coordinate (longitude, latitude order) + type: array + items: + type: number + minItems: 2 + maxItems: 2 + example: + type: Point + coordinates: + - 4.695281 + - 52.656047 + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + substances: + type: array + items: + $ref: '#/definitions/ForcingSubstance' + TimeseriesLocalRain: + required: + - offset + - values + - diameter + - point + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + values: + type: array + items: + type: array + items: + type: number + description: Timestamp + value pair + example: + - 100 + - 0.5 + maxItems: 2 + minItems: 2 + maxItems: 300 + title: Timeseries + description: 'Timeseries provided as a nested list. The inner list consists + of exactly 2 values: timestamp, value' + example: + - - 0 + - 0.1 + - - 100 + - 0.5 + - - 200 + - 0 + minItems: 1 + interpolate: + title: Interpolate + type: boolean + units: + title: Units + description: m/s is only option for now + type: string + enum: + - m/s + - mm/h + - mm/min + diameter: + title: Diameter + type: integer + maximum: 2147483647 + minimum: -2147483648 + point: + title: Point + type: object + description: Point specified in wkt or geojson. Coordinates in longitude, + latitude order. + required: + - type + - coordinates + properties: + type: + title: type + description: Type should always be 'Point' + type: string + default: Point + coordinates: + title: coordinates + description: List of exactly one coordinate (longitude, latitude order) + type: array + items: + type: number + minItems: 2 + maxItems: 2 + example: + type: Point + coordinates: + - 4.695281 + - 52.656047 + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + substances: + type: array + items: + $ref: '#/definitions/ForcingSubstance' + NetCDFRasterRain: + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + multiplier: + title: Multiplier + type: number + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + duration: + title: Duration + description: Duration of event in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + timestamps: + description: in simulation in seconds + type: array + items: + title: Timestamps + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + interval: + title: Interval + description: interval in seconds + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + values_reference: + title: Values reference + type: string + maxLength: 255 + x-nullable: true + fill_value: + title: Fill value + type: string + maxLength: 128 + minLength: 1 + units: + title: Units + type: string + enum: + - m/s + - mm + - mm/h + - mm/hr + x-nullable: true + geotransform: + type: array + items: + title: Geotransform + type: number + maxItems: 6 + epsg_code: + title: Epsg code + type: integer + maximum: 2147483647 + minimum: -2147483648 + file: + $ref: '#/definitions/FileReadOnly' + uid: + title: Uid + type: string + format: uuid + readOnly: true + substances: + type: array + items: + $ref: '#/definitions/ForcingSubstance' + UploadWithSubstances: + required: + - filename + type: object + properties: + substances: + type: array + items: + $ref: '#/definitions/ForcingSubstance' + put_url: + title: Put url + type: string + format: uri + readOnly: true + minLength: 1 + filename: + title: Filename + type: string + maxLength: 255 + minLength: 1 + status: + title: Status + type: string + readOnly: true + minLength: 1 + TimeseriesRain: + required: + - offset + - values + - units + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + duration: + title: Duration (in seconds) + description: event duration in seconds. -9999 is the 'infinite duration' value + (only allowed in conjunction with infinite simulations + type: integer + readOnly: true + x-nullable: true + interpolate: + title: Interpolate + type: boolean + values: + type: array + items: + type: array + items: + type: number + description: Timestamp + value pair + example: + - 100 + - 0.5 + maxItems: 2 + minItems: 2 + maxItems: 300 + title: Timeseries + description: 'Timeseries provided as a nested list. The inner list consists + of exactly 2 values: timestamp, value' + example: + - - 0 + - 0.1 + - - 100 + - 0.5 + - - 200 + - 0 + minItems: 1 + units: + title: Units + description: m/s is only option for now + type: string + enum: + - m/s + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + substances: + type: array + items: + $ref: '#/definitions/ForcingSubstance' + NetCDFTimeseriesRain: + required: + - units + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + multiplier: + title: Multiplier + type: number + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + duration: + title: Duration + description: Duration of event in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + timestamps: + description: in simulation in seconds + type: array + items: + title: Timestamps + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + interval: + title: Interval + description: interval in seconds + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + values_reference: + title: Values reference + type: string + maxLength: 255 + x-nullable: true + fill_value: + title: Fill value + type: string + maxLength: 128 + minLength: 1 + units: + title: Units + type: string + enum: + - mm + - mm/h + file: + $ref: '#/definitions/FileReadOnly' + uid: + title: Uid + type: string + format: uuid + readOnly: true + substances: + type: array + items: + $ref: '#/definitions/ForcingSubstance' + ConstantSourcesSinks: + required: + - offset + - duration + - value + - units + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + duration: + title: Duration + type: number + value: + title: Value + type: number + units: + title: Units + description: "'m/s' (only option for now)" + type: string + enum: + - m/s + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + NetCDFRasterSourcesSinks: + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + multiplier: + title: Multiplier + type: number + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + duration: + title: Duration + description: Duration of event in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + timestamps: + description: in simulation in seconds + type: array + items: + title: Timestamps + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + interval: + title: Interval + description: interval in seconds + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + values_reference: + title: Values reference + type: string + maxLength: 255 + x-nullable: true + units: + title: Units + type: string + enum: + - m/s + - mm + - mm/h + - mm/hr + x-nullable: true + geotransform: + type: array + items: + title: Geotransform + type: number + maxItems: 6 + epsg_code: + title: Epsg code + type: integer + maximum: 2147483647 + minimum: -2147483648 + file: + $ref: '#/definitions/FileReadOnly' + fill_value: + title: Fill value + type: string + maxLength: 128 + minLength: 1 + id: + title: ID + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + TimeseriesSourcesSinks: + required: + - offset + - values + - units + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + interpolate: + title: Interpolate + type: boolean + values: + type: array + items: + type: array + items: + type: number + description: Timestamp + value pair + example: + - 100 + - 0.5 + maxItems: 2 + minItems: 2 + maxItems: 300 + title: Timeseries + description: 'Timeseries provided as a nested list. The inner list consists + of exactly 2 values: timestamp, value' + example: + - - 0 + - 0.1 + - - 100 + - 0.5 + - - 200 + - 0 + minItems: 1 + units: + title: Units + description: "'m/s' (only option for now)" + type: string + enum: + - m/s + uid: + title: Uid + type: string + format: uuid + readOnly: true + id: + title: ID + type: integer + readOnly: true + NetCDFTimeseriesSourcesSinks: + required: + - units + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + multiplier: + title: Multiplier + type: number + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + duration: + title: Duration + description: Duration of event in seconds + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + timestamps: + description: in simulation in seconds + type: array + items: + title: Timestamps + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + interval: + title: Interval + description: interval in seconds + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + values_reference: + title: Values reference + type: string + maxLength: 255 + x-nullable: true + units: + title: Units + type: string + enum: + - mm + - mm/h + file: + $ref: '#/definitions/FileReadOnly' + fill_value: + title: Fill value + type: string + maxLength: 128 + minLength: 1 + id: + title: ID + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + MeasureLocationGridEventState: + required: + - state + - state_detail + type: object + properties: + state: + title: State + type: string + enum: + - processing + - valid + - invalid + state_detail: + title: State detail + type: object + grid_id: + title: Grid id + type: integer + x-nullable: true + location_grid_ids: + type: array + items: + type: integer + x-nullable: true + x-nullable: true + location_resource_ids: + type: array + items: + type: integer + x-nullable: true + x-nullable: true + location_resource_states: + type: array + items: + type: string + minLength: 1 + x-nullable: true + x-nullable: true + location_resource_state_details: + type: array + items: + type: object + x-nullable: true + x-nullable: true + ConstantWind: + required: + - offset + type: object + properties: + id: + title: ID + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + duration: + title: Duration (in seconds) + description: event duration in seconds. -9999 is the 'infinite duration' value + (only allowed in conjunction with infinite simulations + type: integer + maximum: 9223372036854775807 + minimum: -9223372036854775808 + x-nullable: true + values: + description: '[time, speed, direction]' + type: array + items: + type: array + items: + title: Values + type: number + readOnly: true + units: + title: Units + description: wind speed unit (default 'm/s') + type: string + enum: + - m/s + - km/h + speed_interpolate: + title: Speed interpolate + description: interpolate wind speed + type: boolean + readOnly: true + speed_constant: + title: Speed constant + description: constant wind speed + type: boolean + readOnly: true + direction_interpolate: + title: Direction interpolate + description: interpolate wind direction + type: boolean + readOnly: true + direction_constant: + title: Direction constant + description: constant wind direction + type: boolean + readOnly: true + speed_value: + title: Speed value + description: constant wind speed + type: number + minimum: 0 + direction_value: + title: Direction value + description: constant wind direction in degrees (0-360) from north - meteorological + standard (thus, 180 is a southern wind) + type: integer + maximum: 360 + minimum: 0 + TimeseriesWind: + required: + - offset + type: object + properties: + id: + title: ID + type: integer + readOnly: true + uid: + title: Uid + type: string + format: uuid + readOnly: true + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + offset: + title: Offset + description: offset of event in simulation in seconds + type: integer + maximum: 2147483647 + minimum: 0 + values: + description: '[time, speed, direction]' + type: array + items: + type: array + items: + title: Values + type: number + maxItems: 300 + units: + title: Units + description: wind speed unit (default 'm/s') + type: string + enum: + - m/s + - km/h + speed_interpolate: + title: Speed interpolate + description: interpolate wind speed + type: boolean + speed_constant: + title: Speed constant + description: constant wind speed + type: boolean + readOnly: true + direction_interpolate: + title: Direction interpolate + description: interpolate wind direction + type: boolean + direction_constant: + title: Direction constant + description: constant wind direction + type: boolean + readOnly: true + InitialSavedState: + required: + - saved_state + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + saved_state: + title: Saved state + type: string + format: uri + id: + title: ID + type: integer + readOnly: true + uuid: + title: Uuid + type: string + readOnly: true + Progress: + required: + - time + - percentage + type: object + properties: + time: + title: Time + type: number + percentage: + title: Percentage + type: integer + ResultFile: + required: + - filename + - created + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + filename: + title: Filename + type: string + maxLength: 255 + minLength: 1 + description: + title: Description + type: string + x-nullable: true + created: + title: Created + type: string + format: date-time + file: + $ref: '#/definitions/FileReadOnly' + id: + title: ID + type: integer + readOnly: true + ArrivalTimePostProcessing: + type: object + properties: + basic_post_processing: + title: Basic post processing + type: integer + readOnly: true + BasicPostProcessing: + type: object + properties: + simulation: + title: Simulation + type: string + format: uri + readOnly: true + scenario_name: + title: Scenario name + description: Scenario name for saving the results + type: string + maxLength: 128 + minLength: 1 + process_basic_results: + title: Process basic results + type: boolean + result_uuid: + title: Result uuid + type: string + format: uuid + DamagePostProcessing: + required: + - cost_type + - flood_month + - inundation_period + - repair_time_infrastructure + - repair_time_buildings + type: object + properties: + basic_post_processing: + title: Basic post processing + type: integer + readOnly: true + cost_type: + title: Cost type + description: "'min', 'avg', or 'max'" + type: string + enum: + - min + - avg + - max + flood_month: + title: Flood month + type: string + enum: + - jan + - feb + - mar + - apr + - may + - jun + - jul + - aug + - sep + - oct + - nov + - dec + inundation_period: + title: Inundation period + description: time in hours + type: number + minimum: 1.0 + repair_time_infrastructure: + title: Repair time infrastructure + description: time in hours + type: integer + maximum: 240 + minimum: 1 + repair_time_buildings: + title: Repair time buildings + description: time in hours + type: integer + maximum: 240 + minimum: 1 + Result: + required: + - basic + - damage_estimation + - arrival_time + type: object + properties: + basic: + title: Basic + type: boolean + damage_estimation: + title: Damage estimation + type: boolean + arrival_time: + title: Arrival time + type: boolean + DamageEstimation: + type: object + properties: + damage_table: + title: Damage table + type: string + readOnly: true + default: 3Di-V1 + elevation_raster_uuid: + title: Elevation raster uuid + type: string + readOnly: true + default: 36588275-f3e3-4120-8c1e-602f7ae85386 + landcover_raster_uuid: + title: Landcover raster uuid + type: string + readOnly: true + default: 717478ef-099d-41d8-971d-8b4309e59d92 + road_rail_raster_uuid: + title: Road rail raster uuid + type: string + readOnly: true + default: e40c1b96-e71f-462c-8acb-59a3a8b7db89 + cost_type: + title: Cost type + type: integer + readOnly: true + flood_month: + title: Flood month + type: integer + readOnly: true + inundation_period: + title: Inundation period + type: integer + readOnly: true + repair_time_infrastructure: + title: Repair time infrastructure + type: integer + readOnly: true + repair_time_buildings: + title: Repair time buildings + type: integer + readOnly: true + Settings: + type: object + properties: + damage_estimation: + $ref: '#/definitions/DamageEstimation' + PostProcessingOverview: + required: + - results + - settings + type: object + properties: + username: + title: Username + type: string + readOnly: true + external_user_id: + title: External user id + type: string + readOnly: true + metadata_version: + title: Metadata version + type: string + readOnly: true + default: 1.2 + start_time_sim: + title: Start time sim + type: string + readOnly: true + end_time_sim: + title: End time sim + type: string + readOnly: true + results: + $ref: '#/definitions/Result' + settings: + $ref: '#/definitions/Settings' + model_name: + title: Model name + type: string + readOnly: true + simulation_name: + title: Simulation name + type: string + readOnly: true + scenario_name: + title: Scenario name + description: Scenario name for saving the results + type: string + readOnly: true + minLength: 1 + model_id: + title: Model id + type: integer + readOnly: true + model_revision_id: + title: Model revision id + type: string + readOnly: true + email: + title: Email + type: string + readOnly: true + result_uuid: + title: Result uuid + type: string + format: uuid + readOnly: true + organisation_uuid: + title: Organisation uuid + type: string + readOnly: true + simulation: + title: Simulation + type: integer + readOnly: true + PostProcessingStart: + type: object + properties: {} + PostProcessingStatus: + required: + - status + type: object + properties: + simulation: + title: Simulation + type: string + format: uri + readOnly: true + status: + title: Status + type: string + enum: + - created + - requested + - archiving + - archiving_failed + - archived + created: + title: Created + type: string + format: date-time + readOnly: true + AggregationSettings: + required: + - flow_variable + - method + - interval + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + name: + title: Name + description: Give your aggregation setting a name to be able to find it back + in the results file. + type: string + maxLength: 120 + x-nullable: true + flow_variable: + title: Flow variable + description: | + Options: + water_level = Water Level + flow_velocity = Flow Velocity + discharge = Discharge + volume = Volume + pump_discharge = Pump Discharge + wet_cross_section = Wet Cross Section + lateral_discharge = Lateral Discharge + wet_surface = Wet Surface + rain = Rain + simple_infiltration = Simple Infiltration + leakage = Leakage + interception = Interception + surface_source_sink_discharge = Surface Source Sink Discharge + type: string + enum: + - water_level + - flow_velocity + - discharge + - volume + - pump_discharge + - wet_cross_section + - lateral_discharge + - wet_surface + - rain + - simple_infiltration + - leakage + - interception + - surface_source_sink_discharge + method: + title: Method + description: |- + Options: + min = minimum value of the variable in the configured interval + max = maximum value of the variable in the configured interval + avg = average value of the variable in the configured interval + cum = variable integration over time [dt * variable] + cum_positive = variable integration over time [dt * variable] in positive direction + cum_negative = variable integration over time [dt * variable] in negative direction + current = current value of a variable + sum = variable summation over configured interval + + Note: 'current' is required in case one checks the water balance for variables that are the result of the processes. Only valid for flow_variable 'volume' and 'intercepted_volume' + type: string + enum: + - min + - max + - avg + - cum + - cum_positive + - cum_negative + - current + - sum + interval: + title: Interval + description: aggregation interval in seconds + type: number + NumericalSettings: + required: + - pump_implicit_ratio + - cfl_strictness_factor_1d + - cfl_strictness_factor_2d + - convergence_eps + - convergence_cg + - flow_direction_threshold + - friction_shallow_water_depth_correction + - general_numerical_threshold + - limiter_waterlevel_gradient_1d + - limiter_waterlevel_gradient_2d + - limiter_slope_crossectional_area_2d + - limiter_slope_friction_2d + - max_non_linear_newton_iterations + - max_degree_gauss_seidel + - min_friction_velocity + - min_surface_area + - use_preconditioner_cg + - preissmann_slot + - limiter_slope_thin_water_layer + - use_of_cg + - use_nested_newton + - flooding_threshold + type: object + properties: + id: + title: ID + type: integer + readOnly: true + simulation_id: + title: Simulation id + type: integer + readOnly: true + pump_implicit_ratio: + title: Pump implicit ratio + type: number + maximum: 1.0 + minimum: 0.0 + cfl_strictness_factor_1d: + title: Cfl strictness factor 1d + description: Strictness of CFL (Courant–Friedrichs–Lewy) condition for 1D. + type: number + minimum: 1e-14 + cfl_strictness_factor_2d: + title: Cfl strictness factor 2d + description: Strictness of CFL (Courant–Friedrichs–Lewy) condition for 2D. + type: number + minimum: 1e-14 + convergence_eps: + title: Convergence eps + description: Minimal convergence criterion for Newton's method, suitable default + is 1.0e-5, due to numerical precision. + type: number + maximum: 0.0001 + minimum: 1e-07 + convergence_cg: + title: Convergence cg + description: Convergence criterion of cg-method, suitable default is 1.0e-9, + due to numerical precision. + type: number + maximum: 1e-07 + minimum: 1e-12 + flow_direction_threshold: + title: Flow direction threshold + description: Threshold value for upwind scheme based on flow velocity, suitable + default is 1e-06. + type: number + maximum: 0.01 + minimum: 1e-13 + friction_shallow_water_depth_correction: + title: Friction shallow water depth correction + description: |- + In case the friction assumptions based on the dominant friction balance gives a structurally underestimation of the friction, you can switch this setting on. + Options: + 0 = off + 1 = max between avg and divided channel based friction + 2 = always linearized + 3 = linearizes the depth based on a weighed averaged + + If options 3 is used the maximum depth of a thin layer needs to be defined. Do not use in combination with interflow. Suitable default is 0 (OFF). + type: integer + enum: + - 0 + - 1 + - 2 + - 3 + general_numerical_threshold: + title: General numerical threshold + description: Suitable default is 1.0e-8 + type: number + maximum: 1e-07 + minimum: 1e-13 + time_integration_method: + title: Time integration method + description: | + There are various methods to discretize the equations. At the moment only the first-order, semi-implicit method is supported and tested. + Options: + 0 = euler implicit + type: integer + enum: + - 0 + limiter_waterlevel_gradient_1d: + title: Limiter waterlevel gradient 1d + description: The limiter on the water level gradient allows the model to deal + with unrealistically steep gradients. Suitable default is 1. + type: integer + enum: + - 0 + - 1 + limiter_waterlevel_gradient_2d: + title: Limiter waterlevel gradient 2d + description: The limiter on the water level gradient allows the model to deal + with unrealistically steep gradients. Suitable default is 1. + type: integer + enum: + - 0 + - 1 + limiter_slope_crossectional_area_2d: + title: Limiter slope crossectional area 2d + description: |- + This limiter starts working in case the depth based on the downstream water level is zero and may be useful in sloping areas. + Options: + 0 = off + 1 = higher order scheme (might be sensitive to instabilities) + 2 = cross-sections treated as upwind method volume/surface area + 3 = combination traditional method thin layer approach + If option 3 is used the maximum depth of a thin layer needs to be defined. Do not use in combination with interflow. + type: integer + enum: + - 0 + - 1 + - 2 + - 3 + limiter_slope_friction_2d: + title: Limiter slope friction 2d + description: | + This limiter starts working in case the depth based on the downstream water level is zero and may be useful in sloping areas. This limiter is mandatory if the limiter_slope_crossectional_area_2d setting is greater than 0. Do not use in combination with interflow. Suitable default is 0 (OFF) + Options: + 0 = off + 1 = standard + type: integer + enum: + - 0 + - 1 + max_non_linear_newton_iterations: + title: Max non linear newton iterations + description: Maximum number of non-linear newton iterations in single time + step. Suitable default is 20. + type: integer + maximum: 2147483647 + minimum: 1 + max_degree_gauss_seidel: + title: Max degree gauss seidel + description: |- + Values below are advised for different model types: + 700 for 1D flow + 7 for 1D and 2D flow + 5 for surface 2D flow only + 7 for surface and groundwater flow + 70 for 1D, 2D surface and groundwater flow or higher. + Play around with this value, can speed up your model significantly, especially in case of ground water flow. Suitable default is 0. + type: integer + maximum: 2147483647 + minimum: 1 + min_friction_velocity: + title: Min friction velocity + description: To guarantee some initial friction only in flooded areas and + for large time steps, it is wise to assume a minimum velocity for computing + the friction. Suitable default is 0.01. + type: number + maximum: 1 + minimum: 0 + min_surface_area: + title: Min surface area + description: Suitable default is 1.0e-8. + type: number + maximum: 1e-07 + minimum: 1e-13 + use_preconditioner_cg: + title: Use preconditioner cg + description: |- + Use pre-conditioner for matrix solver. Increases simulation speed in most cases. + Options: + 0 = off + 1 = standard + . Suitable default is 1 (STANDARD). + type: integer + enum: + - 0 + - 1 + preissmann_slot: + title: Preissmann slot + description: 'A conceptual vertical narrow slot providing a conceptual free + surface condition for the flow when the water level is above the top of + a closed conduit. Often used to guarantee stability. Not necessary in 3Di + even for pressurized pipe flow. Note: Works only for circular profiles. + Suitable default is 0.0. Unit: m2.' + type: number + minimum: 0 + limiter_slope_thin_water_layer: + title: Limiter slope thin water layer + description: 'Mandatory when using friction_shallow_water_depth_correction + option 3 or limiter_slope_crossectional_area_2d option 3. Unit: m' + type: number + minimum: 0 + use_of_cg: + title: Use of cg + description: Number of conjugate gradient method iterations, before switching + to another method. Suitable default is 20. + type: integer + maximum: 2147483647 + minimum: 1 + use_nested_newton: + title: Use nested newton + description: Set to 'True' for 1D calculations with closed profiles to handle + non-linearity in volume-water level relation. When set to 'False' it will + be used if calculations become non-linear. For sewerage systems it is advised + to set this setting to 'True'. Otherwise a suitable default is 'False' + type: boolean + flooding_threshold: + title: Flooding threshold + description: Water depth threshold for flow between 2D cells. Depth relative + to lowest bathymetry pixel at the edge between two 2D cells. Suitable default + is 0.000001. + type: number + maximum: 0.05 + minimum: 0 + PhysicalSettings: + required: + - use_advection_1d + - use_advection_2d + type: object + properties: + id: + title: ID + type: integer + readOnly: true + simulation_id: + title: Simulation id + type: integer + readOnly: true + use_advection_1d: + title: Use advection 1d + description: | + Options: + 0 = off + 1 = standard + type: integer + enum: + - 0 + - 1 + use_advection_2d: + title: Use advection 2d + description: | + Options: + 0 = off + 1 = standard + type: integer + enum: + - 0 + - 1 + TimeStepSettings: + required: + - time_step + - min_time_step + - use_time_step_stretch + - output_time_step + type: object + properties: + id: + title: ID + type: integer + readOnly: true + simulation_id: + title: Simulation id + type: integer + readOnly: true + time_step: + title: Time step + description: Size of the simulation time step in seconds. + type: number + minimum: 1e-14 + min_time_step: + title: Min time step + description: Minimum size of the simulation time step in seconds. Suitable + default is 0.001. + type: number + minimum: 1e-14 + max_time_step: + title: Max time step + description: Only in combination with use_time_step_stretch=True. + type: number + minimum: 1e-14 + x-nullable: true + use_time_step_stretch: + title: Use time step stretch + description: Permit the time step to increase automatically, when the flow + allows it. + type: boolean + output_time_step: + title: Output time step + description: The interval in seconds in which results are saved to disk. + type: number + minimum: 1e-14 + SimulationSettingsOverview: + type: object + properties: + physical_settings: + $ref: '#/definitions/PhysicalSettings' + numerical_settings: + $ref: '#/definitions/NumericalSettings' + time_step_settings: + $ref: '#/definitions/TimeStepSettings' + aggregation_settings: + type: array + items: + $ref: '#/definitions/AggregationSettings' + readOnly: true + CurrentStatus: + required: + - id + - name + - created + type: object + properties: + id: + title: Id + type: integer + name: + title: Name + type: string + minLength: 1 + created: + title: Created + type: string + format: date-time + time: + title: Time + type: number + paused: + title: Paused + type: boolean + exit_code: + title: Exit code + type: string + readOnly: true + SimulationStatus: + required: + - name + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + name: + title: Name + type: string + enum: + - created + - starting + - initialized + - queued + - ended + - postprocessing + - finished + - crashed + simulation: + title: Simulation + type: string + format: uri + readOnly: true + simulation_id: + title: Simulation id + type: integer + readOnly: true + simulation_name: + title: Simulation name + type: string + readOnly: true + simulation_user_email: + title: Simulation user email + type: string + readOnly: true + simulation_organisation_unique_id: + title: Simulation organisation unique id + type: string + readOnly: true + simulation_tags: + type: array + items: + type: string + x-nullable: true + readOnly: true + simulation_user_first_name: + title: Simulation user first name + type: string + readOnly: true + simulation_user_last_name: + title: Simulation user last name + type: string + readOnly: true + threedimodel_slug: + title: Threedimodel slug + type: string + readOnly: true + threedimodel_id: + title: Threedimodel id + type: integer + readOnly: true + has_results: + title: Has results + type: boolean + readOnly: true + created: + title: Created + type: string + format: date-time + readOnly: true + expiry: + title: Expiry + type: string + format: date-time + readOnly: true + x-nullable: true + time: + title: Time (in seconds) + description: simulation time in seconds + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + paused: + title: True if simulation is paused, only valid in initialized state + type: boolean + x-nullable: true + detail: + title: Detail + type: object + x-nullable: true + exit_code: + title: Exit code + description: only available for final statuses like 'finished' or 'crashed'. + Gives detailed insight to the application state when the simulation finished + type: integer + enum: + - 1110 + - 1210 + - 1240 + - 4161 + - 4262 + - 4263 + - 4264 + - 4265 + - 4120 + - 4220 + - 4150 + - 4280 + - 4240 + - 4270 + - 4230 + - 4231 + - 4232 + - 2150 + - 2110 + - 2210 + - 2120 + - 2220 + - 2230 + - 2240 + x-nullable: true + id: + title: ID + type: integer + readOnly: true + BreachGraphRequest: + required: + - start_time + - subscribe + - line_id + type: object + properties: + start_time: + title: Start time + description: simulation time in seconds + type: integer + minimum: 0 + history_points_limit: + title: History points limit + description: Maximum number of points of history to return + type: integer + default: 200 + maximum: 500 + minimum: 1 + subscribe: + title: Subscribe + description: Subscribe for new results during simulation + type: boolean + subscribe_rate_limit: + title: Subscribe rate limit + description: Max number of items per second for subscription + type: number + default: 0.5 + maximum: 2 + minimum: 0.25 + line_id: + title: Line id + type: integer + minimum: 1 + BreachGraph: + required: + - url + type: object + properties: + url: + title: Url + type: string + format: uri + minLength: 1 + PumpDischargeGraphRequest: + required: + - start_time + - subscribe + - pump_id + type: object + properties: + start_time: + title: Start time + description: simulation time in seconds + type: integer + minimum: 0 + history_points_limit: + title: History points limit + description: Maximum number of points of history to return + type: integer + default: 200 + maximum: 500 + minimum: 1 + subscribe: + title: Subscribe + description: Subscribe for new results during simulation + type: boolean + subscribe_rate_limit: + title: Subscribe rate limit + description: Max number of items per second for subscription + type: number + default: 0.5 + maximum: 2 + minimum: 0.25 + pump_id: + title: Pump id + type: integer + minimum: 1 + PumpDischargeGraph: + required: + - url + type: object + properties: + url: + title: Url + type: string + format: uri + minLength: 1 + RainGraphRequest: + required: + - start_time + - subscribe + - node_id + type: object + properties: + start_time: + title: Start time + description: simulation time in seconds + type: integer + minimum: 0 + history_points_limit: + title: History points limit + description: Maximum number of points of history to return + type: integer + default: 200 + maximum: 500 + minimum: 1 + subscribe: + title: Subscribe + description: Subscribe for new results during simulation + type: boolean + subscribe_rate_limit: + title: Subscribe rate limit + description: Max number of items per second for subscription + type: number + default: 0.5 + maximum: 2 + minimum: 0.25 + node_id: + title: Node id + type: integer + minimum: 1 + RainGraph: + required: + - url + type: object + properties: + url: + title: Url + type: string + format: uri + minLength: 1 + WaterFlowGraphRequest: + required: + - start_time + - subscribe + - line_id + type: object + properties: + start_time: + title: Start time + description: simulation time in seconds + type: integer + minimum: 0 + history_points_limit: + title: History points limit + description: Maximum number of points of history to return + type: integer + default: 200 + maximum: 500 + minimum: 1 + subscribe: + title: Subscribe + description: Subscribe for new results during simulation + type: boolean + subscribe_rate_limit: + title: Subscribe rate limit + description: Max number of items per second for subscription + type: number + default: 0.5 + maximum: 2 + minimum: 0.25 + line_id: + title: Line id + type: integer + minimum: 1 + WaterGraph: + required: + - url + type: object + properties: + url: + title: Url + type: string + format: uri + minLength: 1 + WaterLevelGraphRequest: + required: + - start_time + - subscribe + - node_id + type: object + properties: + start_time: + title: Start time + description: simulation time in seconds + type: integer + minimum: 0 + history_points_limit: + title: History points limit + description: Maximum number of points of history to return + type: integer + default: 200 + maximum: 500 + minimum: 1 + subscribe: + title: Subscribe + description: Subscribe for new results during simulation + type: boolean + subscribe_rate_limit: + title: Subscribe rate limit + description: Max number of items per second for subscription + type: number + default: 0.5 + maximum: 2 + minimum: 0.25 + node_id: + title: Node id + type: integer + minimum: 1 + WaterLevelProfileRequest: + required: + - geometry + - subscribe + type: object + properties: + geometry: + title: Linestring + description: Linestring (epsg:4326) specified in wkt or geojson. Coordinates + in longitude, latitude order. + type: object + required: + - type + - coordinates + properties: + type: + title: type + description: Type should always be 'linestring' or 'LINESTRING' + type: string + default: Linestring + coordinates: + title: coordinates + description: List of coordinates. (longitude, latitude order) + type: array + items: + type: array + items: + type: number + minItems: 2 + maxItems: 2 + minItems: 2 + example: + type: LineString + coordinates: + - - 4.668275805499175 + - 52.619558913867856 + - - 4.73849433310911 + - 52.66453976184968 + points_limit: + title: Points limit + description: Maximum number of points to return + type: integer + default: 100 + maximum: 200 + minimum: 1 + subscribe: + title: Subscribe + description: Subscribe for new results during simulation + type: boolean + subscribe_rate_limit: + title: Subscribe rate limit + description: Max number of items per second for subscription + type: number + default: 0.5 + maximum: 1 + minimum: 0.25 + WaterLevelProfile: + required: + - url + type: object + properties: + url: + title: Url + type: string + format: uri + minLength: 1 + Waterdepth: + required: + - websocket_url + type: object + properties: + websocket_url: + title: Websocket url + type: string + format: uri + minLength: 1 + Profile: + required: + - url + type: object + properties: + url: + title: Url + type: string + format: uri + minLength: 1 + TMS: + required: + - tms_url + - minmax_url + type: object + properties: + tms_url: + title: Tms url + type: string + format: uri + minLength: 1 + minmax_url: + title: Minmax url + type: string + format: uri + minLength: 1 + SimulationChannel: + type: object + properties: + id: + title: ID + type: integer + readOnly: true + simulation: + title: Simulation + type: string + format: uri + readOnly: true + channel_name: + title: Channel name + type: string + readOnly: true + minLength: 1 + created: + title: Created + type: string + format: date-time + readOnly: true + state: + title: State + type: string + enum: + - pending + - confirmed + - timeout + readOnly: true + SimulationStatusStatistics: + required: + - name + - total + type: object + properties: + name: + title: Name + type: string + minLength: 1 + total: + title: Total + type: integer + RasterOptions: + type: object + properties: + dem_file: + title: Dem file + type: string + maxLength: 80 + minLength: 1 + dem_raw_file: + title: Dem raw file + type: string + maxLength: 80 + minLength: 1 + equilibrium_infiltration_rate_file: + title: Equilibrium infiltration rate file + type: string + maxLength: 80 + minLength: 1 + frict_coef_file: + title: Frict coef file + type: string + maxLength: 80 + minLength: 1 + initial_groundwater_level_file: + title: Initial groundwater level file + type: string + maxLength: 80 + minLength: 1 + initial_waterlevel_file: + title: Initial waterlevel file + type: string + maxLength: 80 + minLength: 1 + groundwater_hydro_connectivity_file: + title: Groundwater hydro connectivity file + type: string + maxLength: 80 + minLength: 1 + groundwater_impervious_layer_level_file: + title: Groundwater impervious layer level file + type: string + maxLength: 80 + minLength: 1 + infiltration_decay_period_file: + title: Infiltration decay period file + type: string + maxLength: 80 + minLength: 1 + initial_infiltration_rate_file: + title: Initial infiltration rate file + type: string + maxLength: 80 + minLength: 1 + leakage_file: + title: Leakage file + type: string + maxLength: 80 + minLength: 1 + phreatic_storage_capacity_file: + title: Phreatic storage capacity file + type: string + maxLength: 80 + minLength: 1 + hydraulic_conductivity_file: + title: Hydraulic conductivity file + type: string + maxLength: 80 + minLength: 1 + porosity_file: + title: Porosity file + type: string + maxLength: 80 + minLength: 1 + infiltration_rate_file: + title: Infiltration rate file + type: string + maxLength: 80 + minLength: 1 + max_infiltration_capacity_file: + title: Max infiltration capacity file + type: string + maxLength: 80 + minLength: 1 + interception_file: + title: Interception file + type: string + maxLength: 80 + minLength: 1 + vegetation_height_file: + title: Vegetation height file + type: string + maxLength: 80 + minLength: 1 + vegetation_drag_coefficient_file: + title: Vegetation drag coefficient file + type: string + maxLength: 80 + minLength: 1 + vegetation_stem_count_file: + title: Vegetation stem count file + type: string + maxLength: 80 + minLength: 1 + vegetation_stem_diameter_file: + title: Vegetation stem diameter file + type: string + maxLength: 80 + minLength: 1 + initial_concentration_file: + title: Initial concentration file + type: string + maxLength: 80 + minLength: 1 + BoundaryCondition: + required: + - boundary_id + - type + - dimension + type: object + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: Url + type: string + format: uri + readOnly: true + boundary_id: + title: Boundary id + type: integer + maximum: 2147483647 + minimum: -2147483648 + threedimodel: + title: Threedimodel + type: string + format: uri + readOnly: true + type: + title: Type + type: string + enum: + - velocity + - sommerfeldt + - riemann + - water_level + - discharge + dimension: + title: Dimension + type: string + enum: + - one_d + - two_d + Raster: + required: + - type + - name + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + type: + title: Type + type: string + enum: + - dem_file + - dem_raw_file + - equilibrium_infiltration_rate_file + - frict_coef_file + - initial_groundwater_level_file + - initial_waterlevel_file + - groundwater_hydro_connectivity_file + - groundwater_impervious_layer_level_file + - infiltration_decay_period_file + - initial_infiltration_rate_file + - leakage_file + - phreatic_storage_capacity_file + - hydraulic_conductivity_file + - porosity_file + - infiltration_rate_file + - max_infiltration_capacity_file + - interception_file + - vegetation_height_file + - vegetation_drag_coefficient_file + - vegetation_stem_count_file + - vegetation_stem_diameter_file + - initial_concentration_file + threedimodel: + title: Threedimodel + type: string + format: uri + readOnly: true + x-nullable: true + name: + title: Name + type: string + maxLength: 60 + minLength: 1 + file: + $ref: '#/definitions/FileReadOnly' + id: + title: ID + type: integer + readOnly: true + epsg_code: + title: Epsg code + type: integer + maximum: 2147483647 + minimum: -2147483648 + x-nullable: true + extent: + title: Extent + type: object + description: Extent specified either in geojson, wkt or ewkt. Coordinates + in longitude, latitude order. + required: + - type + - coordinates + properties: + type: + title: type + description: Type should always be 'Linestring' + type: string + default: Linestring + coordinates: + title: coordinates + description: Exactly 2 coordinates, specifying the bottom left (longitude, + latitude order)and upper right respectively + type: array + items: + type: array + items: + type: number + minItems: 2 + maxItems: 2 + minItems: 2 + maxItems: 2 + minItems: 2 + maxItems: 2 + example: + type: LineString + coordinates: + - - 4.668275805499175 + - 52.619558913867856 + - - 4.73849433310911 + - 52.66453976184968 + geotransform: + type: array + items: + title: Geotransform + type: number + maxItems: 6 + x-nullable: true + unit: + title: Unit + type: string + enum: + - meters + x-nullable: true + InitialWaterlevel: + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + threedimodel: + title: Threedimodel + type: string + format: uri + readOnly: true + user_generated: + title: User generated + type: boolean + file: + $ref: '#/definitions/FileReadOnly' + source_raster: + title: Source raster + type: string + format: uri + state: + title: State + type: string + enum: + - processing + - valid + - invalid + readOnly: true + state_detail: + title: State detail + type: object + readOnly: true + x-nullable: true + id: + title: ID + type: integer + readOnly: true + source_raster_id: + title: Source raster id + type: integer + readOnly: true + dimension: + title: Dimension + type: string + enum: + - one_d + - two_d + PotentialBreach: + required: + - connected_pnt_id + - levee_material + - line_id + - maximum_breach_depth + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + connected_pnt_id: + title: Connected pnt id + type: integer + maximum: 2147483647 + minimum: -2147483648 + levee_material: + title: Levee material + type: string + enum: + - sand + - clay + line_id: + title: Line id + type: integer + maximum: 2147483647 + minimum: -2147483648 + maximum_breach_depth: + title: Maximum breach depth + type: number + threedimodel: + title: Threedimodel + type: string + format: uri + readOnly: true + id: + title: ID + type: integer + readOnly: true + ThreediModelSavedState: + required: + - name + - type + type: object + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: Url + type: string + format: uri + readOnly: true + name: + title: Name + type: string + maxLength: 80 + minLength: 1 + created: + title: Created + type: string + format: date-time + x-nullable: true + type: + title: Type + type: string + enum: + - stable_threshold + - timed + tags: + title: tags + type: array + description: tags provided as a list of strings + items: + type: string + example: + - tag_1 + - tag_2 + used_in_simulation: + title: Used in simulation + type: string + readOnly: true + expiry: + title: Expiry + type: string + format: date-time + x-nullable: true + time: + title: Time in simulation (in seconds) + description: Time in simulation to create savedstate + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + variables: + type: array + items: + title: Variables + type: string + enum: + - s1 + - u1 + maxItems: 2 + x-nullable: true + thresholds: + type: array + items: + title: Thresholds + type: number + maxItems: 2 + x-nullable: true + ThreediModelTask: + required: + - name + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + name: + title: Name + type: string + enum: + - make_gridadmin + - make_tables + - make_cog + - make_geojson + - make_simulation_templates + - inherit_simulation_templates + - make_aggregations + params: + title: Params + type: object + x-nullable: true + created: + title: Created + type: string + format: date-time + readOnly: true + last_updated: + title: Last updated + type: string + format: date-time + readOnly: true + status: + title: Status + type: string + enum: + - created + - pending + - sent + - received + - started + - success + - failure + - revoked + detail: + title: Detail + type: object + threedimodel: + title: Threedimodel + type: string + format: uri + readOnly: true + id: + title: ID + type: integer + readOnly: true + Usage: + type: object + properties: + id: + title: ID + type: integer + readOnly: true + simulation: + $ref: '#/definitions/Simulation' + started: + title: Started + type: string + format: date-time + x-nullable: true + finished: + title: Finished + type: string + format: date-time + x-nullable: true + total_time: + title: Total time + type: integer + maximum: 2147483647 + minimum: 0 + x-nullable: true + status: + title: Status + type: string + readOnly: true + simulation_type: + title: Simulation type + type: string + readOnly: true + user_name: + title: User name + type: string + readOnly: true + organisation_uuid: + title: Organisation uuid + type: string + readOnly: true + UsageStatistics: + required: + - total_sessions + - total_duration + - avg_duration + - min_duration + - max_duration + - duration_humanized + - min_started + - max_started + type: object + properties: + total_sessions: + title: Total sessions + type: integer + total_duration: + title: Total duration + type: integer + avg_duration: + title: Avg duration + type: number + min_duration: + title: Min duration + type: integer + max_duration: + title: Max duration + type: integer + duration_humanized: + title: Duration humanized + type: string + minLength: 1 + min_started: + title: Min started + type: string + format: date-time + x-nullable: true + max_started: + title: Max started + type: string + format: date-time + x-nullable: true diff --git a/threedi_api_client/aio/openapi/api_client.py b/threedi_api_client/aio/openapi/api_client.py index 0a2d8272..2bc452b5 100644 --- a/threedi_api_client/aio/openapi/api_client.py +++ b/threedi_api_client/aio/openapi/api_client.py @@ -2,7 +2,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/aio/openapi/configuration.py b/threedi_api_client/aio/openapi/configuration.py index 040e00c2..ea18316c 100644 --- a/threedi_api_client/aio/openapi/configuration.py +++ b/threedi_api_client/aio/openapi/configuration.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/aio/openapi/rest.py b/threedi_api_client/aio/openapi/rest.py index 363c202e..d545f250 100644 --- a/threedi_api_client/aio/openapi/rest.py +++ b/threedi_api_client/aio/openapi/rest.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/__init__.py b/threedi_api_client/openapi/__init__.py index ac378296..c97c0924 100644 --- a/threedi_api_client/openapi/__init__.py +++ b/threedi_api_client/openapi/__init__.py @@ -5,7 +5,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -72,10 +72,12 @@ from threedi_api_client.openapi.models.file_timeseries_leakage import FileTimeseriesLeakage from threedi_api_client.openapi.models.file_timeseries_rain import FileTimeseriesRain from threedi_api_client.openapi.models.file_timeseries_sources_sinks import FileTimeseriesSourcesSinks +from threedi_api_client.openapi.models.forcing_substance import ForcingSubstance from threedi_api_client.openapi.models.from_template import FromTemplate from threedi_api_client.openapi.models.grid_event_state import GridEventState from threedi_api_client.openapi.models.ground_water_level import GroundWaterLevel from threedi_api_client.openapi.models.ground_water_raster import GroundWaterRaster +from threedi_api_client.openapi.models.initial_concentration import InitialConcentration from threedi_api_client.openapi.models.initial_saved_state import InitialSavedState from threedi_api_client.openapi.models.initial_saved_state_overview import InitialSavedStateOverview from threedi_api_client.openapi.models.initial_waterlevel import InitialWaterlevel @@ -150,6 +152,10 @@ from threedi_api_client.openapi.models.inline_response20070 import InlineResponse20070 from threedi_api_client.openapi.models.inline_response20071 import InlineResponse20071 from threedi_api_client.openapi.models.inline_response20072 import InlineResponse20072 +from threedi_api_client.openapi.models.inline_response20073 import InlineResponse20073 +from threedi_api_client.openapi.models.inline_response20074 import InlineResponse20074 +from threedi_api_client.openapi.models.inline_response20075 import InlineResponse20075 +from threedi_api_client.openapi.models.inline_response20076 import InlineResponse20076 from threedi_api_client.openapi.models.inline_response2008 import InlineResponse2008 from threedi_api_client.openapi.models.inline_response2009 import InlineResponse2009 from threedi_api_client.openapi.models.inpy_version import InpyVersion @@ -172,6 +178,7 @@ from threedi_api_client.openapi.models.net_cdf_timeseries_sources_sinks import NetCDFTimeseriesSourcesSinks from threedi_api_client.openapi.models.numerical_settings import NumericalSettings from threedi_api_client.openapi.models.obstacle_edit import ObstacleEdit +from threedi_api_client.openapi.models.one_d_substance_concentration import OneDSubstanceConcentration from threedi_api_client.openapi.models.one_d_water_level import OneDWaterLevel from threedi_api_client.openapi.models.one_d_water_level_file import OneDWaterLevelFile from threedi_api_client.openapi.models.one_d_water_level_predefined import OneDWaterLevelPredefined @@ -221,6 +228,7 @@ from threedi_api_client.openapi.models.sqlite_file_upload import SqliteFileUpload from threedi_api_client.openapi.models.stable_threshold_saved_state import StableThresholdSavedState from threedi_api_client.openapi.models.status import Status +from threedi_api_client.openapi.models.substance import Substance from threedi_api_client.openapi.models.tms import TMS from threedi_api_client.openapi.models.table_structure_control import TableStructureControl from threedi_api_client.openapi.models.template import Template @@ -242,12 +250,14 @@ from threedi_api_client.openapi.models.timeseries_sources_sinks_overview import TimeseriesSourcesSinksOverview from threedi_api_client.openapi.models.timeseries_wind import TimeseriesWind from threedi_api_client.openapi.models.tokens import Tokens +from threedi_api_client.openapi.models.two_d_substance_concentration import TwoDSubstanceConcentration from threedi_api_client.openapi.models.two_d_water_level import TwoDWaterLevel from threedi_api_client.openapi.models.two_d_water_raster import TwoDWaterRaster from threedi_api_client.openapi.models.update_revision import UpdateRevision from threedi_api_client.openapi.models.update_template import UpdateTemplate from threedi_api_client.openapi.models.upload import Upload from threedi_api_client.openapi.models.upload_event_file import UploadEventFile +from threedi_api_client.openapi.models.upload_with_substances import UploadWithSubstances from threedi_api_client.openapi.models.usage import Usage from threedi_api_client.openapi.models.usage_statistics import UsageStatistics from threedi_api_client.openapi.models.user import User diff --git a/threedi_api_client/openapi/api/v3_api.py b/threedi_api_client/openapi/api/v3_api.py index c249f697..a05172a9 100644 --- a/threedi_api_client/openapi/api/v3_api.py +++ b/threedi_api_client/openapi/api/v3_api.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -425,7 +425,7 @@ def auth_users_list(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse2002 + :return: InlineResponse2006 If the method is called asynchronously, returns the request thread. """ @@ -471,7 +471,7 @@ def auth_users_list_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse2002, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse2006, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -585,7 +585,7 @@ def auth_users_list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse2002', # noqa: E501 + response_type='InlineResponse2006', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -1096,7 +1096,7 @@ def contracts_list(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse2003 + :return: InlineResponse2007 If the method is called asynchronously, returns the request thread. """ @@ -1150,7 +1150,7 @@ def contracts_list_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse2003, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse2007, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -1288,7 +1288,7 @@ def contracts_list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse2003', # noqa: E501 + response_type='InlineResponse2007', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -2034,7 +2034,7 @@ def files_list(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse2004 + :return: InlineResponse2008 If the method is called asynchronously, returns the request thread. """ @@ -2075,7 +2075,7 @@ def files_list_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse2004, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse2008, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -2174,7 +2174,7 @@ def files_list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse2004', # noqa: E501 + response_type='InlineResponse2008', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -2947,7 +2947,7 @@ def inpy_versions_list(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse2005 + :return: InlineResponse2009 If the method is called asynchronously, returns the request thread. """ @@ -3002,7 +3002,7 @@ def inpy_versions_list_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse2005, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse2009, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -3143,7 +3143,7 @@ def inpy_versions_list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse2005', # noqa: E501 + response_type='InlineResponse2009', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -3559,7 +3559,7 @@ def organisations_list(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse2006 + :return: InlineResponse20010 If the method is called asynchronously, returns the request thread. """ @@ -3608,7 +3608,7 @@ def organisations_list_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse2006, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20010, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -3731,7 +3731,7 @@ def organisations_list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse2006', # noqa: E501 + response_type='InlineResponse20010', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -4005,7 +4005,7 @@ def organisations_users_list(self, unique_id, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse2007 + :return: InlineResponse20011 If the method is called asynchronously, returns the request thread. """ @@ -4052,7 +4052,7 @@ def organisations_users_list_with_http_info(self, unique_id, **kwargs): # noqa: number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse2007, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20011, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -4173,7 +4173,7 @@ def organisations_users_list_with_http_info(self, unique_id, **kwargs): # noqa: body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse2007', # noqa: E501 + response_type='InlineResponse20011', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -4714,7 +4714,7 @@ def permissions_list(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse2008 + :return: InlineResponse20012 If the method is called asynchronously, returns the request thread. """ @@ -4769,7 +4769,7 @@ def permissions_list_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse2008, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20012, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -4910,7 +4910,7 @@ def permissions_list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse2008', # noqa: E501 + response_type='InlineResponse20012', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -5312,7 +5312,7 @@ def repositories_list(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse2009 + :return: InlineResponse20013 If the method is called asynchronously, returns the request thread. """ @@ -5373,7 +5373,7 @@ def repositories_list_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse2009, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20013, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -5532,7 +5532,7 @@ def repositories_list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse2009', # noqa: E501 + response_type='InlineResponse20013', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -6432,7 +6432,7 @@ def revisions_list(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20010 + :return: InlineResponse20014 If the method is called asynchronously, returns the request thread. """ @@ -6509,7 +6509,7 @@ def revisions_list_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20010, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20014, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -6716,7 +6716,7 @@ def revisions_list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20010', # noqa: E501 + response_type='InlineResponse20014', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -7225,7 +7225,7 @@ def roles_list(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20011 + :return: InlineResponse20015 If the method is called asynchronously, returns the request thread. """ @@ -7253,7 +7253,7 @@ def roles_list_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20011, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20015, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -7313,7 +7313,7 @@ def roles_list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20011', # noqa: E501 + response_type='InlineResponse20015', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -7890,7 +7890,7 @@ def schematisations_list(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20012 + :return: InlineResponse20016 If the method is called asynchronously, returns the request thread. """ @@ -8012,7 +8012,7 @@ def schematisations_list_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20012, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20016, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -8354,7 +8354,7 @@ def schematisations_list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20012', # noqa: E501 + response_type='InlineResponse20016', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -9350,7 +9350,7 @@ def schematisations_revisions_list(self, schematisation_pk, **kwargs): # noqa: number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20013 + :return: InlineResponse20017 If the method is called asynchronously, returns the request thread. """ @@ -9452,7 +9452,7 @@ def schematisations_revisions_list_with_http_info(self, schematisation_pk, **kwa number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20013, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20017, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -9738,7 +9738,7 @@ def schematisations_revisions_list_with_http_info(self, schematisation_pk, **kwa body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20013', # noqa: E501 + response_type='InlineResponse20017', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -10296,7 +10296,7 @@ def schematisations_revisions_rasters_list(self, revision_pk, schematisation_pk, number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20014 + :return: InlineResponse20018 If the method is called asynchronously, returns the request thread. """ @@ -10325,7 +10325,7 @@ def schematisations_revisions_rasters_list_with_http_info(self, revision_pk, sch number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20014, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20018, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -10399,7 +10399,7 @@ def schematisations_revisions_rasters_list_with_http_info(self, revision_pk, sch body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20014', # noqa: E501 + response_type='InlineResponse20018', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -11754,7 +11754,7 @@ def schematisations_revisions_tasks_list(self, revision_pk, schematisation_pk, * number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20015 + :return: InlineResponse20019 If the method is called asynchronously, returns the request thread. """ @@ -11784,7 +11784,7 @@ def schematisations_revisions_tasks_list_with_http_info(self, revision_pk, schem number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20015, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20019, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -11858,7 +11858,7 @@ def schematisations_revisions_tasks_list_with_http_info(self, revision_pk, schem body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20015', # noqa: E501 + response_type='InlineResponse20019', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -12816,7 +12816,7 @@ def simulation_templates_list(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20016 + :return: InlineResponse20020 If the method is called asynchronously, returns the request thread. """ @@ -12877,7 +12877,7 @@ def simulation_templates_list_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20016, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20020, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -13039,7 +13039,7 @@ def simulation_templates_list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20016', # noqa: E501 + response_type='InlineResponse20020', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -14036,7 +14036,7 @@ def simulations_create_saved_states_stable_threshold_list(self, simulation_pk, * number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20019 + :return: InlineResponse20023 If the method is called asynchronously, returns the request thread. """ @@ -14065,7 +14065,7 @@ def simulations_create_saved_states_stable_threshold_list_with_http_info(self, s number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20019, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20023, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -14132,7 +14132,7 @@ def simulations_create_saved_states_stable_threshold_list_with_http_info(self, s body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20019', # noqa: E501 + response_type='InlineResponse20023', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -14933,7 +14933,7 @@ def simulations_create_saved_states_timed_list(self, simulation_pk, **kwargs): number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20020 + :return: InlineResponse20024 If the method is called asynchronously, returns the request thread. """ @@ -14962,7 +14962,7 @@ def simulations_create_saved_states_timed_list_with_http_info(self, simulation_p number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20020, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20024, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -15029,7 +15029,7 @@ def simulations_create_saved_states_timed_list_with_http_info(self, simulation_p body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20020', # noqa: E501 + response_type='InlineResponse20024', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -15787,7 +15787,7 @@ def simulations_events_with_http_info(self, id, **kwargs): # noqa: E501 def simulations_events_boundaryconditions_file_create(self, simulation_pk, data, **kwargs): # noqa: E501 """Endpoint for uploading a boundary-conditions file. # noqa: E501 - The format of the filename should be ., e.g. `boundary_conditions_bergermeer.json` Every leading and trailing spaces will be removed. Other spaces are converted to underscores and anything that is not an alphanumeric, dash, underscore, or dot will be removed as well. The response provides a put_url which allows you to upload a file containing one or more boundary-conditions. The uploaded file should be a JSON-file containing an array of boundary-conditions timeseries. The file must contain a timeseries for each boundary condition in the threedimodel. This is validated after upload. Boundary-conditions need to be added before initializing/starting the simulation and cannot be changed once the simulation is initialized. Example ------- **Notes** The ordering of the boundaries does not matter. ``` [ { \"id\": 1, # sqlite boundary_1d table id \"type\": \"1D\", # \"1D\" for 1d boundaries \"interpolate\": false, \"values\": [ [0, 0.5], [500, 0,8], [1000, 0] ] }, { \"id\": 2, # sqlite boundary_2d table id \"type\": \"2D\", # \"2D\" for 2d boundaries \"interpolate\": false, \"values\": [ [0, 0,3], [400, 0.1] ] }, { \"id\": 3, \"type\": \"2D\", \"interpolate\": false, \"values\": [ [0, -2.4], [1300, 0,3], [3000, 1.2], [3600, 0] ] } ] ``` # noqa: E501 + The format of the filename should be ., e.g. `boundary_conditions_bergermeer.json` Every leading and trailing spaces will be removed. Other spaces are converted to underscores and anything that is not an alphanumeric, dash, underscore, or dot will be removed as well. The response provides a put_url which allows you to upload a file containing one or more boundary-conditions. The uploaded file should be a JSON-file containing an array of boundary-conditions timeseries. The file must contain a timeseries for each boundary condition in the threedimodel. This is validated after upload. Boundary-conditions need to be added before initializing/starting the simulation and cannot be changed once the simulation is initialized. Example ------- **Notes** The ordering of the boundaries does not matter. ``` [ { \"id\": 1, # sqlite boundary_1d table id \"type\": \"1D\", # \"1D\" for 1d boundaries \"interpolate\": false, \"values\": [ [0, 0.5], [500, 0,8], [1000, 0] ] }, { \"id\": 2, # sqlite boundary_2d table id \"type\": \"2D\", # \"2D\" for 2d boundaries \"interpolate\": false, \"values\": [ [0, 0,3], [400, 0.1] ] }, { \"id\": 3, \"type\": \"2D\", \"interpolate\": false, \"values\": [ [0, -2.4], [1300, 0,3], [3000, 1.2], [3600, 0] ] } ] ``` Example with (water quality) substances. **Note**, the substance concentrations timesteps need to exactly match the boundary values timesteps (0, 500, 1000 in example below). ``` [ { \"id\": 1, # sqlite boundary_1d table id \"type\": \"1D\", # \"1D\" for 1d boundaries \"interpolate\": false, \"values\": [ [0, 0.5], [500, 0,8], [1000, 0] ] \"substances\": [ { \"substance\": 1, \"concentrations\": [ [0, 0.1], [500, 0.2], [1000, 0] ] } ] } ] ``` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.simulations_events_boundaryconditions_file_create(simulation_pk, data, async_req=True) @@ -15813,7 +15813,7 @@ def simulations_events_boundaryconditions_file_create(self, simulation_pk, data, def simulations_events_boundaryconditions_file_create_with_http_info(self, simulation_pk, data, **kwargs): # noqa: E501 """Endpoint for uploading a boundary-conditions file. # noqa: E501 - The format of the filename should be ., e.g. `boundary_conditions_bergermeer.json` Every leading and trailing spaces will be removed. Other spaces are converted to underscores and anything that is not an alphanumeric, dash, underscore, or dot will be removed as well. The response provides a put_url which allows you to upload a file containing one or more boundary-conditions. The uploaded file should be a JSON-file containing an array of boundary-conditions timeseries. The file must contain a timeseries for each boundary condition in the threedimodel. This is validated after upload. Boundary-conditions need to be added before initializing/starting the simulation and cannot be changed once the simulation is initialized. Example ------- **Notes** The ordering of the boundaries does not matter. ``` [ { \"id\": 1, # sqlite boundary_1d table id \"type\": \"1D\", # \"1D\" for 1d boundaries \"interpolate\": false, \"values\": [ [0, 0.5], [500, 0,8], [1000, 0] ] }, { \"id\": 2, # sqlite boundary_2d table id \"type\": \"2D\", # \"2D\" for 2d boundaries \"interpolate\": false, \"values\": [ [0, 0,3], [400, 0.1] ] }, { \"id\": 3, \"type\": \"2D\", \"interpolate\": false, \"values\": [ [0, -2.4], [1300, 0,3], [3000, 1.2], [3600, 0] ] } ] ``` # noqa: E501 + The format of the filename should be ., e.g. `boundary_conditions_bergermeer.json` Every leading and trailing spaces will be removed. Other spaces are converted to underscores and anything that is not an alphanumeric, dash, underscore, or dot will be removed as well. The response provides a put_url which allows you to upload a file containing one or more boundary-conditions. The uploaded file should be a JSON-file containing an array of boundary-conditions timeseries. The file must contain a timeseries for each boundary condition in the threedimodel. This is validated after upload. Boundary-conditions need to be added before initializing/starting the simulation and cannot be changed once the simulation is initialized. Example ------- **Notes** The ordering of the boundaries does not matter. ``` [ { \"id\": 1, # sqlite boundary_1d table id \"type\": \"1D\", # \"1D\" for 1d boundaries \"interpolate\": false, \"values\": [ [0, 0.5], [500, 0,8], [1000, 0] ] }, { \"id\": 2, # sqlite boundary_2d table id \"type\": \"2D\", # \"2D\" for 2d boundaries \"interpolate\": false, \"values\": [ [0, 0,3], [400, 0.1] ] }, { \"id\": 3, \"type\": \"2D\", \"interpolate\": false, \"values\": [ [0, -2.4], [1300, 0,3], [3000, 1.2], [3600, 0] ] } ] ``` Example with (water quality) substances. **Note**, the substance concentrations timesteps need to exactly match the boundary values timesteps (0, 500, 1000 in example below). ``` [ { \"id\": 1, # sqlite boundary_1d table id \"type\": \"1D\", # \"1D\" for 1d boundaries \"interpolate\": false, \"values\": [ [0, 0.5], [500, 0,8], [1000, 0] ] \"substances\": [ { \"substance\": 1, \"concentrations\": [ [0, 0.1], [500, 0.2], [1000, 0] ] } ] } ] ``` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.simulations_events_boundaryconditions_file_create_with_http_info(simulation_pk, data, async_req=True) @@ -16172,7 +16172,7 @@ def simulations_events_boundaryconditions_file_list(self, simulation_pk, **kwarg number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20021 + :return: InlineResponse20025 If the method is called asynchronously, returns the request thread. """ @@ -16200,7 +16200,7 @@ def simulations_events_boundaryconditions_file_list_with_http_info(self, simulat number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20021, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20025, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -16267,7 +16267,7 @@ def simulations_events_boundaryconditions_file_list_with_http_info(self, simulat body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20021', # noqa: E501 + response_type='InlineResponse20025', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -17060,7 +17060,7 @@ def simulations_events_breaches_list(self, simulation_pk, **kwargs): # noqa: E5 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20022 + :return: InlineResponse20026 If the method is called asynchronously, returns the request thread. """ @@ -17089,7 +17089,7 @@ def simulations_events_breaches_list_with_http_info(self, simulation_pk, **kwarg number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20022, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20026, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -17156,7 +17156,7 @@ def simulations_events_breaches_list_with_http_info(self, simulation_pk, **kwarg body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20022', # noqa: E501 + response_type='InlineResponse20026', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -17821,7 +17821,7 @@ def simulations_events_lateral_constant_list(self, simulation_pk, **kwargs): # number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20023 + :return: InlineResponse20027 If the method is called asynchronously, returns the request thread. """ @@ -17850,7 +17850,7 @@ def simulations_events_lateral_constant_list_with_http_info(self, simulation_pk, number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20023, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20027, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -17917,7 +17917,7 @@ def simulations_events_lateral_constant_list_with_http_info(self, simulation_pk, body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20023', # noqa: E501 + response_type='InlineResponse20027', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -18451,7 +18451,7 @@ def simulations_events_lateral_constant_update_with_http_info(self, id, simulati def simulations_events_lateral_file_create(self, simulation_pk, data, **kwargs): # noqa: E501 """Endpoint for uploading a file with one or more laterals. # noqa: E501 - The format of the filename should be ., e.g. `laterals_bergermeer.json` Every leading and trailing spaces will be removed. Other spaces are converted to underscores and anything that is not an alphanumeric, dash, underscore, or dot will be removed as well. The response provides a put_url which allows you to upload a file containing one or more laterals. These laterals should either be a constant- or a timeseries-lateral, or a combination of both. See their respective endpoint for the required fields of these laterals. The uploaded file should be a JSON-file containing an array of laterals. Example of the content of such a file: ``` [ { \"offset\": 100, \"value\": 0.05, \"duration\": 300, \"units\": \"m3/s\", \"connection_node\": 5 }, { \"offset\": 180, \"interpolate\": false, \"values\": [ [0.0, 0.0002], [900.0, 0.0], [1200.0, 0.0001], [1620.0, 0.0] ], \"units\": \"m3/s\", \"connection_node\": 4 }, { \"offset\": 0, \"value\": 0.03, \"duration\": 500, \"units\": \"m3/s\", \"point\": { \"type\": \"Point\", \"coordinates\": [4.70184629, 52.62586862] # longitude, latitude } } ] ``` The `offset` of this file-lateral-event will be applied to each individual lateral offset in the uploaded file If the `periodic` field is set to `daily` the values given are used for every hour of every day in the simulation. Exactly 25 (0-24) timeseries per entry are required like such: \"values\": [ [0.0, 0.0002], [3600, 0.01], ..... ..... [82800, 0.15] # 3600.0 * 23 [86400, 0.0] # 3600.0 * 24 ] Only laterals with 'values' are allowed in this case. The **hour** (not minutes or seconds) of the simulation `start_datetime` (UTC) is taken into consideration for the first timeseries value to use. Periodic laterals are intended for dry weather flow. # noqa: E501 + The format of the filename should be ., e.g. `laterals_bergermeer.json` Every leading and trailing spaces will be removed. Other spaces are converted to underscores and anything that is not an alphanumeric, dash, underscore, or dot will be removed as well. The response provides a put_url which allows you to upload a file containing one or more laterals. These laterals should either be a constant- or a timeseries-lateral, or a combination of both. See their respective endpoint for the required fields of these laterals. The uploaded file should be a JSON-file containing an array of laterals. Example of the content of such a file: ``` [ { \"offset\": 100, \"value\": 0.05, \"duration\": 300, \"units\": \"m3/s\", \"connection_node\": 5 }, { \"offset\": 180, \"interpolate\": false, \"values\": [ [0.0, 0.0002], [900.0, 0.0], [1200.0, 0.0001], [1620.0, 0.0] ], \"units\": \"m3/s\", \"connection_node\": 4 }, { \"offset\": 0, \"value\": 0.03, \"duration\": 500, \"units\": \"m3/s\", \"point\": { \"type\": \"Point\", \"coordinates\": [4.70184629, 52.62586862] # longitude, latitude } } ] ``` The `offset` of this file-lateral-event will be applied to each individual lateral offset in the uploaded file If the `periodic` field is set to `daily` the values given are used for every hour of every day in the simulation. Exactly 25 (0-24) timeseries per entry are required like such: \"values\": [ [0.0, 0.0002], [3600, 0.01], ..... ..... [82800, 0.15] # 3600.0 * 23 [86400, 0.0] # 3600.0 * 24 ] Only laterals with 'values' are allowed in this case. The **hour** (not minutes or seconds) of the simulation `start_datetime` (UTC) is taken into consideration for the first timeseries value to use. Periodic laterals are intended for dry weather flow. Example with (water quality) substances. **Note**: the substance concentrations timesteps need to exactly match the lateral values timesteps (0, 300 in example below). ``` [ { \"offset\": 100, \"values\": [[0, 0.05], [300, 0]], \"units\": \"m3/s\", \"connection_node\": 5, \"substances\": [ {\"substance\": 1, \"concentrations\": [[0, 0.1], [300, 0]]} ] } ] ``` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.simulations_events_lateral_file_create(simulation_pk, data, async_req=True) @@ -18477,7 +18477,7 @@ def simulations_events_lateral_file_create(self, simulation_pk, data, **kwargs): def simulations_events_lateral_file_create_with_http_info(self, simulation_pk, data, **kwargs): # noqa: E501 """Endpoint for uploading a file with one or more laterals. # noqa: E501 - The format of the filename should be ., e.g. `laterals_bergermeer.json` Every leading and trailing spaces will be removed. Other spaces are converted to underscores and anything that is not an alphanumeric, dash, underscore, or dot will be removed as well. The response provides a put_url which allows you to upload a file containing one or more laterals. These laterals should either be a constant- or a timeseries-lateral, or a combination of both. See their respective endpoint for the required fields of these laterals. The uploaded file should be a JSON-file containing an array of laterals. Example of the content of such a file: ``` [ { \"offset\": 100, \"value\": 0.05, \"duration\": 300, \"units\": \"m3/s\", \"connection_node\": 5 }, { \"offset\": 180, \"interpolate\": false, \"values\": [ [0.0, 0.0002], [900.0, 0.0], [1200.0, 0.0001], [1620.0, 0.0] ], \"units\": \"m3/s\", \"connection_node\": 4 }, { \"offset\": 0, \"value\": 0.03, \"duration\": 500, \"units\": \"m3/s\", \"point\": { \"type\": \"Point\", \"coordinates\": [4.70184629, 52.62586862] # longitude, latitude } } ] ``` The `offset` of this file-lateral-event will be applied to each individual lateral offset in the uploaded file If the `periodic` field is set to `daily` the values given are used for every hour of every day in the simulation. Exactly 25 (0-24) timeseries per entry are required like such: \"values\": [ [0.0, 0.0002], [3600, 0.01], ..... ..... [82800, 0.15] # 3600.0 * 23 [86400, 0.0] # 3600.0 * 24 ] Only laterals with 'values' are allowed in this case. The **hour** (not minutes or seconds) of the simulation `start_datetime` (UTC) is taken into consideration for the first timeseries value to use. Periodic laterals are intended for dry weather flow. # noqa: E501 + The format of the filename should be ., e.g. `laterals_bergermeer.json` Every leading and trailing spaces will be removed. Other spaces are converted to underscores and anything that is not an alphanumeric, dash, underscore, or dot will be removed as well. The response provides a put_url which allows you to upload a file containing one or more laterals. These laterals should either be a constant- or a timeseries-lateral, or a combination of both. See their respective endpoint for the required fields of these laterals. The uploaded file should be a JSON-file containing an array of laterals. Example of the content of such a file: ``` [ { \"offset\": 100, \"value\": 0.05, \"duration\": 300, \"units\": \"m3/s\", \"connection_node\": 5 }, { \"offset\": 180, \"interpolate\": false, \"values\": [ [0.0, 0.0002], [900.0, 0.0], [1200.0, 0.0001], [1620.0, 0.0] ], \"units\": \"m3/s\", \"connection_node\": 4 }, { \"offset\": 0, \"value\": 0.03, \"duration\": 500, \"units\": \"m3/s\", \"point\": { \"type\": \"Point\", \"coordinates\": [4.70184629, 52.62586862] # longitude, latitude } } ] ``` The `offset` of this file-lateral-event will be applied to each individual lateral offset in the uploaded file If the `periodic` field is set to `daily` the values given are used for every hour of every day in the simulation. Exactly 25 (0-24) timeseries per entry are required like such: \"values\": [ [0.0, 0.0002], [3600, 0.01], ..... ..... [82800, 0.15] # 3600.0 * 23 [86400, 0.0] # 3600.0 * 24 ] Only laterals with 'values' are allowed in this case. The **hour** (not minutes or seconds) of the simulation `start_datetime` (UTC) is taken into consideration for the first timeseries value to use. Periodic laterals are intended for dry weather flow. Example with (water quality) substances. **Note**: the substance concentrations timesteps need to exactly match the lateral values timesteps (0, 300 in example below). ``` [ { \"offset\": 100, \"values\": [[0, 0.05], [300, 0]], \"units\": \"m3/s\", \"connection_node\": 5, \"substances\": [ {\"substance\": 1, \"concentrations\": [[0, 0.1], [300, 0]]} ] } ] ``` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.simulations_events_lateral_file_create_with_http_info(simulation_pk, data, async_req=True) @@ -18836,7 +18836,7 @@ def simulations_events_lateral_file_list(self, simulation_pk, **kwargs): # noqa number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20024 + :return: InlineResponse20028 If the method is called asynchronously, returns the request thread. """ @@ -18864,7 +18864,7 @@ def simulations_events_lateral_file_list_with_http_info(self, simulation_pk, **k number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20024, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20028, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -18931,7 +18931,7 @@ def simulations_events_lateral_file_list_with_http_info(self, simulation_pk, **k body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20024', # noqa: E501 + response_type='InlineResponse20028', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -19722,7 +19722,7 @@ def simulations_events_lateral_timeseries_list(self, simulation_pk, **kwargs): number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20025 + :return: InlineResponse20029 If the method is called asynchronously, returns the request thread. """ @@ -19751,7 +19751,7 @@ def simulations_events_lateral_timeseries_list_with_http_info(self, simulation_p number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20025, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20029, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -19818,7 +19818,7 @@ def simulations_events_lateral_timeseries_list_with_http_info(self, simulation_p body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20025', # noqa: E501 + response_type='InlineResponse20029', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -20615,7 +20615,7 @@ def simulations_events_leakage_constant_list(self, simulation_pk, **kwargs): # number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20026 + :return: InlineResponse20030 If the method is called asynchronously, returns the request thread. """ @@ -20644,7 +20644,7 @@ def simulations_events_leakage_constant_list_with_http_info(self, simulation_pk, number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20026, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20030, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -20711,7 +20711,7 @@ def simulations_events_leakage_constant_list_with_http_info(self, simulation_pk, body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20026', # noqa: E501 + response_type='InlineResponse20030', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -21376,7 +21376,7 @@ def simulations_events_leakage_rasters_netcdf_list(self, simulation_pk, **kwargs number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20027 + :return: InlineResponse20031 If the method is called asynchronously, returns the request thread. """ @@ -21405,7 +21405,7 @@ def simulations_events_leakage_rasters_netcdf_list_with_http_info(self, simulati number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20027, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20031, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -21472,7 +21472,7 @@ def simulations_events_leakage_rasters_netcdf_list_with_http_info(self, simulati body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20027', # noqa: E501 + response_type='InlineResponse20031', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -21867,7 +21867,7 @@ def simulations_events_leakage_timeseries_list(self, simulation_pk, **kwargs): number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20028 + :return: InlineResponse20032 If the method is called asynchronously, returns the request thread. """ @@ -21896,7 +21896,7 @@ def simulations_events_leakage_timeseries_list_with_http_info(self, simulation_p number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20028, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20032, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -21963,7 +21963,7 @@ def simulations_events_leakage_timeseries_list_with_http_info(self, simulation_p body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20028', # noqa: E501 + response_type='InlineResponse20032', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -22237,7 +22237,7 @@ def simulations_events_leakage_timeseries_netcdf_list(self, simulation_pk, **kwa number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20029 + :return: InlineResponse20033 If the method is called asynchronously, returns the request thread. """ @@ -22266,7 +22266,7 @@ def simulations_events_leakage_timeseries_netcdf_list_with_http_info(self, simul number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20029, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20033, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -22333,7 +22333,7 @@ def simulations_events_leakage_timeseries_netcdf_list_with_http_info(self, simul body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20029', # noqa: E501 + response_type='InlineResponse20033', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -23121,7 +23121,7 @@ def simulations_events_rain_constant_list(self, simulation_pk, **kwargs): # noq number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20030 + :return: InlineResponse20034 If the method is called asynchronously, returns the request thread. """ @@ -23150,7 +23150,7 @@ def simulations_events_rain_constant_list_with_http_info(self, simulation_pk, ** number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20030, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20034, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -23217,7 +23217,7 @@ def simulations_events_rain_constant_list_with_http_info(self, simulation_pk, ** body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20030', # noqa: E501 + response_type='InlineResponse20034', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -23882,7 +23882,7 @@ def simulations_events_rain_local_constant_list(self, simulation_pk, **kwargs): number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20031 + :return: InlineResponse20035 If the method is called asynchronously, returns the request thread. """ @@ -23911,7 +23911,7 @@ def simulations_events_rain_local_constant_list_with_http_info(self, simulation_ number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20031, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20035, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -23978,7 +23978,7 @@ def simulations_events_rain_local_constant_list_with_http_info(self, simulation_ body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20031', # noqa: E501 + response_type='InlineResponse20035', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -24643,7 +24643,7 @@ def simulations_events_rain_local_timeseries_list(self, simulation_pk, **kwargs) number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20032 + :return: InlineResponse20036 If the method is called asynchronously, returns the request thread. """ @@ -24672,7 +24672,7 @@ def simulations_events_rain_local_timeseries_list_with_http_info(self, simulatio number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20032, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20036, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -24739,7 +24739,7 @@ def simulations_events_rain_local_timeseries_list_with_http_info(self, simulatio body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20032', # noqa: E501 + response_type='InlineResponse20036', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -25404,7 +25404,7 @@ def simulations_events_rain_rasters_lizard_list(self, simulation_pk, **kwargs): number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20033 + :return: InlineResponse20037 If the method is called asynchronously, returns the request thread. """ @@ -25433,7 +25433,7 @@ def simulations_events_rain_rasters_lizard_list_with_http_info(self, simulation_ number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20033, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20037, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -25500,7 +25500,7 @@ def simulations_events_rain_rasters_lizard_list_with_http_info(self, simulation_ body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20033', # noqa: E501 + response_type='InlineResponse20037', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -25910,7 +25910,7 @@ def simulations_events_rain_rasters_netcdf_create(self, simulation_pk, data, **k :param async_req bool: execute request asynchronously :param str simulation_pk: (required) - :param Upload data: (required) + :param UploadWithSubstances data: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -25918,7 +25918,7 @@ def simulations_events_rain_rasters_netcdf_create(self, simulation_pk, data, **k number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: Upload + :return: UploadWithSubstances If the method is called asynchronously, returns the request thread. """ @@ -25936,7 +25936,7 @@ def simulations_events_rain_rasters_netcdf_create_with_http_info(self, simulatio :param async_req bool: execute request asynchronously :param str simulation_pk: (required) - :param Upload data: (required) + :param UploadWithSubstances data: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -25946,7 +25946,7 @@ def simulations_events_rain_rasters_netcdf_create_with_http_info(self, simulatio number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(Upload, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(UploadWithSubstances, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -26018,7 +26018,7 @@ def simulations_events_rain_rasters_netcdf_create_with_http_info(self, simulatio body=body_params, post_params=form_params, files=local_var_files, - response_type='Upload', # noqa: E501 + response_type='UploadWithSubstances', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -26165,7 +26165,7 @@ def simulations_events_rain_rasters_netcdf_list(self, simulation_pk, **kwargs): number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20034 + :return: InlineResponse20038 If the method is called asynchronously, returns the request thread. """ @@ -26194,7 +26194,7 @@ def simulations_events_rain_rasters_netcdf_list_with_http_info(self, simulation_ number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20034, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20038, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -26261,7 +26261,7 @@ def simulations_events_rain_rasters_netcdf_list_with_http_info(self, simulation_ body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20034', # noqa: E501 + response_type='InlineResponse20038', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -26926,7 +26926,7 @@ def simulations_events_rain_timeseries_list(self, simulation_pk, **kwargs): # n number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20035 + :return: InlineResponse20039 If the method is called asynchronously, returns the request thread. """ @@ -26955,7 +26955,7 @@ def simulations_events_rain_timeseries_list_with_http_info(self, simulation_pk, number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20035, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20039, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -27022,7 +27022,7 @@ def simulations_events_rain_timeseries_list_with_http_info(self, simulation_pk, body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20035', # noqa: E501 + response_type='InlineResponse20039', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -27296,7 +27296,7 @@ def simulations_events_rain_timeseries_lizard_list(self, simulation_pk, **kwargs number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20036 + :return: InlineResponse20040 If the method is called asynchronously, returns the request thread. """ @@ -27325,7 +27325,7 @@ def simulations_events_rain_timeseries_lizard_list_with_http_info(self, simulati number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20036, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20040, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -27392,7 +27392,7 @@ def simulations_events_rain_timeseries_lizard_list_with_http_info(self, simulati body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20036', # noqa: E501 + response_type='InlineResponse20040', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -27802,7 +27802,7 @@ def simulations_events_rain_timeseries_netcdf_create(self, simulation_pk, data, :param async_req bool: execute request asynchronously :param str simulation_pk: (required) - :param Upload data: (required) + :param UploadWithSubstances data: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -27810,7 +27810,7 @@ def simulations_events_rain_timeseries_netcdf_create(self, simulation_pk, data, number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: Upload + :return: UploadWithSubstances If the method is called asynchronously, returns the request thread. """ @@ -27828,7 +27828,7 @@ def simulations_events_rain_timeseries_netcdf_create_with_http_info(self, simula :param async_req bool: execute request asynchronously :param str simulation_pk: (required) - :param Upload data: (required) + :param UploadWithSubstances data: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -27838,7 +27838,7 @@ def simulations_events_rain_timeseries_netcdf_create_with_http_info(self, simula number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(Upload, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(UploadWithSubstances, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -27910,7 +27910,7 @@ def simulations_events_rain_timeseries_netcdf_create_with_http_info(self, simula body=body_params, post_params=form_params, files=local_var_files, - response_type='Upload', # noqa: E501 + response_type='UploadWithSubstances', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -28057,7 +28057,7 @@ def simulations_events_rain_timeseries_netcdf_list(self, simulation_pk, **kwargs number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20037 + :return: InlineResponse20041 If the method is called asynchronously, returns the request thread. """ @@ -28086,7 +28086,7 @@ def simulations_events_rain_timeseries_netcdf_list_with_http_info(self, simulati number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20037, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20041, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -28153,7 +28153,7 @@ def simulations_events_rain_timeseries_netcdf_list_with_http_info(self, simulati body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20037', # noqa: E501 + response_type='InlineResponse20041', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -29209,7 +29209,7 @@ def simulations_events_raster_edits_list(self, simulation_pk, **kwargs): # noqa number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20038 + :return: InlineResponse20042 If the method is called asynchronously, returns the request thread. """ @@ -29238,7 +29238,7 @@ def simulations_events_raster_edits_list_with_http_info(self, simulation_pk, **k number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20038, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20042, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -29305,7 +29305,7 @@ def simulations_events_raster_edits_list_with_http_info(self, simulation_pk, **k body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20038', # noqa: E501 + response_type='InlineResponse20042', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -30093,7 +30093,7 @@ def simulations_events_sources_sinks_constant_list(self, simulation_pk, **kwargs number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20039 + :return: InlineResponse20043 If the method is called asynchronously, returns the request thread. """ @@ -30122,7 +30122,7 @@ def simulations_events_sources_sinks_constant_list_with_http_info(self, simulati number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20039, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20043, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -30189,7 +30189,7 @@ def simulations_events_sources_sinks_constant_list_with_http_info(self, simulati body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20039', # noqa: E501 + response_type='InlineResponse20043', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -30854,7 +30854,7 @@ def simulations_events_sources_sinks_rasters_lizard_list(self, simulation_pk, ** number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20040 + :return: InlineResponse20044 If the method is called asynchronously, returns the request thread. """ @@ -30883,7 +30883,7 @@ def simulations_events_sources_sinks_rasters_lizard_list_with_http_info(self, si number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20040, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20044, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -30950,7 +30950,7 @@ def simulations_events_sources_sinks_rasters_lizard_list_with_http_info(self, si body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20040', # noqa: E501 + response_type='InlineResponse20044', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -31615,7 +31615,7 @@ def simulations_events_sources_sinks_rasters_netcdf_list(self, simulation_pk, ** number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20041 + :return: InlineResponse20045 If the method is called asynchronously, returns the request thread. """ @@ -31644,7 +31644,7 @@ def simulations_events_sources_sinks_rasters_netcdf_list_with_http_info(self, si number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20041, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20045, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -31711,7 +31711,7 @@ def simulations_events_sources_sinks_rasters_netcdf_list_with_http_info(self, si body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20041', # noqa: E501 + response_type='InlineResponse20045', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -32376,7 +32376,7 @@ def simulations_events_sources_sinks_timeseries_list(self, simulation_pk, **kwar number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20042 + :return: InlineResponse20046 If the method is called asynchronously, returns the request thread. """ @@ -32405,7 +32405,7 @@ def simulations_events_sources_sinks_timeseries_list_with_http_info(self, simula number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20042, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20046, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -32472,7 +32472,7 @@ def simulations_events_sources_sinks_timeseries_list_with_http_info(self, simula body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20042', # noqa: E501 + response_type='InlineResponse20046', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -32746,7 +32746,7 @@ def simulations_events_sources_sinks_timeseries_lizard_list(self, simulation_pk, number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20043 + :return: InlineResponse20047 If the method is called asynchronously, returns the request thread. """ @@ -32775,7 +32775,7 @@ def simulations_events_sources_sinks_timeseries_lizard_list_with_http_info(self, number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20043, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20047, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -32842,7 +32842,7 @@ def simulations_events_sources_sinks_timeseries_lizard_list_with_http_info(self, body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20043', # noqa: E501 + response_type='InlineResponse20047', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -33507,7 +33507,7 @@ def simulations_events_sources_sinks_timeseries_netcdf_list(self, simulation_pk, number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20044 + :return: InlineResponse20048 If the method is called asynchronously, returns the request thread. """ @@ -33536,7 +33536,7 @@ def simulations_events_sources_sinks_timeseries_netcdf_list_with_http_info(self, number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20044, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20048, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -33603,7 +33603,7 @@ def simulations_events_sources_sinks_timeseries_netcdf_list_with_http_info(self, body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20044', # noqa: E501 + response_type='InlineResponse20048', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -34513,7 +34513,7 @@ def simulations_events_structure_control_file_list(self, simulation_pk, **kwargs number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20045 + :return: InlineResponse20049 If the method is called asynchronously, returns the request thread. """ @@ -34541,7 +34541,7 @@ def simulations_events_structure_control_file_list_with_http_info(self, simulati number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20045, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20049, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -34608,7 +34608,7 @@ def simulations_events_structure_control_file_list_with_http_info(self, simulati body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20045', # noqa: E501 + response_type='InlineResponse20049', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -35399,7 +35399,7 @@ def simulations_events_structure_control_memory_list(self, simulation_pk, **kwar number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20046 + :return: InlineResponse20050 If the method is called asynchronously, returns the request thread. """ @@ -35428,7 +35428,7 @@ def simulations_events_structure_control_memory_list_with_http_info(self, simula number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20046, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20050, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -35495,7 +35495,7 @@ def simulations_events_structure_control_memory_list_with_http_info(self, simula body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20046', # noqa: E501 + response_type='InlineResponse20050', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -36292,7 +36292,7 @@ def simulations_events_structure_control_table_list(self, simulation_pk, **kwarg number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20047 + :return: InlineResponse20051 If the method is called asynchronously, returns the request thread. """ @@ -36321,7 +36321,7 @@ def simulations_events_structure_control_table_list_with_http_info(self, simulat number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20047, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20051, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -36388,7 +36388,7 @@ def simulations_events_structure_control_table_list_with_http_info(self, simulat body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20047', # noqa: E501 + response_type='InlineResponse20051', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -37185,7 +37185,7 @@ def simulations_events_structure_control_timed_list(self, simulation_pk, **kwarg number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20048 + :return: InlineResponse20052 If the method is called asynchronously, returns the request thread. """ @@ -37214,7 +37214,7 @@ def simulations_events_structure_control_timed_list_with_http_info(self, simulat number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20048, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20052, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -37281,7 +37281,7 @@ def simulations_events_structure_control_timed_list_with_http_info(self, simulat body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20048', # noqa: E501 + response_type='InlineResponse20052', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -38078,7 +38078,7 @@ def simulations_events_wind_constant_list(self, simulation_pk, **kwargs): # noq number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20049 + :return: InlineResponse20053 If the method is called asynchronously, returns the request thread. """ @@ -38107,7 +38107,7 @@ def simulations_events_wind_constant_list_with_http_info(self, simulation_pk, ** number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20049, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20053, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -38174,7 +38174,7 @@ def simulations_events_wind_constant_list_with_http_info(self, simulation_pk, ** body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20049', # noqa: E501 + response_type='InlineResponse20053', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -38843,7 +38843,7 @@ def simulations_events_wind_timeseries_list(self, simulation_pk, **kwargs): # n number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20050 + :return: InlineResponse20054 If the method is called asynchronously, returns the request thread. """ @@ -38872,7 +38872,7 @@ def simulations_events_wind_timeseries_list_with_http_info(self, simulation_pk, number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20050, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20054, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -38939,7 +38939,7 @@ def simulations_events_wind_timeseries_list_with_http_info(self, simulation_pk, body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20050', # noqa: E501 + response_type='InlineResponse20054', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -39726,7 +39726,7 @@ def simulations_initial1d_water_level_constant_list(self, simulation_pk, **kwarg number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20051 + :return: InlineResponse20055 If the method is called asynchronously, returns the request thread. """ @@ -39755,7 +39755,7 @@ def simulations_initial1d_water_level_constant_list_with_http_info(self, simulat number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20051, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20055, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -39822,7 +39822,7 @@ def simulations_initial1d_water_level_constant_list_with_http_info(self, simulat body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20051', # noqa: E501 + response_type='InlineResponse20055', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -40491,7 +40491,7 @@ def simulations_initial1d_water_level_file_list(self, simulation_pk, **kwargs): number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20052 + :return: InlineResponse20056 If the method is called asynchronously, returns the request thread. """ @@ -40520,7 +40520,7 @@ def simulations_initial1d_water_level_file_list_with_http_info(self, simulation_ number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20052, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20056, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -40587,7 +40587,7 @@ def simulations_initial1d_water_level_file_list_with_http_info(self, simulation_ body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20052', # noqa: E501 + response_type='InlineResponse20056', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -41256,7 +41256,7 @@ def simulations_initial1d_water_level_predefined_list(self, simulation_pk, **kwa number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20053 + :return: InlineResponse20057 If the method is called asynchronously, returns the request thread. """ @@ -41285,7 +41285,7 @@ def simulations_initial1d_water_level_predefined_list_with_http_info(self, simul number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20053, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20057, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -41352,7 +41352,7 @@ def simulations_initial1d_water_level_predefined_list_with_http_info(self, simul body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20053', # noqa: E501 + response_type='InlineResponse20057', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -42021,7 +42021,7 @@ def simulations_initial2d_water_level_constant_list(self, simulation_pk, **kwarg number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20054 + :return: InlineResponse20058 If the method is called asynchronously, returns the request thread. """ @@ -42050,7 +42050,7 @@ def simulations_initial2d_water_level_constant_list_with_http_info(self, simulat number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20054, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20058, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -42117,7 +42117,7 @@ def simulations_initial2d_water_level_constant_list_with_http_info(self, simulat body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20054', # noqa: E501 + response_type='InlineResponse20058', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -42786,7 +42786,7 @@ def simulations_initial2d_water_level_raster_list(self, simulation_pk, **kwargs) number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20055 + :return: InlineResponse20059 If the method is called asynchronously, returns the request thread. """ @@ -42815,7 +42815,7 @@ def simulations_initial2d_water_level_raster_list_with_http_info(self, simulatio number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20055, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20059, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -42882,7 +42882,7 @@ def simulations_initial2d_water_level_raster_list_with_http_info(self, simulatio body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20055', # noqa: E501 + response_type='InlineResponse20059', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -43551,7 +43551,7 @@ def simulations_initial_groundwater_level_constant_list(self, simulation_pk, **k number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20056 + :return: InlineResponse20060 If the method is called asynchronously, returns the request thread. """ @@ -43580,7 +43580,7 @@ def simulations_initial_groundwater_level_constant_list_with_http_info(self, sim number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20056, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20060, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -43647,7 +43647,7 @@ def simulations_initial_groundwater_level_constant_list_with_http_info(self, sim body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20056', # noqa: E501 + response_type='InlineResponse20060', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -44316,7 +44316,7 @@ def simulations_initial_groundwater_level_raster_list(self, simulation_pk, **kwa number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20057 + :return: InlineResponse20061 If the method is called asynchronously, returns the request thread. """ @@ -44345,7 +44345,7 @@ def simulations_initial_groundwater_level_raster_list_with_http_info(self, simul number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20057, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20061, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -44412,7 +44412,7 @@ def simulations_initial_groundwater_level_raster_list_with_http_info(self, simul body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20057', # noqa: E501 + response_type='InlineResponse20061', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -45081,7 +45081,7 @@ def simulations_initial_saved_state_list(self, simulation_pk, **kwargs): # noqa number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20058 + :return: InlineResponse20062 If the method is called asynchronously, returns the request thread. """ @@ -45110,7 +45110,7 @@ def simulations_initial_saved_state_list_with_http_info(self, simulation_pk, **k number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20058, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20062, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -45177,7 +45177,7 @@ def simulations_initial_saved_state_list_with_http_info(self, simulation_pk, **k body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20058', # noqa: E501 + response_type='InlineResponse20062', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -45846,7 +45846,7 @@ def simulations_initial_wind_drag_coefficient_list(self, simulation_pk, **kwargs number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20059 + :return: InlineResponse20063 If the method is called asynchronously, returns the request thread. """ @@ -45875,7 +45875,7 @@ def simulations_initial_wind_drag_coefficient_list_with_http_info(self, simulati number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20059, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20063, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -45942,7 +45942,7 @@ def simulations_initial_wind_drag_coefficient_list_with_http_info(self, simulati body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20059', # noqa: E501 + response_type='InlineResponse20063', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -46405,7 +46405,7 @@ def simulations_list(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20017 + :return: InlineResponse20021 If the method is called asynchronously, returns the request thread. """ @@ -46474,7 +46474,7 @@ def simulations_list_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20017, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20021, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -46657,7 +46657,7 @@ def simulations_list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20017', # noqa: E501 + response_type='InlineResponse20021', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -46809,7 +46809,7 @@ def simulations_post_processing_lizard_queue_list(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20018 + :return: InlineResponse20022 If the method is called asynchronously, returns the request thread. """ @@ -46837,7 +46837,7 @@ def simulations_post_processing_lizard_queue_list_with_http_info(self, **kwargs) number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20018, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20022, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -46897,7 +46897,7 @@ def simulations_post_processing_lizard_queue_list_with_http_info(self, **kwargs) body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20018', # noqa: E501 + response_type='InlineResponse20022', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -47530,7 +47530,7 @@ def simulations_results_files_list(self, simulation_pk, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20060 + :return: InlineResponse20064 If the method is called asynchronously, returns the request thread. """ @@ -47559,7 +47559,7 @@ def simulations_results_files_list_with_http_info(self, simulation_pk, **kwargs) number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20060, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20064, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -47626,7 +47626,7 @@ def simulations_results_files_list_with_http_info(self, simulation_pk, **kwargs) body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20060', # noqa: E501 + response_type='InlineResponse20064', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -49882,7 +49882,7 @@ def simulations_results_post_processing_lizard_status_history_list(self, simulat number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20061 + :return: InlineResponse20065 If the method is called asynchronously, returns the request thread. """ @@ -49910,7 +49910,7 @@ def simulations_results_post_processing_lizard_status_history_list_with_http_inf number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20061, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20065, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -49977,7 +49977,7 @@ def simulations_results_post_processing_lizard_status_history_list_with_http_inf body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20061', # noqa: E501 + response_type='InlineResponse20065', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -50375,7 +50375,7 @@ def simulations_settings_aggregation_list(self, simulation_pk, **kwargs): # noq number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20062 + :return: InlineResponse20066 If the method is called asynchronously, returns the request thread. """ @@ -50404,7 +50404,7 @@ def simulations_settings_aggregation_list_with_http_info(self, simulation_pk, ** number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20062, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20066, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -50471,7 +50471,7 @@ def simulations_settings_aggregation_list_with_http_info(self, simulation_pk, ** body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20062', # noqa: E501 + response_type='InlineResponse20066', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -52690,7 +52690,7 @@ def simulations_status_history_list(self, simulation_pk, **kwargs): # noqa: E50 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20063 + :return: InlineResponse20067 If the method is called asynchronously, returns the request thread. """ @@ -52718,7 +52718,7 @@ def simulations_status_history_list_with_http_info(self, simulation_pk, **kwargs number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20063, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20067, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -52785,7 +52785,7 @@ def simulations_status_history_list_with_http_info(self, simulation_pk, **kwargs body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20063', # noqa: E501 + response_type='InlineResponse20067', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -54733,7 +54733,7 @@ def simulations_websockets_list(self, simulation_pk, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20064 + :return: InlineResponse20068 If the method is called asynchronously, returns the request thread. """ @@ -54762,7 +54762,7 @@ def simulations_websockets_list_with_http_info(self, simulation_pk, **kwargs): number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20064, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20068, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -54829,7 +54829,7 @@ def simulations_websockets_list_with_http_info(self, simulation_pk, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20064', # noqa: E501 + response_type='InlineResponse20068', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -54924,7 +54924,7 @@ def statuses_list(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20063 + :return: InlineResponse20067 If the method is called asynchronously, returns the request thread. """ @@ -55020,7 +55020,7 @@ def statuses_list_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20063, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20067, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -55284,7 +55284,7 @@ def statuses_list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20063', # noqa: E501 + response_type='InlineResponse20067', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -56125,7 +56125,7 @@ def threedimodels_boundaryconditions_list(self, threedimodel_pk, **kwargs): # n number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20066 + :return: InlineResponse20070 If the method is called asynchronously, returns the request thread. """ @@ -56154,7 +56154,7 @@ def threedimodels_boundaryconditions_list_with_http_info(self, threedimodel_pk, number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20066, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20070, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -56221,7 +56221,7 @@ def threedimodels_boundaryconditions_list_with_http_info(self, threedimodel_pk, body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20066', # noqa: E501 + response_type='InlineResponse20070', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -59978,7 +59978,7 @@ def threedimodels_initial_waterlevels_list(self, threedimodel_pk, **kwargs): # number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20067 + :return: InlineResponse20071 If the method is called asynchronously, returns the request thread. """ @@ -60007,7 +60007,7 @@ def threedimodels_initial_waterlevels_list_with_http_info(self, threedimodel_pk, number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20067, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20071, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -60074,7 +60074,7 @@ def threedimodels_initial_waterlevels_list_with_http_info(self, threedimodel_pk, body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20067', # noqa: E501 + response_type='InlineResponse20071', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -60901,6 +60901,7 @@ def threedimodels_list(self, **kwargs): # noqa: E501 :param str slug__endswith: :param str slug__regex: :param float epsg: + :param float id: :param str is_valid: :param str inpy_version__slug: :param str inpy_version__slug__iexact: @@ -60929,6 +60930,8 @@ def threedimodels_list(self, **kwargs): # noqa: E501 :param str inpy_version__threedicore_version__istartswith: :param str inpy_version__threedicore_version__endswith: :param str inpy_version__threedicore_version__regex: + :param str revision__commit_user__username: + :param str revision__commit_user__username__istartswith: :param float revision__id: :param float revision__number: :param float revision__number__gt: @@ -60967,9 +60970,11 @@ def threedimodels_list(self, **kwargs): # noqa: E501 :param str revision__schematisation__owner__unique_id: :param float revision__schematisation__id: :param str revision__is_pinned: + :param str revision__schematisation__tags__in: :param str disabled: :param str inp_success: :param str inpy_version__active: + :param str is_generating: :param str ordering: Which field to use when ordering the results. :param int limit: Number of results to return per page. :param int offset: The initial index from which to return the results. @@ -60980,7 +60985,7 @@ def threedimodels_list(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20065 + :return: InlineResponse20069 If the method is called asynchronously, returns the request thread. """ @@ -61016,6 +61021,7 @@ def threedimodels_list_with_http_info(self, **kwargs): # noqa: E501 :param str slug__endswith: :param str slug__regex: :param float epsg: + :param float id: :param str is_valid: :param str inpy_version__slug: :param str inpy_version__slug__iexact: @@ -61044,6 +61050,8 @@ def threedimodels_list_with_http_info(self, **kwargs): # noqa: E501 :param str inpy_version__threedicore_version__istartswith: :param str inpy_version__threedicore_version__endswith: :param str inpy_version__threedicore_version__regex: + :param str revision__commit_user__username: + :param str revision__commit_user__username__istartswith: :param float revision__id: :param float revision__number: :param float revision__number__gt: @@ -61082,9 +61090,11 @@ def threedimodels_list_with_http_info(self, **kwargs): # noqa: E501 :param str revision__schematisation__owner__unique_id: :param float revision__schematisation__id: :param str revision__is_pinned: + :param str revision__schematisation__tags__in: :param str disabled: :param str inp_success: :param str inpy_version__active: + :param str is_generating: :param str ordering: Which field to use when ordering the results. :param int limit: Number of results to return per page. :param int offset: The initial index from which to return the results. @@ -61097,7 +61107,7 @@ def threedimodels_list_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20065, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20069, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -61124,6 +61134,7 @@ def threedimodels_list_with_http_info(self, **kwargs): # noqa: E501 'slug__endswith', 'slug__regex', 'epsg', + 'id', 'is_valid', 'inpy_version__slug', 'inpy_version__slug__iexact', @@ -61152,6 +61163,8 @@ def threedimodels_list_with_http_info(self, **kwargs): # noqa: E501 'inpy_version__threedicore_version__istartswith', 'inpy_version__threedicore_version__endswith', 'inpy_version__threedicore_version__regex', + 'revision__commit_user__username', + 'revision__commit_user__username__istartswith', 'revision__id', 'revision__number', 'revision__number__gt', @@ -61190,9 +61203,11 @@ def threedimodels_list_with_http_info(self, **kwargs): # noqa: E501 'revision__schematisation__owner__unique_id', 'revision__schematisation__id', 'revision__is_pinned', + 'revision__schematisation__tags__in', 'disabled', 'inp_success', 'inpy_version__active', + 'is_generating', 'ordering', 'limit', 'offset' @@ -61258,6 +61273,8 @@ def threedimodels_list_with_http_info(self, **kwargs): # noqa: E501 query_params.append(('slug__regex', local_var_params['slug__regex'])) # noqa: E501 if 'epsg' in local_var_params and local_var_params['epsg'] is not None: # noqa: E501 query_params.append(('epsg', local_var_params['epsg'])) # noqa: E501 + if 'id' in local_var_params and local_var_params['id'] is not None: # noqa: E501 + query_params.append(('id', local_var_params['id'])) # noqa: E501 if 'is_valid' in local_var_params and local_var_params['is_valid'] is not None: # noqa: E501 query_params.append(('is_valid', local_var_params['is_valid'])) # noqa: E501 if 'inpy_version__slug' in local_var_params and local_var_params['inpy_version__slug'] is not None: # noqa: E501 @@ -61314,6 +61331,10 @@ def threedimodels_list_with_http_info(self, **kwargs): # noqa: E501 query_params.append(('inpy_version__threedicore_version__endswith', local_var_params['inpy_version__threedicore_version__endswith'])) # noqa: E501 if 'inpy_version__threedicore_version__regex' in local_var_params and local_var_params['inpy_version__threedicore_version__regex'] is not None: # noqa: E501 query_params.append(('inpy_version__threedicore_version__regex', local_var_params['inpy_version__threedicore_version__regex'])) # noqa: E501 + if 'revision__commit_user__username' in local_var_params and local_var_params['revision__commit_user__username'] is not None: # noqa: E501 + query_params.append(('revision__commit_user__username', local_var_params['revision__commit_user__username'])) # noqa: E501 + if 'revision__commit_user__username__istartswith' in local_var_params and local_var_params['revision__commit_user__username__istartswith'] is not None: # noqa: E501 + query_params.append(('revision__commit_user__username__istartswith', local_var_params['revision__commit_user__username__istartswith'])) # noqa: E501 if 'revision__id' in local_var_params and local_var_params['revision__id'] is not None: # noqa: E501 query_params.append(('revision__id', local_var_params['revision__id'])) # noqa: E501 if 'revision__number' in local_var_params and local_var_params['revision__number'] is not None: # noqa: E501 @@ -61390,12 +61411,16 @@ def threedimodels_list_with_http_info(self, **kwargs): # noqa: E501 query_params.append(('revision__schematisation__id', local_var_params['revision__schematisation__id'])) # noqa: E501 if 'revision__is_pinned' in local_var_params and local_var_params['revision__is_pinned'] is not None: # noqa: E501 query_params.append(('revision__is_pinned', local_var_params['revision__is_pinned'])) # noqa: E501 + if 'revision__schematisation__tags__in' in local_var_params and local_var_params['revision__schematisation__tags__in'] is not None: # noqa: E501 + query_params.append(('revision__schematisation__tags__in', local_var_params['revision__schematisation__tags__in'])) # noqa: E501 if 'disabled' in local_var_params and local_var_params['disabled'] is not None: # noqa: E501 query_params.append(('disabled', local_var_params['disabled'])) # noqa: E501 if 'inp_success' in local_var_params and local_var_params['inp_success'] is not None: # noqa: E501 query_params.append(('inp_success', local_var_params['inp_success'])) # noqa: E501 if 'inpy_version__active' in local_var_params and local_var_params['inpy_version__active'] is not None: # noqa: E501 query_params.append(('inpy_version__active', local_var_params['inpy_version__active'])) # noqa: E501 + if 'is_generating' in local_var_params and local_var_params['is_generating'] is not None: # noqa: E501 + query_params.append(('is_generating', local_var_params['is_generating'])) # noqa: E501 if 'ordering' in local_var_params and local_var_params['ordering'] is not None: # noqa: E501 query_params.append(('ordering', local_var_params['ordering'])) # noqa: E501 if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501 @@ -61424,7 +61449,7 @@ def threedimodels_list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20065', # noqa: E501 + response_type='InlineResponse20069', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -62099,7 +62124,7 @@ def threedimodels_potentialbreaches_list(self, threedimodel_pk, **kwargs): # no number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20068 + :return: InlineResponse20072 If the method is called asynchronously, returns the request thread. """ @@ -62140,7 +62165,7 @@ def threedimodels_potentialbreaches_list_with_http_info(self, threedimodel_pk, * number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20068, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20072, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -62243,7 +62268,7 @@ def threedimodels_potentialbreaches_list_with_http_info(self, threedimodel_pk, * body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20068', # noqa: E501 + response_type='InlineResponse20072', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -63022,7 +63047,7 @@ def threedimodels_rasters_list(self, threedimodel_pk, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20069 + :return: InlineResponse20073 If the method is called asynchronously, returns the request thread. """ @@ -63069,7 +63094,7 @@ def threedimodels_rasters_list_with_http_info(self, threedimodel_pk, **kwargs): number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20069, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20073, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -63190,7 +63215,7 @@ def threedimodels_rasters_list_with_http_info(self, threedimodel_pk, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20069', # noqa: E501 + response_type='InlineResponse20073', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -63983,7 +64008,7 @@ def threedimodels_saved_states_list(self, threedimodel_pk, **kwargs): # noqa: E number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20070 + :return: InlineResponse20074 If the method is called asynchronously, returns the request thread. """ @@ -64013,7 +64038,7 @@ def threedimodels_saved_states_list_with_http_info(self, threedimodel_pk, **kwar number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20070, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20074, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -64083,7 +64108,7 @@ def threedimodels_saved_states_list_with_http_info(self, threedimodel_pk, **kwar body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20070', # noqa: E501 + response_type='InlineResponse20074', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -64721,7 +64746,7 @@ def threedimodels_tasks_list(self, threedimodel_pk, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20071 + :return: InlineResponse20075 If the method is called asynchronously, returns the request thread. """ @@ -64750,7 +64775,7 @@ def threedimodels_tasks_list_with_http_info(self, threedimodel_pk, **kwargs): # number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20071, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20075, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -64817,7 +64842,7 @@ def threedimodels_tasks_list_with_http_info(self, threedimodel_pk, **kwargs): # body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20071', # noqa: E501 + response_type='InlineResponse20075', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -65522,6 +65547,7 @@ def usage_list(self, **kwargs): # noqa: E501 :param float total_time__lt: :param float total_time__lte: :param str total_time__isnull: + :param float simulation__id: :param str simulation__name: :param str simulation__name__iexact: :param str simulation__name__contains: @@ -65579,7 +65605,7 @@ def usage_list(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20072 + :return: InlineResponse20076 If the method is called asynchronously, returns the request thread. """ @@ -65634,6 +65660,7 @@ def usage_list_with_http_info(self, **kwargs): # noqa: E501 :param float total_time__lt: :param float total_time__lte: :param str total_time__isnull: + :param float simulation__id: :param str simulation__name: :param str simulation__name__iexact: :param str simulation__name__contains: @@ -65693,7 +65720,7 @@ def usage_list_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20072, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20076, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -65739,6 +65766,7 @@ def usage_list_with_http_info(self, **kwargs): # noqa: E501 'total_time__lt', 'total_time__lte', 'total_time__isnull', + 'simulation__id', 'simulation__name', 'simulation__name__iexact', 'simulation__name__contains', @@ -65889,6 +65917,8 @@ def usage_list_with_http_info(self, **kwargs): # noqa: E501 query_params.append(('total_time__lte', local_var_params['total_time__lte'])) # noqa: E501 if 'total_time__isnull' in local_var_params and local_var_params['total_time__isnull'] is not None: # noqa: E501 query_params.append(('total_time__isnull', local_var_params['total_time__isnull'])) # noqa: E501 + if 'simulation__id' in local_var_params and local_var_params['simulation__id'] is not None: # noqa: E501 + query_params.append(('simulation__id', local_var_params['simulation__id'])) # noqa: E501 if 'simulation__name' in local_var_params and local_var_params['simulation__name'] is not None: # noqa: E501 query_params.append(('simulation__name', local_var_params['simulation__name'])) # noqa: E501 if 'simulation__name__iexact' in local_var_params and local_var_params['simulation__name__iexact'] is not None: # noqa: E501 @@ -66011,7 +66041,7 @@ def usage_list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20072', # noqa: E501 + response_type='InlineResponse20076', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -66181,6 +66211,7 @@ def usage_statistics(self, **kwargs): # noqa: E501 :param float total_time__lt: :param float total_time__lte: :param str total_time__isnull: + :param float simulation__id: :param str simulation__name: :param str simulation__name__iexact: :param str simulation__name__contains: @@ -66293,6 +66324,7 @@ def usage_statistics_with_http_info(self, **kwargs): # noqa: E501 :param float total_time__lt: :param float total_time__lte: :param str total_time__isnull: + :param float simulation__id: :param str simulation__name: :param str simulation__name__iexact: :param str simulation__name__contains: @@ -66398,6 +66430,7 @@ def usage_statistics_with_http_info(self, **kwargs): # noqa: E501 'total_time__lt', 'total_time__lte', 'total_time__isnull', + 'simulation__id', 'simulation__name', 'simulation__name__iexact', 'simulation__name__contains', @@ -66548,6 +66581,8 @@ def usage_statistics_with_http_info(self, **kwargs): # noqa: E501 query_params.append(('total_time__lte', local_var_params['total_time__lte'])) # noqa: E501 if 'total_time__isnull' in local_var_params and local_var_params['total_time__isnull'] is not None: # noqa: E501 query_params.append(('total_time__isnull', local_var_params['total_time__isnull'])) # noqa: E501 + if 'simulation__id' in local_var_params and local_var_params['simulation__id'] is not None: # noqa: E501 + query_params.append(('simulation__id', local_var_params['simulation__id'])) # noqa: E501 if 'simulation__name' in local_var_params and local_var_params['simulation__name'] is not None: # noqa: E501 query_params.append(('simulation__name', local_var_params['simulation__name'])) # noqa: E501 if 'simulation__name__iexact' in local_var_params and local_var_params['simulation__name__iexact'] is not None: # noqa: E501 diff --git a/threedi_api_client/openapi/api/v3_beta_api.py b/threedi_api_client/openapi/api/v3_beta_api.py index 5084f29f..2e3942cc 100644 --- a/threedi_api_client/openapi/api/v3_beta_api.py +++ b/threedi_api_client/openapi/api/v3_beta_api.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -1751,15 +1751,3178 @@ def simulations_events_obstacle_edits_update_with_http_info(self, id, simulation _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) + def simulations_initial1d_substance_concentrations_create(self, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_initial1d_substance_concentrations_create # noqa: E501 + + Start the simulation with a 1D (water quality) concentrations from a file. Applies the given values to the predefined nodes subset \"1D\" as described in the [threedigrid documentation] [ref] [ref]: https://threedigrid.readthedocs.io/en/latest/api.html#subsets # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial1d_substance_concentrations_create(simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str simulation_pk: (required) + :param OneDSubstanceConcentration data: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: OneDSubstanceConcentration + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_initial1d_substance_concentrations_create_with_http_info(simulation_pk, data, **kwargs) # noqa: E501 + + def simulations_initial1d_substance_concentrations_create_with_http_info(self, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_initial1d_substance_concentrations_create # noqa: E501 + + Start the simulation with a 1D (water quality) concentrations from a file. Applies the given values to the predefined nodes subset \"1D\" as described in the [threedigrid documentation] [ref] [ref]: https://threedigrid.readthedocs.io/en/latest/api.html#subsets # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial1d_substance_concentrations_create_with_http_info(simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str simulation_pk: (required) + :param OneDSubstanceConcentration data: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(OneDSubstanceConcentration, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'simulation_pk', + 'data' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_initial1d_substance_concentrations_create" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_initial1d_substance_concentrations_create`") # noqa: E501 + # verify the required parameter 'data' is set + if self.api_client.client_side_validation and ('data' not in local_var_params or # noqa: E501 + local_var_params['data'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `data` when calling `simulations_initial1d_substance_concentrations_create`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'data' in local_var_params: + body_params = local_var_params['data'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/initial/1d_substance_concentrations/', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='OneDSubstanceConcentration', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def simulations_initial1d_substance_concentrations_delete(self, id, simulation_pk, **kwargs): # noqa: E501 + """simulations_initial1d_substance_concentrations_delete # noqa: E501 + + Initial 1D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial1d_substance_concentrations_delete(id, simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this one d substance concentration. (required) + :param str simulation_pk: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_initial1d_substance_concentrations_delete_with_http_info(id, simulation_pk, **kwargs) # noqa: E501 + + def simulations_initial1d_substance_concentrations_delete_with_http_info(self, id, simulation_pk, **kwargs): # noqa: E501 + """simulations_initial1d_substance_concentrations_delete # noqa: E501 + + Initial 1D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial1d_substance_concentrations_delete_with_http_info(id, simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this one d substance concentration. (required) + :param str simulation_pk: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'id', + 'simulation_pk' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_initial1d_substance_concentrations_delete" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `simulations_initial1d_substance_concentrations_delete`") # noqa: E501 + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_initial1d_substance_concentrations_delete`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/initial/1d_substance_concentrations/{id}/', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def simulations_initial1d_substance_concentrations_list(self, simulation_pk, **kwargs): # noqa: E501 + """simulations_initial1d_substance_concentrations_list # noqa: E501 + + Initial 1D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial1d_substance_concentrations_list(simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str simulation_pk: (required) + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: InlineResponse2002 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_initial1d_substance_concentrations_list_with_http_info(simulation_pk, **kwargs) # noqa: E501 + + def simulations_initial1d_substance_concentrations_list_with_http_info(self, simulation_pk, **kwargs): # noqa: E501 + """simulations_initial1d_substance_concentrations_list # noqa: E501 + + Initial 1D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial1d_substance_concentrations_list_with_http_info(simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str simulation_pk: (required) + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(InlineResponse2002, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'simulation_pk', + 'limit', + 'offset' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_initial1d_substance_concentrations_list" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_initial1d_substance_concentrations_list`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501 + query_params.append(('limit', local_var_params['limit'])) # noqa: E501 + if 'offset' in local_var_params and local_var_params['offset'] is not None: # noqa: E501 + query_params.append(('offset', local_var_params['offset'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/initial/1d_substance_concentrations/', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponse2002', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def simulations_initial1d_substance_concentrations_partial_update(self, id, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_initial1d_substance_concentrations_partial_update # noqa: E501 + + Initial 1D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial1d_substance_concentrations_partial_update(id, simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this one d substance concentration. (required) + :param str simulation_pk: (required) + :param OneDSubstanceConcentration data: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: OneDSubstanceConcentration + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_initial1d_substance_concentrations_partial_update_with_http_info(id, simulation_pk, data, **kwargs) # noqa: E501 + + def simulations_initial1d_substance_concentrations_partial_update_with_http_info(self, id, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_initial1d_substance_concentrations_partial_update # noqa: E501 + + Initial 1D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial1d_substance_concentrations_partial_update_with_http_info(id, simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this one d substance concentration. (required) + :param str simulation_pk: (required) + :param OneDSubstanceConcentration data: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(OneDSubstanceConcentration, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'id', + 'simulation_pk', + 'data' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_initial1d_substance_concentrations_partial_update" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `simulations_initial1d_substance_concentrations_partial_update`") # noqa: E501 + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_initial1d_substance_concentrations_partial_update`") # noqa: E501 + # verify the required parameter 'data' is set + if self.api_client.client_side_validation and ('data' not in local_var_params or # noqa: E501 + local_var_params['data'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `data` when calling `simulations_initial1d_substance_concentrations_partial_update`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'data' in local_var_params: + body_params = local_var_params['data'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/initial/1d_substance_concentrations/{id}/', 'PATCH', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='OneDSubstanceConcentration', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def simulations_initial1d_substance_concentrations_read(self, id, simulation_pk, **kwargs): # noqa: E501 + """simulations_initial1d_substance_concentrations_read # noqa: E501 + + Initial 1D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial1d_substance_concentrations_read(id, simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this one d substance concentration. (required) + :param str simulation_pk: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: OneDSubstanceConcentration + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_initial1d_substance_concentrations_read_with_http_info(id, simulation_pk, **kwargs) # noqa: E501 + + def simulations_initial1d_substance_concentrations_read_with_http_info(self, id, simulation_pk, **kwargs): # noqa: E501 + """simulations_initial1d_substance_concentrations_read # noqa: E501 + + Initial 1D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial1d_substance_concentrations_read_with_http_info(id, simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this one d substance concentration. (required) + :param str simulation_pk: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(OneDSubstanceConcentration, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'id', + 'simulation_pk' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_initial1d_substance_concentrations_read" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `simulations_initial1d_substance_concentrations_read`") # noqa: E501 + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_initial1d_substance_concentrations_read`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/initial/1d_substance_concentrations/{id}/', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='OneDSubstanceConcentration', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def simulations_initial1d_substance_concentrations_update(self, id, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_initial1d_substance_concentrations_update # noqa: E501 + + Initial 1D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial1d_substance_concentrations_update(id, simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this one d substance concentration. (required) + :param str simulation_pk: (required) + :param OneDSubstanceConcentration data: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: OneDSubstanceConcentration + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_initial1d_substance_concentrations_update_with_http_info(id, simulation_pk, data, **kwargs) # noqa: E501 + + def simulations_initial1d_substance_concentrations_update_with_http_info(self, id, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_initial1d_substance_concentrations_update # noqa: E501 + + Initial 1D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial1d_substance_concentrations_update_with_http_info(id, simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this one d substance concentration. (required) + :param str simulation_pk: (required) + :param OneDSubstanceConcentration data: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(OneDSubstanceConcentration, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'id', + 'simulation_pk', + 'data' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_initial1d_substance_concentrations_update" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `simulations_initial1d_substance_concentrations_update`") # noqa: E501 + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_initial1d_substance_concentrations_update`") # noqa: E501 + # verify the required parameter 'data' is set + if self.api_client.client_side_validation and ('data' not in local_var_params or # noqa: E501 + local_var_params['data'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `data` when calling `simulations_initial1d_substance_concentrations_update`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'data' in local_var_params: + body_params = local_var_params['data'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/initial/1d_substance_concentrations/{id}/', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='OneDSubstanceConcentration', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def simulations_initial2d_substance_concentrations_create(self, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_initial2d_substance_concentrations_create # noqa: E501 + + Start the simulation with 2D (water quality) concentrations derived from the raster by using the aggregation method. Applies the resulting levels to the predefined nodes subset \"2D_OPEN_WATER\" as described in the [threedigrid documentation] [ref] [ref]: https://threedigrid.readthedocs.io/en/latest/api.html#subsets # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial2d_substance_concentrations_create(simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str simulation_pk: (required) + :param TwoDSubstanceConcentration data: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: TwoDSubstanceConcentration + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_initial2d_substance_concentrations_create_with_http_info(simulation_pk, data, **kwargs) # noqa: E501 + + def simulations_initial2d_substance_concentrations_create_with_http_info(self, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_initial2d_substance_concentrations_create # noqa: E501 + + Start the simulation with 2D (water quality) concentrations derived from the raster by using the aggregation method. Applies the resulting levels to the predefined nodes subset \"2D_OPEN_WATER\" as described in the [threedigrid documentation] [ref] [ref]: https://threedigrid.readthedocs.io/en/latest/api.html#subsets # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial2d_substance_concentrations_create_with_http_info(simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str simulation_pk: (required) + :param TwoDSubstanceConcentration data: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(TwoDSubstanceConcentration, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'simulation_pk', + 'data' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_initial2d_substance_concentrations_create" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_initial2d_substance_concentrations_create`") # noqa: E501 + # verify the required parameter 'data' is set + if self.api_client.client_side_validation and ('data' not in local_var_params or # noqa: E501 + local_var_params['data'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `data` when calling `simulations_initial2d_substance_concentrations_create`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'data' in local_var_params: + body_params = local_var_params['data'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/initial/2d_substance_concentrations/', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='TwoDSubstanceConcentration', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def simulations_initial2d_substance_concentrations_delete(self, id, simulation_pk, **kwargs): # noqa: E501 + """simulations_initial2d_substance_concentrations_delete # noqa: E501 + + Initial 2D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial2d_substance_concentrations_delete(id, simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this two d substance concentration. (required) + :param str simulation_pk: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_initial2d_substance_concentrations_delete_with_http_info(id, simulation_pk, **kwargs) # noqa: E501 + + def simulations_initial2d_substance_concentrations_delete_with_http_info(self, id, simulation_pk, **kwargs): # noqa: E501 + """simulations_initial2d_substance_concentrations_delete # noqa: E501 + + Initial 2D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial2d_substance_concentrations_delete_with_http_info(id, simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this two d substance concentration. (required) + :param str simulation_pk: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'id', + 'simulation_pk' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_initial2d_substance_concentrations_delete" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `simulations_initial2d_substance_concentrations_delete`") # noqa: E501 + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_initial2d_substance_concentrations_delete`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/initial/2d_substance_concentrations/{id}/', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def simulations_initial2d_substance_concentrations_list(self, simulation_pk, **kwargs): # noqa: E501 + """simulations_initial2d_substance_concentrations_list # noqa: E501 + + Initial 2D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial2d_substance_concentrations_list(simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str simulation_pk: (required) + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: InlineResponse2003 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_initial2d_substance_concentrations_list_with_http_info(simulation_pk, **kwargs) # noqa: E501 + + def simulations_initial2d_substance_concentrations_list_with_http_info(self, simulation_pk, **kwargs): # noqa: E501 + """simulations_initial2d_substance_concentrations_list # noqa: E501 + + Initial 2D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial2d_substance_concentrations_list_with_http_info(simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str simulation_pk: (required) + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(InlineResponse2003, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'simulation_pk', + 'limit', + 'offset' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_initial2d_substance_concentrations_list" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_initial2d_substance_concentrations_list`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501 + query_params.append(('limit', local_var_params['limit'])) # noqa: E501 + if 'offset' in local_var_params and local_var_params['offset'] is not None: # noqa: E501 + query_params.append(('offset', local_var_params['offset'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/initial/2d_substance_concentrations/', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponse2003', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def simulations_initial2d_substance_concentrations_partial_update(self, id, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_initial2d_substance_concentrations_partial_update # noqa: E501 + + Initial 2D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial2d_substance_concentrations_partial_update(id, simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this two d substance concentration. (required) + :param str simulation_pk: (required) + :param TwoDSubstanceConcentration data: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: TwoDSubstanceConcentration + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_initial2d_substance_concentrations_partial_update_with_http_info(id, simulation_pk, data, **kwargs) # noqa: E501 + + def simulations_initial2d_substance_concentrations_partial_update_with_http_info(self, id, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_initial2d_substance_concentrations_partial_update # noqa: E501 + + Initial 2D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial2d_substance_concentrations_partial_update_with_http_info(id, simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this two d substance concentration. (required) + :param str simulation_pk: (required) + :param TwoDSubstanceConcentration data: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(TwoDSubstanceConcentration, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'id', + 'simulation_pk', + 'data' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_initial2d_substance_concentrations_partial_update" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `simulations_initial2d_substance_concentrations_partial_update`") # noqa: E501 + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_initial2d_substance_concentrations_partial_update`") # noqa: E501 + # verify the required parameter 'data' is set + if self.api_client.client_side_validation and ('data' not in local_var_params or # noqa: E501 + local_var_params['data'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `data` when calling `simulations_initial2d_substance_concentrations_partial_update`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'data' in local_var_params: + body_params = local_var_params['data'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/initial/2d_substance_concentrations/{id}/', 'PATCH', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='TwoDSubstanceConcentration', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def simulations_initial2d_substance_concentrations_read(self, id, simulation_pk, **kwargs): # noqa: E501 + """simulations_initial2d_substance_concentrations_read # noqa: E501 + + Initial 2D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial2d_substance_concentrations_read(id, simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this two d substance concentration. (required) + :param str simulation_pk: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: TwoDSubstanceConcentration + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_initial2d_substance_concentrations_read_with_http_info(id, simulation_pk, **kwargs) # noqa: E501 + + def simulations_initial2d_substance_concentrations_read_with_http_info(self, id, simulation_pk, **kwargs): # noqa: E501 + """simulations_initial2d_substance_concentrations_read # noqa: E501 + + Initial 2D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial2d_substance_concentrations_read_with_http_info(id, simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this two d substance concentration. (required) + :param str simulation_pk: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(TwoDSubstanceConcentration, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'id', + 'simulation_pk' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_initial2d_substance_concentrations_read" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `simulations_initial2d_substance_concentrations_read`") # noqa: E501 + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_initial2d_substance_concentrations_read`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/initial/2d_substance_concentrations/{id}/', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='TwoDSubstanceConcentration', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def simulations_initial2d_substance_concentrations_update(self, id, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_initial2d_substance_concentrations_update # noqa: E501 + + Initial 2D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial2d_substance_concentrations_update(id, simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this two d substance concentration. (required) + :param str simulation_pk: (required) + :param TwoDSubstanceConcentration data: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: TwoDSubstanceConcentration + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_initial2d_substance_concentrations_update_with_http_info(id, simulation_pk, data, **kwargs) # noqa: E501 + + def simulations_initial2d_substance_concentrations_update_with_http_info(self, id, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_initial2d_substance_concentrations_update # noqa: E501 + + Initial 2D substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_initial2d_substance_concentrations_update_with_http_info(id, simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this two d substance concentration. (required) + :param str simulation_pk: (required) + :param TwoDSubstanceConcentration data: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(TwoDSubstanceConcentration, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'id', + 'simulation_pk', + 'data' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_initial2d_substance_concentrations_update" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `simulations_initial2d_substance_concentrations_update`") # noqa: E501 + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_initial2d_substance_concentrations_update`") # noqa: E501 + # verify the required parameter 'data' is set + if self.api_client.client_side_validation and ('data' not in local_var_params or # noqa: E501 + local_var_params['data'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `data` when calling `simulations_initial2d_substance_concentrations_update`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'data' in local_var_params: + body_params = local_var_params['data'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/initial/2d_substance_concentrations/{id}/', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='TwoDSubstanceConcentration', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def simulations_substances_create(self, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_substances_create # noqa: E501 + + Water quality substances # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_substances_create(simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str simulation_pk: (required) + :param Substance data: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Substance + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_substances_create_with_http_info(simulation_pk, data, **kwargs) # noqa: E501 + + def simulations_substances_create_with_http_info(self, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_substances_create # noqa: E501 + + Water quality substances # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_substances_create_with_http_info(simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str simulation_pk: (required) + :param Substance data: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(Substance, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'simulation_pk', + 'data' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_substances_create" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_substances_create`") # noqa: E501 + # verify the required parameter 'data' is set + if self.api_client.client_side_validation and ('data' not in local_var_params or # noqa: E501 + local_var_params['data'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `data` when calling `simulations_substances_create`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'data' in local_var_params: + body_params = local_var_params['data'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/substances/', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='Substance', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def simulations_substances_delete(self, id, simulation_pk, **kwargs): # noqa: E501 + """simulations_substances_delete # noqa: E501 + + Water quality substances # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_substances_delete(id, simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this substance. (required) + :param str simulation_pk: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_substances_delete_with_http_info(id, simulation_pk, **kwargs) # noqa: E501 + + def simulations_substances_delete_with_http_info(self, id, simulation_pk, **kwargs): # noqa: E501 + """simulations_substances_delete # noqa: E501 + + Water quality substances # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_substances_delete_with_http_info(id, simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this substance. (required) + :param str simulation_pk: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'id', + 'simulation_pk' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_substances_delete" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `simulations_substances_delete`") # noqa: E501 + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_substances_delete`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/substances/{id}/', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def simulations_substances_list(self, simulation_pk, **kwargs): # noqa: E501 + """simulations_substances_list # noqa: E501 + + Water quality substances # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_substances_list(simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str simulation_pk: (required) + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: InlineResponse2004 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_substances_list_with_http_info(simulation_pk, **kwargs) # noqa: E501 + + def simulations_substances_list_with_http_info(self, simulation_pk, **kwargs): # noqa: E501 + """simulations_substances_list # noqa: E501 + + Water quality substances # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_substances_list_with_http_info(simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str simulation_pk: (required) + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(InlineResponse2004, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'simulation_pk', + 'limit', + 'offset' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_substances_list" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_substances_list`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501 + query_params.append(('limit', local_var_params['limit'])) # noqa: E501 + if 'offset' in local_var_params and local_var_params['offset'] is not None: # noqa: E501 + query_params.append(('offset', local_var_params['offset'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/substances/', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponse2004', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def simulations_substances_partial_update(self, id, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_substances_partial_update # noqa: E501 + + Water quality substances # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_substances_partial_update(id, simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this substance. (required) + :param str simulation_pk: (required) + :param Substance data: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Substance + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_substances_partial_update_with_http_info(id, simulation_pk, data, **kwargs) # noqa: E501 + + def simulations_substances_partial_update_with_http_info(self, id, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_substances_partial_update # noqa: E501 + + Water quality substances # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_substances_partial_update_with_http_info(id, simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this substance. (required) + :param str simulation_pk: (required) + :param Substance data: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(Substance, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'id', + 'simulation_pk', + 'data' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_substances_partial_update" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `simulations_substances_partial_update`") # noqa: E501 + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_substances_partial_update`") # noqa: E501 + # verify the required parameter 'data' is set + if self.api_client.client_side_validation and ('data' not in local_var_params or # noqa: E501 + local_var_params['data'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `data` when calling `simulations_substances_partial_update`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'data' in local_var_params: + body_params = local_var_params['data'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/substances/{id}/', 'PATCH', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='Substance', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def simulations_substances_read(self, id, simulation_pk, **kwargs): # noqa: E501 + """simulations_substances_read # noqa: E501 + + Water quality substances # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_substances_read(id, simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this substance. (required) + :param str simulation_pk: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Substance + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_substances_read_with_http_info(id, simulation_pk, **kwargs) # noqa: E501 + + def simulations_substances_read_with_http_info(self, id, simulation_pk, **kwargs): # noqa: E501 + """simulations_substances_read # noqa: E501 + + Water quality substances # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_substances_read_with_http_info(id, simulation_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this substance. (required) + :param str simulation_pk: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(Substance, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'id', + 'simulation_pk' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_substances_read" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `simulations_substances_read`") # noqa: E501 + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_substances_read`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/substances/{id}/', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='Substance', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def simulations_substances_update(self, id, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_substances_update # noqa: E501 + + Water quality substances # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_substances_update(id, simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this substance. (required) + :param str simulation_pk: (required) + :param Substance data: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Substance + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.simulations_substances_update_with_http_info(id, simulation_pk, data, **kwargs) # noqa: E501 + + def simulations_substances_update_with_http_info(self, id, simulation_pk, data, **kwargs): # noqa: E501 + """simulations_substances_update # noqa: E501 + + Water quality substances # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.simulations_substances_update_with_http_info(id, simulation_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this substance. (required) + :param str simulation_pk: (required) + :param Substance data: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(Substance, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'id', + 'simulation_pk', + 'data' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method simulations_substances_update" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `simulations_substances_update`") # noqa: E501 + # verify the required parameter 'simulation_pk' is set + if self.api_client.client_side_validation and ('simulation_pk' not in local_var_params or # noqa: E501 + local_var_params['simulation_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `simulation_pk` when calling `simulations_substances_update`") # noqa: E501 + # verify the required parameter 'data' is set + if self.api_client.client_side_validation and ('data' not in local_var_params or # noqa: E501 + local_var_params['data'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `data` when calling `simulations_substances_update`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'simulation_pk' in local_var_params: + path_params['simulation_pk'] = local_var_params['simulation_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'data' in local_var_params: + body_params = local_var_params['data'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/simulations/{simulation_pk}/substances/{id}/', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='Substance', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + def status_current_version(self, **kwargs): # noqa: E501 """status_current_version # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.status_current_version(async_req=True) + >>> thread = api.status_current_version(async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: CurrentVersion + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.status_current_version_with_http_info(**kwargs) # noqa: E501 + + def status_current_version_with_http_info(self, **kwargs): # noqa: E501 + """status_current_version # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.status_current_version_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(CurrentVersion, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method status_current_version" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/status/current-version/', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='CurrentVersion', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def status_list(self, **kwargs): # noqa: E501 + """status_list # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.status_list(async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Status + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.status_list_with_http_info(**kwargs) # noqa: E501 + + def status_list_with_http_info(self, **kwargs): # noqa: E501 + """status_list # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.status_list_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(Status, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method status_list" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/status/', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='Status', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def threedimodels_initial_concentrations_create(self, threedimodel_pk, data, **kwargs): # noqa: E501 + """Add new initial concentrations # noqa: E501 + + ### Adding (extra) 1D initial concentrations Extra 1D initial concentrations can be added by posting: {\"dimension\": \"one_d\"} Using the 'id' value from the response, a JSON file needs to be uploaded via the PUT_URL retrieved from `initial_concentrations/{id}/upload/` in the following JSON format: Python code: import json file_contents = json.dumps({ \"node_ids\": [node_id_1, node_id2, ....], \"values\" : [value_for_node_id_1, value_for_node_id_2, ...] }) # Notes: # - Omitted values are considered dry. # - `node_ids` need to be sorted and unique # - Make sure that the positions of the node_id's and values match. ### Adding (extra) 2D initial substance concentrations 2D initial concentrations can be added by uploading an 'initial_concentration_file' Geotiff raster via `rasters/{id}/upload/` . This automatically triggers the creation of a 2D initial concentration. The source raster is linked as 'source_raster'. The values in the `source_raster` are aggregated per node using max, min and mean operators. The resulting values are stored in a file linked under `file`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.threedimodels_initial_concentrations_create(threedimodel_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str threedimodel_pk: (required) + :param InitialConcentration data: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: InitialConcentration + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.threedimodels_initial_concentrations_create_with_http_info(threedimodel_pk, data, **kwargs) # noqa: E501 + + def threedimodels_initial_concentrations_create_with_http_info(self, threedimodel_pk, data, **kwargs): # noqa: E501 + """Add new initial concentrations # noqa: E501 + + ### Adding (extra) 1D initial concentrations Extra 1D initial concentrations can be added by posting: {\"dimension\": \"one_d\"} Using the 'id' value from the response, a JSON file needs to be uploaded via the PUT_URL retrieved from `initial_concentrations/{id}/upload/` in the following JSON format: Python code: import json file_contents = json.dumps({ \"node_ids\": [node_id_1, node_id2, ....], \"values\" : [value_for_node_id_1, value_for_node_id_2, ...] }) # Notes: # - Omitted values are considered dry. # - `node_ids` need to be sorted and unique # - Make sure that the positions of the node_id's and values match. ### Adding (extra) 2D initial substance concentrations 2D initial concentrations can be added by uploading an 'initial_concentration_file' Geotiff raster via `rasters/{id}/upload/` . This automatically triggers the creation of a 2D initial concentration. The source raster is linked as 'source_raster'. The values in the `source_raster` are aggregated per node using max, min and mean operators. The resulting values are stored in a file linked under `file`. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.threedimodels_initial_concentrations_create_with_http_info(threedimodel_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str threedimodel_pk: (required) + :param InitialConcentration data: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(InitialConcentration, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'threedimodel_pk', + 'data' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method threedimodels_initial_concentrations_create" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'threedimodel_pk' is set + if self.api_client.client_side_validation and ('threedimodel_pk' not in local_var_params or # noqa: E501 + local_var_params['threedimodel_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `threedimodel_pk` when calling `threedimodels_initial_concentrations_create`") # noqa: E501 + # verify the required parameter 'data' is set + if self.api_client.client_side_validation and ('data' not in local_var_params or # noqa: E501 + local_var_params['data'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `data` when calling `threedimodels_initial_concentrations_create`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'threedimodel_pk' in local_var_params: + path_params['threedimodel_pk'] = local_var_params['threedimodel_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'data' in local_var_params: + body_params = local_var_params['data'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/threedimodels/{threedimodel_pk}/initial_concentrations/', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InitialConcentration', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def threedimodels_initial_concentrations_delete(self, id, threedimodel_pk, **kwargs): # noqa: E501 + """threedimodels_initial_concentrations_delete # noqa: E501 + + Delete initial substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.threedimodels_initial_concentrations_delete(id, threedimodel_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this initial concentration. (required) + :param str threedimodel_pk: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.threedimodels_initial_concentrations_delete_with_http_info(id, threedimodel_pk, **kwargs) # noqa: E501 + + def threedimodels_initial_concentrations_delete_with_http_info(self, id, threedimodel_pk, **kwargs): # noqa: E501 + """threedimodels_initial_concentrations_delete # noqa: E501 + + Delete initial substance concentration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.threedimodels_initial_concentrations_delete_with_http_info(id, threedimodel_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this initial concentration. (required) + :param str threedimodel_pk: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'id', + 'threedimodel_pk' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method threedimodels_initial_concentrations_delete" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `threedimodels_initial_concentrations_delete`") # noqa: E501 + # verify the required parameter 'threedimodel_pk' is set + if self.api_client.client_side_validation and ('threedimodel_pk' not in local_var_params or # noqa: E501 + local_var_params['threedimodel_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `threedimodel_pk` when calling `threedimodels_initial_concentrations_delete`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'threedimodel_pk' in local_var_params: + path_params['threedimodel_pk'] = local_var_params['threedimodel_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/threedimodels/{threedimodel_pk}/initial_concentrations/{id}/', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def threedimodels_initial_concentrations_download(self, id, threedimodel_pk, **kwargs): # noqa: E501 + """threedimodels_initial_concentrations_download # noqa: E501 + + Endpoint for downloading files. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.threedimodels_initial_concentrations_download(id, threedimodel_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this initial concentration. (required) + :param str threedimodel_pk: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Download + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.threedimodels_initial_concentrations_download_with_http_info(id, threedimodel_pk, **kwargs) # noqa: E501 + + def threedimodels_initial_concentrations_download_with_http_info(self, id, threedimodel_pk, **kwargs): # noqa: E501 + """threedimodels_initial_concentrations_download # noqa: E501 + + Endpoint for downloading files. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.threedimodels_initial_concentrations_download_with_http_info(id, threedimodel_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this initial concentration. (required) + :param str threedimodel_pk: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(Download, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'id', + 'threedimodel_pk' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method threedimodels_initial_concentrations_download" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `threedimodels_initial_concentrations_download`") # noqa: E501 + # verify the required parameter 'threedimodel_pk' is set + if self.api_client.client_side_validation and ('threedimodel_pk' not in local_var_params or # noqa: E501 + local_var_params['threedimodel_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `threedimodel_pk` when calling `threedimodels_initial_concentrations_download`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'threedimodel_pk' in local_var_params: + path_params['threedimodel_pk'] = local_var_params['threedimodel_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/threedimodels/{threedimodel_pk}/initial_concentrations/{id}/download/', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='Download', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def threedimodels_initial_concentrations_list(self, threedimodel_pk, **kwargs): # noqa: E501 + """threedimodels_initial_concentrations_list # noqa: E501 + + ## Description Initial substance concentrations on threedimodels can be used in a simulation to specify the initial substance concentration on the 1D and/or 2D domain. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.threedimodels_initial_concentrations_list(threedimodel_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str threedimodel_pk: (required) + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: InlineResponse2005 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.threedimodels_initial_concentrations_list_with_http_info(threedimodel_pk, **kwargs) # noqa: E501 + + def threedimodels_initial_concentrations_list_with_http_info(self, threedimodel_pk, **kwargs): # noqa: E501 + """threedimodels_initial_concentrations_list # noqa: E501 + + ## Description Initial substance concentrations on threedimodels can be used in a simulation to specify the initial substance concentration on the 1D and/or 2D domain. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.threedimodels_initial_concentrations_list_with_http_info(threedimodel_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str threedimodel_pk: (required) + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(InlineResponse2005, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'threedimodel_pk', + 'limit', + 'offset' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method threedimodels_initial_concentrations_list" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'threedimodel_pk' is set + if self.api_client.client_side_validation and ('threedimodel_pk' not in local_var_params or # noqa: E501 + local_var_params['threedimodel_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `threedimodel_pk` when calling `threedimodels_initial_concentrations_list`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'threedimodel_pk' in local_var_params: + path_params['threedimodel_pk'] = local_var_params['threedimodel_pk'] # noqa: E501 + + query_params = [] + if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501 + query_params.append(('limit', local_var_params['limit'])) # noqa: E501 + if 'offset' in local_var_params and local_var_params['offset'] is not None: # noqa: E501 + query_params.append(('offset', local_var_params['offset'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/threedimodels/{threedimodel_pk}/initial_concentrations/', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponse2005', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def threedimodels_initial_concentrations_partial_update(self, id, threedimodel_pk, data, **kwargs): # noqa: E501 + """threedimodels_initial_concentrations_partial_update # noqa: E501 + + ## Description Initial substance concentrations on threedimodels can be used in a simulation to specify the initial substance concentration on the 1D and/or 2D domain. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.threedimodels_initial_concentrations_partial_update(id, threedimodel_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this initial concentration. (required) + :param str threedimodel_pk: (required) + :param InitialConcentration data: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: InitialConcentration + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.threedimodels_initial_concentrations_partial_update_with_http_info(id, threedimodel_pk, data, **kwargs) # noqa: E501 + + def threedimodels_initial_concentrations_partial_update_with_http_info(self, id, threedimodel_pk, data, **kwargs): # noqa: E501 + """threedimodels_initial_concentrations_partial_update # noqa: E501 + + ## Description Initial substance concentrations on threedimodels can be used in a simulation to specify the initial substance concentration on the 1D and/or 2D domain. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.threedimodels_initial_concentrations_partial_update_with_http_info(id, threedimodel_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this initial concentration. (required) + :param str threedimodel_pk: (required) + :param InitialConcentration data: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(InitialConcentration, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'id', + 'threedimodel_pk', + 'data' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method threedimodels_initial_concentrations_partial_update" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `threedimodels_initial_concentrations_partial_update`") # noqa: E501 + # verify the required parameter 'threedimodel_pk' is set + if self.api_client.client_side_validation and ('threedimodel_pk' not in local_var_params or # noqa: E501 + local_var_params['threedimodel_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `threedimodel_pk` when calling `threedimodels_initial_concentrations_partial_update`") # noqa: E501 + # verify the required parameter 'data' is set + if self.api_client.client_side_validation and ('data' not in local_var_params or # noqa: E501 + local_var_params['data'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `data` when calling `threedimodels_initial_concentrations_partial_update`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'threedimodel_pk' in local_var_params: + path_params['threedimodel_pk'] = local_var_params['threedimodel_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'data' in local_var_params: + body_params = local_var_params['data'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/threedimodels/{threedimodel_pk}/initial_concentrations/{id}/', 'PATCH', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InitialConcentration', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def threedimodels_initial_concentrations_processed(self, id, threedimodel_pk, data, **kwargs): # noqa: E501 + """threedimodels_initial_concentrations_processed # noqa: E501 + + ## Description Initial substance concentrations on threedimodels can be used in a simulation to specify the initial substance concentration on the 1D and/or 2D domain. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.threedimodels_initial_concentrations_processed(id, threedimodel_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this initial concentration. (required) + :param str threedimodel_pk: (required) + :param BaseEventState data: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.threedimodels_initial_concentrations_processed_with_http_info(id, threedimodel_pk, data, **kwargs) # noqa: E501 + + def threedimodels_initial_concentrations_processed_with_http_info(self, id, threedimodel_pk, data, **kwargs): # noqa: E501 + """threedimodels_initial_concentrations_processed # noqa: E501 + + ## Description Initial substance concentrations on threedimodels can be used in a simulation to specify the initial substance concentration on the 1D and/or 2D domain. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.threedimodels_initial_concentrations_processed_with_http_info(id, threedimodel_pk, data, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this initial concentration. (required) + :param str threedimodel_pk: (required) + :param BaseEventState data: (required) + :param _return_http_data_only: response data without head status code + and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -1767,22 +4930,127 @@ def status_current_version(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: CurrentVersion + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'id', + 'threedimodel_pk', + 'data' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method threedimodels_initial_concentrations_processed" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `threedimodels_initial_concentrations_processed`") # noqa: E501 + # verify the required parameter 'threedimodel_pk' is set + if self.api_client.client_side_validation and ('threedimodel_pk' not in local_var_params or # noqa: E501 + local_var_params['threedimodel_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `threedimodel_pk` when calling `threedimodels_initial_concentrations_processed`") # noqa: E501 + # verify the required parameter 'data' is set + if self.api_client.client_side_validation and ('data' not in local_var_params or # noqa: E501 + local_var_params['data'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `data` when calling `threedimodels_initial_concentrations_processed`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'threedimodel_pk' in local_var_params: + path_params['threedimodel_pk'] = local_var_params['threedimodel_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'data' in local_var_params: + body_params = local_var_params['data'] + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/threedimodels/{threedimodel_pk}/initial_concentrations/{id}/processed/', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def threedimodels_initial_concentrations_read(self, id, threedimodel_pk, **kwargs): # noqa: E501 + """threedimodels_initial_concentrations_read # noqa: E501 + + ## Description Initial substance concentrations on threedimodels can be used in a simulation to specify the initial substance concentration on the 1D and/or 2D domain. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.threedimodels_initial_concentrations_read(id, threedimodel_pk, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this initial concentration. (required) + :param str threedimodel_pk: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: InitialConcentration If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True - return self.status_current_version_with_http_info(**kwargs) # noqa: E501 + return self.threedimodels_initial_concentrations_read_with_http_info(id, threedimodel_pk, **kwargs) # noqa: E501 - def status_current_version_with_http_info(self, **kwargs): # noqa: E501 - """status_current_version # noqa: E501 + def threedimodels_initial_concentrations_read_with_http_info(self, id, threedimodel_pk, **kwargs): # noqa: E501 + """threedimodels_initial_concentrations_read # noqa: E501 + ## Description Initial substance concentrations on threedimodels can be used in a simulation to specify the initial substance concentration on the 1D and/or 2D domain. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.status_current_version_with_http_info(async_req=True) + >>> thread = api.threedimodels_initial_concentrations_read_with_http_info(id, threedimodel_pk, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this initial concentration. (required) + :param str threedimodel_pk: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -1792,7 +5060,7 @@ def status_current_version_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(CurrentVersion, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InitialConcentration, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -1800,6 +5068,8 @@ def status_current_version_with_http_info(self, **kwargs): # noqa: E501 local_var_params = locals() all_params = [ + 'id', + 'threedimodel_pk' ] all_params.extend( [ @@ -1814,14 +5084,26 @@ def status_current_version_with_http_info(self, **kwargs): # noqa: E501 if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method status_current_version" % key + " to method threedimodels_initial_concentrations_read" % key ) local_var_params[key] = val del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `threedimodels_initial_concentrations_read`") # noqa: E501 + # verify the required parameter 'threedimodel_pk' is set + if self.api_client.client_side_validation and ('threedimodel_pk' not in local_var_params or # noqa: E501 + local_var_params['threedimodel_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `threedimodel_pk` when calling `threedimodels_initial_concentrations_read`") # noqa: E501 collection_formats = {} path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'threedimodel_pk' in local_var_params: + path_params['threedimodel_pk'] = local_var_params['threedimodel_pk'] # noqa: E501 query_params = [] @@ -1839,14 +5121,14 @@ def status_current_version_with_http_info(self, **kwargs): # noqa: E501 auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 return self.api_client.call_api( - '/v3-beta/status/current-version/', 'GET', + '/v3-beta/threedimodels/{threedimodel_pk}/initial_concentrations/{id}/', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='CurrentVersion', # noqa: E501 + response_type='InitialConcentration', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -1854,15 +5136,19 @@ def status_current_version_with_http_info(self, **kwargs): # noqa: E501 _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) - def status_list(self, **kwargs): # noqa: E501 - """status_list # noqa: E501 + def threedimodels_initial_concentrations_update(self, id, threedimodel_pk, data, **kwargs): # noqa: E501 + """threedimodels_initial_concentrations_update # noqa: E501 + ## Description Initial substance concentrations on threedimodels can be used in a simulation to specify the initial substance concentration on the 1D and/or 2D domain. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.status_list(async_req=True) + >>> thread = api.threedimodels_initial_concentrations_update(id, threedimodel_pk, data, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this initial concentration. (required) + :param str threedimodel_pk: (required) + :param InitialConcentration data: (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -1870,22 +5156,26 @@ def status_list(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: Status + :return: InitialConcentration If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True - return self.status_list_with_http_info(**kwargs) # noqa: E501 + return self.threedimodels_initial_concentrations_update_with_http_info(id, threedimodel_pk, data, **kwargs) # noqa: E501 - def status_list_with_http_info(self, **kwargs): # noqa: E501 - """status_list # noqa: E501 + def threedimodels_initial_concentrations_update_with_http_info(self, id, threedimodel_pk, data, **kwargs): # noqa: E501 + """threedimodels_initial_concentrations_update # noqa: E501 + ## Description Initial substance concentrations on threedimodels can be used in a simulation to specify the initial substance concentration on the 1D and/or 2D domain. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.status_list_with_http_info(async_req=True) + >>> thread = api.threedimodels_initial_concentrations_update_with_http_info(id, threedimodel_pk, data, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this initial concentration. (required) + :param str threedimodel_pk: (required) + :param InitialConcentration data: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -1895,7 +5185,7 @@ def status_list_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(Status, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InitialConcentration, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -1903,6 +5193,9 @@ def status_list_with_http_info(self, **kwargs): # noqa: E501 local_var_params = locals() all_params = [ + 'id', + 'threedimodel_pk', + 'data' ] all_params.extend( [ @@ -1917,14 +5210,30 @@ def status_list_with_http_info(self, **kwargs): # noqa: E501 if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method status_list" % key + " to method threedimodels_initial_concentrations_update" % key ) local_var_params[key] = val del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `threedimodels_initial_concentrations_update`") # noqa: E501 + # verify the required parameter 'threedimodel_pk' is set + if self.api_client.client_side_validation and ('threedimodel_pk' not in local_var_params or # noqa: E501 + local_var_params['threedimodel_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `threedimodel_pk` when calling `threedimodels_initial_concentrations_update`") # noqa: E501 + # verify the required parameter 'data' is set + if self.api_client.client_side_validation and ('data' not in local_var_params or # noqa: E501 + local_var_params['data'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `data` when calling `threedimodels_initial_concentrations_update`") # noqa: E501 collection_formats = {} path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'threedimodel_pk' in local_var_params: + path_params['threedimodel_pk'] = local_var_params['threedimodel_pk'] # noqa: E501 query_params = [] @@ -1934,22 +5243,164 @@ def status_list_with_http_info(self, **kwargs): # noqa: E501 local_var_files = {} body_params = None + if 'data' in local_var_params: + body_params = local_var_params['data'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + # Authentication setting auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 return self.api_client.call_api( - '/v3-beta/status/', 'GET', + '/v3-beta/threedimodels/{threedimodel_pk}/initial_concentrations/{id}/', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='Status', # noqa: E501 + response_type='InitialConcentration', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def threedimodels_initial_concentrations_upload(self, id, threedimodel_pk, data, **kwargs): # noqa: E501 + """threedimodels_initial_concentrations_upload # noqa: E501 + + Endpoint for uploading an initial substance concentration file, see the POST endpoint for documentation about the file format. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.threedimodels_initial_concentrations_upload(id, threedimodel_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this initial concentration. (required) + :param str threedimodel_pk: (required) + :param Upload data: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Upload + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.threedimodels_initial_concentrations_upload_with_http_info(id, threedimodel_pk, data, **kwargs) # noqa: E501 + + def threedimodels_initial_concentrations_upload_with_http_info(self, id, threedimodel_pk, data, **kwargs): # noqa: E501 + """threedimodels_initial_concentrations_upload # noqa: E501 + + Endpoint for uploading an initial substance concentration file, see the POST endpoint for documentation about the file format. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.threedimodels_initial_concentrations_upload_with_http_info(id, threedimodel_pk, data, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int id: A unique integer value identifying this initial concentration. (required) + :param str threedimodel_pk: (required) + :param Upload data: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(Upload, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'id', + 'threedimodel_pk', + 'data' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method threedimodels_initial_concentrations_upload" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'id' is set + if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501 + local_var_params['id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `id` when calling `threedimodels_initial_concentrations_upload`") # noqa: E501 + # verify the required parameter 'threedimodel_pk' is set + if self.api_client.client_side_validation and ('threedimodel_pk' not in local_var_params or # noqa: E501 + local_var_params['threedimodel_pk'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `threedimodel_pk` when calling `threedimodels_initial_concentrations_upload`") # noqa: E501 + # verify the required parameter 'data' is set + if self.api_client.client_side_validation and ('data' not in local_var_params or # noqa: E501 + local_var_params['data'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `data` when calling `threedimodels_initial_concentrations_upload`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in local_var_params: + path_params['id'] = local_var_params['id'] # noqa: E501 + if 'threedimodel_pk' in local_var_params: + path_params['threedimodel_pk'] = local_var_params['threedimodel_pk'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'data' in local_var_params: + body_params = local_var_params['data'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Basic', 'Bearer', 'OAuth2'] # noqa: E501 + + return self.api_client.call_api( + '/v3-beta/threedimodels/{threedimodel_pk}/initial_concentrations/{id}/upload/', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='Upload', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 diff --git a/threedi_api_client/openapi/api_client.py b/threedi_api_client/openapi/api_client.py index c94ead18..585dccb3 100644 --- a/threedi_api_client/openapi/api_client.py +++ b/threedi_api_client/openapi/api_client.py @@ -2,7 +2,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/configuration.py b/threedi_api_client/openapi/configuration.py index d39648ad..8a5190e4 100644 --- a/threedi_api_client/openapi/configuration.py +++ b/threedi_api_client/openapi/configuration.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/exceptions.py b/threedi_api_client/openapi/exceptions.py index 3eb6301c..3f235ab5 100644 --- a/threedi_api_client/openapi/exceptions.py +++ b/threedi_api_client/openapi/exceptions.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/__init__.py b/threedi_api_client/openapi/models/__init__.py index c89609a2..c57416c9 100644 --- a/threedi_api_client/openapi/models/__init__.py +++ b/threedi_api_client/openapi/models/__init__.py @@ -4,7 +4,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -57,10 +57,12 @@ from threedi_api_client.openapi.models.file_timeseries_leakage import FileTimeseriesLeakage from threedi_api_client.openapi.models.file_timeseries_rain import FileTimeseriesRain from threedi_api_client.openapi.models.file_timeseries_sources_sinks import FileTimeseriesSourcesSinks +from threedi_api_client.openapi.models.forcing_substance import ForcingSubstance from threedi_api_client.openapi.models.from_template import FromTemplate from threedi_api_client.openapi.models.grid_event_state import GridEventState from threedi_api_client.openapi.models.ground_water_level import GroundWaterLevel from threedi_api_client.openapi.models.ground_water_raster import GroundWaterRaster +from threedi_api_client.openapi.models.initial_concentration import InitialConcentration from threedi_api_client.openapi.models.initial_saved_state import InitialSavedState from threedi_api_client.openapi.models.initial_saved_state_overview import InitialSavedStateOverview from threedi_api_client.openapi.models.initial_waterlevel import InitialWaterlevel @@ -135,6 +137,10 @@ from threedi_api_client.openapi.models.inline_response20070 import InlineResponse20070 from threedi_api_client.openapi.models.inline_response20071 import InlineResponse20071 from threedi_api_client.openapi.models.inline_response20072 import InlineResponse20072 +from threedi_api_client.openapi.models.inline_response20073 import InlineResponse20073 +from threedi_api_client.openapi.models.inline_response20074 import InlineResponse20074 +from threedi_api_client.openapi.models.inline_response20075 import InlineResponse20075 +from threedi_api_client.openapi.models.inline_response20076 import InlineResponse20076 from threedi_api_client.openapi.models.inline_response2008 import InlineResponse2008 from threedi_api_client.openapi.models.inline_response2009 import InlineResponse2009 from threedi_api_client.openapi.models.inpy_version import InpyVersion @@ -157,6 +163,7 @@ from threedi_api_client.openapi.models.net_cdf_timeseries_sources_sinks import NetCDFTimeseriesSourcesSinks from threedi_api_client.openapi.models.numerical_settings import NumericalSettings from threedi_api_client.openapi.models.obstacle_edit import ObstacleEdit +from threedi_api_client.openapi.models.one_d_substance_concentration import OneDSubstanceConcentration from threedi_api_client.openapi.models.one_d_water_level import OneDWaterLevel from threedi_api_client.openapi.models.one_d_water_level_file import OneDWaterLevelFile from threedi_api_client.openapi.models.one_d_water_level_predefined import OneDWaterLevelPredefined @@ -206,6 +213,7 @@ from threedi_api_client.openapi.models.sqlite_file_upload import SqliteFileUpload from threedi_api_client.openapi.models.stable_threshold_saved_state import StableThresholdSavedState from threedi_api_client.openapi.models.status import Status +from threedi_api_client.openapi.models.substance import Substance from threedi_api_client.openapi.models.tms import TMS from threedi_api_client.openapi.models.table_structure_control import TableStructureControl from threedi_api_client.openapi.models.template import Template @@ -227,12 +235,14 @@ from threedi_api_client.openapi.models.timeseries_sources_sinks_overview import TimeseriesSourcesSinksOverview from threedi_api_client.openapi.models.timeseries_wind import TimeseriesWind from threedi_api_client.openapi.models.tokens import Tokens +from threedi_api_client.openapi.models.two_d_substance_concentration import TwoDSubstanceConcentration from threedi_api_client.openapi.models.two_d_water_level import TwoDWaterLevel from threedi_api_client.openapi.models.two_d_water_raster import TwoDWaterRaster from threedi_api_client.openapi.models.update_revision import UpdateRevision from threedi_api_client.openapi.models.update_template import UpdateTemplate from threedi_api_client.openapi.models.upload import Upload from threedi_api_client.openapi.models.upload_event_file import UploadEventFile +from threedi_api_client.openapi.models.upload_with_substances import UploadWithSubstances from threedi_api_client.openapi.models.usage import Usage from threedi_api_client.openapi.models.usage_statistics import UsageStatistics from threedi_api_client.openapi.models.user import User diff --git a/threedi_api_client/openapi/models/action.py b/threedi_api_client/openapi/models/action.py index d68e4727..3fa1676b 100644 --- a/threedi_api_client/openapi/models/action.py +++ b/threedi_api_client/openapi/models/action.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -232,7 +232,7 @@ def simulation_runner(self, simulation_runner): :param simulation_runner: The simulation_runner of this Action. # noqa: E501 :type: str """ - allowed_values = ["3.2.65-3.2.1"] # noqa: E501 + allowed_values = ["3.3.4-3.3.1"] # noqa: E501 if self.local_vars_configuration.client_side_validation and simulation_runner not in allowed_values: # noqa: E501 self.__handle_validation_error( "Invalid value for `simulation_runner` ({0}), must be one of {1}" # noqa: E501 diff --git a/threedi_api_client/openapi/models/aggregation_settings.py b/threedi_api_client/openapi/models/aggregation_settings.py index e183825f..a4d3053a 100644 --- a/threedi_api_client/openapi/models/aggregation_settings.py +++ b/threedi_api_client/openapi/models/aggregation_settings.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/arrival_time_post_processing.py b/threedi_api_client/openapi/models/arrival_time_post_processing.py index e5b69788..9fe1c191 100644 --- a/threedi_api_client/openapi/models/arrival_time_post_processing.py +++ b/threedi_api_client/openapi/models/arrival_time_post_processing.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/authenticate.py b/threedi_api_client/openapi/models/authenticate.py index 29d5f386..f1ac7aeb 100644 --- a/threedi_api_client/openapi/models/authenticate.py +++ b/threedi_api_client/openapi/models/authenticate.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/base_event_state.py b/threedi_api_client/openapi/models/base_event_state.py index 6b214371..4a380fdd 100644 --- a/threedi_api_client/openapi/models/base_event_state.py +++ b/threedi_api_client/openapi/models/base_event_state.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/basic_post_processing.py b/threedi_api_client/openapi/models/basic_post_processing.py index f4d34fbf..4da0b02a 100644 --- a/threedi_api_client/openapi/models/basic_post_processing.py +++ b/threedi_api_client/openapi/models/basic_post_processing.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/boundary_condition.py b/threedi_api_client/openapi/models/boundary_condition.py index 32530e72..02016a81 100644 --- a/threedi_api_client/openapi/models/boundary_condition.py +++ b/threedi_api_client/openapi/models/boundary_condition.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/breach.py b/threedi_api_client/openapi/models/breach.py index 2517eb49..6f5910e1 100644 --- a/threedi_api_client/openapi/models/breach.py +++ b/threedi_api_client/openapi/models/breach.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/breach_graph.py b/threedi_api_client/openapi/models/breach_graph.py index 78600c0c..605873bf 100644 --- a/threedi_api_client/openapi/models/breach_graph.py +++ b/threedi_api_client/openapi/models/breach_graph.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/breach_graph_request.py b/threedi_api_client/openapi/models/breach_graph_request.py index c207cfad..e3959434 100644 --- a/threedi_api_client/openapi/models/breach_graph_request.py +++ b/threedi_api_client/openapi/models/breach_graph_request.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/commit.py b/threedi_api_client/openapi/models/commit.py index 0425f7c2..14985394 100644 --- a/threedi_api_client/openapi/models/commit.py +++ b/threedi_api_client/openapi/models/commit.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/constant_lateral.py b/threedi_api_client/openapi/models/constant_lateral.py index 31ebdca5..1dfac169 100644 --- a/threedi_api_client/openapi/models/constant_lateral.py +++ b/threedi_api_client/openapi/models/constant_lateral.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -48,7 +48,8 @@ class ConstantLateral(object): 'state_detail': 'object', 'grid_id': 'int', 'uid': 'str', - 'id': 'int' + 'id': 'int', + 'substances': 'list[ForcingSubstance]' } attribute_map = { @@ -64,10 +65,11 @@ class ConstantLateral(object): 'state_detail': 'state_detail', 'grid_id': 'grid_id', 'uid': 'uid', - 'id': 'id' + 'id': 'id', + 'substances': 'substances' } - def __init__(self, url=None, simulation=None, offset=None, duration=None, value=None, units=None, point=None, connection_node=None, state=None, state_detail=None, grid_id=None, uid=None, id=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, url=None, simulation=None, offset=None, duration=None, value=None, units=None, point=None, connection_node=None, state=None, state_detail=None, grid_id=None, uid=None, id=None, substances=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """ConstantLateral - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -89,6 +91,7 @@ def __init__(self, url=None, simulation=None, offset=None, duration=None, value= self._grid_id = None self._uid = None self._id = None + self._substances = None self.discriminator = None if url is not None: @@ -104,14 +107,14 @@ def __init__(self, url=None, simulation=None, offset=None, duration=None, value= self.connection_node = connection_node if state is not None: self.state = state - if state_detail is not None: - self.state_detail = state_detail - if grid_id is not None: - self.grid_id = grid_id + self.state_detail = state_detail + self.grid_id = grid_id if uid is not None: self.uid = uid if id is not None: self.id = id + if substances is not None: + self.substances = substances @property def url(self): @@ -428,6 +431,27 @@ def id(self, id): self._id = id + @property + def substances(self): + """Gets the substances of this ConstantLateral. # noqa: E501 + + + :return: The substances of this ConstantLateral. # noqa: E501 + :rtype: list[ForcingSubstance] + """ + return self._substances + + @substances.setter + def substances(self, substances): + """Sets the substances of this ConstantLateral. + + + :param substances: The substances of this ConstantLateral. # noqa: E501 + :type: list[ForcingSubstance] + """ + + self._substances = substances + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/threedi_api_client/openapi/models/constant_leakage.py b/threedi_api_client/openapi/models/constant_leakage.py index b8f762f9..4cc30da6 100644 --- a/threedi_api_client/openapi/models/constant_leakage.py +++ b/threedi_api_client/openapi/models/constant_leakage.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/constant_local_rain.py b/threedi_api_client/openapi/models/constant_local_rain.py index 2fbaef57..0cf894d8 100644 --- a/threedi_api_client/openapi/models/constant_local_rain.py +++ b/threedi_api_client/openapi/models/constant_local_rain.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -46,7 +46,8 @@ class ConstantLocalRain(object): 'diameter': 'int', 'point': 'Point', 'uid': 'str', - 'id': 'int' + 'id': 'int', + 'substances': 'list[ForcingSubstance]' } attribute_map = { @@ -60,10 +61,11 @@ class ConstantLocalRain(object): 'diameter': 'diameter', 'point': 'point', 'uid': 'uid', - 'id': 'id' + 'id': 'id', + 'substances': 'substances' } - def __init__(self, url=None, simulation=None, offset=None, value=None, units=None, duration=None, interpolate=None, diameter=None, point=None, uid=None, id=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, url=None, simulation=None, offset=None, value=None, units=None, duration=None, interpolate=None, diameter=None, point=None, uid=None, id=None, substances=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """ConstantLocalRain - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -83,6 +85,7 @@ def __init__(self, url=None, simulation=None, offset=None, value=None, units=Non self._point = None self._uid = None self._id = None + self._substances = None self.discriminator = None if url is not None: @@ -102,6 +105,8 @@ def __init__(self, url=None, simulation=None, offset=None, value=None, units=Non self.uid = uid if id is not None: self.id = id + if substances is not None: + self.substances = substances @property def url(self): @@ -372,6 +377,27 @@ def id(self, id): self._id = id + @property + def substances(self): + """Gets the substances of this ConstantLocalRain. # noqa: E501 + + + :return: The substances of this ConstantLocalRain. # noqa: E501 + :rtype: list[ForcingSubstance] + """ + return self._substances + + @substances.setter + def substances(self, substances): + """Sets the substances of this ConstantLocalRain. + + + :param substances: The substances of this ConstantLocalRain. # noqa: E501 + :type: list[ForcingSubstance] + """ + + self._substances = substances + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/threedi_api_client/openapi/models/constant_rain.py b/threedi_api_client/openapi/models/constant_rain.py index 87670877..23eb23c6 100644 --- a/threedi_api_client/openapi/models/constant_rain.py +++ b/threedi_api_client/openapi/models/constant_rain.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -43,7 +43,8 @@ class ConstantRain(object): 'value': 'float', 'units': 'str', 'uid': 'str', - 'id': 'int' + 'id': 'int', + 'substances': 'list[ForcingSubstance]' } attribute_map = { @@ -54,10 +55,11 @@ class ConstantRain(object): 'value': 'value', 'units': 'units', 'uid': 'uid', - 'id': 'id' + 'id': 'id', + 'substances': 'substances' } - def __init__(self, url=None, simulation=None, offset=None, duration=None, value=None, units=None, uid=None, id=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, url=None, simulation=None, offset=None, duration=None, value=None, units=None, uid=None, id=None, substances=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """ConstantRain - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -74,6 +76,7 @@ def __init__(self, url=None, simulation=None, offset=None, duration=None, value= self._units = None self._uid = None self._id = None + self._substances = None self.discriminator = None if url is not None: @@ -88,6 +91,8 @@ def __init__(self, url=None, simulation=None, offset=None, duration=None, value= self.uid = uid if id is not None: self.id = id + if substances is not None: + self.substances = substances @property def url(self): @@ -289,6 +294,27 @@ def id(self, id): self._id = id + @property + def substances(self): + """Gets the substances of this ConstantRain. # noqa: E501 + + + :return: The substances of this ConstantRain. # noqa: E501 + :rtype: list[ForcingSubstance] + """ + return self._substances + + @substances.setter + def substances(self, substances): + """Sets the substances of this ConstantRain. + + + :param substances: The substances of this ConstantRain. # noqa: E501 + :type: list[ForcingSubstance] + """ + + self._substances = substances + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/threedi_api_client/openapi/models/constant_sources_sinks.py b/threedi_api_client/openapi/models/constant_sources_sinks.py index e1cef40f..48340c0b 100644 --- a/threedi_api_client/openapi/models/constant_sources_sinks.py +++ b/threedi_api_client/openapi/models/constant_sources_sinks.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/constant_wind.py b/threedi_api_client/openapi/models/constant_wind.py index ae2cd4f5..79163a98 100644 --- a/threedi_api_client/openapi/models/constant_wind.py +++ b/threedi_api_client/openapi/models/constant_wind.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/contract.py b/threedi_api_client/openapi/models/contract.py index 93568eb6..70b7878d 100644 --- a/threedi_api_client/openapi/models/contract.py +++ b/threedi_api_client/openapi/models/contract.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/copy_to_threedi_model.py b/threedi_api_client/openapi/models/copy_to_threedi_model.py index b4daca60..3f039da1 100644 --- a/threedi_api_client/openapi/models/copy_to_threedi_model.py +++ b/threedi_api_client/openapi/models/copy_to_threedi_model.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/create_revision.py b/threedi_api_client/openapi/models/create_revision.py index 13be1f43..71486392 100644 --- a/threedi_api_client/openapi/models/create_revision.py +++ b/threedi_api_client/openapi/models/create_revision.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/create_template.py b/threedi_api_client/openapi/models/create_template.py index d866cfab..73bdeb83 100644 --- a/threedi_api_client/openapi/models/create_template.py +++ b/threedi_api_client/openapi/models/create_template.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/create_threedimodel.py b/threedi_api_client/openapi/models/create_threedimodel.py index e4bee1e1..eb0bef41 100644 --- a/threedi_api_client/openapi/models/create_threedimodel.py +++ b/threedi_api_client/openapi/models/create_threedimodel.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/current_status.py b/threedi_api_client/openapi/models/current_status.py index 65cfa51f..e33deaa3 100644 --- a/threedi_api_client/openapi/models/current_status.py +++ b/threedi_api_client/openapi/models/current_status.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/current_version.py b/threedi_api_client/openapi/models/current_version.py index 10f78fa2..8ee9a66a 100644 --- a/threedi_api_client/openapi/models/current_version.py +++ b/threedi_api_client/openapi/models/current_version.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/damage_estimation.py b/threedi_api_client/openapi/models/damage_estimation.py index 48cbcf37..8dad3a0b 100644 --- a/threedi_api_client/openapi/models/damage_estimation.py +++ b/threedi_api_client/openapi/models/damage_estimation.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/damage_post_processing.py b/threedi_api_client/openapi/models/damage_post_processing.py index 941b5fe3..9794ee56 100644 --- a/threedi_api_client/openapi/models/damage_post_processing.py +++ b/threedi_api_client/openapi/models/damage_post_processing.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/destroy_revision.py b/threedi_api_client/openapi/models/destroy_revision.py index 008fa129..3c3de88b 100644 --- a/threedi_api_client/openapi/models/destroy_revision.py +++ b/threedi_api_client/openapi/models/destroy_revision.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/download.py b/threedi_api_client/openapi/models/download.py index 2c2ee21a..a9e88e31 100644 --- a/threedi_api_client/openapi/models/download.py +++ b/threedi_api_client/openapi/models/download.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -68,10 +68,8 @@ def __init__(self, get_url=None, is_internal=True, etag=None, size=None, local_v self.get_url = get_url if is_internal is not None: self.is_internal = is_internal - if etag is not None: - self.etag = etag - if size is not None: - self.size = size + self.etag = etag + self.size = size @property def get_url(self): diff --git a/threedi_api_client/openapi/models/event.py b/threedi_api_client/openapi/models/event.py index d4eab118..fcddb66c 100644 --- a/threedi_api_client/openapi/models/event.py +++ b/threedi_api_client/openapi/models/event.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -36,6 +36,7 @@ class Event(object): and the value is json key in definition. """ openapi_types = { + 'substances': 'list[Substance]', 'lizardrasterrain': 'list[LizardRasterRain]', 'lizardtimeseriesrain': 'list[LizardTimeseriesRain]', 'timeseriesrain': 'list[TimeseriesRainOverview]', @@ -55,6 +56,8 @@ class Event(object): 'initial_onedwaterlevel': 'OneDWaterLevel', 'initial_onedwaterlevelfile': 'OneDWaterLevelFile', 'initial_twodwaterraster': 'TwoDWaterRaster', + 'initial_oned_substance_concentrations': 'list[OneDSubstanceConcentration]', + 'initial_twod_substance_concentrations': 'list[TwoDSubstanceConcentration]', 'filerasterrain': 'list[FileRasterRain]', 'filetimeseriesrain': 'list[FileTimeseriesRain]', 'initial_savedstate': 'InitialSavedStateOverview', @@ -74,6 +77,7 @@ class Event(object): } attribute_map = { + 'substances': 'substances', 'lizardrasterrain': 'lizardrasterrain', 'lizardtimeseriesrain': 'lizardtimeseriesrain', 'timeseriesrain': 'timeseriesrain', @@ -93,6 +97,8 @@ class Event(object): 'initial_onedwaterlevel': 'initial_onedwaterlevel', 'initial_onedwaterlevelfile': 'initial_onedwaterlevelfile', 'initial_twodwaterraster': 'initial_twodwaterraster', + 'initial_oned_substance_concentrations': 'initial_oned_substance_concentrations', + 'initial_twod_substance_concentrations': 'initial_twod_substance_concentrations', 'filerasterrain': 'filerasterrain', 'filetimeseriesrain': 'filetimeseriesrain', 'initial_savedstate': 'initial_savedstate', @@ -111,7 +117,7 @@ class Event(object): 'initial_winddragcoefficient': 'initial_winddragcoefficient' } - def __init__(self, lizardrasterrain=None, lizardtimeseriesrain=None, timeseriesrain=None, breach=None, lizardrastersourcessinks=None, lizardtimeseriessourcessinks=None, filerastersourcessinks=None, filetimeseriessourcessinks=None, timeseriessourcessinks=None, leakage=None, filetimeseriesleakage=None, filerasterleakage=None, initial_twodwaterlevel=None, initial_onedwaterlevelpredefined=None, initial_groundwaterlevel=None, initial_groundwaterraster=None, initial_onedwaterlevel=None, initial_onedwaterlevelfile=None, initial_twodwaterraster=None, filerasterrain=None, filetimeseriesrain=None, initial_savedstate=None, savedstates=None, laterals=None, filelaterals=None, fileboundaryconditions=None, tablestructurecontrols=None, memorystructurecontrols=None, timedstructurecontrols=None, filestructurecontrols=None, rasteredits=None, obstacleedits=None, localrain=None, wind=None, initial_winddragcoefficient=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, substances=None, lizardrasterrain=None, lizardtimeseriesrain=None, timeseriesrain=None, breach=None, lizardrastersourcessinks=None, lizardtimeseriessourcessinks=None, filerastersourcessinks=None, filetimeseriessourcessinks=None, timeseriessourcessinks=None, leakage=None, filetimeseriesleakage=None, filerasterleakage=None, initial_twodwaterlevel=None, initial_onedwaterlevelpredefined=None, initial_groundwaterlevel=None, initial_groundwaterraster=None, initial_onedwaterlevel=None, initial_onedwaterlevelfile=None, initial_twodwaterraster=None, initial_oned_substance_concentrations=None, initial_twod_substance_concentrations=None, filerasterrain=None, filetimeseriesrain=None, initial_savedstate=None, savedstates=None, laterals=None, filelaterals=None, fileboundaryconditions=None, tablestructurecontrols=None, memorystructurecontrols=None, timedstructurecontrols=None, filestructurecontrols=None, rasteredits=None, obstacleedits=None, localrain=None, wind=None, initial_winddragcoefficient=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """Event - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -120,6 +126,7 @@ def __init__(self, lizardrasterrain=None, lizardtimeseriesrain=None, timeseriesr # True if data is coming from API self._fetched_from_api = fetched_from_api + self._substances = None self._lizardrasterrain = None self._lizardtimeseriesrain = None self._timeseriesrain = None @@ -139,6 +146,8 @@ def __init__(self, lizardrasterrain=None, lizardtimeseriesrain=None, timeseriesr self._initial_onedwaterlevel = None self._initial_onedwaterlevelfile = None self._initial_twodwaterraster = None + self._initial_oned_substance_concentrations = None + self._initial_twod_substance_concentrations = None self._filerasterrain = None self._filetimeseriesrain = None self._initial_savedstate = None @@ -157,6 +166,8 @@ def __init__(self, lizardrasterrain=None, lizardtimeseriesrain=None, timeseriesr self._initial_winddragcoefficient = None self.discriminator = None + if substances is not None: + self.substances = substances if lizardrasterrain is not None: self.lizardrasterrain = lizardrasterrain if lizardtimeseriesrain is not None: @@ -195,6 +206,10 @@ def __init__(self, lizardrasterrain=None, lizardtimeseriesrain=None, timeseriesr self.initial_onedwaterlevelfile = initial_onedwaterlevelfile if initial_twodwaterraster is not None: self.initial_twodwaterraster = initial_twodwaterraster + if initial_oned_substance_concentrations is not None: + self.initial_oned_substance_concentrations = initial_oned_substance_concentrations + if initial_twod_substance_concentrations is not None: + self.initial_twod_substance_concentrations = initial_twod_substance_concentrations if filerasterrain is not None: self.filerasterrain = filerasterrain if filetimeseriesrain is not None: @@ -228,6 +243,27 @@ def __init__(self, lizardrasterrain=None, lizardtimeseriesrain=None, timeseriesr if initial_winddragcoefficient is not None: self.initial_winddragcoefficient = initial_winddragcoefficient + @property + def substances(self): + """Gets the substances of this Event. # noqa: E501 + + + :return: The substances of this Event. # noqa: E501 + :rtype: list[Substance] + """ + return self._substances + + @substances.setter + def substances(self, substances): + """Sets the substances of this Event. + + + :param substances: The substances of this Event. # noqa: E501 + :type: list[Substance] + """ + + self._substances = substances + @property def lizardrasterrain(self): """Gets the lizardrasterrain of this Event. # noqa: E501 @@ -627,6 +663,48 @@ def initial_twodwaterraster(self, initial_twodwaterraster): self._initial_twodwaterraster = initial_twodwaterraster + @property + def initial_oned_substance_concentrations(self): + """Gets the initial_oned_substance_concentrations of this Event. # noqa: E501 + + + :return: The initial_oned_substance_concentrations of this Event. # noqa: E501 + :rtype: list[OneDSubstanceConcentration] + """ + return self._initial_oned_substance_concentrations + + @initial_oned_substance_concentrations.setter + def initial_oned_substance_concentrations(self, initial_oned_substance_concentrations): + """Sets the initial_oned_substance_concentrations of this Event. + + + :param initial_oned_substance_concentrations: The initial_oned_substance_concentrations of this Event. # noqa: E501 + :type: list[OneDSubstanceConcentration] + """ + + self._initial_oned_substance_concentrations = initial_oned_substance_concentrations + + @property + def initial_twod_substance_concentrations(self): + """Gets the initial_twod_substance_concentrations of this Event. # noqa: E501 + + + :return: The initial_twod_substance_concentrations of this Event. # noqa: E501 + :rtype: list[TwoDSubstanceConcentration] + """ + return self._initial_twod_substance_concentrations + + @initial_twod_substance_concentrations.setter + def initial_twod_substance_concentrations(self, initial_twod_substance_concentrations): + """Sets the initial_twod_substance_concentrations of this Event. + + + :param initial_twod_substance_concentrations: The initial_twod_substance_concentrations of this Event. # noqa: E501 + :type: list[TwoDSubstanceConcentration] + """ + + self._initial_twod_substance_concentrations = initial_twod_substance_concentrations + @property def filerasterrain(self): """Gets the filerasterrain of this Event. # noqa: E501 diff --git a/threedi_api_client/openapi/models/extent.py b/threedi_api_client/openapi/models/extent.py index 8c130990..22d23e35 100644 --- a/threedi_api_client/openapi/models/extent.py +++ b/threedi_api_client/openapi/models/extent.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/file.py b/threedi_api_client/openapi/models/file.py index 6aec0bea..e0215095 100644 --- a/threedi_api_client/openapi/models/file.py +++ b/threedi_api_client/openapi/models/file.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -358,7 +358,7 @@ def type(self, type): """ if self.local_vars_configuration.client_side_validation and type is None: # noqa: E501 self.__handle_validation_error("Invalid value for `type`, must not be `None`") # noqa: E501 - allowed_values = ["timeseries", "rastertimeseries", "savedstate", "results", "rasters", "gridadmin", "geopackage", "geojson", "initialwaterlevel", "bulklateral", "bulkcontrol", "bulk_boundaryconditions", "sqlite", "tables"] # noqa: E501 + allowed_values = ["timeseries", "rastertimeseries", "savedstate", "results", "rasters", "gridadmin", "geopackage", "geojson", "initialwaterlevel", "initial_substance_concentration", "bulklateral", "bulkcontrol", "bulk_boundaryconditions", "sqlite", "tables"] # noqa: E501 if self.local_vars_configuration.client_side_validation and type not in allowed_values: # noqa: E501 self.__handle_validation_error( "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 diff --git a/threedi_api_client/openapi/models/file_boundary_condition.py b/threedi_api_client/openapi/models/file_boundary_condition.py index ea8bd8fa..fd8b5b1f 100644 --- a/threedi_api_client/openapi/models/file_boundary_condition.py +++ b/threedi_api_client/openapi/models/file_boundary_condition.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -85,8 +85,7 @@ def __init__(self, url=None, id=None, uid=None, simulation=None, file=None, stat self.file = file if state is not None: self.state = state - if state_detail is not None: - self.state_detail = state_detail + self.state_detail = state_detail @property def url(self): diff --git a/threedi_api_client/openapi/models/file_lateral.py b/threedi_api_client/openapi/models/file_lateral.py index 8c2a5990..b47af562 100644 --- a/threedi_api_client/openapi/models/file_lateral.py +++ b/threedi_api_client/openapi/models/file_lateral.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -92,10 +92,8 @@ def __init__(self, url=None, id=None, uid=None, simulation=None, offset=None, fi self.file = file if state is not None: self.state = state - if state_detail is not None: - self.state_detail = state_detail - if periodic is not None: - self.periodic = periodic + self.state_detail = state_detail + self.periodic = periodic @property def url(self): @@ -299,7 +297,7 @@ def periodic(self, periodic): :param periodic: The periodic of this FileLateral. # noqa: E501 :type: str """ - allowed_values = ["daily"] # noqa: E501 + allowed_values = [None,"daily"] # noqa: E501 if self.local_vars_configuration.client_side_validation and periodic not in allowed_values: # noqa: E501 self.__handle_validation_error( "Invalid value for `periodic` ({0}), must be one of {1}" # noqa: E501 diff --git a/threedi_api_client/openapi/models/file_meta.py b/threedi_api_client/openapi/models/file_meta.py index 9d7275bb..110a6ff4 100644 --- a/threedi_api_client/openapi/models/file_meta.py +++ b/threedi_api_client/openapi/models/file_meta.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/file_raster_leakage.py b/threedi_api_client/openapi/models/file_raster_leakage.py index ac030f94..87ab0233 100644 --- a/threedi_api_client/openapi/models/file_raster_leakage.py +++ b/threedi_api_client/openapi/models/file_raster_leakage.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/file_raster_rain.py b/threedi_api_client/openapi/models/file_raster_rain.py index a6c24bb3..e7bd9354 100644 --- a/threedi_api_client/openapi/models/file_raster_rain.py +++ b/threedi_api_client/openapi/models/file_raster_rain.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -51,7 +51,8 @@ class FileRasterRain(object): 'file': 'FileReadOnly', 'type': 'str', 'uid': 'str', - 'id': 'int' + 'id': 'int', + 'substances': 'list[ForcingSubstance]' } attribute_map = { @@ -70,10 +71,11 @@ class FileRasterRain(object): 'file': 'file', 'type': 'type', 'uid': 'uid', - 'id': 'id' + 'id': 'id', + 'substances': 'substances' } - def __init__(self, url=None, multiplier=None, simulation=None, offset=None, duration=None, timestamps=None, interval=None, values_reference=None, fill_value=None, units=None, geotransform=None, epsg_code=None, file=None, type=None, uid=None, id=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, url=None, multiplier=None, simulation=None, offset=None, duration=None, timestamps=None, interval=None, values_reference=None, fill_value=None, units=None, geotransform=None, epsg_code=None, file=None, type=None, uid=None, id=None, substances=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """FileRasterRain - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -98,6 +100,7 @@ def __init__(self, url=None, multiplier=None, simulation=None, offset=None, dura self._type = None self._uid = None self._id = None + self._substances = None self.discriminator = None if url is not None: @@ -126,6 +129,8 @@ def __init__(self, url=None, multiplier=None, simulation=None, offset=None, dura self.uid = uid if id is not None: self.id = id + if substances is not None: + self.substances = substances @property def url(self): @@ -516,6 +521,27 @@ def id(self, id): self._id = id + @property + def substances(self): + """Gets the substances of this FileRasterRain. # noqa: E501 + + + :return: The substances of this FileRasterRain. # noqa: E501 + :rtype: list[ForcingSubstance] + """ + return self._substances + + @substances.setter + def substances(self, substances): + """Sets the substances of this FileRasterRain. + + + :param substances: The substances of this FileRasterRain. # noqa: E501 + :type: list[ForcingSubstance] + """ + + self._substances = substances + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/threedi_api_client/openapi/models/file_raster_sources_sinks.py b/threedi_api_client/openapi/models/file_raster_sources_sinks.py index 33a08d63..04b34467 100644 --- a/threedi_api_client/openapi/models/file_raster_sources_sinks.py +++ b/threedi_api_client/openapi/models/file_raster_sources_sinks.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/file_read_only.py b/threedi_api_client/openapi/models/file_read_only.py index ff08ddee..d675ef44 100644 --- a/threedi_api_client/openapi/models/file_read_only.py +++ b/threedi_api_client/openapi/models/file_read_only.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -91,15 +91,13 @@ def __init__(self, url=None, filename=None, state=None, state_description=None, self.state_description = state_description if type is not None: self.type = type - if size is not None: - self.size = size + self.size = size self.etag = etag if expiry_date is not None: self.expiry_date = expiry_date if id is not None: self.id = id - if meta is not None: - self.meta = meta + self.meta = meta @property def url(self): @@ -215,7 +213,7 @@ def type(self, type): :param type: The type of this FileReadOnly. # noqa: E501 :type: str """ - allowed_values = ["timeseries", "rastertimeseries", "savedstate", "results", "rasters", "gridadmin", "geopackage", "geojson", "initialwaterlevel", "bulklateral", "bulkcontrol", "bulk_boundaryconditions", "sqlite", "tables"] # noqa: E501 + allowed_values = ["timeseries", "rastertimeseries", "savedstate", "results", "rasters", "gridadmin", "geopackage", "geojson", "initialwaterlevel", "initial_substance_concentration", "bulklateral", "bulkcontrol", "bulk_boundaryconditions", "sqlite", "tables"] # noqa: E501 if self.local_vars_configuration.client_side_validation and type not in allowed_values: # noqa: E501 self.__handle_validation_error( "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 diff --git a/threedi_api_client/openapi/models/file_structure_control.py b/threedi_api_client/openapi/models/file_structure_control.py index c86a8b7c..b9b400d2 100644 --- a/threedi_api_client/openapi/models/file_structure_control.py +++ b/threedi_api_client/openapi/models/file_structure_control.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -89,8 +89,7 @@ def __init__(self, url=None, id=None, uid=None, simulation=None, offset=None, fi self.file = file if state is not None: self.state = state - if state_detail is not None: - self.state_detail = state_detail + self.state_detail = state_detail @property def url(self): diff --git a/threedi_api_client/openapi/models/file_timeseries_leakage.py b/threedi_api_client/openapi/models/file_timeseries_leakage.py index 6a535da0..f944b990 100644 --- a/threedi_api_client/openapi/models/file_timeseries_leakage.py +++ b/threedi_api_client/openapi/models/file_timeseries_leakage.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/file_timeseries_rain.py b/threedi_api_client/openapi/models/file_timeseries_rain.py index 23665c12..1469087e 100644 --- a/threedi_api_client/openapi/models/file_timeseries_rain.py +++ b/threedi_api_client/openapi/models/file_timeseries_rain.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -49,7 +49,8 @@ class FileTimeseriesRain(object): 'units': 'str', 'file': 'FileReadOnly', 'uid': 'str', - 'id': 'int' + 'id': 'int', + 'substances': 'list[ForcingSubstance]' } attribute_map = { @@ -66,10 +67,11 @@ class FileTimeseriesRain(object): 'units': 'units', 'file': 'file', 'uid': 'uid', - 'id': 'id' + 'id': 'id', + 'substances': 'substances' } - def __init__(self, url=None, multiplier=None, simulation=None, offset=None, duration=None, timestamps=None, interval=None, values_reference=None, fill_value=None, type=None, units=None, file=None, uid=None, id=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, url=None, multiplier=None, simulation=None, offset=None, duration=None, timestamps=None, interval=None, values_reference=None, fill_value=None, type=None, units=None, file=None, uid=None, id=None, substances=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """FileTimeseriesRain - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -92,6 +94,7 @@ def __init__(self, url=None, multiplier=None, simulation=None, offset=None, dura self._file = None self._uid = None self._id = None + self._substances = None self.discriminator = None if url is not None: @@ -116,6 +119,8 @@ def __init__(self, url=None, multiplier=None, simulation=None, offset=None, dura self.uid = uid if id is not None: self.id = id + if substances is not None: + self.substances = substances @property def url(self): @@ -460,6 +465,27 @@ def id(self, id): self._id = id + @property + def substances(self): + """Gets the substances of this FileTimeseriesRain. # noqa: E501 + + + :return: The substances of this FileTimeseriesRain. # noqa: E501 + :rtype: list[ForcingSubstance] + """ + return self._substances + + @substances.setter + def substances(self, substances): + """Sets the substances of this FileTimeseriesRain. + + + :param substances: The substances of this FileTimeseriesRain. # noqa: E501 + :type: list[ForcingSubstance] + """ + + self._substances = substances + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/threedi_api_client/openapi/models/file_timeseries_sources_sinks.py b/threedi_api_client/openapi/models/file_timeseries_sources_sinks.py index fe9416b9..f68c2abb 100644 --- a/threedi_api_client/openapi/models/file_timeseries_sources_sinks.py +++ b/threedi_api_client/openapi/models/file_timeseries_sources_sinks.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/forcing_substance.py b/threedi_api_client/openapi/models/forcing_substance.py index b9c5d1e2..6ab1cb82 100644 --- a/threedi_api_client/openapi/models/forcing_substance.py +++ b/threedi_api_client/openapi/models/forcing_substance.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.3.0 3Di core release: 3.3.0 deployed on: 08:58AM (UTC) on November 17, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -40,7 +40,7 @@ class ForcingSubstance(object): 'substance': 'str', 'substance_id': 'int', 'substance_name': 'str', - 'concentration': 'float' + 'concentrations': 'list[list[float]]' } attribute_map = { @@ -48,10 +48,10 @@ class ForcingSubstance(object): 'substance': 'substance', 'substance_id': 'substance_id', 'substance_name': 'substance_name', - 'concentration': 'concentration' + 'concentrations': 'concentrations' } - def __init__(self, id=None, substance=None, substance_id=None, substance_name=None, concentration=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, id=None, substance=None, substance_id=None, substance_name=None, concentrations=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """ForcingSubstance - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -64,7 +64,7 @@ def __init__(self, id=None, substance=None, substance_id=None, substance_name=No self._substance = None self._substance_id = None self._substance_name = None - self._concentration = None + self._concentrations = None self.discriminator = None if id is not None: @@ -74,7 +74,7 @@ def __init__(self, id=None, substance=None, substance_id=None, substance_name=No self.substance_id = substance_id if substance_name is not None: self.substance_name = substance_name - self.concentration = concentration + self.concentrations = concentrations @property def id(self): @@ -163,27 +163,29 @@ def substance_name(self, substance_name): self._substance_name = substance_name @property - def concentration(self): - """Gets the concentration of this ForcingSubstance. # noqa: E501 + def concentrations(self): + """Gets the concentrations of this ForcingSubstance. # noqa: E501 + Timeseries provided as a nested list. The inner list consists of exactly 2 values: timestamp, value # noqa: E501 - :return: The concentration of this ForcingSubstance. # noqa: E501 - :rtype: float + :return: The concentrations of this ForcingSubstance. # noqa: E501 + :rtype: list[list[float]] """ - return self._concentration + return self._concentrations - @concentration.setter - def concentration(self, concentration): - """Sets the concentration of this ForcingSubstance. + @concentrations.setter + def concentrations(self, concentrations): + """Sets the concentrations of this ForcingSubstance. + Timeseries provided as a nested list. The inner list consists of exactly 2 values: timestamp, value # noqa: E501 - :param concentration: The concentration of this ForcingSubstance. # noqa: E501 - :type: float + :param concentrations: The concentrations of this ForcingSubstance. # noqa: E501 + :type: list[list[float]] """ - if self.local_vars_configuration.client_side_validation and concentration is None: # noqa: E501 - self.__handle_validation_error("Invalid value for `concentration`, must not be `None`") # noqa: E501 + if self.local_vars_configuration.client_side_validation and concentrations is None: # noqa: E501 + self.__handle_validation_error("Invalid value for `concentrations`, must not be `None`") # noqa: E501 - self._concentration = concentration + self._concentrations = concentrations def to_dict(self): """Returns the model properties as a dict""" diff --git a/threedi_api_client/openapi/models/from_template.py b/threedi_api_client/openapi/models/from_template.py index 3cef3f3e..b4c3c831 100644 --- a/threedi_api_client/openapi/models/from_template.py +++ b/threedi_api_client/openapi/models/from_template.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/grid_event_state.py b/threedi_api_client/openapi/models/grid_event_state.py index ceadb516..2674e410 100644 --- a/threedi_api_client/openapi/models/grid_event_state.py +++ b/threedi_api_client/openapi/models/grid_event_state.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/ground_water_level.py b/threedi_api_client/openapi/models/ground_water_level.py index d4203f12..02bff446 100644 --- a/threedi_api_client/openapi/models/ground_water_level.py +++ b/threedi_api_client/openapi/models/ground_water_level.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/ground_water_raster.py b/threedi_api_client/openapi/models/ground_water_raster.py index 278d4531..64e2eb50 100644 --- a/threedi_api_client/openapi/models/ground_water_raster.py +++ b/threedi_api_client/openapi/models/ground_water_raster.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/initial_concentration.py b/threedi_api_client/openapi/models/initial_concentration.py index 29486dda..95edb89f 100644 --- a/threedi_api_client/openapi/models/initial_concentration.py +++ b/threedi_api_client/openapi/models/initial_concentration.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.3.0 3Di core release: 3.3.0 deployed on: 08:58AM (UTC) on November 17, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/initial_saved_state.py b/threedi_api_client/openapi/models/initial_saved_state.py index d725cbd7..3985e8a3 100644 --- a/threedi_api_client/openapi/models/initial_saved_state.py +++ b/threedi_api_client/openapi/models/initial_saved_state.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/initial_saved_state_overview.py b/threedi_api_client/openapi/models/initial_saved_state_overview.py index 6f605c36..ec697ccf 100644 --- a/threedi_api_client/openapi/models/initial_saved_state_overview.py +++ b/threedi_api_client/openapi/models/initial_saved_state_overview.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/initial_waterlevel.py b/threedi_api_client/openapi/models/initial_waterlevel.py index b10cf371..3bc4f741 100644 --- a/threedi_api_client/openapi/models/initial_waterlevel.py +++ b/threedi_api_client/openapi/models/initial_waterlevel.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -94,8 +94,7 @@ def __init__(self, url=None, threedimodel=None, user_generated=None, file=None, self.source_raster = source_raster if state is not None: self.state = state - if state_detail is not None: - self.state_detail = state_detail + self.state_detail = state_detail if id is not None: self.id = id if source_raster_id is not None: diff --git a/threedi_api_client/openapi/models/inline_response200.py b/threedi_api_client/openapi/models/inline_response200.py index cee6d2b2..a5b40e25 100644 --- a/threedi_api_client/openapi/models/inline_response200.py +++ b/threedi_api_client/openapi/models/inline_response200.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/inline_response2001.py b/threedi_api_client/openapi/models/inline_response2001.py index 113e7bc7..0a785399 100644 --- a/threedi_api_client/openapi/models/inline_response2001.py +++ b/threedi_api_client/openapi/models/inline_response2001.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/inline_response20010.py b/threedi_api_client/openapi/models/inline_response20010.py index e943fcd5..a0f75952 100644 --- a/threedi_api_client/openapi/models/inline_response20010.py +++ b/threedi_api_client/openapi/models/inline_response20010.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20010(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[Revision]' + 'results': 'list[Organisation]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20010. # noqa: E501 - :rtype: list[Revision] + :rtype: list[Organisation] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20010. # noqa: E501 - :type: list[Revision] + :type: list[Organisation] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20011.py b/threedi_api_client/openapi/models/inline_response20011.py index dd4787f5..341c35c6 100644 --- a/threedi_api_client/openapi/models/inline_response20011.py +++ b/threedi_api_client/openapi/models/inline_response20011.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20011(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[Role]' + 'results': 'list[OrganisationUser]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20011. # noqa: E501 - :rtype: list[Role] + :rtype: list[OrganisationUser] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20011. # noqa: E501 - :type: list[Role] + :type: list[OrganisationUser] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20012.py b/threedi_api_client/openapi/models/inline_response20012.py index a09e14e4..e067ab16 100644 --- a/threedi_api_client/openapi/models/inline_response20012.py +++ b/threedi_api_client/openapi/models/inline_response20012.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20012(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[Schematisation]' + 'results': 'list[OrganisationRole]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20012. # noqa: E501 - :rtype: list[Schematisation] + :rtype: list[OrganisationRole] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20012. # noqa: E501 - :type: list[Schematisation] + :type: list[OrganisationRole] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20013.py b/threedi_api_client/openapi/models/inline_response20013.py index 294f0c3a..3c3f8301 100644 --- a/threedi_api_client/openapi/models/inline_response20013.py +++ b/threedi_api_client/openapi/models/inline_response20013.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20013(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[SchematisationRevision]' + 'results': 'list[Repository]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20013. # noqa: E501 - :rtype: list[SchematisationRevision] + :rtype: list[Repository] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20013. # noqa: E501 - :type: list[SchematisationRevision] + :type: list[Repository] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20014.py b/threedi_api_client/openapi/models/inline_response20014.py index f1736c36..537dc43a 100644 --- a/threedi_api_client/openapi/models/inline_response20014.py +++ b/threedi_api_client/openapi/models/inline_response20014.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20014(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[RevisionRaster]' + 'results': 'list[Revision]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20014. # noqa: E501 - :rtype: list[RevisionRaster] + :rtype: list[Revision] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20014. # noqa: E501 - :type: list[RevisionRaster] + :type: list[Revision] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20015.py b/threedi_api_client/openapi/models/inline_response20015.py index 9bcbd231..f4afa8fd 100644 --- a/threedi_api_client/openapi/models/inline_response20015.py +++ b/threedi_api_client/openapi/models/inline_response20015.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20015(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[RevisionTask]' + 'results': 'list[Role]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20015. # noqa: E501 - :rtype: list[RevisionTask] + :rtype: list[Role] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20015. # noqa: E501 - :type: list[RevisionTask] + :type: list[Role] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20016.py b/threedi_api_client/openapi/models/inline_response20016.py index fbee004c..c7b7e3ec 100644 --- a/threedi_api_client/openapi/models/inline_response20016.py +++ b/threedi_api_client/openapi/models/inline_response20016.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20016(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[Template]' + 'results': 'list[Schematisation]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20016. # noqa: E501 - :rtype: list[Template] + :rtype: list[Schematisation] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20016. # noqa: E501 - :type: list[Template] + :type: list[Schematisation] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20017.py b/threedi_api_client/openapi/models/inline_response20017.py index ca2db03c..df99d719 100644 --- a/threedi_api_client/openapi/models/inline_response20017.py +++ b/threedi_api_client/openapi/models/inline_response20017.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20017(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[Simulation]' + 'results': 'list[SchematisationRevision]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20017. # noqa: E501 - :rtype: list[Simulation] + :rtype: list[SchematisationRevision] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20017. # noqa: E501 - :type: list[Simulation] + :type: list[SchematisationRevision] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20018.py b/threedi_api_client/openapi/models/inline_response20018.py index acc3c5a1..38ac423d 100644 --- a/threedi_api_client/openapi/models/inline_response20018.py +++ b/threedi_api_client/openapi/models/inline_response20018.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20018(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[PostProcessingQueue]' + 'results': 'list[RevisionRaster]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20018. # noqa: E501 - :rtype: list[PostProcessingQueue] + :rtype: list[RevisionRaster] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20018. # noqa: E501 - :type: list[PostProcessingQueue] + :type: list[RevisionRaster] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20019.py b/threedi_api_client/openapi/models/inline_response20019.py index fa801af5..ce6080ea 100644 --- a/threedi_api_client/openapi/models/inline_response20019.py +++ b/threedi_api_client/openapi/models/inline_response20019.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20019(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[StableThresholdSavedState]' + 'results': 'list[RevisionTask]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20019. # noqa: E501 - :rtype: list[StableThresholdSavedState] + :rtype: list[RevisionTask] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20019. # noqa: E501 - :type: list[StableThresholdSavedState] + :type: list[RevisionTask] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response2002.py b/threedi_api_client/openapi/models/inline_response2002.py index bfcdc05d..22d3357c 100644 --- a/threedi_api_client/openapi/models/inline_response2002.py +++ b/threedi_api_client/openapi/models/inline_response2002.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse2002(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[User]' + 'results': 'list[OneDSubstanceConcentration]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse2002. # noqa: E501 - :rtype: list[User] + :rtype: list[OneDSubstanceConcentration] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse2002. # noqa: E501 - :type: list[User] + :type: list[OneDSubstanceConcentration] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20020.py b/threedi_api_client/openapi/models/inline_response20020.py index 57c073b8..4a73a80a 100644 --- a/threedi_api_client/openapi/models/inline_response20020.py +++ b/threedi_api_client/openapi/models/inline_response20020.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20020(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[TimedSavedStateUpdate]' + 'results': 'list[Template]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20020. # noqa: E501 - :rtype: list[TimedSavedStateUpdate] + :rtype: list[Template] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20020. # noqa: E501 - :type: list[TimedSavedStateUpdate] + :type: list[Template] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20021.py b/threedi_api_client/openapi/models/inline_response20021.py index 3a950a74..8dd849cd 100644 --- a/threedi_api_client/openapi/models/inline_response20021.py +++ b/threedi_api_client/openapi/models/inline_response20021.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20021(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[FileBoundaryCondition]' + 'results': 'list[Simulation]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20021. # noqa: E501 - :rtype: list[FileBoundaryCondition] + :rtype: list[Simulation] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20021. # noqa: E501 - :type: list[FileBoundaryCondition] + :type: list[Simulation] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20022.py b/threedi_api_client/openapi/models/inline_response20022.py index 3e9f26b9..a064eb62 100644 --- a/threedi_api_client/openapi/models/inline_response20022.py +++ b/threedi_api_client/openapi/models/inline_response20022.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20022(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[Breach]' + 'results': 'list[PostProcessingQueue]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20022. # noqa: E501 - :rtype: list[Breach] + :rtype: list[PostProcessingQueue] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20022. # noqa: E501 - :type: list[Breach] + :type: list[PostProcessingQueue] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20023.py b/threedi_api_client/openapi/models/inline_response20023.py index 6449a053..c7746de5 100644 --- a/threedi_api_client/openapi/models/inline_response20023.py +++ b/threedi_api_client/openapi/models/inline_response20023.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20023(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[ConstantLateral]' + 'results': 'list[StableThresholdSavedState]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20023. # noqa: E501 - :rtype: list[ConstantLateral] + :rtype: list[StableThresholdSavedState] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20023. # noqa: E501 - :type: list[ConstantLateral] + :type: list[StableThresholdSavedState] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20024.py b/threedi_api_client/openapi/models/inline_response20024.py index 382fabf7..14c165bf 100644 --- a/threedi_api_client/openapi/models/inline_response20024.py +++ b/threedi_api_client/openapi/models/inline_response20024.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20024(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[FileLateral]' + 'results': 'list[TimedSavedStateUpdate]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20024. # noqa: E501 - :rtype: list[FileLateral] + :rtype: list[TimedSavedStateUpdate] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20024. # noqa: E501 - :type: list[FileLateral] + :type: list[TimedSavedStateUpdate] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20025.py b/threedi_api_client/openapi/models/inline_response20025.py index 77d5b757..e7c6ca16 100644 --- a/threedi_api_client/openapi/models/inline_response20025.py +++ b/threedi_api_client/openapi/models/inline_response20025.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20025(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[TimeseriesLateral]' + 'results': 'list[FileBoundaryCondition]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20025. # noqa: E501 - :rtype: list[TimeseriesLateral] + :rtype: list[FileBoundaryCondition] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20025. # noqa: E501 - :type: list[TimeseriesLateral] + :type: list[FileBoundaryCondition] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20026.py b/threedi_api_client/openapi/models/inline_response20026.py index fcb575ed..ae6bc8cc 100644 --- a/threedi_api_client/openapi/models/inline_response20026.py +++ b/threedi_api_client/openapi/models/inline_response20026.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20026(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[ConstantLeakage]' + 'results': 'list[Breach]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20026. # noqa: E501 - :rtype: list[ConstantLeakage] + :rtype: list[Breach] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20026. # noqa: E501 - :type: list[ConstantLeakage] + :type: list[Breach] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20027.py b/threedi_api_client/openapi/models/inline_response20027.py index 45f2e31a..09251f16 100644 --- a/threedi_api_client/openapi/models/inline_response20027.py +++ b/threedi_api_client/openapi/models/inline_response20027.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20027(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[NetCDFRasterLeakage]' + 'results': 'list[ConstantLateral]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20027. # noqa: E501 - :rtype: list[NetCDFRasterLeakage] + :rtype: list[ConstantLateral] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20027. # noqa: E501 - :type: list[NetCDFRasterLeakage] + :type: list[ConstantLateral] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20028.py b/threedi_api_client/openapi/models/inline_response20028.py index 1425c5c7..de63dd17 100644 --- a/threedi_api_client/openapi/models/inline_response20028.py +++ b/threedi_api_client/openapi/models/inline_response20028.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20028(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[TimeseriesLeakage]' + 'results': 'list[FileLateral]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20028. # noqa: E501 - :rtype: list[TimeseriesLeakage] + :rtype: list[FileLateral] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20028. # noqa: E501 - :type: list[TimeseriesLeakage] + :type: list[FileLateral] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20029.py b/threedi_api_client/openapi/models/inline_response20029.py index 0f62bb85..be2e0502 100644 --- a/threedi_api_client/openapi/models/inline_response20029.py +++ b/threedi_api_client/openapi/models/inline_response20029.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20029(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[NetCDFTimeseriesLeakage]' + 'results': 'list[TimeseriesLateral]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20029. # noqa: E501 - :rtype: list[NetCDFTimeseriesLeakage] + :rtype: list[TimeseriesLateral] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20029. # noqa: E501 - :type: list[NetCDFTimeseriesLeakage] + :type: list[TimeseriesLateral] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response2003.py b/threedi_api_client/openapi/models/inline_response2003.py index 5e5b67cf..d55f8c17 100644 --- a/threedi_api_client/openapi/models/inline_response2003.py +++ b/threedi_api_client/openapi/models/inline_response2003.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse2003(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[Contract]' + 'results': 'list[TwoDSubstanceConcentration]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse2003. # noqa: E501 - :rtype: list[Contract] + :rtype: list[TwoDSubstanceConcentration] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse2003. # noqa: E501 - :type: list[Contract] + :type: list[TwoDSubstanceConcentration] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20030.py b/threedi_api_client/openapi/models/inline_response20030.py index 316be02c..f09364a7 100644 --- a/threedi_api_client/openapi/models/inline_response20030.py +++ b/threedi_api_client/openapi/models/inline_response20030.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20030(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[ConstantRain]' + 'results': 'list[ConstantLeakage]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20030. # noqa: E501 - :rtype: list[ConstantRain] + :rtype: list[ConstantLeakage] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20030. # noqa: E501 - :type: list[ConstantRain] + :type: list[ConstantLeakage] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20031.py b/threedi_api_client/openapi/models/inline_response20031.py index 8287dd9c..662f1655 100644 --- a/threedi_api_client/openapi/models/inline_response20031.py +++ b/threedi_api_client/openapi/models/inline_response20031.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20031(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[ConstantLocalRain]' + 'results': 'list[NetCDFRasterLeakage]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20031. # noqa: E501 - :rtype: list[ConstantLocalRain] + :rtype: list[NetCDFRasterLeakage] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20031. # noqa: E501 - :type: list[ConstantLocalRain] + :type: list[NetCDFRasterLeakage] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20032.py b/threedi_api_client/openapi/models/inline_response20032.py index 009fb94c..2643465c 100644 --- a/threedi_api_client/openapi/models/inline_response20032.py +++ b/threedi_api_client/openapi/models/inline_response20032.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20032(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[TimeseriesLocalRain]' + 'results': 'list[TimeseriesLeakage]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20032. # noqa: E501 - :rtype: list[TimeseriesLocalRain] + :rtype: list[TimeseriesLeakage] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20032. # noqa: E501 - :type: list[TimeseriesLocalRain] + :type: list[TimeseriesLeakage] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20033.py b/threedi_api_client/openapi/models/inline_response20033.py index 57844af1..01af0349 100644 --- a/threedi_api_client/openapi/models/inline_response20033.py +++ b/threedi_api_client/openapi/models/inline_response20033.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20033(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[LizardRasterRain]' + 'results': 'list[NetCDFTimeseriesLeakage]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20033. # noqa: E501 - :rtype: list[LizardRasterRain] + :rtype: list[NetCDFTimeseriesLeakage] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20033. # noqa: E501 - :type: list[LizardRasterRain] + :type: list[NetCDFTimeseriesLeakage] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20034.py b/threedi_api_client/openapi/models/inline_response20034.py index edb3a52b..dc596286 100644 --- a/threedi_api_client/openapi/models/inline_response20034.py +++ b/threedi_api_client/openapi/models/inline_response20034.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20034(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[NetCDFRasterRain]' + 'results': 'list[ConstantRain]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20034. # noqa: E501 - :rtype: list[NetCDFRasterRain] + :rtype: list[ConstantRain] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20034. # noqa: E501 - :type: list[NetCDFRasterRain] + :type: list[ConstantRain] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20035.py b/threedi_api_client/openapi/models/inline_response20035.py index 8ef3850e..f64d3f79 100644 --- a/threedi_api_client/openapi/models/inline_response20035.py +++ b/threedi_api_client/openapi/models/inline_response20035.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20035(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[TimeseriesRain]' + 'results': 'list[ConstantLocalRain]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20035. # noqa: E501 - :rtype: list[TimeseriesRain] + :rtype: list[ConstantLocalRain] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20035. # noqa: E501 - :type: list[TimeseriesRain] + :type: list[ConstantLocalRain] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20036.py b/threedi_api_client/openapi/models/inline_response20036.py index cc792f69..196ef8ac 100644 --- a/threedi_api_client/openapi/models/inline_response20036.py +++ b/threedi_api_client/openapi/models/inline_response20036.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20036(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[LizardTimeseriesRain]' + 'results': 'list[TimeseriesLocalRain]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20036. # noqa: E501 - :rtype: list[LizardTimeseriesRain] + :rtype: list[TimeseriesLocalRain] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20036. # noqa: E501 - :type: list[LizardTimeseriesRain] + :type: list[TimeseriesLocalRain] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20037.py b/threedi_api_client/openapi/models/inline_response20037.py index cd74f6ea..f5972890 100644 --- a/threedi_api_client/openapi/models/inline_response20037.py +++ b/threedi_api_client/openapi/models/inline_response20037.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20037(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[NetCDFTimeseriesRain]' + 'results': 'list[LizardRasterRain]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20037. # noqa: E501 - :rtype: list[NetCDFTimeseriesRain] + :rtype: list[LizardRasterRain] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20037. # noqa: E501 - :type: list[NetCDFTimeseriesRain] + :type: list[LizardRasterRain] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20038.py b/threedi_api_client/openapi/models/inline_response20038.py index 77edfe68..6dba0508 100644 --- a/threedi_api_client/openapi/models/inline_response20038.py +++ b/threedi_api_client/openapi/models/inline_response20038.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20038(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[RasterEdit]' + 'results': 'list[NetCDFRasterRain]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20038. # noqa: E501 - :rtype: list[RasterEdit] + :rtype: list[NetCDFRasterRain] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20038. # noqa: E501 - :type: list[RasterEdit] + :type: list[NetCDFRasterRain] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20039.py b/threedi_api_client/openapi/models/inline_response20039.py index 7673e8a2..7bb1c9eb 100644 --- a/threedi_api_client/openapi/models/inline_response20039.py +++ b/threedi_api_client/openapi/models/inline_response20039.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20039(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[ConstantSourcesSinks]' + 'results': 'list[TimeseriesRain]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20039. # noqa: E501 - :rtype: list[ConstantSourcesSinks] + :rtype: list[TimeseriesRain] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20039. # noqa: E501 - :type: list[ConstantSourcesSinks] + :type: list[TimeseriesRain] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response2004.py b/threedi_api_client/openapi/models/inline_response2004.py index 0faca1e3..7618db8d 100644 --- a/threedi_api_client/openapi/models/inline_response2004.py +++ b/threedi_api_client/openapi/models/inline_response2004.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse2004(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[File]' + 'results': 'list[Substance]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse2004. # noqa: E501 - :rtype: list[File] + :rtype: list[Substance] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse2004. # noqa: E501 - :type: list[File] + :type: list[Substance] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20040.py b/threedi_api_client/openapi/models/inline_response20040.py index 0165b604..f3ac3a9c 100644 --- a/threedi_api_client/openapi/models/inline_response20040.py +++ b/threedi_api_client/openapi/models/inline_response20040.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20040(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[LizardRasterSourcesSinks]' + 'results': 'list[LizardTimeseriesRain]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20040. # noqa: E501 - :rtype: list[LizardRasterSourcesSinks] + :rtype: list[LizardTimeseriesRain] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20040. # noqa: E501 - :type: list[LizardRasterSourcesSinks] + :type: list[LizardTimeseriesRain] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20041.py b/threedi_api_client/openapi/models/inline_response20041.py index 51828d4c..7bd3093f 100644 --- a/threedi_api_client/openapi/models/inline_response20041.py +++ b/threedi_api_client/openapi/models/inline_response20041.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20041(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[NetCDFRasterSourcesSinks]' + 'results': 'list[NetCDFTimeseriesRain]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20041. # noqa: E501 - :rtype: list[NetCDFRasterSourcesSinks] + :rtype: list[NetCDFTimeseriesRain] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20041. # noqa: E501 - :type: list[NetCDFRasterSourcesSinks] + :type: list[NetCDFTimeseriesRain] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20042.py b/threedi_api_client/openapi/models/inline_response20042.py index 32e93d77..0aef11e2 100644 --- a/threedi_api_client/openapi/models/inline_response20042.py +++ b/threedi_api_client/openapi/models/inline_response20042.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20042(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[TimeseriesSourcesSinks]' + 'results': 'list[RasterEdit]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20042. # noqa: E501 - :rtype: list[TimeseriesSourcesSinks] + :rtype: list[RasterEdit] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20042. # noqa: E501 - :type: list[TimeseriesSourcesSinks] + :type: list[RasterEdit] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20043.py b/threedi_api_client/openapi/models/inline_response20043.py index b7a34df6..b57f8de2 100644 --- a/threedi_api_client/openapi/models/inline_response20043.py +++ b/threedi_api_client/openapi/models/inline_response20043.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20043(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[LizardTimeseriesSourcesSinks]' + 'results': 'list[ConstantSourcesSinks]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20043. # noqa: E501 - :rtype: list[LizardTimeseriesSourcesSinks] + :rtype: list[ConstantSourcesSinks] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20043. # noqa: E501 - :type: list[LizardTimeseriesSourcesSinks] + :type: list[ConstantSourcesSinks] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20044.py b/threedi_api_client/openapi/models/inline_response20044.py index 4e0e0ef0..72885b5c 100644 --- a/threedi_api_client/openapi/models/inline_response20044.py +++ b/threedi_api_client/openapi/models/inline_response20044.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20044(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[NetCDFTimeseriesSourcesSinks]' + 'results': 'list[LizardRasterSourcesSinks]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20044. # noqa: E501 - :rtype: list[NetCDFTimeseriesSourcesSinks] + :rtype: list[LizardRasterSourcesSinks] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20044. # noqa: E501 - :type: list[NetCDFTimeseriesSourcesSinks] + :type: list[LizardRasterSourcesSinks] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20045.py b/threedi_api_client/openapi/models/inline_response20045.py index 2ee46646..4d70e85d 100644 --- a/threedi_api_client/openapi/models/inline_response20045.py +++ b/threedi_api_client/openapi/models/inline_response20045.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20045(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[FileStructureControl]' + 'results': 'list[NetCDFRasterSourcesSinks]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20045. # noqa: E501 - :rtype: list[FileStructureControl] + :rtype: list[NetCDFRasterSourcesSinks] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20045. # noqa: E501 - :type: list[FileStructureControl] + :type: list[NetCDFRasterSourcesSinks] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20046.py b/threedi_api_client/openapi/models/inline_response20046.py index 95072b7e..12c2188e 100644 --- a/threedi_api_client/openapi/models/inline_response20046.py +++ b/threedi_api_client/openapi/models/inline_response20046.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20046(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[MemoryStructureControl]' + 'results': 'list[TimeseriesSourcesSinks]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20046. # noqa: E501 - :rtype: list[MemoryStructureControl] + :rtype: list[TimeseriesSourcesSinks] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20046. # noqa: E501 - :type: list[MemoryStructureControl] + :type: list[TimeseriesSourcesSinks] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20047.py b/threedi_api_client/openapi/models/inline_response20047.py index 6332126a..8d92421a 100644 --- a/threedi_api_client/openapi/models/inline_response20047.py +++ b/threedi_api_client/openapi/models/inline_response20047.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20047(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[TableStructureControl]' + 'results': 'list[LizardTimeseriesSourcesSinks]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20047. # noqa: E501 - :rtype: list[TableStructureControl] + :rtype: list[LizardTimeseriesSourcesSinks] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20047. # noqa: E501 - :type: list[TableStructureControl] + :type: list[LizardTimeseriesSourcesSinks] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20048.py b/threedi_api_client/openapi/models/inline_response20048.py index 14c3c93e..6d68de62 100644 --- a/threedi_api_client/openapi/models/inline_response20048.py +++ b/threedi_api_client/openapi/models/inline_response20048.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20048(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[TimedStructureControl]' + 'results': 'list[NetCDFTimeseriesSourcesSinks]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20048. # noqa: E501 - :rtype: list[TimedStructureControl] + :rtype: list[NetCDFTimeseriesSourcesSinks] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20048. # noqa: E501 - :type: list[TimedStructureControl] + :type: list[NetCDFTimeseriesSourcesSinks] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20049.py b/threedi_api_client/openapi/models/inline_response20049.py index 6f989def..967d0ff7 100644 --- a/threedi_api_client/openapi/models/inline_response20049.py +++ b/threedi_api_client/openapi/models/inline_response20049.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20049(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[ConstantWind]' + 'results': 'list[FileStructureControl]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20049. # noqa: E501 - :rtype: list[ConstantWind] + :rtype: list[FileStructureControl] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20049. # noqa: E501 - :type: list[ConstantWind] + :type: list[FileStructureControl] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response2005.py b/threedi_api_client/openapi/models/inline_response2005.py index 54627da9..88771d8a 100644 --- a/threedi_api_client/openapi/models/inline_response2005.py +++ b/threedi_api_client/openapi/models/inline_response2005.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse2005(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[InpyVersion]' + 'results': 'list[InitialConcentration]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse2005. # noqa: E501 - :rtype: list[InpyVersion] + :rtype: list[InitialConcentration] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse2005. # noqa: E501 - :type: list[InpyVersion] + :type: list[InitialConcentration] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20050.py b/threedi_api_client/openapi/models/inline_response20050.py index 739b5302..22bf741b 100644 --- a/threedi_api_client/openapi/models/inline_response20050.py +++ b/threedi_api_client/openapi/models/inline_response20050.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20050(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[TimeseriesWind]' + 'results': 'list[MemoryStructureControl]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20050. # noqa: E501 - :rtype: list[TimeseriesWind] + :rtype: list[MemoryStructureControl] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20050. # noqa: E501 - :type: list[TimeseriesWind] + :type: list[MemoryStructureControl] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20051.py b/threedi_api_client/openapi/models/inline_response20051.py index 93b7d7e5..6050b68f 100644 --- a/threedi_api_client/openapi/models/inline_response20051.py +++ b/threedi_api_client/openapi/models/inline_response20051.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20051(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[OneDWaterLevel]' + 'results': 'list[TableStructureControl]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20051. # noqa: E501 - :rtype: list[OneDWaterLevel] + :rtype: list[TableStructureControl] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20051. # noqa: E501 - :type: list[OneDWaterLevel] + :type: list[TableStructureControl] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20052.py b/threedi_api_client/openapi/models/inline_response20052.py index 3028be02..8c95c3aa 100644 --- a/threedi_api_client/openapi/models/inline_response20052.py +++ b/threedi_api_client/openapi/models/inline_response20052.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20052(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[OneDWaterLevelFile]' + 'results': 'list[TimedStructureControl]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20052. # noqa: E501 - :rtype: list[OneDWaterLevelFile] + :rtype: list[TimedStructureControl] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20052. # noqa: E501 - :type: list[OneDWaterLevelFile] + :type: list[TimedStructureControl] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20053.py b/threedi_api_client/openapi/models/inline_response20053.py index 7b8149d7..7b643148 100644 --- a/threedi_api_client/openapi/models/inline_response20053.py +++ b/threedi_api_client/openapi/models/inline_response20053.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20053(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[OneDWaterLevelPredefined]' + 'results': 'list[ConstantWind]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20053. # noqa: E501 - :rtype: list[OneDWaterLevelPredefined] + :rtype: list[ConstantWind] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20053. # noqa: E501 - :type: list[OneDWaterLevelPredefined] + :type: list[ConstantWind] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20054.py b/threedi_api_client/openapi/models/inline_response20054.py index f04abb34..13878db3 100644 --- a/threedi_api_client/openapi/models/inline_response20054.py +++ b/threedi_api_client/openapi/models/inline_response20054.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20054(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[TwoDWaterLevel]' + 'results': 'list[TimeseriesWind]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20054. # noqa: E501 - :rtype: list[TwoDWaterLevel] + :rtype: list[TimeseriesWind] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20054. # noqa: E501 - :type: list[TwoDWaterLevel] + :type: list[TimeseriesWind] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20055.py b/threedi_api_client/openapi/models/inline_response20055.py index 7ba0f2a2..2de3f0dd 100644 --- a/threedi_api_client/openapi/models/inline_response20055.py +++ b/threedi_api_client/openapi/models/inline_response20055.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20055(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[TwoDWaterRaster]' + 'results': 'list[OneDWaterLevel]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20055. # noqa: E501 - :rtype: list[TwoDWaterRaster] + :rtype: list[OneDWaterLevel] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20055. # noqa: E501 - :type: list[TwoDWaterRaster] + :type: list[OneDWaterLevel] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20056.py b/threedi_api_client/openapi/models/inline_response20056.py index 3a8008f8..4e4ed2c9 100644 --- a/threedi_api_client/openapi/models/inline_response20056.py +++ b/threedi_api_client/openapi/models/inline_response20056.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20056(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[GroundWaterLevel]' + 'results': 'list[OneDWaterLevelFile]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20056. # noqa: E501 - :rtype: list[GroundWaterLevel] + :rtype: list[OneDWaterLevelFile] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20056. # noqa: E501 - :type: list[GroundWaterLevel] + :type: list[OneDWaterLevelFile] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20057.py b/threedi_api_client/openapi/models/inline_response20057.py index 2c9e65fe..4f137c9d 100644 --- a/threedi_api_client/openapi/models/inline_response20057.py +++ b/threedi_api_client/openapi/models/inline_response20057.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20057(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[GroundWaterRaster]' + 'results': 'list[OneDWaterLevelPredefined]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20057. # noqa: E501 - :rtype: list[GroundWaterRaster] + :rtype: list[OneDWaterLevelPredefined] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20057. # noqa: E501 - :type: list[GroundWaterRaster] + :type: list[OneDWaterLevelPredefined] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20058.py b/threedi_api_client/openapi/models/inline_response20058.py index 86b30191..d61fec1d 100644 --- a/threedi_api_client/openapi/models/inline_response20058.py +++ b/threedi_api_client/openapi/models/inline_response20058.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20058(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[InitialSavedState]' + 'results': 'list[TwoDWaterLevel]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20058. # noqa: E501 - :rtype: list[InitialSavedState] + :rtype: list[TwoDWaterLevel] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20058. # noqa: E501 - :type: list[InitialSavedState] + :type: list[TwoDWaterLevel] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20059.py b/threedi_api_client/openapi/models/inline_response20059.py index 5106f3dd..6daa77d3 100644 --- a/threedi_api_client/openapi/models/inline_response20059.py +++ b/threedi_api_client/openapi/models/inline_response20059.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20059(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[WindDragCoefficient]' + 'results': 'list[TwoDWaterRaster]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20059. # noqa: E501 - :rtype: list[WindDragCoefficient] + :rtype: list[TwoDWaterRaster] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20059. # noqa: E501 - :type: list[WindDragCoefficient] + :type: list[TwoDWaterRaster] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response2006.py b/threedi_api_client/openapi/models/inline_response2006.py index 0aa84208..74ba68b3 100644 --- a/threedi_api_client/openapi/models/inline_response2006.py +++ b/threedi_api_client/openapi/models/inline_response2006.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse2006(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[Organisation]' + 'results': 'list[User]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse2006. # noqa: E501 - :rtype: list[Organisation] + :rtype: list[User] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse2006. # noqa: E501 - :type: list[Organisation] + :type: list[User] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20060.py b/threedi_api_client/openapi/models/inline_response20060.py index 9686a9ac..fa1e6ad5 100644 --- a/threedi_api_client/openapi/models/inline_response20060.py +++ b/threedi_api_client/openapi/models/inline_response20060.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20060(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[ResultFile]' + 'results': 'list[GroundWaterLevel]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20060. # noqa: E501 - :rtype: list[ResultFile] + :rtype: list[GroundWaterLevel] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20060. # noqa: E501 - :type: list[ResultFile] + :type: list[GroundWaterLevel] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20061.py b/threedi_api_client/openapi/models/inline_response20061.py index f075bd08..f1691767 100644 --- a/threedi_api_client/openapi/models/inline_response20061.py +++ b/threedi_api_client/openapi/models/inline_response20061.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20061(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[PostProcessingStatus]' + 'results': 'list[GroundWaterRaster]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20061. # noqa: E501 - :rtype: list[PostProcessingStatus] + :rtype: list[GroundWaterRaster] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20061. # noqa: E501 - :type: list[PostProcessingStatus] + :type: list[GroundWaterRaster] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20062.py b/threedi_api_client/openapi/models/inline_response20062.py index c4c7ed68..5a6833ad 100644 --- a/threedi_api_client/openapi/models/inline_response20062.py +++ b/threedi_api_client/openapi/models/inline_response20062.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20062(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[AggregationSettings]' + 'results': 'list[InitialSavedState]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20062. # noqa: E501 - :rtype: list[AggregationSettings] + :rtype: list[InitialSavedState] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20062. # noqa: E501 - :type: list[AggregationSettings] + :type: list[InitialSavedState] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20063.py b/threedi_api_client/openapi/models/inline_response20063.py index cdd88381..5041f2fd 100644 --- a/threedi_api_client/openapi/models/inline_response20063.py +++ b/threedi_api_client/openapi/models/inline_response20063.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20063(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[SimulationStatus]' + 'results': 'list[WindDragCoefficient]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20063. # noqa: E501 - :rtype: list[SimulationStatus] + :rtype: list[WindDragCoefficient] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20063. # noqa: E501 - :type: list[SimulationStatus] + :type: list[WindDragCoefficient] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20064.py b/threedi_api_client/openapi/models/inline_response20064.py index 28cae474..bfc723fc 100644 --- a/threedi_api_client/openapi/models/inline_response20064.py +++ b/threedi_api_client/openapi/models/inline_response20064.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20064(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[SimulationChannel]' + 'results': 'list[ResultFile]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20064. # noqa: E501 - :rtype: list[SimulationChannel] + :rtype: list[ResultFile] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20064. # noqa: E501 - :type: list[SimulationChannel] + :type: list[ResultFile] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20065.py b/threedi_api_client/openapi/models/inline_response20065.py index e5a01bab..f35ed707 100644 --- a/threedi_api_client/openapi/models/inline_response20065.py +++ b/threedi_api_client/openapi/models/inline_response20065.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20065(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[ThreediModel]' + 'results': 'list[PostProcessingStatus]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20065. # noqa: E501 - :rtype: list[ThreediModel] + :rtype: list[PostProcessingStatus] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20065. # noqa: E501 - :type: list[ThreediModel] + :type: list[PostProcessingStatus] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20066.py b/threedi_api_client/openapi/models/inline_response20066.py index 781e94ee..74bbfdde 100644 --- a/threedi_api_client/openapi/models/inline_response20066.py +++ b/threedi_api_client/openapi/models/inline_response20066.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20066(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[BoundaryCondition]' + 'results': 'list[AggregationSettings]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20066. # noqa: E501 - :rtype: list[BoundaryCondition] + :rtype: list[AggregationSettings] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20066. # noqa: E501 - :type: list[BoundaryCondition] + :type: list[AggregationSettings] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20067.py b/threedi_api_client/openapi/models/inline_response20067.py index cadef768..36353e9f 100644 --- a/threedi_api_client/openapi/models/inline_response20067.py +++ b/threedi_api_client/openapi/models/inline_response20067.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20067(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[InitialWaterlevel]' + 'results': 'list[SimulationStatus]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20067. # noqa: E501 - :rtype: list[InitialWaterlevel] + :rtype: list[SimulationStatus] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20067. # noqa: E501 - :type: list[InitialWaterlevel] + :type: list[SimulationStatus] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20068.py b/threedi_api_client/openapi/models/inline_response20068.py index d4482e00..aa48bd15 100644 --- a/threedi_api_client/openapi/models/inline_response20068.py +++ b/threedi_api_client/openapi/models/inline_response20068.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20068(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[PotentialBreach]' + 'results': 'list[SimulationChannel]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20068. # noqa: E501 - :rtype: list[PotentialBreach] + :rtype: list[SimulationChannel] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20068. # noqa: E501 - :type: list[PotentialBreach] + :type: list[SimulationChannel] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20069.py b/threedi_api_client/openapi/models/inline_response20069.py index 6f0f7d7a..f311b9a3 100644 --- a/threedi_api_client/openapi/models/inline_response20069.py +++ b/threedi_api_client/openapi/models/inline_response20069.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20069(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[Raster]' + 'results': 'list[ThreediModel]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20069. # noqa: E501 - :rtype: list[Raster] + :rtype: list[ThreediModel] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20069. # noqa: E501 - :type: list[Raster] + :type: list[ThreediModel] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response2007.py b/threedi_api_client/openapi/models/inline_response2007.py index 914d8f3a..9916c347 100644 --- a/threedi_api_client/openapi/models/inline_response2007.py +++ b/threedi_api_client/openapi/models/inline_response2007.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse2007(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[OrganisationUser]' + 'results': 'list[Contract]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse2007. # noqa: E501 - :rtype: list[OrganisationUser] + :rtype: list[Contract] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse2007. # noqa: E501 - :type: list[OrganisationUser] + :type: list[Contract] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20070.py b/threedi_api_client/openapi/models/inline_response20070.py index 151a1afb..a3f8ae6c 100644 --- a/threedi_api_client/openapi/models/inline_response20070.py +++ b/threedi_api_client/openapi/models/inline_response20070.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20070(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[ThreediModelSavedState]' + 'results': 'list[BoundaryCondition]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20070. # noqa: E501 - :rtype: list[ThreediModelSavedState] + :rtype: list[BoundaryCondition] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20070. # noqa: E501 - :type: list[ThreediModelSavedState] + :type: list[BoundaryCondition] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20071.py b/threedi_api_client/openapi/models/inline_response20071.py index 254c069e..5b7a4a0f 100644 --- a/threedi_api_client/openapi/models/inline_response20071.py +++ b/threedi_api_client/openapi/models/inline_response20071.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20071(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[ThreediModelTask]' + 'results': 'list[InitialWaterlevel]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20071. # noqa: E501 - :rtype: list[ThreediModelTask] + :rtype: list[InitialWaterlevel] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20071. # noqa: E501 - :type: list[ThreediModelTask] + :type: list[InitialWaterlevel] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20072.py b/threedi_api_client/openapi/models/inline_response20072.py index f5953980..92bb69de 100644 --- a/threedi_api_client/openapi/models/inline_response20072.py +++ b/threedi_api_client/openapi/models/inline_response20072.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse20072(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[Usage]' + 'results': 'list[PotentialBreach]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse20072. # noqa: E501 - :rtype: list[Usage] + :rtype: list[PotentialBreach] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse20072. # noqa: E501 - :type: list[Usage] + :type: list[PotentialBreach] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response20073.py b/threedi_api_client/openapi/models/inline_response20073.py index c331be44..c900f876 100644 --- a/threedi_api_client/openapi/models/inline_response20073.py +++ b/threedi_api_client/openapi/models/inline_response20073.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.3.0 3Di core release: 3.3.0 deployed on: 08:58AM (UTC) on November 17, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/inline_response20074.py b/threedi_api_client/openapi/models/inline_response20074.py index 07a2c3b5..201ddb47 100644 --- a/threedi_api_client/openapi/models/inline_response20074.py +++ b/threedi_api_client/openapi/models/inline_response20074.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.3.0 3Di core release: 3.3.0 deployed on: 08:58AM (UTC) on November 17, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/inline_response20075.py b/threedi_api_client/openapi/models/inline_response20075.py index 7b1f96b0..eb63a037 100644 --- a/threedi_api_client/openapi/models/inline_response20075.py +++ b/threedi_api_client/openapi/models/inline_response20075.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.3.0 3Di core release: 3.3.0 deployed on: 08:58AM (UTC) on November 17, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/inline_response20076.py b/threedi_api_client/openapi/models/inline_response20076.py index 0a3eb291..17484427 100644 --- a/threedi_api_client/openapi/models/inline_response20076.py +++ b/threedi_api_client/openapi/models/inline_response20076.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.3.0 3Di core release: 3.3.0 deployed on: 08:58AM (UTC) on November 17, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/inline_response2008.py b/threedi_api_client/openapi/models/inline_response2008.py index 87d84c2a..608831ed 100644 --- a/threedi_api_client/openapi/models/inline_response2008.py +++ b/threedi_api_client/openapi/models/inline_response2008.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse2008(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[OrganisationRole]' + 'results': 'list[File]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse2008. # noqa: E501 - :rtype: list[OrganisationRole] + :rtype: list[File] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse2008. # noqa: E501 - :type: list[OrganisationRole] + :type: list[File] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inline_response2009.py b/threedi_api_client/openapi/models/inline_response2009.py index 4044d51a..b26c0dec 100644 --- a/threedi_api_client/openapi/models/inline_response2009.py +++ b/threedi_api_client/openapi/models/inline_response2009.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -39,7 +39,7 @@ class InlineResponse2009(object): 'count': 'int', 'next': 'str', 'previous': 'str', - 'results': 'list[Repository]' + 'results': 'list[InpyVersion]' } attribute_map = { @@ -140,7 +140,7 @@ def results(self): :return: The results of this InlineResponse2009. # noqa: E501 - :rtype: list[Repository] + :rtype: list[InpyVersion] """ return self._results @@ -150,7 +150,7 @@ def results(self, results): :param results: The results of this InlineResponse2009. # noqa: E501 - :type: list[Repository] + :type: list[InpyVersion] """ if self.local_vars_configuration.client_side_validation and results is None: # noqa: E501 self.__handle_validation_error("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/threedi_api_client/openapi/models/inpy_version.py b/threedi_api_client/openapi/models/inpy_version.py index 1a1bdf74..7c86e858 100644 --- a/threedi_api_client/openapi/models/inpy_version.py +++ b/threedi_api_client/openapi/models/inpy_version.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/lateral.py b/threedi_api_client/openapi/models/lateral.py index eeaf2fa8..19cf96e2 100644 --- a/threedi_api_client/openapi/models/lateral.py +++ b/threedi_api_client/openapi/models/lateral.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -50,7 +50,8 @@ class Lateral(object): 'state_detail': 'object', 'grid_id': 'int', 'uid': 'str', - 'id': 'int' + 'id': 'int', + 'substances': 'list[ForcingSubstance]' } attribute_map = { @@ -68,10 +69,11 @@ class Lateral(object): 'state_detail': 'state_detail', 'grid_id': 'grid_id', 'uid': 'uid', - 'id': 'id' + 'id': 'id', + 'substances': 'substances' } - def __init__(self, url=None, simulation=None, offset=None, duration=None, interpolate=None, values=None, units=None, constant=None, point=None, connection_node=None, state=None, state_detail=None, grid_id=None, uid=None, id=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, url=None, simulation=None, offset=None, duration=None, interpolate=None, values=None, units=None, constant=None, point=None, connection_node=None, state=None, state_detail=None, grid_id=None, uid=None, id=None, substances=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """Lateral - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -95,6 +97,7 @@ def __init__(self, url=None, simulation=None, offset=None, duration=None, interp self._grid_id = None self._uid = None self._id = None + self._substances = None self.discriminator = None if url is not None: @@ -114,14 +117,14 @@ def __init__(self, url=None, simulation=None, offset=None, duration=None, interp self.connection_node = connection_node if state is not None: self.state = state - if state_detail is not None: - self.state_detail = state_detail - if grid_id is not None: - self.grid_id = grid_id + self.state_detail = state_detail + self.grid_id = grid_id if uid is not None: self.uid = uid if id is not None: self.id = id + if substances is not None: + self.substances = substances @property def url(self): @@ -482,6 +485,27 @@ def id(self, id): self._id = id + @property + def substances(self): + """Gets the substances of this Lateral. # noqa: E501 + + + :return: The substances of this Lateral. # noqa: E501 + :rtype: list[ForcingSubstance] + """ + return self._substances + + @substances.setter + def substances(self, substances): + """Sets the substances of this Lateral. + + + :param substances: The substances of this Lateral. # noqa: E501 + :type: list[ForcingSubstance] + """ + + self._substances = substances + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/threedi_api_client/openapi/models/linestring.py b/threedi_api_client/openapi/models/linestring.py index 88fb8e31..9e6911cf 100644 --- a/threedi_api_client/openapi/models/linestring.py +++ b/threedi_api_client/openapi/models/linestring.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/lizard_raster_rain.py b/threedi_api_client/openapi/models/lizard_raster_rain.py index e9f87329..770f4abc 100644 --- a/threedi_api_client/openapi/models/lizard_raster_rain.py +++ b/threedi_api_client/openapi/models/lizard_raster_rain.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -50,7 +50,8 @@ class LizardRasterRain(object): 'user_id': 'int', 'origin_offset': 'int', 'store_path': 'str', - 'id': 'int' + 'id': 'int', + 'substances': 'list[ForcingSubstance]' } attribute_map = { @@ -68,10 +69,11 @@ class LizardRasterRain(object): 'user_id': 'user_id', 'origin_offset': 'origin_offset', 'store_path': 'store_path', - 'id': 'id' + 'id': 'id', + 'substances': 'substances' } - def __init__(self, url=None, uid=None, offset=None, duration=None, units=None, reference_uuid=None, start_datetime=None, simulation=None, multiplier=None, interval=None, user=None, user_id=None, origin_offset=None, store_path=None, id=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, url=None, uid=None, offset=None, duration=None, units=None, reference_uuid=None, start_datetime=None, simulation=None, multiplier=None, interval=None, user=None, user_id=None, origin_offset=None, store_path=None, id=None, substances=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """LizardRasterRain - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -95,6 +97,7 @@ def __init__(self, url=None, uid=None, offset=None, duration=None, units=None, r self._origin_offset = None self._store_path = None self._id = None + self._substances = None self.discriminator = None if url is not None: @@ -123,6 +126,8 @@ def __init__(self, url=None, uid=None, offset=None, duration=None, units=None, r self.store_path = store_path if id is not None: self.id = id + if substances is not None: + self.substances = substances @property def url(self): @@ -476,6 +481,27 @@ def id(self, id): self._id = id + @property + def substances(self): + """Gets the substances of this LizardRasterRain. # noqa: E501 + + + :return: The substances of this LizardRasterRain. # noqa: E501 + :rtype: list[ForcingSubstance] + """ + return self._substances + + @substances.setter + def substances(self, substances): + """Sets the substances of this LizardRasterRain. + + + :param substances: The substances of this LizardRasterRain. # noqa: E501 + :type: list[ForcingSubstance] + """ + + self._substances = substances + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/threedi_api_client/openapi/models/lizard_raster_sources_sinks.py b/threedi_api_client/openapi/models/lizard_raster_sources_sinks.py index 8417c635..e9df2504 100644 --- a/threedi_api_client/openapi/models/lizard_raster_sources_sinks.py +++ b/threedi_api_client/openapi/models/lizard_raster_sources_sinks.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/lizard_timeseries_rain.py b/threedi_api_client/openapi/models/lizard_timeseries_rain.py index a6f03fd6..dd99d0e9 100644 --- a/threedi_api_client/openapi/models/lizard_timeseries_rain.py +++ b/threedi_api_client/openapi/models/lizard_timeseries_rain.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -46,7 +46,8 @@ class LizardTimeseriesRain(object): 'values': 'list[list[float]]', 'units': 'str', 'id': 'int', - 'uid': 'str' + 'uid': 'str', + 'substances': 'list[ForcingSubstance]' } attribute_map = { @@ -60,10 +61,11 @@ class LizardTimeseriesRain(object): 'values': 'values', 'units': 'units', 'id': 'id', - 'uid': 'uid' + 'uid': 'uid', + 'substances': 'substances' } - def __init__(self, url=None, simulation=None, offset=None, duration=None, reference_uuid=None, start_datetime=None, interpolate=None, values=None, units=None, id=None, uid=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, url=None, simulation=None, offset=None, duration=None, reference_uuid=None, start_datetime=None, interpolate=None, values=None, units=None, id=None, uid=None, substances=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """LizardTimeseriesRain - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -83,6 +85,7 @@ def __init__(self, url=None, simulation=None, offset=None, duration=None, refere self._units = None self._id = None self._uid = None + self._substances = None self.discriminator = None if url is not None: @@ -103,6 +106,8 @@ def __init__(self, url=None, simulation=None, offset=None, duration=None, refere self.id = id if uid is not None: self.uid = uid + if substances is not None: + self.substances = substances @property def url(self): @@ -371,6 +376,27 @@ def uid(self, uid): self._uid = uid + @property + def substances(self): + """Gets the substances of this LizardTimeseriesRain. # noqa: E501 + + + :return: The substances of this LizardTimeseriesRain. # noqa: E501 + :rtype: list[ForcingSubstance] + """ + return self._substances + + @substances.setter + def substances(self, substances): + """Sets the substances of this LizardTimeseriesRain. + + + :param substances: The substances of this LizardTimeseriesRain. # noqa: E501 + :type: list[ForcingSubstance] + """ + + self._substances = substances + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/threedi_api_client/openapi/models/lizard_timeseries_sources_sinks.py b/threedi_api_client/openapi/models/lizard_timeseries_sources_sinks.py index 5e4db9dc..4d339e02 100644 --- a/threedi_api_client/openapi/models/lizard_timeseries_sources_sinks.py +++ b/threedi_api_client/openapi/models/lizard_timeseries_sources_sinks.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/local_rain.py b/threedi_api_client/openapi/models/local_rain.py index 06d4aa0b..b4bc43d2 100644 --- a/threedi_api_client/openapi/models/local_rain.py +++ b/threedi_api_client/openapi/models/local_rain.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -47,7 +47,8 @@ class LocalRain(object): 'point': 'Point', 'diameter': 'int', 'uid': 'str', - 'id': 'int' + 'id': 'int', + 'substances': 'list[ForcingSubstance]' } attribute_map = { @@ -62,10 +63,11 @@ class LocalRain(object): 'point': 'point', 'diameter': 'diameter', 'uid': 'uid', - 'id': 'id' + 'id': 'id', + 'substances': 'substances' } - def __init__(self, url=None, simulation=None, offset=None, duration=None, interpolate=None, values=None, units=None, constant=None, point=None, diameter=None, uid=None, id=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, url=None, simulation=None, offset=None, duration=None, interpolate=None, values=None, units=None, constant=None, point=None, diameter=None, uid=None, id=None, substances=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """LocalRain - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -86,6 +88,7 @@ def __init__(self, url=None, simulation=None, offset=None, duration=None, interp self._diameter = None self._uid = None self._id = None + self._substances = None self.discriminator = None if url is not None: @@ -107,6 +110,8 @@ def __init__(self, url=None, simulation=None, offset=None, duration=None, interp self.uid = uid if id is not None: self.id = id + if substances is not None: + self.substances = substances @property def url(self): @@ -400,6 +405,27 @@ def id(self, id): self._id = id + @property + def substances(self): + """Gets the substances of this LocalRain. # noqa: E501 + + + :return: The substances of this LocalRain. # noqa: E501 + :rtype: list[ForcingSubstance] + """ + return self._substances + + @substances.setter + def substances(self, substances): + """Sets the substances of this LocalRain. + + + :param substances: The substances of this LocalRain. # noqa: E501 + :type: list[ForcingSubstance] + """ + + self._substances = substances + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/threedi_api_client/openapi/models/measure_location.py b/threedi_api_client/openapi/models/measure_location.py index ee07e7d9..d4f9695b 100644 --- a/threedi_api_client/openapi/models/measure_location.py +++ b/threedi_api_client/openapi/models/measure_location.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -81,8 +81,7 @@ def __init__(self, id=None, weight=None, content_type=None, content_pk=None, gri self.grid_id = grid_id if state is not None: self.state = state - if state_detail is not None: - self.state_detail = state_detail + self.state_detail = state_detail @property def id(self): diff --git a/threedi_api_client/openapi/models/measure_location_grid_event_state.py b/threedi_api_client/openapi/models/measure_location_grid_event_state.py index cd35ca14..c71b92d5 100644 --- a/threedi_api_client/openapi/models/measure_location_grid_event_state.py +++ b/threedi_api_client/openapi/models/measure_location_grid_event_state.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/measure_specification.py b/threedi_api_client/openapi/models/measure_specification.py index be4e62f4..06510ff6 100644 --- a/threedi_api_client/openapi/models/measure_specification.py +++ b/threedi_api_client/openapi/models/measure_specification.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/memory_structure_control.py b/threedi_api_client/openapi/models/memory_structure_control.py index 6dee8858..25605d48 100644 --- a/threedi_api_client/openapi/models/memory_structure_control.py +++ b/threedi_api_client/openapi/models/memory_structure_control.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -116,8 +116,7 @@ def __init__(self, id=None, url=None, offset=None, duration=None, measure_specif self.value = value if state is not None: self.state = state - if state_detail is not None: - self.state_detail = state_detail + self.state_detail = state_detail self.grid_id = grid_id if uid is not None: self.uid = uid diff --git a/threedi_api_client/openapi/models/net_cdf_raster_leakage.py b/threedi_api_client/openapi/models/net_cdf_raster_leakage.py index 2ac084c3..2ea51140 100644 --- a/threedi_api_client/openapi/models/net_cdf_raster_leakage.py +++ b/threedi_api_client/openapi/models/net_cdf_raster_leakage.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/net_cdf_raster_rain.py b/threedi_api_client/openapi/models/net_cdf_raster_rain.py index 899e7476..9ec21a93 100644 --- a/threedi_api_client/openapi/models/net_cdf_raster_rain.py +++ b/threedi_api_client/openapi/models/net_cdf_raster_rain.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -49,7 +49,8 @@ class NetCDFRasterRain(object): 'geotransform': 'list[float]', 'epsg_code': 'int', 'file': 'FileReadOnly', - 'uid': 'str' + 'uid': 'str', + 'substances': 'list[ForcingSubstance]' } attribute_map = { @@ -66,10 +67,11 @@ class NetCDFRasterRain(object): 'geotransform': 'geotransform', 'epsg_code': 'epsg_code', 'file': 'file', - 'uid': 'uid' + 'uid': 'uid', + 'substances': 'substances' } - def __init__(self, url=None, multiplier=None, simulation=None, offset=None, duration=None, timestamps=None, interval=None, values_reference=None, fill_value=None, units=None, geotransform=None, epsg_code=None, file=None, uid=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, url=None, multiplier=None, simulation=None, offset=None, duration=None, timestamps=None, interval=None, values_reference=None, fill_value=None, units=None, geotransform=None, epsg_code=None, file=None, uid=None, substances=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """NetCDFRasterRain - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -92,6 +94,7 @@ def __init__(self, url=None, multiplier=None, simulation=None, offset=None, dura self._epsg_code = None self._file = None self._uid = None + self._substances = None self.discriminator = None if url is not None: @@ -116,6 +119,8 @@ def __init__(self, url=None, multiplier=None, simulation=None, offset=None, dura self.file = file if uid is not None: self.uid = uid + if substances is not None: + self.substances = substances @property def url(self): @@ -458,6 +463,27 @@ def uid(self, uid): self._uid = uid + @property + def substances(self): + """Gets the substances of this NetCDFRasterRain. # noqa: E501 + + + :return: The substances of this NetCDFRasterRain. # noqa: E501 + :rtype: list[ForcingSubstance] + """ + return self._substances + + @substances.setter + def substances(self, substances): + """Sets the substances of this NetCDFRasterRain. + + + :param substances: The substances of this NetCDFRasterRain. # noqa: E501 + :type: list[ForcingSubstance] + """ + + self._substances = substances + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/threedi_api_client/openapi/models/net_cdf_raster_sources_sinks.py b/threedi_api_client/openapi/models/net_cdf_raster_sources_sinks.py index a1e98fa7..2d1453d9 100644 --- a/threedi_api_client/openapi/models/net_cdf_raster_sources_sinks.py +++ b/threedi_api_client/openapi/models/net_cdf_raster_sources_sinks.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/net_cdf_timeseries_leakage.py b/threedi_api_client/openapi/models/net_cdf_timeseries_leakage.py index ee988f37..2468f9e6 100644 --- a/threedi_api_client/openapi/models/net_cdf_timeseries_leakage.py +++ b/threedi_api_client/openapi/models/net_cdf_timeseries_leakage.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/net_cdf_timeseries_rain.py b/threedi_api_client/openapi/models/net_cdf_timeseries_rain.py index e7d99f00..f17c9aeb 100644 --- a/threedi_api_client/openapi/models/net_cdf_timeseries_rain.py +++ b/threedi_api_client/openapi/models/net_cdf_timeseries_rain.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -47,7 +47,8 @@ class NetCDFTimeseriesRain(object): 'fill_value': 'str', 'units': 'str', 'file': 'FileReadOnly', - 'uid': 'str' + 'uid': 'str', + 'substances': 'list[ForcingSubstance]' } attribute_map = { @@ -62,10 +63,11 @@ class NetCDFTimeseriesRain(object): 'fill_value': 'fill_value', 'units': 'units', 'file': 'file', - 'uid': 'uid' + 'uid': 'uid', + 'substances': 'substances' } - def __init__(self, url=None, multiplier=None, simulation=None, offset=None, duration=None, timestamps=None, interval=None, values_reference=None, fill_value=None, units=None, file=None, uid=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, url=None, multiplier=None, simulation=None, offset=None, duration=None, timestamps=None, interval=None, values_reference=None, fill_value=None, units=None, file=None, uid=None, substances=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """NetCDFTimeseriesRain - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -86,6 +88,7 @@ def __init__(self, url=None, multiplier=None, simulation=None, offset=None, dura self._units = None self._file = None self._uid = None + self._substances = None self.discriminator = None if url is not None: @@ -106,6 +109,8 @@ def __init__(self, url=None, multiplier=None, simulation=None, offset=None, dura self.file = file if uid is not None: self.uid = uid + if substances is not None: + self.substances = substances @property def url(self): @@ -402,6 +407,27 @@ def uid(self, uid): self._uid = uid + @property + def substances(self): + """Gets the substances of this NetCDFTimeseriesRain. # noqa: E501 + + + :return: The substances of this NetCDFTimeseriesRain. # noqa: E501 + :rtype: list[ForcingSubstance] + """ + return self._substances + + @substances.setter + def substances(self, substances): + """Sets the substances of this NetCDFTimeseriesRain. + + + :param substances: The substances of this NetCDFTimeseriesRain. # noqa: E501 + :type: list[ForcingSubstance] + """ + + self._substances = substances + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/threedi_api_client/openapi/models/net_cdf_timeseries_sources_sinks.py b/threedi_api_client/openapi/models/net_cdf_timeseries_sources_sinks.py index ecdb1d7a..b7fd866e 100644 --- a/threedi_api_client/openapi/models/net_cdf_timeseries_sources_sinks.py +++ b/threedi_api_client/openapi/models/net_cdf_timeseries_sources_sinks.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/numerical_settings.py b/threedi_api_client/openapi/models/numerical_settings.py index 6d1dfea8..a0940eba 100644 --- a/threedi_api_client/openapi/models/numerical_settings.py +++ b/threedi_api_client/openapi/models/numerical_settings.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/obstacle_edit.py b/threedi_api_client/openapi/models/obstacle_edit.py index 590f402f..37204d25 100644 --- a/threedi_api_client/openapi/models/obstacle_edit.py +++ b/threedi_api_client/openapi/models/obstacle_edit.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -88,8 +88,7 @@ def __init__(self, url=None, simulation=None, offset=None, value=None, linestrin self.linestring = linestring if state is not None: self.state = state - if state_detail is not None: - self.state_detail = state_detail + self.state_detail = state_detail if uid is not None: self.uid = uid if id is not None: diff --git a/threedi_api_client/openapi/models/one_d_substance_concentration.py b/threedi_api_client/openapi/models/one_d_substance_concentration.py index e076d390..34b96889 100644 --- a/threedi_api_client/openapi/models/one_d_substance_concentration.py +++ b/threedi_api_client/openapi/models/one_d_substance_concentration.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.3.0 3Di core release: 3.3.0 deployed on: 08:58AM (UTC) on November 17, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/one_d_water_level.py b/threedi_api_client/openapi/models/one_d_water_level.py index 7e35d10b..cfbdb1a9 100644 --- a/threedi_api_client/openapi/models/one_d_water_level.py +++ b/threedi_api_client/openapi/models/one_d_water_level.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/one_d_water_level_file.py b/threedi_api_client/openapi/models/one_d_water_level_file.py index be2de3a2..f12b11e6 100644 --- a/threedi_api_client/openapi/models/one_d_water_level_file.py +++ b/threedi_api_client/openapi/models/one_d_water_level_file.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/one_d_water_level_predefined.py b/threedi_api_client/openapi/models/one_d_water_level_predefined.py index f0a1af8c..c5c2c254 100644 --- a/threedi_api_client/openapi/models/one_d_water_level_predefined.py +++ b/threedi_api_client/openapi/models/one_d_water_level_predefined.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/organisation.py b/threedi_api_client/openapi/models/organisation.py index 55a1ffa4..36abc0ed 100644 --- a/threedi_api_client/openapi/models/organisation.py +++ b/threedi_api_client/openapi/models/organisation.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/organisation_role.py b/threedi_api_client/openapi/models/organisation_role.py index a1905445..16698d87 100644 --- a/threedi_api_client/openapi/models/organisation_role.py +++ b/threedi_api_client/openapi/models/organisation_role.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/organisation_user.py b/threedi_api_client/openapi/models/organisation_user.py index 8b72af70..59e670e3 100644 --- a/threedi_api_client/openapi/models/organisation_user.py +++ b/threedi_api_client/openapi/models/organisation_user.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/organisation_user_role_patch.py b/threedi_api_client/openapi/models/organisation_user_role_patch.py index 05f90741..b727047c 100644 --- a/threedi_api_client/openapi/models/organisation_user_role_patch.py +++ b/threedi_api_client/openapi/models/organisation_user_role_patch.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/personal_api_key.py b/threedi_api_client/openapi/models/personal_api_key.py index 53bdc986..1253a4a0 100644 --- a/threedi_api_client/openapi/models/personal_api_key.py +++ b/threedi_api_client/openapi/models/personal_api_key.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -82,8 +82,7 @@ def __init__(self, prefix=None, scope=None, name=None, expiry_date=None, created self.created = created if revoked is not None: self.revoked = revoked - if last_used is not None: - self.last_used = last_used + self.last_used = last_used @property def prefix(self): diff --git a/threedi_api_client/openapi/models/personal_api_key_with_secret.py b/threedi_api_client/openapi/models/personal_api_key_with_secret.py index 925d0920..82610c8a 100644 --- a/threedi_api_client/openapi/models/personal_api_key_with_secret.py +++ b/threedi_api_client/openapi/models/personal_api_key_with_secret.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -88,8 +88,7 @@ def __init__(self, prefix=None, scope=None, name=None, expiry_date=None, created self.created = created if revoked is not None: self.revoked = revoked - if last_used is not None: - self.last_used = last_used + self.last_used = last_used if key is not None: self.key = key if message is not None: diff --git a/threedi_api_client/openapi/models/physical_settings.py b/threedi_api_client/openapi/models/physical_settings.py index 6223a69e..d6ee7995 100644 --- a/threedi_api_client/openapi/models/physical_settings.py +++ b/threedi_api_client/openapi/models/physical_settings.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/point.py b/threedi_api_client/openapi/models/point.py index 3377039d..c0c5d736 100644 --- a/threedi_api_client/openapi/models/point.py +++ b/threedi_api_client/openapi/models/point.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/polygon.py b/threedi_api_client/openapi/models/polygon.py index adae3a41..a3841146 100644 --- a/threedi_api_client/openapi/models/polygon.py +++ b/threedi_api_client/openapi/models/polygon.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/post_processing_overview.py b/threedi_api_client/openapi/models/post_processing_overview.py index c6271b3e..63d673a6 100644 --- a/threedi_api_client/openapi/models/post_processing_overview.py +++ b/threedi_api_client/openapi/models/post_processing_overview.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/post_processing_queue.py b/threedi_api_client/openapi/models/post_processing_queue.py index 65f91719..79489d11 100644 --- a/threedi_api_client/openapi/models/post_processing_queue.py +++ b/threedi_api_client/openapi/models/post_processing_queue.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/post_processing_status.py b/threedi_api_client/openapi/models/post_processing_status.py index a1e34067..ac99114b 100644 --- a/threedi_api_client/openapi/models/post_processing_status.py +++ b/threedi_api_client/openapi/models/post_processing_status.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/potential_breach.py b/threedi_api_client/openapi/models/potential_breach.py index 26e909c7..36a3c51b 100644 --- a/threedi_api_client/openapi/models/potential_breach.py +++ b/threedi_api_client/openapi/models/potential_breach.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/profile.py b/threedi_api_client/openapi/models/profile.py index 7d5c7d2a..2ba8c33f 100644 --- a/threedi_api_client/openapi/models/profile.py +++ b/threedi_api_client/openapi/models/profile.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/progress.py b/threedi_api_client/openapi/models/progress.py index 2fd33a97..4aa0f65d 100644 --- a/threedi_api_client/openapi/models/progress.py +++ b/threedi_api_client/openapi/models/progress.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/pump_discharge_graph.py b/threedi_api_client/openapi/models/pump_discharge_graph.py index f25ed0be..f1902390 100644 --- a/threedi_api_client/openapi/models/pump_discharge_graph.py +++ b/threedi_api_client/openapi/models/pump_discharge_graph.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/pump_discharge_graph_request.py b/threedi_api_client/openapi/models/pump_discharge_graph_request.py index 19f1e941..c1f96c0b 100644 --- a/threedi_api_client/openapi/models/pump_discharge_graph_request.py +++ b/threedi_api_client/openapi/models/pump_discharge_graph_request.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/rain_graph.py b/threedi_api_client/openapi/models/rain_graph.py index b57796da..deb0d472 100644 --- a/threedi_api_client/openapi/models/rain_graph.py +++ b/threedi_api_client/openapi/models/rain_graph.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/rain_graph_request.py b/threedi_api_client/openapi/models/rain_graph_request.py index 660a0846..2d8fae97 100644 --- a/threedi_api_client/openapi/models/rain_graph_request.py +++ b/threedi_api_client/openapi/models/rain_graph_request.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/raster.py b/threedi_api_client/openapi/models/raster.py index 5472aa63..efb3d5a4 100644 --- a/threedi_api_client/openapi/models/raster.py +++ b/threedi_api_client/openapi/models/raster.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -85,8 +85,7 @@ def __init__(self, url=None, type=None, threedimodel=None, name=None, file=None, if url is not None: self.url = url self.type = type - if threedimodel is not None: - self.threedimodel = threedimodel + self.threedimodel = threedimodel self.name = name if file is not None: self.file = file @@ -139,7 +138,7 @@ def type(self, type): """ if self.local_vars_configuration.client_side_validation and type is None: # noqa: E501 self.__handle_validation_error("Invalid value for `type`, must not be `None`") # noqa: E501 - allowed_values = ["dem_file", "dem_raw_file", "equilibrium_infiltration_rate_file", "frict_coef_file", "initial_groundwater_level_file", "initial_waterlevel_file", "groundwater_hydro_connectivity_file", "groundwater_impervious_layer_level_file", "infiltration_decay_period_file", "initial_infiltration_rate_file", "leakage_file", "phreatic_storage_capacity_file", "hydraulic_conductivity_file", "porosity_file", "infiltration_rate_file", "max_infiltration_capacity_file", "interception_file", "vegetation_height_file", "vegetation_drag_coefficient_file", "vegetation_stem_count_file", "vegetation_stem_diameter_file"] # noqa: E501 + allowed_values = ["dem_file", "dem_raw_file", "equilibrium_infiltration_rate_file", "frict_coef_file", "initial_groundwater_level_file", "initial_waterlevel_file", "groundwater_hydro_connectivity_file", "groundwater_impervious_layer_level_file", "infiltration_decay_period_file", "initial_infiltration_rate_file", "leakage_file", "phreatic_storage_capacity_file", "hydraulic_conductivity_file", "porosity_file", "infiltration_rate_file", "max_infiltration_capacity_file", "interception_file", "vegetation_height_file", "vegetation_drag_coefficient_file", "vegetation_stem_count_file", "vegetation_stem_diameter_file", "initial_concentration_file"] # noqa: E501 if self.local_vars_configuration.client_side_validation and type not in allowed_values: # noqa: E501 self.__handle_validation_error( "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 diff --git a/threedi_api_client/openapi/models/raster_create.py b/threedi_api_client/openapi/models/raster_create.py index 983bc654..be8b1175 100644 --- a/threedi_api_client/openapi/models/raster_create.py +++ b/threedi_api_client/openapi/models/raster_create.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -85,12 +85,10 @@ def __init__(self, url=None, type=None, name=None, id=None, epsg_code=None, exte self.name = name if id is not None: self.id = id - if epsg_code is not None: - self.epsg_code = epsg_code + self.epsg_code = epsg_code if extent is not None: self.extent = extent - if geotransform is not None: - self.geotransform = geotransform + self.geotransform = geotransform self.unit = unit if md5sum is not None: self.md5sum = md5sum diff --git a/threedi_api_client/openapi/models/raster_edit.py b/threedi_api_client/openapi/models/raster_edit.py index 52c55e74..f42a86fa 100644 --- a/threedi_api_client/openapi/models/raster_edit.py +++ b/threedi_api_client/openapi/models/raster_edit.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/raster_edit_urls.py b/threedi_api_client/openapi/models/raster_edit_urls.py index b6529177..8a1b0ef3 100644 --- a/threedi_api_client/openapi/models/raster_edit_urls.py +++ b/threedi_api_client/openapi/models/raster_edit_urls.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/raster_options.py b/threedi_api_client/openapi/models/raster_options.py index 9ee06834..121a7626 100644 --- a/threedi_api_client/openapi/models/raster_options.py +++ b/threedi_api_client/openapi/models/raster_options.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -56,7 +56,8 @@ class RasterOptions(object): 'vegetation_height_file': 'str', 'vegetation_drag_coefficient_file': 'str', 'vegetation_stem_count_file': 'str', - 'vegetation_stem_diameter_file': 'str' + 'vegetation_stem_diameter_file': 'str', + 'initial_concentration_file': 'str' } attribute_map = { @@ -80,10 +81,11 @@ class RasterOptions(object): 'vegetation_height_file': 'vegetation_height_file', 'vegetation_drag_coefficient_file': 'vegetation_drag_coefficient_file', 'vegetation_stem_count_file': 'vegetation_stem_count_file', - 'vegetation_stem_diameter_file': 'vegetation_stem_diameter_file' + 'vegetation_stem_diameter_file': 'vegetation_stem_diameter_file', + 'initial_concentration_file': 'initial_concentration_file' } - def __init__(self, dem_file=None, dem_raw_file=None, equilibrium_infiltration_rate_file=None, frict_coef_file=None, initial_groundwater_level_file=None, initial_waterlevel_file=None, groundwater_hydro_connectivity_file=None, groundwater_impervious_layer_level_file=None, infiltration_decay_period_file=None, initial_infiltration_rate_file=None, leakage_file=None, phreatic_storage_capacity_file=None, hydraulic_conductivity_file=None, porosity_file=None, infiltration_rate_file=None, max_infiltration_capacity_file=None, interception_file=None, vegetation_height_file=None, vegetation_drag_coefficient_file=None, vegetation_stem_count_file=None, vegetation_stem_diameter_file=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, dem_file=None, dem_raw_file=None, equilibrium_infiltration_rate_file=None, frict_coef_file=None, initial_groundwater_level_file=None, initial_waterlevel_file=None, groundwater_hydro_connectivity_file=None, groundwater_impervious_layer_level_file=None, infiltration_decay_period_file=None, initial_infiltration_rate_file=None, leakage_file=None, phreatic_storage_capacity_file=None, hydraulic_conductivity_file=None, porosity_file=None, infiltration_rate_file=None, max_infiltration_capacity_file=None, interception_file=None, vegetation_height_file=None, vegetation_drag_coefficient_file=None, vegetation_stem_count_file=None, vegetation_stem_diameter_file=None, initial_concentration_file=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """RasterOptions - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -113,6 +115,7 @@ def __init__(self, dem_file=None, dem_raw_file=None, equilibrium_infiltration_ra self._vegetation_drag_coefficient_file = None self._vegetation_stem_count_file = None self._vegetation_stem_diameter_file = None + self._initial_concentration_file = None self.discriminator = None if dem_file is not None: @@ -157,6 +160,8 @@ def __init__(self, dem_file=None, dem_raw_file=None, equilibrium_infiltration_ra self.vegetation_stem_count_file = vegetation_stem_count_file if vegetation_stem_diameter_file is not None: self.vegetation_stem_diameter_file = vegetation_stem_diameter_file + if initial_concentration_file is not None: + self.initial_concentration_file = initial_concentration_file @property def dem_file(self): @@ -725,6 +730,33 @@ def vegetation_stem_diameter_file(self, vegetation_stem_diameter_file): self._vegetation_stem_diameter_file = vegetation_stem_diameter_file + @property + def initial_concentration_file(self): + """Gets the initial_concentration_file of this RasterOptions. # noqa: E501 + + + :return: The initial_concentration_file of this RasterOptions. # noqa: E501 + :rtype: str + """ + return self._initial_concentration_file + + @initial_concentration_file.setter + def initial_concentration_file(self, initial_concentration_file): + """Sets the initial_concentration_file of this RasterOptions. + + + :param initial_concentration_file: The initial_concentration_file of this RasterOptions. # noqa: E501 + :type: str + """ + if (self.local_vars_configuration.client_side_validation and + initial_concentration_file is not None and len(initial_concentration_file) > 80): + self.__handle_validation_error("Invalid value for `initial_concentration_file`, length must be less than or equal to `80`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + initial_concentration_file is not None and len(initial_concentration_file) < 1): + self.__handle_validation_error("Invalid value for `initial_concentration_file`, length must be greater than or equal to `1`") # noqa: E501 + + self._initial_concentration_file = initial_concentration_file + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/threedi_api_client/openapi/models/refresh.py b/threedi_api_client/openapi/models/refresh.py index 05ee01e8..75db6bbc 100644 --- a/threedi_api_client/openapi/models/refresh.py +++ b/threedi_api_client/openapi/models/refresh.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/repository.py b/threedi_api_client/openapi/models/repository.py index c29aef86..daef30a6 100644 --- a/threedi_api_client/openapi/models/repository.py +++ b/threedi_api_client/openapi/models/repository.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/result.py b/threedi_api_client/openapi/models/result.py index 09b939ff..edcc22ad 100644 --- a/threedi_api_client/openapi/models/result.py +++ b/threedi_api_client/openapi/models/result.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/result_file.py b/threedi_api_client/openapi/models/result_file.py index a70494bb..b24b4215 100644 --- a/threedi_api_client/openapi/models/result_file.py +++ b/threedi_api_client/openapi/models/result_file.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/revision.py b/threedi_api_client/openapi/models/revision.py index 91fead37..60cf4ecc 100644 --- a/threedi_api_client/openapi/models/revision.py +++ b/threedi_api_client/openapi/models/revision.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/revision_raster.py b/threedi_api_client/openapi/models/revision_raster.py index cfe06ce7..563a1711 100644 --- a/threedi_api_client/openapi/models/revision_raster.py +++ b/threedi_api_client/openapi/models/revision_raster.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -87,12 +87,10 @@ def __init__(self, url=None, type=None, name=None, file=None, id=None, epsg_code self.file = file if id is not None: self.id = id - if epsg_code is not None: - self.epsg_code = epsg_code + self.epsg_code = epsg_code if extent is not None: self.extent = extent - if geotransform is not None: - self.geotransform = geotransform + self.geotransform = geotransform self.unit = unit @property diff --git a/threedi_api_client/openapi/models/revision_task.py b/threedi_api_client/openapi/models/revision_task.py index 7dae2a0d..365c905b 100644 --- a/threedi_api_client/openapi/models/revision_task.py +++ b/threedi_api_client/openapi/models/revision_task.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/role.py b/threedi_api_client/openapi/models/role.py index 29ddab4f..aee9cebc 100644 --- a/threedi_api_client/openapi/models/role.py +++ b/threedi_api_client/openapi/models/role.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/saved_state_overview.py b/threedi_api_client/openapi/models/saved_state_overview.py index 25cd06a0..8ec8e1c8 100644 --- a/threedi_api_client/openapi/models/saved_state_overview.py +++ b/threedi_api_client/openapi/models/saved_state_overview.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/schematisation.py b/threedi_api_client/openapi/models/schematisation.py index 2aef78bb..874247c5 100644 --- a/threedi_api_client/openapi/models/schematisation.py +++ b/threedi_api_client/openapi/models/schematisation.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -117,10 +117,8 @@ def __init__(self, url=None, id=None, owner=None, name=None, slug=None, tags=Non self.created_by_last_name = created_by_last_name if created is not None: self.created = created - if archived is not None: - self.archived = archived - if last_updated is not None: - self.last_updated = last_updated + self.archived = archived + self.last_updated = last_updated if storage_usage is not None: self.storage_usage = storage_usage if threedimodel_limit is not None: diff --git a/threedi_api_client/openapi/models/schematisation_revision.py b/threedi_api_client/openapi/models/schematisation_revision.py index f0d766e9..1a168086 100644 --- a/threedi_api_client/openapi/models/schematisation_revision.py +++ b/threedi_api_client/openapi/models/schematisation_revision.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -104,8 +104,7 @@ def __init__(self, url=None, id=None, created=None, schematisation=None, schemat self.url = url if id is not None: self.id = id - if created is not None: - self.created = created + self.created = created if schematisation is not None: self.schematisation = schematisation if schematisation_id is not None: @@ -116,20 +115,16 @@ def __init__(self, url=None, id=None, created=None, schematisation=None, schemat self.sqlite = sqlite if rasters is not None: self.rasters = rasters - if archived is not None: - self.archived = archived - if commit_date is not None: - self.commit_date = commit_date + self.archived = archived + self.commit_date = commit_date if commit_user is not None: self.commit_user = commit_user if commit_first_name is not None: self.commit_first_name = commit_first_name if commit_last_name is not None: self.commit_last_name = commit_last_name - if commit_message is not None: - self.commit_message = commit_message - if is_valid is not None: - self.is_valid = is_valid + self.commit_message = commit_message + self.is_valid = is_valid if has_threedimodel is not None: self.has_threedimodel = has_threedimodel diff --git a/threedi_api_client/openapi/models/settings.py b/threedi_api_client/openapi/models/settings.py index 41a2d3cd..f2ae9c7a 100644 --- a/threedi_api_client/openapi/models/settings.py +++ b/threedi_api_client/openapi/models/settings.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/simulation.py b/threedi_api_client/openapi/models/simulation.py index eb5d579d..72c5d18b 100644 --- a/threedi_api_client/openapi/models/simulation.py +++ b/threedi_api_client/openapi/models/simulation.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/simulation_channel.py b/threedi_api_client/openapi/models/simulation_channel.py index caf70de2..a4272ab2 100644 --- a/threedi_api_client/openapi/models/simulation_channel.py +++ b/threedi_api_client/openapi/models/simulation_channel.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/simulation_settings_overview.py b/threedi_api_client/openapi/models/simulation_settings_overview.py index ac9d8e13..f36c6cff 100644 --- a/threedi_api_client/openapi/models/simulation_settings_overview.py +++ b/threedi_api_client/openapi/models/simulation_settings_overview.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/simulation_status.py b/threedi_api_client/openapi/models/simulation_status.py index c26266b1..d4762c3b 100644 --- a/threedi_api_client/openapi/models/simulation_status.py +++ b/threedi_api_client/openapi/models/simulation_status.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -135,7 +135,8 @@ def __init__(self, url=None, name=None, simulation=None, simulation_id=None, sim self.threedimodel_slug = threedimodel_slug if threedimodel_id is not None: self.threedimodel_id = threedimodel_id - self.has_results = has_results + if has_results is not None: + self.has_results = has_results if created is not None: self.created = created self.expiry = expiry diff --git a/threedi_api_client/openapi/models/simulation_status_statistics.py b/threedi_api_client/openapi/models/simulation_status_statistics.py index 5d9db26c..5bc7bb15 100644 --- a/threedi_api_client/openapi/models/simulation_status_statistics.py +++ b/threedi_api_client/openapi/models/simulation_status_statistics.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/simulation_update.py b/threedi_api_client/openapi/models/simulation_update.py index c2f93f9d..6c3a7320 100644 --- a/threedi_api_client/openapi/models/simulation_update.py +++ b/threedi_api_client/openapi/models/simulation_update.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/sqlite.py b/threedi_api_client/openapi/models/sqlite.py index 54e84cab..bcc11e83 100644 --- a/threedi_api_client/openapi/models/sqlite.py +++ b/threedi_api_client/openapi/models/sqlite.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/sqlite_file_upload.py b/threedi_api_client/openapi/models/sqlite_file_upload.py index ff6750a8..d17bd7bc 100644 --- a/threedi_api_client/openapi/models/sqlite_file_upload.py +++ b/threedi_api_client/openapi/models/sqlite_file_upload.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/stable_threshold_saved_state.py b/threedi_api_client/openapi/models/stable_threshold_saved_state.py index e1cb4ecc..6242f190 100644 --- a/threedi_api_client/openapi/models/stable_threshold_saved_state.py +++ b/threedi_api_client/openapi/models/stable_threshold_saved_state.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -83,10 +83,8 @@ def __init__(self, url=None, name=None, simulation=None, created=None, tags=None self.url = url if name is not None: self.name = name - if simulation is not None: - self.simulation = simulation - if created is not None: - self.created = created + self.simulation = simulation + self.created = created if tags is not None: self.tags = tags self.expiry = expiry diff --git a/threedi_api_client/openapi/models/status.py b/threedi_api_client/openapi/models/status.py index 83930850..ec963fc4 100644 --- a/threedi_api_client/openapi/models/status.py +++ b/threedi_api_client/openapi/models/status.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/substance.py b/threedi_api_client/openapi/models/substance.py index cb8bd6de..712c8a90 100644 --- a/threedi_api_client/openapi/models/substance.py +++ b/threedi_api_client/openapi/models/substance.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.3.0 3Di core release: 3.3.0 deployed on: 08:58AM (UTC) on November 17, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/table_structure_control.py b/threedi_api_client/openapi/models/table_structure_control.py index d0b4cb26..53286279 100644 --- a/threedi_api_client/openapi/models/table_structure_control.py +++ b/threedi_api_client/openapi/models/table_structure_control.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -104,8 +104,7 @@ def __init__(self, id=None, url=None, offset=None, duration=None, measure_specif self.values = values if state is not None: self.state = state - if state_detail is not None: - self.state_detail = state_detail + self.state_detail = state_detail self.grid_id = grid_id if uid is not None: self.uid = uid diff --git a/threedi_api_client/openapi/models/template.py b/threedi_api_client/openapi/models/template.py index 874d4a13..850324e9 100644 --- a/threedi_api_client/openapi/models/template.py +++ b/threedi_api_client/openapi/models/template.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/threedi_model.py b/threedi_api_client/openapi/models/threedi_model.py index ed8ef8b0..3bc3c3db 100644 --- a/threedi_api_client/openapi/models/threedi_model.py +++ b/threedi_api_client/openapi/models/threedi_model.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -145,8 +145,7 @@ def __init__(self, url=None, id=None, user=None, threedi_version=None, breach_co self.id = id if user is not None: self.user = user - if threedi_version is not None: - self.threedi_version = threedi_version + self.threedi_version = threedi_version self.breach_count = breach_count self.revision = revision if revision_id is not None: diff --git a/threedi_api_client/openapi/models/threedi_model_saved_state.py b/threedi_api_client/openapi/models/threedi_model_saved_state.py index ad24f2d6..ab74a593 100644 --- a/threedi_api_client/openapi/models/threedi_model_saved_state.py +++ b/threedi_api_client/openapi/models/threedi_model_saved_state.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/threedi_model_task.py b/threedi_api_client/openapi/models/threedi_model_task.py index 2e4a7eae..fd73ab2a 100644 --- a/threedi_api_client/openapi/models/threedi_model_task.py +++ b/threedi_api_client/openapi/models/threedi_model_task.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/threshold.py b/threedi_api_client/openapi/models/threshold.py index e5eed4b1..c038a62d 100644 --- a/threedi_api_client/openapi/models/threshold.py +++ b/threedi_api_client/openapi/models/threshold.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/time_step_settings.py b/threedi_api_client/openapi/models/time_step_settings.py index d78c5713..11a03128 100644 --- a/threedi_api_client/openapi/models/time_step_settings.py +++ b/threedi_api_client/openapi/models/time_step_settings.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/timed_saved_state_update.py b/threedi_api_client/openapi/models/timed_saved_state_update.py index e6f707a7..d1fa7566 100644 --- a/threedi_api_client/openapi/models/timed_saved_state_update.py +++ b/threedi_api_client/openapi/models/timed_saved_state_update.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -89,8 +89,7 @@ def __init__(self, url=None, name=None, simulation=None, created=None, created_t self.url = url if name is not None: self.name = name - if simulation is not None: - self.simulation = simulation + self.simulation = simulation self.created = created self.created_time = created_time if tags is not None: diff --git a/threedi_api_client/openapi/models/timed_structure_control.py b/threedi_api_client/openapi/models/timed_structure_control.py index 729ea11e..8927e46d 100644 --- a/threedi_api_client/openapi/models/timed_structure_control.py +++ b/threedi_api_client/openapi/models/timed_structure_control.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -105,8 +105,7 @@ def __init__(self, id=None, url=None, simulation=None, offset=None, duration=Non self.structure_type = structure_type if state is not None: self.state = state - if state_detail is not None: - self.state_detail = state_detail + self.state_detail = state_detail self.grid_id = grid_id if uid is not None: self.uid = uid diff --git a/threedi_api_client/openapi/models/timeout.py b/threedi_api_client/openapi/models/timeout.py index d4d5bdf2..669b02fd 100644 --- a/threedi_api_client/openapi/models/timeout.py +++ b/threedi_api_client/openapi/models/timeout.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/timeseries_lateral.py b/threedi_api_client/openapi/models/timeseries_lateral.py index d2a757da..cab86585 100644 --- a/threedi_api_client/openapi/models/timeseries_lateral.py +++ b/threedi_api_client/openapi/models/timeseries_lateral.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -48,7 +48,8 @@ class TimeseriesLateral(object): 'state_detail': 'object', 'grid_id': 'int', 'id': 'int', - 'uid': 'str' + 'uid': 'str', + 'substances': 'list[ForcingSubstance]' } attribute_map = { @@ -64,10 +65,11 @@ class TimeseriesLateral(object): 'state_detail': 'state_detail', 'grid_id': 'grid_id', 'id': 'id', - 'uid': 'uid' + 'uid': 'uid', + 'substances': 'substances' } - def __init__(self, url=None, simulation=None, offset=None, interpolate=None, values=None, units=None, point=None, connection_node=None, state=None, state_detail=None, grid_id=None, id=None, uid=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, url=None, simulation=None, offset=None, interpolate=None, values=None, units=None, point=None, connection_node=None, state=None, state_detail=None, grid_id=None, id=None, uid=None, substances=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """TimeseriesLateral - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -89,6 +91,7 @@ def __init__(self, url=None, simulation=None, offset=None, interpolate=None, val self._grid_id = None self._id = None self._uid = None + self._substances = None self.discriminator = None if url is not None: @@ -105,14 +108,14 @@ def __init__(self, url=None, simulation=None, offset=None, interpolate=None, val self.connection_node = connection_node if state is not None: self.state = state - if state_detail is not None: - self.state_detail = state_detail - if grid_id is not None: - self.grid_id = grid_id + self.state_detail = state_detail + self.grid_id = grid_id if id is not None: self.id = id if uid is not None: self.uid = uid + if substances is not None: + self.substances = substances @property def url(self): @@ -423,6 +426,27 @@ def uid(self, uid): self._uid = uid + @property + def substances(self): + """Gets the substances of this TimeseriesLateral. # noqa: E501 + + + :return: The substances of this TimeseriesLateral. # noqa: E501 + :rtype: list[ForcingSubstance] + """ + return self._substances + + @substances.setter + def substances(self, substances): + """Sets the substances of this TimeseriesLateral. + + + :param substances: The substances of this TimeseriesLateral. # noqa: E501 + :type: list[ForcingSubstance] + """ + + self._substances = substances + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/threedi_api_client/openapi/models/timeseries_leakage.py b/threedi_api_client/openapi/models/timeseries_leakage.py index c08ecf41..cd198a5f 100644 --- a/threedi_api_client/openapi/models/timeseries_leakage.py +++ b/threedi_api_client/openapi/models/timeseries_leakage.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/timeseries_leakage_overview.py b/threedi_api_client/openapi/models/timeseries_leakage_overview.py index 92188f76..5c90c421 100644 --- a/threedi_api_client/openapi/models/timeseries_leakage_overview.py +++ b/threedi_api_client/openapi/models/timeseries_leakage_overview.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/timeseries_local_rain.py b/threedi_api_client/openapi/models/timeseries_local_rain.py index d7324345..d29da771 100644 --- a/threedi_api_client/openapi/models/timeseries_local_rain.py +++ b/threedi_api_client/openapi/models/timeseries_local_rain.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -45,7 +45,8 @@ class TimeseriesLocalRain(object): 'diameter': 'int', 'point': 'Point', 'uid': 'str', - 'id': 'int' + 'id': 'int', + 'substances': 'list[ForcingSubstance]' } attribute_map = { @@ -58,10 +59,11 @@ class TimeseriesLocalRain(object): 'diameter': 'diameter', 'point': 'point', 'uid': 'uid', - 'id': 'id' + 'id': 'id', + 'substances': 'substances' } - def __init__(self, url=None, simulation=None, offset=None, values=None, interpolate=None, units=None, diameter=None, point=None, uid=None, id=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, url=None, simulation=None, offset=None, values=None, interpolate=None, units=None, diameter=None, point=None, uid=None, id=None, substances=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """TimeseriesLocalRain - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -80,6 +82,7 @@ def __init__(self, url=None, simulation=None, offset=None, values=None, interpol self._point = None self._uid = None self._id = None + self._substances = None self.discriminator = None if url is not None: @@ -98,6 +101,8 @@ def __init__(self, url=None, simulation=None, offset=None, values=None, interpol self.uid = uid if id is not None: self.id = id + if substances is not None: + self.substances = substances @property def url(self): @@ -341,6 +346,27 @@ def id(self, id): self._id = id + @property + def substances(self): + """Gets the substances of this TimeseriesLocalRain. # noqa: E501 + + + :return: The substances of this TimeseriesLocalRain. # noqa: E501 + :rtype: list[ForcingSubstance] + """ + return self._substances + + @substances.setter + def substances(self, substances): + """Sets the substances of this TimeseriesLocalRain. + + + :param substances: The substances of this TimeseriesLocalRain. # noqa: E501 + :type: list[ForcingSubstance] + """ + + self._substances = substances + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/threedi_api_client/openapi/models/timeseries_rain.py b/threedi_api_client/openapi/models/timeseries_rain.py index 7c84ee0f..7b5630e2 100644 --- a/threedi_api_client/openapi/models/timeseries_rain.py +++ b/threedi_api_client/openapi/models/timeseries_rain.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -44,7 +44,8 @@ class TimeseriesRain(object): 'values': 'list[list[float]]', 'units': 'str', 'uid': 'str', - 'id': 'int' + 'id': 'int', + 'substances': 'list[ForcingSubstance]' } attribute_map = { @@ -56,10 +57,11 @@ class TimeseriesRain(object): 'values': 'values', 'units': 'units', 'uid': 'uid', - 'id': 'id' + 'id': 'id', + 'substances': 'substances' } - def __init__(self, url=None, simulation=None, offset=None, duration=None, interpolate=None, values=None, units=None, uid=None, id=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, url=None, simulation=None, offset=None, duration=None, interpolate=None, values=None, units=None, uid=None, id=None, substances=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """TimeseriesRain - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -77,6 +79,7 @@ def __init__(self, url=None, simulation=None, offset=None, duration=None, interp self._units = None self._uid = None self._id = None + self._substances = None self.discriminator = None if url is not None: @@ -84,8 +87,7 @@ def __init__(self, url=None, simulation=None, offset=None, duration=None, interp if simulation is not None: self.simulation = simulation self.offset = offset - if duration is not None: - self.duration = duration + self.duration = duration if interpolate is not None: self.interpolate = interpolate self.values = values @@ -94,6 +96,8 @@ def __init__(self, url=None, simulation=None, offset=None, duration=None, interp self.uid = uid if id is not None: self.id = id + if substances is not None: + self.substances = substances @property def url(self): @@ -310,6 +314,27 @@ def id(self, id): self._id = id + @property + def substances(self): + """Gets the substances of this TimeseriesRain. # noqa: E501 + + + :return: The substances of this TimeseriesRain. # noqa: E501 + :rtype: list[ForcingSubstance] + """ + return self._substances + + @substances.setter + def substances(self, substances): + """Sets the substances of this TimeseriesRain. + + + :param substances: The substances of this TimeseriesRain. # noqa: E501 + :type: list[ForcingSubstance] + """ + + self._substances = substances + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/threedi_api_client/openapi/models/timeseries_rain_overview.py b/threedi_api_client/openapi/models/timeseries_rain_overview.py index cb4ef18f..982592d6 100644 --- a/threedi_api_client/openapi/models/timeseries_rain_overview.py +++ b/threedi_api_client/openapi/models/timeseries_rain_overview.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl @@ -45,7 +45,8 @@ class TimeseriesRainOverview(object): 'units': 'str', 'constant': 'bool', 'uid': 'str', - 'id': 'int' + 'id': 'int', + 'substances': 'list[ForcingSubstance]' } attribute_map = { @@ -58,10 +59,11 @@ class TimeseriesRainOverview(object): 'units': 'units', 'constant': 'constant', 'uid': 'uid', - 'id': 'id' + 'id': 'id', + 'substances': 'substances' } - def __init__(self, url=None, simulation=None, offset=None, duration=None, interpolate=None, values=None, units=None, constant=None, uid=None, id=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 + def __init__(self, url=None, simulation=None, offset=None, duration=None, interpolate=None, values=None, units=None, constant=None, uid=None, id=None, substances=None, local_vars_configuration=None, fetched_from_api=False): # noqa: E501 """TimeseriesRainOverview - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -80,6 +82,7 @@ def __init__(self, url=None, simulation=None, offset=None, duration=None, interp self._constant = None self._uid = None self._id = None + self._substances = None self.discriminator = None if url is not None: @@ -87,8 +90,7 @@ def __init__(self, url=None, simulation=None, offset=None, duration=None, interp if simulation is not None: self.simulation = simulation self.offset = offset - if duration is not None: - self.duration = duration + self.duration = duration if interpolate is not None: self.interpolate = interpolate self.values = values @@ -99,6 +101,8 @@ def __init__(self, url=None, simulation=None, offset=None, duration=None, interp self.uid = uid if id is not None: self.id = id + if substances is not None: + self.substances = substances @property def url(self): @@ -336,6 +340,27 @@ def id(self, id): self._id = id + @property + def substances(self): + """Gets the substances of this TimeseriesRainOverview. # noqa: E501 + + + :return: The substances of this TimeseriesRainOverview. # noqa: E501 + :rtype: list[ForcingSubstance] + """ + return self._substances + + @substances.setter + def substances(self, substances): + """Sets the substances of this TimeseriesRainOverview. + + + :param substances: The substances of this TimeseriesRainOverview. # noqa: E501 + :type: list[ForcingSubstance] + """ + + self._substances = substances + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/threedi_api_client/openapi/models/timeseries_sources_sinks.py b/threedi_api_client/openapi/models/timeseries_sources_sinks.py index 1d7c71a0..02d50221 100644 --- a/threedi_api_client/openapi/models/timeseries_sources_sinks.py +++ b/threedi_api_client/openapi/models/timeseries_sources_sinks.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/timeseries_sources_sinks_overview.py b/threedi_api_client/openapi/models/timeseries_sources_sinks_overview.py index 451face2..e79e3c16 100644 --- a/threedi_api_client/openapi/models/timeseries_sources_sinks_overview.py +++ b/threedi_api_client/openapi/models/timeseries_sources_sinks_overview.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/timeseries_wind.py b/threedi_api_client/openapi/models/timeseries_wind.py index 7a96dd28..32506df0 100644 --- a/threedi_api_client/openapi/models/timeseries_wind.py +++ b/threedi_api_client/openapi/models/timeseries_wind.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/tms.py b/threedi_api_client/openapi/models/tms.py index 051df20e..f194622b 100644 --- a/threedi_api_client/openapi/models/tms.py +++ b/threedi_api_client/openapi/models/tms.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/tokens.py b/threedi_api_client/openapi/models/tokens.py index d8d0a565..b96a0db1 100644 --- a/threedi_api_client/openapi/models/tokens.py +++ b/threedi_api_client/openapi/models/tokens.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/two_d_substance_concentration.py b/threedi_api_client/openapi/models/two_d_substance_concentration.py index e962441d..576f728e 100644 --- a/threedi_api_client/openapi/models/two_d_substance_concentration.py +++ b/threedi_api_client/openapi/models/two_d_substance_concentration.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.3.0 3Di core release: 3.3.0 deployed on: 08:58AM (UTC) on November 17, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/two_d_water_level.py b/threedi_api_client/openapi/models/two_d_water_level.py index 5bae5dd9..a0c4309c 100644 --- a/threedi_api_client/openapi/models/two_d_water_level.py +++ b/threedi_api_client/openapi/models/two_d_water_level.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/two_d_water_raster.py b/threedi_api_client/openapi/models/two_d_water_raster.py index fe82b836..5a61f4b9 100644 --- a/threedi_api_client/openapi/models/two_d_water_raster.py +++ b/threedi_api_client/openapi/models/two_d_water_raster.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/update_revision.py b/threedi_api_client/openapi/models/update_revision.py index e2c914d8..a543ab57 100644 --- a/threedi_api_client/openapi/models/update_revision.py +++ b/threedi_api_client/openapi/models/update_revision.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/update_template.py b/threedi_api_client/openapi/models/update_template.py index c77e7fb3..f335f60c 100644 --- a/threedi_api_client/openapi/models/update_template.py +++ b/threedi_api_client/openapi/models/update_template.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/upload.py b/threedi_api_client/openapi/models/upload.py index 05743df2..a91adf3e 100644 --- a/threedi_api_client/openapi/models/upload.py +++ b/threedi_api_client/openapi/models/upload.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/upload_event_file.py b/threedi_api_client/openapi/models/upload_event_file.py index d86dfb41..2609be2b 100644 --- a/threedi_api_client/openapi/models/upload_event_file.py +++ b/threedi_api_client/openapi/models/upload_event_file.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/upload_with_substances.py b/threedi_api_client/openapi/models/upload_with_substances.py index c1c9001e..30e8f2b7 100644 --- a/threedi_api_client/openapi/models/upload_with_substances.py +++ b/threedi_api_client/openapi/models/upload_with_substances.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.3.0 3Di core release: 3.3.0 deployed on: 08:58AM (UTC) on November 17, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/usage.py b/threedi_api_client/openapi/models/usage.py index 0d73f1c0..43e3f6dc 100644 --- a/threedi_api_client/openapi/models/usage.py +++ b/threedi_api_client/openapi/models/usage.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/usage_statistics.py b/threedi_api_client/openapi/models/usage_statistics.py index 2f6fb92b..14353c9c 100644 --- a/threedi_api_client/openapi/models/usage_statistics.py +++ b/threedi_api_client/openapi/models/usage_statistics.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/user.py b/threedi_api_client/openapi/models/user.py index 16c69c2d..f8cdaf41 100644 --- a/threedi_api_client/openapi/models/user.py +++ b/threedi_api_client/openapi/models/user.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/user_tokens.py b/threedi_api_client/openapi/models/user_tokens.py index 343b56c0..01843144 100644 --- a/threedi_api_client/openapi/models/user_tokens.py +++ b/threedi_api_client/openapi/models/user_tokens.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/water_flow_graph_request.py b/threedi_api_client/openapi/models/water_flow_graph_request.py index 1d265c5b..d8a9e718 100644 --- a/threedi_api_client/openapi/models/water_flow_graph_request.py +++ b/threedi_api_client/openapi/models/water_flow_graph_request.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/water_graph.py b/threedi_api_client/openapi/models/water_graph.py index 90a67b6b..8415bb6e 100644 --- a/threedi_api_client/openapi/models/water_graph.py +++ b/threedi_api_client/openapi/models/water_graph.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/water_level_graph_request.py b/threedi_api_client/openapi/models/water_level_graph_request.py index 43cd3598..7196b6d9 100644 --- a/threedi_api_client/openapi/models/water_level_graph_request.py +++ b/threedi_api_client/openapi/models/water_level_graph_request.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/water_level_profile.py b/threedi_api_client/openapi/models/water_level_profile.py index 2e48476f..5d58c444 100644 --- a/threedi_api_client/openapi/models/water_level_profile.py +++ b/threedi_api_client/openapi/models/water_level_profile.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/water_level_profile_request.py b/threedi_api_client/openapi/models/water_level_profile_request.py index 8d8804dd..2e2f0a91 100644 --- a/threedi_api_client/openapi/models/water_level_profile_request.py +++ b/threedi_api_client/openapi/models/water_level_profile_request.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/waterdepth.py b/threedi_api_client/openapi/models/waterdepth.py index 3d64e796..37c6aac5 100644 --- a/threedi_api_client/openapi/models/waterdepth.py +++ b/threedi_api_client/openapi/models/waterdepth.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/wind.py b/threedi_api_client/openapi/models/wind.py index 2bf531db..0d0f1676 100644 --- a/threedi_api_client/openapi/models/wind.py +++ b/threedi_api_client/openapi/models/wind.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/models/wind_drag_coefficient.py b/threedi_api_client/openapi/models/wind_drag_coefficient.py index b4e8932c..143680ad 100644 --- a/threedi_api_client/openapi/models/wind_drag_coefficient.py +++ b/threedi_api_client/openapi/models/wind_drag_coefficient.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl diff --git a/threedi_api_client/openapi/rest.py b/threedi_api_client/openapi/rest.py index 63ff9f5e..35659dee 100644 --- a/threedi_api_client/openapi/rest.py +++ b/threedi_api_client/openapi/rest.py @@ -3,7 +3,7 @@ """ 3Di API - 3Di simulation API (latest stable version: v3) Framework release: 3.2.65 3Di core release: 3.2.1 deployed on: 12:21PM (UTC) on October 03, 2023 # noqa: E501 + 3Di simulation API (latest stable version: v3) Framework release: 3.3.4 3Di core release: 3.3.1 deployed on: 08:44AM (UTC) on December 14, 2023 # noqa: E501 The version of the OpenAPI document: v3 Contact: info@nelen-schuurmans.nl