Provoly logo
API docs by Redocly

API Baseline (0.7.0)

Download OpenAPI specification:

URL: ../provoly-back/main/index.html License: Apache 2.0

CRUD Operation on repositories data

Version

Retrieve the application and chart versions

Responses

Response samples

Content type
application/json
{
  • "applicationVersion": "0.4.8",
  • "chartVersion": "0.4.8"
}

Model

Save a new category

They are used to categorise attributes of a data model. If a category with this id already exists, update it.

Authorizations:
oidc
Request Body schema: application/json
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "category_name"
}

Retrieve all categories

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a category based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Category UUID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "category_name"
}

Delete a category based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

UUID of the category

Responses

Response samples

Content type
application/json

Occurs when you try to delete default category.

{
  • "application": "data-ref",
  • "code": "NOT_MODIFIABLE",
  • "message": "This is default category id. It can't be deleted"
}

Create a new field

Authorizations:
oidc
Request Body schema: application/json
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
required
string or null
slug
string
type
required
string (Type)
unit
string or null
localeFormat
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "id": "fcc51f53-9295-4caf-968e-873b601763b1",
  • "name": "field_code",
  • "type": "integer",
  • "localeFormat": false
}

Retrieve all existing fields

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a field based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Field UUID

Responses

Response samples

Content type
application/json
Example
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "my field",
  • "slug": "73981_my_field",
  • "type": "integer",
  • "unit": "string",
  • "localeFormat": true
}

Delete a field based on its identifier

Deleting a field is only possible if it's not used in a oclass or named query.

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

UUID of the field to delete

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "Entity : ac2c1a7f-0694-4f03-bb00-d349adeecd3d inexistant."
}

Update an existing field

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Field UUID

Request Body schema: application/json
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
required
string or null
slug
string
type
required
string (Type)
unit
string or null
localeFormat
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "id": "fcc51f53-9295-4caf-968e-873b601763b1",
  • "name": "field_code",
  • "type": "integer",
  • "localeFormat": false
}

Retrieve all field's associate items

A field can be used in oClasses and named queries.

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Field id

Responses

Response samples

Content type
application/json
{
  • "associations": [
    ],
  • "usedElsewhere": false
}

Retrieve all existing fields for an oClass

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Class UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Save or update new oClass

An oClass is made up of attributes and is used to define the data model that will be inserted. An attribute belongs to a single class, and can be grouped by category. OClass names must be unique and attributes ids must be unique. All attributes must contain an unique technical name. If class with same id already exists, update it. Note: It's not possible to change fields.

Authorizations:
oidc
Request Body schema: application/json
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
string
storage
string (Storage)
Enum: "ELASTIC" "POSTGIS" "KUZZLE"
icon
string
Array of objects (AttributeDefWriteDto)
slug
string
Array of objects or null (MetadataValueWriteDto)

Responses

Request samples

Content type
application/json

With the "car_id" attribute able to have several values, and "date_accident", "location" and "weather" that belong to same category.

{
  • "id": "c3ffd8e7-e334-4710-aeb1-8506a12ad39c",
  • "name": "Accident",
  • "icon": "path/to/icon",
  • "storage": "ELASTIC",
  • "attributes": [
    ]
}

Response samples

Content type
application/json

Occurs when you try to create a class without technical name in attribute.

{
  • "application": "data-ref",
  • "code": "BAD_REQUEST",
  • "message": "Missing technical name in attribute 39257557-083b-4427-9493-1cedc92b25cf"
}

Retrieve all defined oClasses

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve an oClass based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Class UUID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "icon": "string",
  • "attributes": [
    ],
  • "slug": "string",
  • "metadata": [
    ]
}

Delete an oClass based on its identifier

Delete a class is possible if not used elsewhere. Deleting a class means deleting the table that contained the data

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Class UUID

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "Entity : ac2c1a7f-0694-4f03-bb00-d349adeecd3d inexistant."
}

Retrieve an oClass based on its identifier with more details

This oClass contains more information about the attributes used in the oClass, with details of the associated fields.

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Class UUID

Responses

Response samples

Content type
application/json
{
  • "id": "c3ffd8e7-e334-4710-aeb1-8506a12ad39c",
  • "slug": "7d2cda0aab_accident",
  • "name": "Accident",
  • "attributes": [
    ]
}

Save a new attribute to a class

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Class UUID

Request Body schema: application/json
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
string
technicalName
string
field
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
category
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
multiValued
boolean
slug
string

Responses

Request samples

