Documentation Powered by ReDoc

Hydamo Validatietool API (1.1.0)

Download OpenAPI specification:Download

HyDAMO supportdesk: helpdesk-hydamo-validatietool@hkv.nl URL: https://github.com/HetWaterschapshuis/ValidatietoolHyDAMO/support License: MIT license

This API is used by the Hydamo Validatietool for validation HyDAMO objects

Authentication

OAuth2

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://www.googleapis.com/oauth/authorize
Token URL: https://www.googleapis.com/oauth/token
Scopes:
  • read -

    Grants read access

  • write -

    Grants write access

  • admin -

    Grants access to admin operations

Info

Gets api information

Responses

Response samples

Content type
application/json
{
  • "version": "1.1.0",
  • "validation_module": "1.1",
  • "title": "HyDAMO Validationtool",
  • "description": "HyDAMO Validationtool",
  • "contact": "helpdesk-hydamo-validatietool@hkv.nl"
}

Tasks

Gets all tasks

Gets a complete overview of all Validationtool tasks

Authorizations:
OAuth2 (read)

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Creates a new task.

Creates a new HyDAMO* validationtool task with id and status 'new'

Authorizations:
OAuth2 (write)
path Parameters
task_name
required
string

Task name

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Validation stuw",
  • "status": "new",
  • "numberOfDatasets": 0,
  • "validationRules": false,
  • "host": "",
  • "owner": "abcdefghijeklmnopqrstuvwxyz1",
  • "format": ""
}

Gets a task by ID

Gets a HyDAMO validationtool task by ID.

Authorizations:
OAuth2 (read)
path Parameters
task_id
required
integer <int64>

Task ID

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Validation stuw",
  • "status": "ready_to_validate",
  • "numberOfDatasets": 2,
  • "validationRules": true,
  • "host": "",
  • "owner": "abcdefghijeklmnopqrstuvwxyz1",
  • "format": "geopackage,geojson,csv"
}

Delete a task by ID

Deletes a HyDAMO validationtool task by ID.

Authorizations:
OAuth2 (write)
path Parameters
task_id
required
integer <int64>

Task ID

Responses

Executes a task by ID and format

Starts a HyDAMO validationtool task by ID.

Authorizations:
OAuth2 (write)
path Parameters
task_id
required
integer <int64>

Task ID

format
required
string

Format (geopackage/geojson/csv) by multiple choices comma separated

Responses

Kill a task by ID

Kills an already running HyDAMO validationtool task by ID.

Authorizations:
OAuth2 (write)
path Parameters
task_id
required
integer <int64>

Task ID

Responses

TaskDataset

Gets list of uploaded datasets

Gets list of uploaded datasets in a task by ID.

Authorizations:
OAuth2 (read)
path Parameters
task_id
required
integer <int64>

Task ID

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Upload a datasets file for a task by id

Uploads a dataset file for a Validationtool task by ID

Authorizations:
OAuth2 (write)
path Parameters
task_id
required
integer <int64>

Task ID

Request Body schema: multipart/form-data
file
string <binary>

Responses

Get a file with a dataset by id of a task by id

Gets a file with a dataset by ID of a Validationtool task by ID

Authorizations:
OAuth2 (read)
path Parameters
task_id
required
integer <int64>

Task ID

dataset_id
required
integer <int64>

Dataset ID

Responses

Deletes a dataset by Id from a task by Id

Deletes a dataset by ID for a specific task with task ID.

Authorizations:
OAuth2 (write)
path Parameters
task_id
required
integer <int64>

Task ID

dataset_id
required
integer <int64>

Dataset ID

Responses

TaskValidationRules

Get the validation rules file by task Id

gets the file with validationrules for a Validationtool task by ID

Authorizations:
OAuth2 (read)
path Parameters
task_id
required
integer <int64>

Task ID

Responses

Upload a file with validationrules for a task by id

uploads file with validationrules for a Validationtool task by ID

Authorizations:
OAuth2 (write)
path Parameters
task_id
required
integer <int64>

Task ID

Request Body schema: multipart/form-data
file
string <binary>

Responses

Deletes a validation rules file by Id from a task by Id

deletes a file with validationrules for a Validationtool task by ID

Authorizations:
OAuth2 (write)
path Parameters
task_id
required
integer <int64>

Task ID

Responses

TaskResult

Gets a result by Id of a task by Id

Gets a result by ID for a specific task.

Authorizations:
OAuth2 (read)
path Parameters
task_id
required
integer <int64>

Task ID

format
required
string

Format (geopackage/geojson/csv/object-type exception metadata)

Responses