Content type
application/json
Example
{
  • "id": "ba681f33-fe70-42f8-a277-05c607ba29cf",
  • "name": "attribute_example",
  • "technicalName": "attribute_example",
  • "field": "423b5c01-1816-41d4-b358-200000000010",
  • "category": "991eb4b2-253c-4875-b708-8209fa5bfd51",
  • "multiValued": false,
  • "slug": "ba681f33_attribute_example"
}

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "Entity : ac2c1a7f-0694-4f03-bb00-d349adeecd3d inexistant."
}

Delete an attribute based on its identifier

Authorizations:
oidc
path Parameters
classId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

UUID of the attribute's class

attributeId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

UUID of the attribute to delete

Responses

Response samples

Content type
application/json

Occurs when we try to delete an attribute used by a link, a namedquery or an abac rule.

{
  • "application": "data-ref",
  • "code": "BAD_REQUEST",
  • "message": "The attribute 423b5c01-1816-41d4-b358-100000000021 is used by one or more search(es) and abac rule(s), remove them to delete the attribute"
}

Retrieving the number of dataset in a class

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all classes based on the identifier of a field

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Field UUID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all usages of a class

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

UUID of the class

Responses

Response samples

Content type
application/json

The parameter usedElsewhere in the response body is a boolean used to indicate if the class is used in a private object.

{
  • "associations": [
    ],
  • "usedElsewhere": false
}

Add metadata to a class

Authorizations:
oidc
path Parameters
classId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
metadataDefId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Request Body schema: application/json
value
string or null
metadataDefId
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Request samples

Content type
application/json
{
  • "value": "22"
}

Response samples

Content type
application/json

Occurs when you try to add metadata with a type not supported

{
  • "application": "data-ref",
  • "code": "FORBIDDEN",
  • "message": "Metadata value should be of type : {{type}}"
}

Delete metadata of a class

Authorizations:
oidc
path Parameters
classId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
metadataDefId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "Entity : ac2c1a7f-0694-4f03-bb00-d349adeecd3d inexistant."
}

Retrieve all usages of an attribute

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

UUID of the attribute

Responses

Response samples

Content type
application/json

The parameter usedElsewhere in the response body is a boolean used to indicate if the dataset is used in a private object.

{
  • "associations": [
    ],
  • "usedElsewhere": false
}

Retrieve available storages

Retrieve the list of available storages

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • "POSTGIS",
  • "ELASTIC"
]

Custom Class

Retrieve all custom classes

Authorizations:
oidc

Responses

Response samples

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

Retrieve the list of custom classes for a domain

Authorizations:
oidc
path Parameters
domain
required
string
Example: tooltips

class domain

Responses

Response samples

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

Save a new custom class by adding its configuration JSON file

Authorizations:
oidc
path Parameters
domain
required
string

Class domain

id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Class UUID

Request Body schema: application/json
domain
string [ 1 .. 30 ] characters
oClass
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
content
string <= 100000 characters

Responses

Request samples

Content type
application/json
{
  • "domain": "tooltips",
  • "oClass": "42a6035a-fc3d-4694-a447-3a2189900da3",
  • "content": "\"{\"type\": \"attribute\",\"options\": {attributes: [\"Seats Number\",\"Seats Number IRVE\",\"Seats Number PMR\"]}}\"\n"
}

Response samples

Content type
application/json

Occurs when the format of the JSON file is incorrect

{
  • "application": "data-ref",
  • "code": "BAD_REQUEST",
  • "message": "Json content is invalid"
}

Retrieve a JSON file describing a custom class based on its identifier and its domain

Authorizations:
oidc
path Parameters
domain
required
string

Class domain

id
required
string

Class UUID

Responses

Response samples

Content type
application/json
"string"

Dataset

Save a new dataset for a specific oClass

A dataset is a coherent, versioned (functionally) set of data belonging to the same class. Dataset could be CLOSED and will therefore have several versions, OPEN or MODIFIABLE.

Authorizations:
oidc
Request Body schema: application/json
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
required
string
oClass
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
type
required
string (DatasetType)
Enum: "OPEN" "CLOSED" "MODIFIABLE"
description
string
Array of objects or null (MetadataValueWriteDto)
groups
Array of strings
categories
Array of strings <uuid> (UUID) [ items <uuid >[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-... ]

Responses

Request samples

Content type
application/json
Example
{
  • "id": "423b5c01-1816-41d4-b358-200000000010",
  • "name": "closed dataset",
  • "oClass": "991eb4b2-253c-4875-b708-8209fa5bfd51",
  • "type": "CLOSED"
}

Response samples

Content type
application/json

Occurs when you try to save a dataset that has the same name as its OClass

{
  • "application": "data-ref",
  • "code": "CONFLICT",
  • "message": "Name {{datasetName}} already exists for class {{oClassName}}"
}

Update a dataset based on its identifier

You can only update the dataset name, description, metadata and groups, you cannot change its id, type or OClass.

Authorizations:
oidc
Request Body schema: application/json
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
required
string
oClass
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
type
required
string (DatasetType)
Enum: "OPEN" "CLOSED" "MODIFIABLE"
description
string
Array of objects or null (MetadataValueWriteDto)
groups
Array of strings
categories
Array of strings <uuid> (UUID) [ items <uuid >[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-... ]

Responses

Request samples

Content type
application/json
Example
{
  • "id": "423b5c01-1816-41d4-b358-200000000010",
  • "name": "we change dataset name",
  • "oClass": "991eb4b2-253c-4875-b708-8209fa5bfd51",
  • "type": "CLOSED"
}

Response samples

Content type
application/json

When groups are deleted from a dataset, a list of groups is returned if they were used by a dashboard.

{
  • "missingGroupsByEntity": {
    }
}

Get all datasets

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a dataset based on its identifier.

Also returns the metadata attached to the dataset, if any.

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json
{
  • "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "oClass": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "type": "OPEN",
  • "name": "open dataset of my class",
  • "metadata": [
    ]
}

Delete a dataset based on its identifier

Deleting a dataset is not possible if dataset-version are associated with it

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

dataset UUID

Responses

Response samples

Content type
application/json

Occurs when you try to delete a dataset who owns dataset-version

{
  • "application": "data-ref",
  • "code": "BAD_REQUEST",
  • "message": "You're not allowed to delete dataset {{datasetId}} because it owns one or more dataset version"
}

Retrieve the last active dataset version based on its dataset id

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

UUID of the dataset

Responses

Response samples

Content type
application/json
Example

Example of a dataset version that has warnings.

{
  • "id": "b1a08d9d-4c38-4d43-90f3-25015537ebfd",
  • "dataset": {
    },
  • "oClass": "991eb4b2-253c-4875-b708-8209fa5bfd51",
  • "lastModified": "2023-04-27T13:56:13.861018Z",
  • "version": 1,
  • "state": "ACTIVE",
  • "withFile": false,
  • "hasWarnings": true
}

Retrieve all dataset versions by the identifier of its dataset

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

dataset UUID

Responses

Response samples

Content type
application/json
Example

Example of a disabled dataset version that has warnings.

[
  • {
    }
]

Retrieve all usages of a dataset

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

UUID of the dataset

Responses

Response samples

Content type
application/json

The parameter usedElsewhere in the response body is a boolean used to indicate if the attribute is used in a private object.

{
  • "associations": [
    ],
  • "usedElsewhere": false
}

Add metadata to a dataset

Authorizations:
oidc
path Parameters
datasetId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
metadataDefId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Request Body schema: application/json
value
string or null
metadataDefId
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Request samples

Content type
application/json
{
  • "value": "22"
}

Response samples

Content type
application/json

Occurs when you try to add metadata with a type not supported

{
  • "application": "data-ref",
  • "code": "FORBIDDEN",
  • "message": "Metadata value should be of type : {{type}}"
}

Delete metadata of a dataset

Authorizations:
oidc
path Parameters
datasetId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
metadataDefId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "Entity : ac2c1a7f-0694-4f03-bb00-d349adeecd3d inexistant."
}

Retrieve all datasets associated to a class

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Class UUID

Responses

Response samples

Content type
application/json
{
  • "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "oClass": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "type": "OPEN",
  • "name": "open dataset of my class",
  • "metadata": [
    ]
}

Retrieve a dataset based on its name

Authorizations:
oidc
path Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "oClass": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "type": "OPEN",
  • "name": "open dataset of my class",
  • "metadata": [
    ]
}

Retrieve the last active dataset version of a dataset by its name

Authorizations:
oidc
path Parameters
datasetName
required
string

dataset name

Responses

Response samples

Content type
application/json
Example

Example of a dataset version that has warnings.

{
  • "id": "b1a08d9d-4c38-4d43-90f3-25015537ebfd",
  • "dataset": {
    },
  • "oClass": "991eb4b2-253c-4875-b708-8209fa5bfd51",
  • "lastModified": "2023-04-27T13:56:13.861018Z",
  • "version": 1,
  • "state": "ACTIVE",
  • "withFile": false,
  • "hasWarnings": true
}

Category

Save a new category

Authorizations:
oidc
Request Body schema: application/json
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "category_name"
}

Response samples

Content type
application/json

Occurs when you try to save a category that has the same name as another category

{
  • "application": "data-ref",
  • "code": "CONFLICT",
  • "message": "Name {{categoryName}} already exists"
}

Get all categories

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Dataset Version

Save a new dataset version

Authorizations:
oidc
Request Body schema: application/json
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
dataset
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
oClass
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
lastModified
string <date-time> (Instant)
version
integer <int32>
state
string (DatasetState)
Enum: "LOADING" "INDEXING" "ACTIVE" "ERROR" "INACTIVE" "DELETING" "DELETE_ERROR"
fileName
string

Responses

Request samples

Content type
application/json
{
  • "id": "b1a08d9d-4c38-4d43-90f3-25015537ebfd",
  • "dataset": "423b5c01-1816-41d4-b358-200000000010",
  • "oClass": "991eb4b2-253c-4875-b708-8209fa5bfd51",
  • "lastModified": "2023-04-27T13:56:13.861018Z",
  • "version": 3,
  • "state": "INACTIVE",
  • "fileName": "datas_flood.csv"
}

Response samples

Content type
application/json
Example

Occurs when you try to create a dataset version of a closed dataset with an id already saved

{
  • "application": "data-ref",
  • "code": "BAD_REQUEST",
  • "message": "Dataset version {{datasetVersionId}} already exist."
}

Retrieve all dataset versions

A dataset version is an instantiation of a dataset. It allows us to have coherent and versioned class data. The parameter hasWarnings in the response body is a boolean used to indicate if dataset-version import's generated some warnings.

Authorizations:
oidc
query Parameters
limit
integer

maximum number of elements to retrieve

offset
integer

index of first element to retrieve (starting from the default value : 0)

state
string (DatasetState)
Enum: "LOADING" "INDEXING" "ACTIVE" "ERROR" "INACTIVE" "DELETING" "DELETE_ERROR"
Example: state=ACTIVE

State of the dataset version. Only datasets versions of this state are retrieved

dateMax
string <date>
Example: dateMax=2024-12-29

maximum lastModified of dataset version. Only datasets version with lastModified before this date are retrieved.

dateMin
string <date>
Example: dateMin=2018-01-15

minimum lastModified of dataset version. Only datasets versions with lastModified after this date are retrieved.

dataset
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

UUID of the dataset. Only datasets versions of this dataset are retrieved

orderBy
string (DatasetVersionOrderBy)
Default: "DATE"
Enum: "DATASET_NAME" "DATE"

Data for ordering results.

sortBy
string (Direction)
Default: "asc"
Enum: "asc" "desc"

Sorting order.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a dataset version based on its identifier. It also returns its associated metadata.

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

dataset version UUID

Responses

Response samples

Content type
application/json
Example

Example of a dataset version that has warnings.

{
  • "id": "b1a08d9d-4c38-4d43-90f3-25015537ebfd",
  • "dataset": {
    },
  • "oClass": "991eb4b2-253c-4875-b708-8209fa5bfd51",
  • "lastModified": "2023-04-27T13:56:13.861018Z",
  • "version": 1,
  • "state": "ACTIVE",
  • "withFile": false,
  • "hasWarnings": true
}

Update some informations of the dataset version

Updating producer, production date and additional informations of the dataset version. The updated dataset version's is identified by its ID from path variable.

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

UUID of the dataset version to update

Request Body schema: application/json
producer
string
productionDate
string <date-time> (Instant)
additionalInformation
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json

Occurs when dataset type is 'CLOSED' and :

  • you try to update a dataset version's without sending productionDate or producer.
  • productionDate is after now.
{
  • "application": "data-ref",
  • "code": "BAD_REQUEST",
  • "message": "Dataset cannot transition from LOADING to ACTIVE"
}

Delete a dataset version based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json

Return the dataset version currently deleting, this is an asynchrone operation.

{
  • "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "dataset": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "oClass": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "lastModified": "2022-03-10T16:15:50Z",
  • "version": 1,
  • "state": "DELETING",
  • "fileName": "datas_flood.csv"
}

Add metadata to a dataset version

Authorizations:
oidc
path Parameters
datasetVersionId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
metadataDefId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Request Body schema: application/json
value
string or null
metadataDefId
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Request samples

Content type
application/json
{
  • "value": "22"
}

Response samples

Content type
application/json

Occurs when you try to add metadata with a type not supported

{
  • "application": "data-ref",
  • "code": "FORBIDDEN",
  • "message": "Metadata value should be of type : {{type}}"
}

Delete the metadata related to a dataset version

Authorizations:
oidc
path Parameters
datasetVersionId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
metadataDefId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json

Occurs when you try to delete a metadata not assigned to the dataset version

{
  • "application": "data-ref",
  • "code": "BAD_REQUEST",
  • "message": "Metadata {{metadata_id}} is not assigned to DATASET_VERSION {{dataset_version_id}}"
}

Activate a dataset version based on its identifier

It also deactivates the previous one. It is only possible to have only one version of an active dataset.

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

dataset version UUID

Responses

Response samples

Content type
application/json

Occurs when you try to activate a dataset version that is not ready to be activated

{
  • "application": "data-ref",
  • "code": "BAD_REQUEST",
  • "message": "Dataset cannot transition from LOADING to ACTIVE"
}

Deactivate a dataset version based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

dataset version UUID

Responses

Response samples

Content type
application/json

Occurs when you try to deactivate a dataset version that is not active

{
  • "application": "data-ref",
  • "code": "BAD_REQUEST",
  • "message": "Dataset cannot transition from ERROR to INACTIVE"
}

Retrieve all dataset versions related to the class contained in its dataset

Authorizations:
oidc
path Parameters
classId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

class UUID

Responses

Response samples

Content type
application/json
Example

Example of a disabled dataset version that has warnings.

[
  • {
    }
]

Returns the details of errors and warnings for a dataset version

Authorizations:
oidc
path Parameters
datasetVersionId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

datasetVersion UUID

Responses

Response samples

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

Metadata Def

Save a new metadata definition

A metadata is used to add context to an entity. Metadata definitions must first be created before being used on an entity.

Authorizations:
oidc
Request Body schema: application/json
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
string or null
type
string (VariableTypeDto)
Enum: "INTEGER" "STRING" "DOUBLE" "DATE" "UUID" "LIST"
description
string
allowedValues
Array of strings
slug
string
readOnly
boolean
system
boolean

Responses

Request samples

Content type
application/json
Example
{
  • "id": "ba681f33-fe70-42f8-a277-05c607ba29cf",
  • "name": "metadata_test",
  • "type": "STRING"
}

Response samples

Content type
application/json
{
  • "application": "data-ref",
  • "code": "NAME_ALREADY_USED",
  • "message": "Name {{metadata_def_name}} already exists"
}

Retrieve all metadata definitions

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a metadata definition based on its identifier

Authorizations:
oidc
path Parameters
metadataId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "my metadata definition",
  • "type": "INTEGER",
  • "description": "metadata definition description",
  • "allowedValues": [
    ],
  • "slug": "87280_my_metadata_definition",
  • "readOnly": true,
  • "system": true
}

Retrieve a metadata based on its name

Authorizations:
oidc
path Parameters
metadataName
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "my metadata definition",
  • "type": "INTEGER",
  • "description": "metadata definition description",
  • "allowedValues": [
    ],
  • "slug": "87280_my_metadata_definition",
  • "readOnly": true,
  • "system": true
}

Retrieve a metadata based on its slug

Authorizations:
oidc
path Parameters
metadataSlug
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "my metadata definition",
  • "type": "INTEGER",
  • "description": "metadata definition description",
  • "allowedValues": [
    ],
  • "slug": "87280_my_metadata_definition",
  • "readOnly": true,
  • "system": true
}

Predicate

Save a new predicate

Predicates are used to define abac rules. They can refer to context variables.

Authorizations:
oidc
Request Body schema: application/json
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
string
value
string

Responses

Request samples

Content type
application/json
{
  • "id": "334c1229-61e7-4807-aeaa-edaf16ec2273",
  • "name": "role_data-reader_defcon",
  • "value": "user.hasRole('data-reader') && request.header('User-Agent').startsWith('Post') && var.defcom < 3"
}

Retrieve all defined predicates

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a predicate based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Predicate ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "value": "string"
}

Metadata Context

Retrieve all defined context variables

Context variables are used in our predicates to give more context information.
We treat it as metadata, and it is notably used as a condition of an ABAC rule, or its expression for example.

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Save a new context variable

Authorizations:
oidc
Request Body schema: application/json
name
string
type
string (VariableTypeDto)
Enum: "INTEGER" "STRING" "DOUBLE" "DATE" "UUID" "LIST"
value
integer

Responses

Request samples

Content type
application/json
{
  • "name": "metadataContextVariable",
  • "type": "INTEGER",
  • "value": 3
}

Response samples

Content type
application/json
{
  • "value": {
    }
}

Retrieve a context variable based on its name

Authorizations:
oidc
path Parameters
variableName
required
string

Variable name

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "type": "INTEGER",
  • "value": 0
}

Delete a context variable based on its name

Authorizations:
oidc
path Parameters
variableName
required
string

name of the variable

Responses

Response samples

Content type
application/json
{
  • "application": "data-ref",
  • "code": "FORBIDDEN",
  • "message": "this context is used in rule {{ruleId}}"
}

Abac

Retrieve all ABAC rules

The ABAC (Attribute-Based Access Control) are rules and predicates. They allow us to provide access to users based on who they are rather than what they do.

Authorizations:
oidc
query Parameters
type
string (AbacRuleType)
Enum: "METADATA" "ATTRIBUTE"

Retrieve only rules with selected type.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Save a new ABAC rule

Authorizations:
oidc
Request Body schema: application/json
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
string
description
string
active
boolean

If abac rule is not active, then it will not be taken into account for restriction processes.

predicate
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
type
string (AbacRuleType)
Enum: "METADATA" "ATTRIBUTE"
any (ConditionDto)

Responses

Request samples

Content type
application/json
Example
{
  • "id": "077e4ac8-7499-4489-bd5f-ac37d2ca226d",
  • "type": "ATTRIBUTE",
  • "name": "Attribute example",
  • "predicate": "077e4ac8-7499-4489-bd5f-ac37d2ca226e",
  • "condition": {
    }
}

Response samples

Content type
application/json
Example

Different OClass in AND/OR condition

{
  • "application": "data-ref",
  • "code": "BAD_REQUEST",
  • "message": "Attributes are not on same OClass"
}

Retrieve all ABAC rules for a class based on its identifier

Authorizations:
oidc
path Parameters
oClassId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Class UUID

query Parameters
includeInactive
boolean
Example: includeInactive=true

Boolean to retrieve inactive rules.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve an ABAC rule based on its identifier

Authorizations:
oidc
path Parameters
ruleId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

ABAC rule UUID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "my rule",
  • "description": "description of my rule",
  • "active": true,
  • "predicate": "eeb41ffe-67db-4185-b921-edc0db333e91",
  • "type": "METADATA",
  • "condition": {
    }
}

Delete an ABAC rule based on its identifier

Authorizations:
oidc
path Parameters
ruleId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

UUID of the rule

Responses

Meta Provisioning

Retrieve the automatic metadata feeding rules for an item during its insertion

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Save a new an automatic metadata feeding rule

Authorizations:
oidc
Request Body schema: application/json
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
string
metadata
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
userProfile
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Request samples

Content type
application/json
{
  • "id": "cb8d2714-d1ce-11ec-9d64-0242ac120005",
  • "name": "meta_date",
  • "userProfile": "ba681f33-fe70-42f8-a277-05c607ba28cf",
  • "metadata": "ba681f33-fe70-42f8-a277-05c607ba29cf"
}

Retrieve an automatic metadata feeding rule based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

UUID of the automatic metadata feeding rule to delete

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "metadata": {
    },
  • "userProfile": {
    }
}

Delete an automatic feeding rule based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

UUID of the feeding rule

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "Entity : ac2c1a7f-0694-4f03-bb00-d349adeecd3d inexistant."
}

Relation Type

Retrieve all relation types

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Save a new relation type

Authorizations:
oidc
Request Body schema: application/json
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
string or null
slug
string

Responses

Request samples

Content type
application/json
Example
{
  • "id": "2f021992-5fb0-42d3-9646-0affccb98105",
  • "name": "est accidentée"
}

Retrieve a relation type based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Relation type UUID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "slug": "string",
  • "nbRelation": 0,
  • "nbLink": 0,
  • "deletable": true,
  • "modificationDate": "2022-03-10T16:15:50Z"
}

Delete a relation type based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Relation type UUID

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "Entity : ac2c1a7f-0694-4f03-bb00-d349adeecd3d inexistant."
}

Retrieve all links

A link is a connections or relationships between attributes of classes. They allow us to represent associations between our objects.

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a link based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Link UUID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "relationType": {
    },
  • "attributeSource": {
    },
  • "attributeDestination": {
    }
}

Data Source

Retrieve a DataSource based on its identifier

DataSources are sources containing data that can be displayed in widgets. They include named queries, dataset versions and datasets.

Authorizations:
oidc
path Parameters
dataSourceId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "SEARCH",
  • "oClass": "04c4759f-4d1b-48af-be42-deac3d5dca7a"
}

User

Retrieve all users

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve the current user info

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "familyName": "ThePower",
  • "name": "Agathe",
  • "email": "agathe.thepower@email.com",
  • "roles": [
    ],
  • "groups": [
    ],
  • "isAnonymous": false
}

Retrieve all profile values of a user based on its identifier

Authorizations:
oidc
path Parameters
userId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Save new profile values for a user based on its identifier

Authorizations:
oidc
path Parameters
metadataDefId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
userId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Request Body schema: application/json
values
Array of strings
metadataDefId
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Request samples

Content type
application/json
Example
{
  • "values": [
    ]
}

Delete all profile values of a user based on its identifier

Authorizations:
oidc
path Parameters
metadataDefId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
userId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "Entity : ac2c1a7f-0694-4f03-bb00-d349adeecd3d inexistant."
}

Retrieving metadata value of the current user

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

User Profile

Save a new user profile

Authorizations:
oidc
Request Body schema: application/json
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
string or null
type
string (VariableTypeDto)
Enum: "INTEGER" "STRING" "DOUBLE" "DATE" "UUID" "LIST"
description
string
allowedValues
Array of strings
slug
string

Responses

Request samples

Content type
application/json
Example
{
  • "id": "ba681f33-fe70-42f8-a277-05c607ba28cf",
  • "name": "example_profile",
  • "type": "STRING"
}

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "Entity : ac2c1a7f-0694-4f03-bb00-d349adeecd3d inexistant."
}

Retrieve all user profiles

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a user profile based on its identifier

Authorizations:
oidc
path Parameters
metadataId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "defcon",
  • "type": "INTEGER",
  • "description": "The defense readiness condition (DEFCON) is an alert state used by the United States Armed Forces.",
  • "allowedValues": "[]",
  • "slug": "10928_defcon"
}

Named Query

Save a new named query

Authorizations:
oidc
Request Body schema: application/json
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
string
description
string
any (SearchRequestDto)
favorite
boolean
color
string
object (VisibilityDto)

Responses

Request samples

Content type
application/json
{
  • "id": "09061554-298f-4f56-8cd2-51ccec998307",
  • "name": "NamedQuery_example",
  • "description": "Je suis une named query mono",
  • "color": "rose",
  • "favorite": false,
  • "visibility": {
    },
  • "request": {
    }
}

Retrieve all named queries of the current user

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a named query based on its identifier

This endpoint is used only by data-virt and allows executing a private namedQuery
that we do not own if we know its ID.

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Named query id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Accidents 2019-2022",
  • "description": "Return all accidents between 2019 and 2022 in France",
  • "request": {
    },
  • "favorite": true,
  • "color": "string",
  • "visibility": {
    },
  • "lastExecutionDate": "2022-03-10T16:15:50Z",
  • "owner": true
}

Delete a named query based on its identifier

Currently, only private named queries can be deleted

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Named query id

Responses

Save the execution time of a named query based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

named query id

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "Entity : ac2c1a7f-0694-4f03-bb00-d349adeecd3d inexistant."
}

Set a named query as a favorite for the current user

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Named query UUID

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "Entity : ac2c1a7f-0694-4f03-bb00-d349adeecd3d inexistant."
}

Unset a named query as the favorite for the current user

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Named query id

Responses

Retrieve all information of a named query based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Named query id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Accidents 2019-2022",
  • "description": "Return all accidents between 2019 and 2022 in France",
  • "request": {
    },
  • "favorite": true,
  • "color": "string",
  • "visibility": {
    },
  • "lastExecutionDate": "2022-03-10T16:15:50Z",
  • "owner": true
}

Dashboard

Save a new dashboard

Saves a dashboard for the current user. Groups can be added, otherwise the dashboard is private by default. If the group added is "ALL", then the dashboard can be consulted by anyone. If the group added is "AUTHENTICATED", then everyone will have the right to view the dashboard except the anonymous user. A list of missing groups is returned when the list of groups added to the dashboard does not match those present in the datasets, and the dashboard is not created.

Authorizations:
oidc
Request Body schema: application/json
object
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
string
image
string
description
string
cover
boolean
object
datasource
Array of strings <uuid> (UUID) [ items <uuid >[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-... ]
Array of objects or null (MetadataValueWriteDto)
additionalInformation
string

Responses

Request samples

Content type
application/json
{
  • "id": "f4f77417-0f5b-4d8e-9bde-a8dcf799632f",
  • "name": "dashboard example",
  • "image": "image",
  • "description": "description du widget",
  • "cover": true,
  • "datasource": [
    ],
  • "manifest": {
    },
  • "metadata": [
    ],
  • "accessRightsByGroup": {
    },
  • "additionalInformation": "Some more information"
}

Response samples

Content type
application/json
{
  • "missingGroupsByEntity": {
    }
}

Retrieve the dashboards of the current user

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Save new metadata values for a dashboard based on its identifier

Authorizations:
oidc
path Parameters
metadataDefId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
dashboardId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Request Body schema: application/json
value
string or null
metadataDefId
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Request samples

Content type
application/json
Example
{
  • "value": "some value"
}

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "Entity : ac2c1a7f-0694-4f03-bb00-d349adeecd3d inexistant."
}

Delete metadata values for a dashboard based on its identifier

Authorizations:
oidc
path Parameters
metadataDefId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
dashboardId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "Entity : ac2c1a7f-0694-4f03-bb00-d349adeecd3d inexistant."
}

Retrieve a dashboard based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Dashboard UUID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Flood risk in France",
  • "image": "string",
  • "description": "",
  • "cover": false,
  • "creationDate": "2022-03-10T16:15:50Z",
  • "modificationDate": "2022-03-10T16:15:50Z",
  • "isDefault": true,
  • "manifestUrl": "http://example.com",
  • "owner": true,
  • "datasource": [
    ],
  • "readOnlyMetadata": [
    ],
  • "metadata": [
    ],
  • "accessRightsByGroup": {
    },
  • "additionalInformation": "string"
}

Delete a dashboard based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Dashboard UUID

Responses

Response samples

Content type
application/json
{
  • "application": "data-ref",
  • "code": "FORBIDDEN",
  • "message": "User is not granted to write DASHBOARD {{dashboard_id}}."
}

Retrieve the manifest of the dashboard based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Dashboard UUID

Responses

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Widget

Adding a JSON file describing a widget configuration

Authorizations:
oidc
Request Body schema: application/json
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
string
description
string
image
string
content
string
datasource
Array of strings <uuid> (UUID) [ items <uuid >[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-... ]
cover
boolean

Determine whether the image should take up the whole widget or not

owner
boolean
creationDate
string <date-time> (Instant)
modificationDate
string <date-time> (Instant)
groups
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": "921e297f-4b21-4045-9896-5ec98910cae1",
  • "name": "example_widget_config",
  • "description": "this is a new widget configuration",
  • "image": "",
  • "content": "{\"type\":\"table\",\"layout\":{\"x\":1,\"y\":1,\"width\":1,\"height\":1},\"options\":{\"columns\":[{\"property\":\"date timestamp\",\"label\":\"date timestamp\",\"attributeId\":\"7d4ac9df-dfe7-430f-a4c5-4b8c2c77433c\"},{\"property\":\"identifiant\",\"label\":\"identifiant\",\"attributeId\":\"36d67f72-d5a8-4aed-ae47-dfedb95702cb\"}]},\"title\":\"issueBack115\",\"datasource\":[\"a1041310-3c83-4512-97be-9e665d20d0a5\"],\"header\":{\"datasourceSelection\":false,\"parameters\":true,\"window\":false,\"maximize\":false,\"addToCatalog\":false,\"delete\":false,\"changeSpot\":false},\"cover\":false}",
  • "groups": [
    ],
  • "datasource": [
    ],
  • "cover": false
}

Retrieve all saved widgets

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a widget configuration based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Widget UUID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Flood/submergence risk",
  • "description": "widget displaying a map showing the various risks of submersion and flooding.",
  • "image": "string",
  • "content": "string",
  • "datasource": [
    ],
  • "cover": true,
  • "owner": true,
  • "creationDate": "2022-03-10T16:15:50Z",
  • "modificationDate": "2022-03-10T16:15:50Z",
  • "groups": [
    ]
}

Delete a widget configuration based on its identifier

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Widget UUID

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "Entity : ac2c1a7f-0694-4f03-bb00-d349adeecd3d inexistant."
}

Type

Retrieve all types

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Group

Add new group

Authorizations:
oidc
Request Body schema: application/json
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "6bc614e0-24a7-427d-bc6a-b65de4f3d2b0",
  • "name": "test"
}

Retrieve all groups

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Notification

Save a new notification to the associated users

Authorizations:
oidc
Request Body schema: application/json
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
users
Array of strings <uuid> [ items <uuid >[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-... ]
object (NotificationTextDto)
link
string

Responses

Request samples

Content type
application/json
{
  • "id": "c5b4908f-c477-436b-b346-160803a82915",
  • "users": [
    ],
  • "notificationTextDto": {
    },
  • "link": ""
}

Delete all notifications related to the associated user

Responses

Remove a notification from its associated user

path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Notification UUID

Responses

Response samples

Content type
application/json
{
  • "code": 404,
  • "message": "Entity : ac2c1a7f-0694-4f03-bb00-d349adeecd3d inexistant."
}