DataGEMS Gateway API v1¶
Gateway API exposing the DataGEMS underpinning functionality
Terms of service: https://datagems.eu/terms
Contact: DataGEMS helpdesk
License: EUPL-1.2 license
Servers¶
| Description | URL |
|---|---|
| /gw | /gw |
Collection¶
POST /api/collection/query¶
Query collections
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"ids": [
"5c8fb056-3412-4575-a616-17c449c436f9"
],
"excludedIds": [
"595f1b7f-be8e-4ce3-93a6-a9a725e4a2dd"
],
"datasetIds": [
"0cc778fb-0df3-4734-9613-f59195dcecc3"
],
"like": "string",
"page": {
"offset": 0,
"size": 10
},
"order": {
"items": [
"+name",
"-id"
]
},
"metadata": {
"countAll": true
},
"project": {
"fields": [
"id",
"name",
"foo.id",
"foo.bar.id"
]
}
}
Schema of the request body
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"excludedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Exclude from the lookup items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"datasetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items containing the specific dataset ids. If set, the list of ids must not be empty",
"nullable": true
},
"like": {
"type": "string",
"description": "Limit lookup to items whose name matches the pattern",
"nullable": true
},
"page": {
"$ref": "#/components/schemas/Paging"
},
"order": {
"$ref": "#/components/schemas/Ordering"
},
"metadata": {
"$ref": "#/components/schemas/Header"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"items": [
{
"id": "5e8fdd47-1540-4b04-a8a6-3f124fcabc0f",
"code": "string",
"name": "string",
"datasets": [
{
"id": "af896225-4089-454b-b24b-e6445acb0154",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 172,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": null,
"permissions": [
"string"
]
}
],
"datasetCount": 23,
"permissions": [
"string"
]
}
],
"count": 40
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Collection"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
GET /api/collection/{id}¶
Lookup collection by id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No | ||
id |
path | string | No | The id of the item to lookup |
Response 200 OK
{
"items": [
{
"id": "b15bbff2-5cd3-4143-a67c-fe997d7c00ee",
"code": "string",
"name": "string",
"datasets": [
{
"id": "9e70ef47-ef19-4394-99b5-d280f2f0787b",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 237,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": null,
"permissions": [
"string"
]
}
],
"datasetCount": 4,
"permissions": [
"string"
]
}
],
"count": 43
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Collection"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
Conversation¶
POST /api/conversation/query¶
Query conversations
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"ids": [
"89f810e3-cccd-4da8-a967-fe14ef70ee0b"
],
"userIds": [
"fc68f51c-1fd9-4032-9f5f-a28436fd27f4"
],
"excludedIds": [
"2b1119a4-a645-4bdc-8ab9-0e031db624f6"
],
"isActive": [
159
],
"like": "string",
"page": {
"offset": 0,
"size": 10
},
"order": {
"items": [
"+name",
"-id"
]
},
"metadata": {
"countAll": true
},
"project": {
"fields": [
"id",
"name",
"foo.id",
"foo.bar.id"
]
}
}
Schema of the request body
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"userIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items belonging to specific user ids. If set, the list of ids must not be empty",
"nullable": true
},
"excludedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Exclude from the lookup items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"isActive": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IsActive"
},
"description": "Limit lookup to items that are active, or inactive or both. If set, the list of flags must not be empty",
"nullable": true
},
"like": {
"type": "string",
"description": "Limit lookup to items whose name or email matches the pattern",
"nullable": true
},
"page": {
"$ref": "#/components/schemas/Paging"
},
"order": {
"$ref": "#/components/schemas/Ordering"
},
"metadata": {
"$ref": "#/components/schemas/Header"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"items": [
{
"id": "2efc846c-26e8-4215-951d-4532a0aef98e",
"name": "string",
"user": {
"id": "12f8f50d-f221-4e80-9ca5-cbd4291706bc",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "375358fe-28f1-4fb0-b004-fbe5520bbb75",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "81662624-ef41-418d-b10c-22380207c7b3",
"dataset": {
"id": "81f601aa-fe19-44e6-b11a-f29a5db40b61",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 163,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "a9fbc567-750b-4e69-a545-39841c61e42b",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 222,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 233,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 286,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "d7be53a3-7f66-4809-a335-09ab19807198",
"dataset": null,
"conversation": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": [
{
"id": "386e9691-d6af-4d9d-bd2e-0ee0a0a00954",
"conversation": null,
"kind": 132,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"count": 167
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Conversation"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/conversation/me/query¶
Query user owned conversations
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"ids": [
"39b67701-c8c8-471c-8f68-95bd463a766e"
],
"userIds": [
"c3521448-e018-4e82-b67d-8630dfd8d37a"
],
"excludedIds": [
"f96ed732-385a-4cd8-b21e-47796dc0869f"
],
"isActive": [
158
],
"like": "string",
"page": {
"offset": 0,
"size": 10
},
"order": {
"items": [
"+name",
"-id"
]
},
"metadata": {
"countAll": true
},
"project": {
"fields": [
"id",
"name",
"foo.id",
"foo.bar.id"
]
}
}
Schema of the request body
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"userIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items belonging to specific user ids. If set, the list of ids must not be empty",
"nullable": true
},
"excludedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Exclude from the lookup items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"isActive": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IsActive"
},
"description": "Limit lookup to items that are active, or inactive or both. If set, the list of flags must not be empty",
"nullable": true
},
"like": {
"type": "string",
"description": "Limit lookup to items whose name or email matches the pattern",
"nullable": true
},
"page": {
"$ref": "#/components/schemas/Paging"
},
"order": {
"$ref": "#/components/schemas/Ordering"
},
"metadata": {
"$ref": "#/components/schemas/Header"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"items": [
{
"id": "24748d05-7771-4e4a-9ed1-49d52446b197",
"name": "string",
"user": {
"id": "22f5c000-c031-4600-8df4-111581665897",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "29021569-bb76-4f98-b394-e75c5cb9bf40",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "c9f2b59a-bfa2-40fb-ab6a-89b13e29fa63",
"dataset": {
"id": "8a73890f-0468-4741-8c58-e1b22280ad8b",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 220,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "aee2944a-2e97-481a-94cc-37f009e8f4cb",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 42,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 149,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 265,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "6d5f4b67-1885-4d7c-a910-3ce210c331ae",
"dataset": null,
"conversation": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": [
{
"id": "6f0641e1-d3a7-4f1a-be30-dc128bb12061",
"conversation": null,
"kind": 295,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"count": 159
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Conversation"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
GET /api/conversation/{id}¶
Lookup conversation by id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No | ||
id |
path | string | No | The id of the item to lookup |
Response 200 OK
{
"items": [
{
"id": "9a429546-bb4c-49d6-b673-f45737a5439d",
"name": "string",
"user": {
"id": "6322b393-9ca0-4b2c-9b99-492575c0be36",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "b56b0cea-b7c1-47ca-b1d4-800142d0bc36",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "6532f2c8-733f-460a-b4bc-1bc9f3c48a1c",
"dataset": {
"id": "4f7ac1f8-cb29-49fc-a656-931b3ab31b97",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 99,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "244f04d9-365a-433c-9778-0b78e0e83a66",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 219,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 7,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 157,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "5508a180-9c88-42e3-9a6e-59356a113425",
"dataset": null,
"conversation": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": [
{
"id": "e267b45d-6869-49cc-8090-e65d2b66f3ff",
"conversation": null,
"kind": 278,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"count": 188
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Conversation"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
DELETE /api/conversation/{id}¶
Deletes the user conversation by id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
id |
path | string | No | The id of the item to delete |
Response 200 OK
Response 400 Bad Request
Response 401 Unauthorized
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/conversation/me/persist¶
Persist user owned conversation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No |
Request body
{
"id": "23aa1478-66d9-40ce-8b04-1d5d3b3b8912",
"name": "string",
"eTag": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 200 OK
{
"id": "8e58618d-9e6d-4a45-997e-4d8301bad449",
"name": "string",
"user": {
"id": "5c988955-2e52-40fd-be16-6aace49203fb",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "190bc956-fa07-47ad-a92a-b0ff59df3476",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "46b49e1e-419b-4233-bf77-45a5b7cd6e27",
"dataset": {
"id": "8d3aadbe-0b03-4ae0-ae63-91a295219f25",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 245,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "4d63394a-2648-4392-aede-43d7157efef5",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 6,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 55,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 133,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "a6c38a73-146f-4d44-b6c4-50cd5d13a406",
"dataset": null,
"conversation": {
"id": "fd12d75f-815d-4e02-befc-4cd51f8e0235",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "1cc181b5-b603-403c-8a7b-35aa98550cc7",
"conversation": null,
"kind": 67,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"user": {
"$ref": "#/components/schemas/User"
},
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationDataset"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationMessage"
},
"nullable": true
},
"isActive": {
"$ref": "#/components/schemas/IsActive"
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/conversation/me/persist/deep¶
Persist user owned conversation along with details provided
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No |
Request body
{
"id": "ee37558a-3637-4d2b-bed7-31669f487261",
"name": "string",
"conversationDatasets": [
{
"id": "dc6bab14-c1c9-4f33-8b46-57e9485cf4fe",
"conversationId": "2be8e6e0-e789-4b4a-8ed8-68730fb4d0d5",
"datasetId": "17dbeb7b-5793-49ca-aae9-e487e3b1d260",
"eTag": "string"
}
],
"eTag": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"conversationDatasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationDatasetPersist"
},
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 200 OK
{
"id": "2244921a-55f0-458c-8d69-06d29bc93229",
"name": "string",
"user": {
"id": "c44140ae-93d0-457f-ac15-0ba83f119283",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "ccbfb824-0ed1-4fce-9381-2b0388051cad",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "a07ff11d-2fb1-460c-88be-e336abf3b685",
"dataset": {
"id": "8b4ce56c-83a8-4c73-9393-3a8a01c48997",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 113,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "0ad72cf5-4702-4e2a-95f0-244ab927a40e",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 172,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 179,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 16,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "120becd8-b48b-4a5a-aa20-d646ac8fb1d0",
"dataset": null,
"conversation": {
"id": "1156460a-1a15-4071-8cfb-ec788b53b56b",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "937faa37-4d6b-4889-805a-d3d4d380047b",
"conversation": null,
"kind": 57,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"user": {
"$ref": "#/components/schemas/User"
},
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationDataset"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationMessage"
},
"nullable": true
},
"isActive": {
"$ref": "#/components/schemas/IsActive"
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/conversation/me/patch/dataset¶
Patch user owned conversation with updated datasets
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No |
Request body
{
"id": "ea9b99a6-5059-43ff-91e4-78e561fbe738",
"conversationDatasets": [
{
"id": "cd6f3324-a1a2-4faa-8ec0-f69a1e5576cb",
"conversationId": "7f28721e-5a6d-48a7-a944-1a99260a73cf",
"datasetId": "8d8988db-d6eb-4d3d-80c3-a2edd874c101",
"eTag": "string"
}
],
"eTag": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"conversationDatasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationDatasetPersist"
},
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 200 OK
{
"id": "2510c5d2-fafa-4379-b1d3-36873282ad48",
"name": "string",
"user": {
"id": "aad0df26-789b-4555-be9b-3a84a6a09eaa",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "117fae34-bba9-4289-8e7c-e2904a37b704",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "4a820ae9-8d07-483a-8472-5ee673ff7b63",
"dataset": {
"id": "7b3161a9-fc3e-4753-a2e6-35d3a2b989ec",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 14,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "e983fb0a-a96f-46db-9757-e82333d71581",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 143,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 211,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 241,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "f6199841-0163-412f-9186-bdcd352d09bd",
"dataset": null,
"conversation": {
"id": "73476e6b-ff77-4c5e-8d72-97e0a6d413af",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "98a07ea7-cec3-496b-b604-fa9dc9b0fd2b",
"conversation": null,
"kind": 154,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"user": {
"$ref": "#/components/schemas/User"
},
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationDataset"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationMessage"
},
"nullable": true
},
"isActive": {
"$ref": "#/components/schemas/IsActive"
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/conversation/dataset/query¶
Query conversation datasets
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"ids": [
"82ee705a-4b06-433e-b511-62f8ce367ea6"
],
"excludedIds": [
"8c634fd4-7984-4a16-aece-14e000ecaab3"
],
"conversationIds": [
"95999f7a-3b21-4b98-825b-bd1827fc0a41"
],
"datasetIds": [
"89847f65-f44a-4b99-af56-b57fbc6dc5c7"
],
"isActive": [
213
],
"page": {
"offset": 0,
"size": 10
},
"order": {
"items": [
"+name",
"-id"
]
},
"metadata": {
"countAll": true
},
"project": {
"fields": [
"id",
"name",
"foo.id",
"foo.bar.id"
]
}
}
Schema of the request body
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"excludedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Exclude from the lookup items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"conversationIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items that have the specific conversation ids. If set, the list of ids must not be empty",
"nullable": true
},
"datasetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items that have the specific dataset ids. If set, the list of ids must not be empty",
"nullable": true
},
"isActive": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IsActive"
},
"description": "Limit lookup to items that are active, or inactive or both. If set, the list of flags must not be empty",
"nullable": true
},
"page": {
"$ref": "#/components/schemas/Paging"
},
"order": {
"$ref": "#/components/schemas/Ordering"
},
"metadata": {
"$ref": "#/components/schemas/Header"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"items": [
{
"id": "7043b964-0eec-45e8-8bc7-805053a82e12",
"dataset": {
"id": "85c097be-2a19-4eab-9240-02ba08a414d8",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 125,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "68ebc661-81f5-4ef6-bac2-6a482a9ced7e",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 242,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"conversation": {
"id": "d02f3af6-2ed1-4077-aa77-f3e7868e6aa9",
"name": "string",
"user": {
"id": "4d756329-4d43-4d42-b69c-b5a766a2ac5e",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "2ba233b5-57ca-4c13-83b4-b0f447c5f632",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "9862ed2f-8e71-4b73-81ba-b4f8bd50fd26",
"dataset": null,
"isActive": 247,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 278,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": null,
"messages": [
{
"id": "78053ec4-9691-4a32-8f35-51fffa9ac518",
"conversation": null,
"kind": 125,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"count": 190
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationDataset"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/conversation/dataset/me/query¶
Query user owned conversation datasets
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"ids": [
"11c71197-b042-448d-824d-4a930b98f523"
],
"excludedIds": [
"c8690a8e-bffd-4408-8e64-8d05b2b07737"
],
"conversationIds": [
"5b906a59-f5da-4bed-9da5-59d3e15e0f02"
],
"datasetIds": [
"9e6dafb3-3d12-44b5-af45-25ccd8a82f63"
],
"isActive": [
163
],
"page": {
"offset": 0,
"size": 10
},
"order": {
"items": [
"+name",
"-id"
]
},
"metadata": {
"countAll": true
},
"project": {
"fields": [
"id",
"name",
"foo.id",
"foo.bar.id"
]
}
}
Schema of the request body
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"excludedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Exclude from the lookup items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"conversationIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items that have the specific conversation ids. If set, the list of ids must not be empty",
"nullable": true
},
"datasetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items that have the specific dataset ids. If set, the list of ids must not be empty",
"nullable": true
},
"isActive": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IsActive"
},
"description": "Limit lookup to items that are active, or inactive or both. If set, the list of flags must not be empty",
"nullable": true
},
"page": {
"$ref": "#/components/schemas/Paging"
},
"order": {
"$ref": "#/components/schemas/Ordering"
},
"metadata": {
"$ref": "#/components/schemas/Header"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"items": [
{
"id": "777c5acd-d6a6-4b47-a95a-f01aa191eaf2",
"dataset": {
"id": "d0b28eb7-e50a-4860-9939-42df77b5937d",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 218,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "635ccece-589f-498d-a6f2-53b9f1789510",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 103,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"conversation": {
"id": "b47c93e8-bc17-47d7-a440-9fee93d530bb",
"name": "string",
"user": {
"id": "3e5df62e-a499-4ae7-87a9-b05596014407",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "e4d92117-c77a-40b8-be48-3175346916cf",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "fdd6a615-5fb3-48ac-af9d-75d5dd9eb4c2",
"dataset": null,
"isActive": 78,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 208,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": null,
"messages": [
{
"id": "95d1be83-930c-4154-a4e5-b9d1d28d1df6",
"conversation": null,
"kind": 21,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"count": 36
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationDataset"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
GET /api/conversation/dataset/{id}¶
Lookup conversation dataset by id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No | ||
id |
path | string | No | The id of the item to lookup |
Response 200 OK
{
"items": [
{
"id": "c5ad3f41-afa0-4089-a1f9-ff54b5a07954",
"dataset": {
"id": "1e51613e-eece-428a-9424-d34e0182e97b",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 31,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "5771efe5-2b42-4eb2-bfdb-cfd063c1181e",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 287,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"conversation": {
"id": "71427911-a2c5-4343-89fc-abd635c573a1",
"name": "string",
"user": {
"id": "6c9ab7d2-99a6-4846-acd3-e6c62ae554e4",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "2747a757-4205-4a00-827c-134177f740a6",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "e3491e74-2839-4ed4-a5ed-1e30225b7c2b",
"dataset": null,
"isActive": 90,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 66,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": null,
"messages": [
{
"id": "c1af30b3-f419-4b56-9a9c-c79c4dace02a",
"conversation": null,
"kind": 186,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"count": 43
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationDataset"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/conversation/dataset/me/{conversationId}/{datasetId}¶
Add dataset in owned conversation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
conversationId |
path | string | No | The conversation id to add the provided dataset | |
datasetId |
path | string | No | The dataset id to add the provided conversation | |
f |
query | array | No |
Response 200 OK
{
"id": "b4ed59fc-7a0d-46e9-8ee8-2f9ff563af38",
"name": "string",
"user": {
"id": "5e6db89b-94a1-4561-a34e-45cdbdf0f7cb",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "e643dead-9804-4d49-8658-683d4c563222",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "ab6e2e5d-ad5f-4a57-b82f-673e0ea33700",
"dataset": {
"id": "65f67889-54b6-42fe-8193-0e64879a721d",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 31,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "8e7c0f9b-262e-4db6-a129-96e799dc22c2",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 88,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 256,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 287,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "2986cec7-7cc8-4276-a44e-185df91a3900",
"dataset": null,
"conversation": {
"id": "8aab3d99-e26b-4bd3-9d56-beec4327b1bd",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "c77571dd-cd8f-4301-a637-2e6663256846",
"conversation": null,
"kind": 212,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"user": {
"$ref": "#/components/schemas/User"
},
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationDataset"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationMessage"
},
"nullable": true
},
"isActive": {
"$ref": "#/components/schemas/IsActive"
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
DELETE /api/conversation/dataset/me/{conversationId}/{datasetId}¶
Remove dataset from owned conversation
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
conversationId |
path | string | No | The conversation id from which to remove the provided dataset | |
datasetId |
path | string | No | The dataset id to remove from the provided conversation | |
f |
query | array | No |
Response 200 OK
{
"id": "2f3cca60-c5cf-4362-af9a-3a12725252bb",
"name": "string",
"user": {
"id": "d71d7f49-67fc-4b8e-b97f-a8aa61895bc5",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "92f7d635-1b02-4990-82b2-f6919ce1c897",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "72c90c09-ac3a-4061-8d36-bdfa0e349a4c",
"dataset": {
"id": "01754b31-80a8-4196-9056-05172ce4b7e4",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 30,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "4906b37e-031a-4f02-b88c-bbb500480ffe",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 232,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 179,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 117,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "da8ce652-c521-473b-a17e-049f972d1831",
"dataset": null,
"conversation": {
"id": "a28421d5-a62e-43a4-b066-7ad1a2e07907",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "6651d168-82c6-404b-9317-096f301272a7",
"conversation": null,
"kind": 28,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"user": {
"$ref": "#/components/schemas/User"
},
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationDataset"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationMessage"
},
"nullable": true
},
"isActive": {
"$ref": "#/components/schemas/IsActive"
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/conversation/message/query¶
Query conversation messages
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"ids": [
"2183e5a7-2933-4581-9946-7f28a579544b"
],
"excludedIds": [
"bfbb7e97-e0a3-4937-a054-703b3fdeae6f"
],
"conversationIds": [
"03687b71-2320-4303-a0fd-8fb2d3e3bf0e"
],
"kinds": [
62
],
"page": {
"offset": 0,
"size": 10
},
"order": {
"items": [
"+name",
"-id"
]
},
"metadata": {
"countAll": true
},
"project": {
"fields": [
"id",
"name",
"foo.id",
"foo.bar.id"
]
}
}
Schema of the request body
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"excludedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Exclude from the lookup items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"conversationIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items that have the specific conversation ids. If set, the list of ids must not be empty",
"nullable": true
},
"kinds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationMessageKind"
},
"description": "Limit lookup to items that have the specific kind. If set, the list of ids must not be empty",
"nullable": true
},
"page": {
"$ref": "#/components/schemas/Paging"
},
"order": {
"$ref": "#/components/schemas/Ordering"
},
"metadata": {
"$ref": "#/components/schemas/Header"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"items": [
{
"id": "af7eb87a-f22e-4d98-9ede-ca9b5e8f14fe",
"conversation": {
"id": "deec3af5-3c29-499a-a50d-344c4a64eaae",
"name": "string",
"user": {
"id": "1b9ee037-d863-4c39-96fc-538b3a321658",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "42e38049-d391-4318-b8bc-8a781a426655",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "1656627d-601c-4c3a-9595-69dd205bb166",
"dataset": {
"id": "7ad87d34-8bc4-4f8f-a36c-27d7c6e26d70",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 193,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "4963e2ef-0b3c-4b41-afa2-c7d8e5c30ec7",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 54,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 96,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 167,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "d94c18d9-12b4-48e7-97b8-9e64327b0bd5",
"dataset": null,
"conversation": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"kind": 231,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"count": 188
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationMessage"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/conversation/message/me/query¶
Query user owned conversation messages
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"ids": [
"e20f07da-3180-4a7c-96cb-779cd1f00748"
],
"excludedIds": [
"5653a7f9-20a2-44e2-a98e-c5e7cfb20c95"
],
"conversationIds": [
"f4e79307-1b2e-4dfc-a3e6-f817a4811359"
],
"kinds": [
15
],
"page": {
"offset": 0,
"size": 10
},
"order": {
"items": [
"+name",
"-id"
]
},
"metadata": {
"countAll": true
},
"project": {
"fields": [
"id",
"name",
"foo.id",
"foo.bar.id"
]
}
}
Schema of the request body
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"excludedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Exclude from the lookup items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"conversationIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items that have the specific conversation ids. If set, the list of ids must not be empty",
"nullable": true
},
"kinds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationMessageKind"
},
"description": "Limit lookup to items that have the specific kind. If set, the list of ids must not be empty",
"nullable": true
},
"page": {
"$ref": "#/components/schemas/Paging"
},
"order": {
"$ref": "#/components/schemas/Ordering"
},
"metadata": {
"$ref": "#/components/schemas/Header"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"items": [
{
"id": "807e9deb-8d7c-4d96-98e8-6a2bb4eb3dcc",
"conversation": {
"id": "e7772ec3-0b48-464e-a9e3-d0cd2a4489a9",
"name": "string",
"user": {
"id": "05224266-5f57-44da-b9e8-c4d0f4319dd0",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "36975895-7a51-43bc-b8b2-c2382426c299",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "f1794c69-22fd-47e0-9dae-4ce044842ead",
"dataset": {
"id": "1a2bd2c8-1c84-4ae4-beeb-5c46131a8d97",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 86,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "a96171a6-2216-4cfb-98b0-3b6578d5d90b",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 168,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 226,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 194,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "fc9bd777-1baf-4a98-8307-758afe35e536",
"dataset": null,
"conversation": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"kind": 295,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"count": 234
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConversationMessage"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
Dataset¶
POST /api/dataset/query¶
Query datasets
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"ids": [
"b86847d0-93a5-46f9-9de5-b409d6fa5111"
],
"excludedIds": [
"20c90745-3c31-49ee-a19f-893796c51ebd"
],
"collectionIds": [
"77f64356-7613-4289-ab1e-b6c6d98f8fc7"
],
"like": "string",
"license": "string",
"mimeType": "string",
"fieldsOfScience": [
"string"
],
"publishedRange": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"sizeRange": {
"start": 238,
"end": 124
},
"page": {
"offset": 0,
"size": 10
},
"order": {
"items": [
"+name",
"-id"
]
},
"metadata": {
"countAll": true
},
"project": {
"fields": [
"id",
"name",
"foo.id",
"foo.bar.id"
]
}
}
Schema of the request body
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"excludedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Exclude from the lookup items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"collectionIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items belonging to the specific collection ids. If set, the list of ids must not be empty",
"nullable": true
},
"like": {
"type": "string",
"description": "Limit lookup to items whose name matches the pattern",
"nullable": true
},
"license": {
"type": "string",
"description": "Limit lookup to items whose license matches the provided value",
"nullable": true
},
"mimeType": {
"type": "string",
"description": "Limit lookup to items whose mime type matches the provided value",
"nullable": true
},
"fieldsOfScience": {
"type": "array",
"items": {
"type": "string"
},
"description": "Limit lookup to items belonging to the specific fields of science. If set, the list of values must not be empty",
"nullable": true
},
"publishedRange": {
"$ref": "#/components/schemas/DateOnlyNullableRangeOf"
},
"sizeRange": {
"$ref": "#/components/schemas/Int64NullableRangeOf"
},
"page": {
"$ref": "#/components/schemas/Paging"
},
"order": {
"$ref": "#/components/schemas/Ordering"
},
"metadata": {
"$ref": "#/components/schemas/Header"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"items": [
{
"id": "6dbb8bc4-e31c-4e70-8d72-d53c0df61182",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 114,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "36af4650-b66e-4de5-9103-2ee4e18ca264",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 259,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"count": 260
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dataset"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
GET /api/dataset/{id}¶
Lookup dataset by id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No | ||
id |
path | string | No | The id of the item to lookup |
Response 200 OK
{
"items": [
{
"id": "8fa29314-9876-4b66-b3db-90397406dadf",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 283,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "54e0cc4f-13fb-4632-a554-adf3eb5b078a",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 52,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"count": 124
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dataset"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
Principal¶
GET /api/principal/me¶
Retrieve information for the logged in user
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No |
Response 200 OK
{
"isAuthenticated": true,
"principal": {
"subject": "string",
"name": "string",
"username": "string",
"givenName": "string",
"familyName": "string",
"email": "string"
},
"token": {
"client": "string",
"issuer": "string",
"tokenType": "string",
"authorizedParty": "string",
"audience": [
"string"
],
"expiresAt": "2022-04-13T15:42:05.901Z",
"issuedAt": "2022-04-13T15:42:05.901Z",
"scope": [
"string"
]
},
"roles": [
"string"
],
"permissions": [
"string"
],
"deferredPermissions": [
"string"
],
"datasets": [
"string"
],
"datasetGrants": [
{
"type": 246,
"code": "string",
"access": "string"
}
],
"more": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"isAuthenticated": {
"type": "boolean",
"nullable": true
},
"principal": {
"$ref": "#/components/schemas/PrincipalInfo"
},
"token": {
"$ref": "#/components/schemas/TokenInfo"
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"permissions": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"deferredPermissions": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"datasets": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"datasetGrants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatasetGrant"
},
"nullable": true
},
"more": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
}
Response 401 Unauthorized
Response 500 Internal Server Error
Search¶
POST /api/search/cross-dataset¶
Cross-dataset search
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"query": "string",
"resultCount": 113,
"conversationOptions": {
"conversationId": "fd005c0f-8177-4d9b-b88b-f3a43a71971f",
"autoCreateConversation": true,
"autoUpdateDatasets": true
},
"project": {
"fields": [
"id",
"name",
"foo.id",
"foo.bar.id"
]
}
}
Schema of the request body
{
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The user query for which datasets must be discovered",
"nullable": true
},
"resultCount": {
"type": "integer",
"description": "The number of results to retrieve for the query",
"format": "int32",
"nullable": true
},
"conversationOptions": {
"$ref": "#/components/schemas/ConversationOptions"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"result": [
{
"dataset": {
"id": "3519203e-6a89-49ce-a553-74b354a67f5e",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 139,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "46e3e2c4-8472-4dbb-8a94-68ef2d673a5b",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 83,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"maxSimilarity": 10.12,
"hits": [
{
"content": "string",
"objectId": "string",
"similarity": 10.12
}
]
}
],
"conversationId": "349782cd-910c-4485-bc54-f64ffed8a558"
}
Schema of the response body
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CrossDatasetDiscovery"
},
"nullable": true
},
"conversationId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/search/in-data-explore¶
Explore in selected data
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"query": "string",
"datasetIds": [
"e8fa2e63-c509-49f5-aac0-c46d4222dbd8"
],
"conversationOptions": {
"conversationId": "4b4638b7-ea95-444a-a6b1-c33f8cc55f0a",
"autoCreateConversation": true,
"autoUpdateDatasets": true
},
"project": {
"fields": [
"id",
"name",
"foo.id",
"foo.bar.id"
]
}
}
Schema of the request body
{
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "A string containing the user query in natural language. Cannot be empty.",
"nullable": true
},
"datasetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "The datasets to look into. Cannot be empty.",
"nullable": true
},
"conversationOptions": {
"$ref": "#/components/schemas/ConversationOptions"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"result": [
{
"question": "string",
"data": {},
"status": 110,
"entries": [
{
"process": {
"kind": 241
},
"result": {
"kind": 12,
"message": "string"
},
"status": 166
}
]
}
],
"conversationId": "f320f3b7-045c-4687-ba48-45815ec53a1a"
}
Schema of the response body
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InDataExplore"
},
"nullable": true
},
"conversationId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
User¶
POST /api/user/query¶
Query users
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"ids": [
"8d5ec49e-c134-455b-90ab-90738a9e9ebb"
],
"excludedIds": [
"0a5dd065-9879-4014-b940-94cefec368d8"
],
"idpSubjectIds": [
"string"
],
"like": "string",
"page": {
"offset": 0,
"size": 10
},
"order": {
"items": [
"+name",
"-id"
]
},
"metadata": {
"countAll": true
},
"project": {
"fields": [
"id",
"name",
"foo.id",
"foo.bar.id"
]
}
}
Schema of the request body
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"excludedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Exclude from the lookup items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"idpSubjectIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Limit lookup to items with specific subject identifiers as produced from the idp. If set, the list of ids must not be empty",
"nullable": true
},
"like": {
"type": "string",
"description": "Limit lookup to items whose name or email matches the pattern",
"nullable": true
},
"page": {
"$ref": "#/components/schemas/Paging"
},
"order": {
"$ref": "#/components/schemas/Ordering"
},
"metadata": {
"$ref": "#/components/schemas/Header"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"items": [
{
"id": "39af6220-1d1d-409e-b756-db031deb022a",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "dc51cf81-fb19-42fb-8337-68193a2052bd",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "2c59077c-4ed1-4372-ada6-4e50db60a591",
"dataset": {
"id": "c2fbe5b2-9b32-4910-8ecb-03a2e0afcfa5",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 276,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "cb202e88-64c5-4f83-8e3c-8730bfb3f815",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 271,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 28,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 103,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
}
],
"count": 146
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
GET /api/user/{id}¶
Lookup user by id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No | ||
id |
path | string | No | The id of the item to lookup |
Response 200 OK
{
"items": [
{
"id": "56b8b7fe-cd94-4226-bbb5-a6a4eabb3c7d",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "35b7c627-2ead-44a2-b263-2ab77fec5bd2",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "c7242981-5668-4b77-a676-d800db49f627",
"dataset": {
"id": "dc0d76b2-e30f-46bd-804a-eefefa13aa9b",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 63,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "d422ef07-1ba5-4630-b459-052e1519a639",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 31,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 224,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 96,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
}
],
"count": 174
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
UserCollection¶
POST /api/user/collection/query¶
Query user collections
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"ids": [
"1a35acd7-5a60-4f72-97dd-145934ce1a87"
],
"userIds": [
"08b04f03-9902-4fae-b44a-239beb4b9012"
],
"excludedIds": [
"f096726e-0d2a-488c-b30d-ae9a554f980b"
],
"isActive": [
257
],
"kind": [
155
],
"like": "string",
"page": {
"offset": 0,
"size": 10
},
"order": {
"items": [
"+name",
"-id"
]
},
"metadata": {
"countAll": true
},
"project": {
"fields": [
"id",
"name",
"foo.id",
"foo.bar.id"
]
}
}
Schema of the request body
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"userIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items belonging to specific user ids. If set, the list of ids must not be empty",
"nullable": true
},
"excludedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Exclude from the lookup items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"isActive": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IsActive"
},
"description": "Limit lookup to items that are active, or inactive or both. If set, the list of flags must not be empty",
"nullable": true
},
"kind": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollectionKind"
},
"description": "Limit lookup to items based on the collection kind. If set, the list of flags must not be empty",
"nullable": true
},
"like": {
"type": "string",
"description": "Limit lookup to items whose name or email matches the pattern",
"nullable": true
},
"page": {
"$ref": "#/components/schemas/Paging"
},
"order": {
"$ref": "#/components/schemas/Ordering"
},
"metadata": {
"$ref": "#/components/schemas/Header"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"items": [
{
"id": "4bb32b8a-4325-4625-8dba-d0af9450ce3e",
"name": "string",
"user": {
"id": "57b844f0-373e-4012-a82e-dc0fdb3d3dda",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": null,
"eTag": "string"
},
"userDatasetCollections": [
{
"id": "09a1a5f3-800a-4307-9fb7-3ab3a8f37fec",
"dataset": {
"id": "8c0a75d9-4248-4c38-99f8-6181f166378a",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 96,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "53db8ead-8585-4713-90e2-1dcc684b21d0",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 31,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 108,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 91,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"count": 117
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollection"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/user/collection/me/query¶
Query user owned collections
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"ids": [
"0286802c-8cf9-4cf0-9fcb-599c710142ee"
],
"userIds": [
"c25a15a1-1891-4434-81b8-6891c1b0934c"
],
"excludedIds": [
"0d88f749-2b6b-4508-9893-8cd341824663"
],
"isActive": [
4
],
"kind": [
296
],
"like": "string",
"page": {
"offset": 0,
"size": 10
},
"order": {
"items": [
"+name",
"-id"
]
},
"metadata": {
"countAll": true
},
"project": {
"fields": [
"id",
"name",
"foo.id",
"foo.bar.id"
]
}
}
Schema of the request body
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"userIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items belonging to specific user ids. If set, the list of ids must not be empty",
"nullable": true
},
"excludedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Exclude from the lookup items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"isActive": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IsActive"
},
"description": "Limit lookup to items that are active, or inactive or both. If set, the list of flags must not be empty",
"nullable": true
},
"kind": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollectionKind"
},
"description": "Limit lookup to items based on the collection kind. If set, the list of flags must not be empty",
"nullable": true
},
"like": {
"type": "string",
"description": "Limit lookup to items whose name or email matches the pattern",
"nullable": true
},
"page": {
"$ref": "#/components/schemas/Paging"
},
"order": {
"$ref": "#/components/schemas/Ordering"
},
"metadata": {
"$ref": "#/components/schemas/Header"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"items": [
{
"id": "2c60629b-3ec7-4836-a541-8cbd57c3290a",
"name": "string",
"user": {
"id": "976744bf-fc68-4622-ba13-91e0ae656d65",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": null,
"eTag": "string"
},
"userDatasetCollections": [
{
"id": "aacc7c76-00e3-4403-af72-48e28c7420f6",
"dataset": {
"id": "6322141c-5d9a-4b3a-bd9a-25f8bddb9238",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 22,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "428abba3-ad6d-4d91-88ce-a34354a0e716",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 177,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 195,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 246,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"count": 275
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollection"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
GET /api/user/collection/{id}¶
Lookup user collection by id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No | ||
id |
path | string | No | The id of the item to lookup |
Response 200 OK
{
"items": [
{
"id": "ab2ab1c5-3d90-4a99-914e-32dd87ae900f",
"name": "string",
"user": {
"id": "b7989508-479c-4c78-9d23-686171623469",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": null,
"eTag": "string"
},
"userDatasetCollections": [
{
"id": "71f02de1-bdd7-4a2f-a7a7-696593104ecf",
"dataset": {
"id": "3600d44b-3ecb-457c-a5ef-29fbc2c6d087",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 175,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "de37bb11-5bb5-4d0f-9a37-d88c5ad7560a",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 273,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 124,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 183,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"count": 23
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollection"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
DELETE /api/user/collection/{id}¶
Deletes the user collection by id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
id |
path | string | No | The id of the item to delete |
Response 200 OK
Response 400 Bad Request
Response 401 Unauthorized
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/user/collection/me/persist¶
Persist user owned collection
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No |
Request body
{
"id": "b64d21e3-3473-4560-979f-a3fe767182ae",
"name": "string",
"eTag": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 200 OK
{
"id": "8e371315-802c-4194-95b8-1f538c17e362",
"name": "string",
"user": {
"id": "9d2c16e0-4ff1-479e-b263-328debeeb844",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "50352c45-90b8-4b58-b978-2d37bc16b746",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "32e6c83d-08b6-4124-a72c-4fa97cae7d88",
"dataset": {
"id": "3e73c540-cdf8-406f-a9ec-5e65d98c4449",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 205,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "7df5c774-9de1-4a85-b49f-e35f3dc6e597",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 21,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 179,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 106,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"userDatasetCollections": null,
"isActive": null,
"kind": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"user": {
"$ref": "#/components/schemas/User"
},
"userDatasetCollections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDatasetCollection"
},
"nullable": true
},
"isActive": {
"$ref": "#/components/schemas/IsActive"
},
"kind": {
"$ref": "#/components/schemas/UserCollectionKind"
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/user/collection/me/persist/deep¶
Persist user owned collection along with details provided
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No |
Request body
{
"id": "143eb918-9b4e-4a74-b292-cd555d6890ae",
"name": "string",
"userDatasetCollections": [
{
"id": "4580effa-0c29-4891-9d4e-9bfe37a4834f",
"userCollectionId": "43e36080-bff5-4791-9a23-59b7312d0b95",
"datasetId": "a56463bd-4dec-4e7e-8af6-3ab53643aa28",
"eTag": "string"
}
],
"eTag": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"userDatasetCollections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDatasetCollectionPersist"
},
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 200 OK
{
"id": "14dda2e5-2a78-4d98-8e0f-2e0e501c5e60",
"name": "string",
"user": {
"id": "4ff6c926-00a0-4f7b-8037-61f45ddc9084",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "5a6b9901-4c6f-4371-aa13-ab5a9c1989f6",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "166cd5f8-46e0-42c1-9fdf-f9e3e67280ae",
"dataset": {
"id": "b71ba3ef-c9c9-4118-b440-e0861fafec0b",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 227,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "f5d3ca22-ce2f-4679-ae19-eca35a393665",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 263,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 126,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 191,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"userDatasetCollections": null,
"isActive": null,
"kind": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"user": {
"$ref": "#/components/schemas/User"
},
"userDatasetCollections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDatasetCollection"
},
"nullable": true
},
"isActive": {
"$ref": "#/components/schemas/IsActive"
},
"kind": {
"$ref": "#/components/schemas/UserCollectionKind"
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/user/collection/me/patch/dataset¶
Patch user owned collection with updated datasets
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No |
Request body
{
"id": "d5b88719-0fdd-4b89-96a3-b3cc0ea9775e",
"userDatasetCollections": [
{
"id": "30317291-dc75-4749-9806-b9749f23ceb9",
"userCollectionId": "e118ac63-1605-41af-ae41-4dcc23be378e",
"datasetId": "343c7091-5fb2-4429-a48d-4f0081751bb0",
"eTag": "string"
}
],
"eTag": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"userDatasetCollections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDatasetCollectionPersist"
},
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 200 OK
{
"id": "435c4567-fdc1-4f0b-a8af-53572f57f226",
"name": "string",
"user": {
"id": "3de0b5f4-6ff8-4219-a274-79cd96e8b0ac",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "2b550d8b-e971-4bc5-b989-871731ba3004",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "691bfd28-9cf9-424f-9c53-a2e4acb8bdb4",
"dataset": {
"id": "bdbb1148-c1a7-40f6-a767-f88a0156dd04",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 53,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "8899fa97-2028-40c0-b642-854638057716",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 170,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 139,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 80,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"userDatasetCollections": null,
"isActive": null,
"kind": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"user": {
"$ref": "#/components/schemas/User"
},
"userDatasetCollections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDatasetCollection"
},
"nullable": true
},
"isActive": {
"$ref": "#/components/schemas/IsActive"
},
"kind": {
"$ref": "#/components/schemas/UserCollectionKind"
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/user/collection/dataset/query¶
Query user collection datasets
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"ids": [
"c4335478-e023-4667-969f-f3d1fcc4509c"
],
"excludedIds": [
"23bc3fdf-4aaf-4fd6-bae1-1d6ae52ffecc"
],
"userCollectionIds": [
"234d03b0-97c1-497f-ace2-f12d6f0b0c25"
],
"datasetIds": [
"c81aec6a-0a8c-4b19-9261-9b64151fc4b8"
],
"isActive": [
73
],
"page": {
"offset": 0,
"size": 10
},
"order": {
"items": [
"+name",
"-id"
]
},
"metadata": {
"countAll": true
},
"project": {
"fields": [
"id",
"name",
"foo.id",
"foo.bar.id"
]
}
}
Schema of the request body
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"excludedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Exclude from the lookup items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"userCollectionIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items that have the specific user collection ids. If set, the list of ids must not be empty",
"nullable": true
},
"datasetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items that have the specific dataset ids. If set, the list of ids must not be empty",
"nullable": true
},
"isActive": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IsActive"
},
"description": "Limit lookup to items that are active, or inactive or both. If set, the list of flags must not be empty",
"nullable": true
},
"page": {
"$ref": "#/components/schemas/Paging"
},
"order": {
"$ref": "#/components/schemas/Ordering"
},
"metadata": {
"$ref": "#/components/schemas/Header"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"items": [
{
"id": "102feaf2-0660-4fc0-9b16-b5b9d1beea69",
"dataset": {
"id": "71ce90b1-255f-4e28-8b4c-cff042230dbb",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 60,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "80707d82-1c69-4d21-890c-e4f78aec47d7",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 178,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 13,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": {
"id": "8127efd9-4f28-4dc0-be53-09cfb9bb63af",
"name": "string",
"user": {
"id": "af909595-a320-45a2-a9ea-f671265c74a7",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": null,
"eTag": "string"
},
"userDatasetCollections": null,
"isActive": null,
"kind": 150,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"eTag": "string"
}
],
"count": 92
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDatasetCollection"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/user/collection/dataset/me/query¶
Query user owned collection datasets
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"ids": [
"09261740-b989-44f8-8544-558d25081cae"
],
"excludedIds": [
"5ed06b82-0702-4235-8ad8-7147f21b2938"
],
"userCollectionIds": [
"66569d37-f791-46a1-ac8e-01190acf4747"
],
"datasetIds": [
"944acee4-3111-481b-8406-e73bea2d8578"
],
"isActive": [
102
],
"page": {
"offset": 0,
"size": 10
},
"order": {
"items": [
"+name",
"-id"
]
},
"metadata": {
"countAll": true
},
"project": {
"fields": [
"id",
"name",
"foo.id",
"foo.bar.id"
]
}
}
Schema of the request body
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"excludedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Exclude from the lookup items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"userCollectionIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items that have the specific user collection ids. If set, the list of ids must not be empty",
"nullable": true
},
"datasetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items that have the specific dataset ids. If set, the list of ids must not be empty",
"nullable": true
},
"isActive": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IsActive"
},
"description": "Limit lookup to items that are active, or inactive or both. If set, the list of flags must not be empty",
"nullable": true
},
"page": {
"$ref": "#/components/schemas/Paging"
},
"order": {
"$ref": "#/components/schemas/Ordering"
},
"metadata": {
"$ref": "#/components/schemas/Header"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"items": [
{
"id": "3fa2b5b7-c277-46d3-b3f7-79bd41f6efa8",
"dataset": {
"id": "0c573ef4-8d54-49f6-9606-ead7aa2780fb",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 279,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "ed2f5488-d7ff-4819-a22e-5985ef2efae2",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 247,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 261,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": {
"id": "16756a87-79fe-4a1d-8409-445a140b9904",
"name": "string",
"user": {
"id": "ab2d4b5a-4f04-4263-99e1-055415d484ba",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": null,
"eTag": "string"
},
"userDatasetCollections": null,
"isActive": null,
"kind": 224,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"eTag": "string"
}
],
"count": 270
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDatasetCollection"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
GET /api/user/collection/dataset/{id}¶
Lookup user collection dataset by id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No | ||
id |
path | string | No | The id of the item to lookup |
Response 200 OK
{
"items": [
{
"id": "3fae0400-c790-41b8-9364-e5a938ef5577",
"dataset": {
"id": "831ad51e-5e3f-43c8-bce7-827cbc89f161",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 254,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "d62457a4-efa6-4461-96b0-df511f131cde",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 65,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 259,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": {
"id": "1ecc43d4-15ca-4bac-818b-061c62cb3511",
"name": "string",
"user": {
"id": "a2dd37ec-c7cd-4ed8-87de-8166951acf8d",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": null,
"eTag": "string"
},
"userDatasetCollections": null,
"isActive": null,
"kind": 120,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"eTag": "string"
}
],
"count": 254
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDatasetCollection"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/user/collection/dataset/me/{userCollectionId}/{datasetId}¶
Add dataset in owned user collection
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
datasetId |
path | string | No | The dataset id to add the provided user collection | |
f |
query | array | No | ||
userCollectionId |
path | string | No | The user collection id to add the provided dataset |
Response 200 OK
{
"id": "ff46696a-40c9-44cf-b74c-0e446fdf2a21",
"name": "string",
"user": {
"id": "642afada-2469-4b82-837d-a85a6f36fb64",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "6ca9af68-0fee-40f5-a722-7d54b4630fdd",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "f8589430-82b1-4fa8-b10a-6741b739e8ae",
"dataset": {
"id": "ac3ec957-26ac-4fca-8101-591b37b7fd04",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 45,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "3ac7056d-86a3-4db4-8e86-804fad3e9417",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 211,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 37,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 228,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"userDatasetCollections": null,
"isActive": null,
"kind": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"user": {
"$ref": "#/components/schemas/User"
},
"userDatasetCollections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDatasetCollection"
},
"nullable": true
},
"isActive": {
"$ref": "#/components/schemas/IsActive"
},
"kind": {
"$ref": "#/components/schemas/UserCollectionKind"
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
DELETE /api/user/collection/dataset/me/{userCollectionId}/{datasetId}¶
Remove dataset from owned user collection
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
datasetId |
path | string | No | The dataset id to remove from the provided user collection | |
f |
query | array | No | ||
userCollectionId |
path | string | No | The user collection id from which to remove the provided dataset |
Response 200 OK
{
"id": "50e2db8b-7981-4707-bbe7-e4f997081ebe",
"name": "string",
"user": {
"id": "85fdcbc7-bed5-43c4-8d20-cb0a6896597b",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "de77d1fd-a399-47eb-aa4a-25d4c86af163",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "aa08ea34-5871-4a5c-881f-7fe4305c2cb8",
"dataset": {
"id": "506b95e3-d7a9-49af-804b-7d784542aff5",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 106,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "705ba199-a971-4d0d-9513-7fb727b2e8ff",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 220,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 255,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 179,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"userDatasetCollections": null,
"isActive": null,
"kind": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"user": {
"$ref": "#/components/schemas/User"
},
"userDatasetCollections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDatasetCollection"
},
"nullable": true
},
"isActive": {
"$ref": "#/components/schemas/IsActive"
},
"kind": {
"$ref": "#/components/schemas/UserCollectionKind"
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
VersionInfo¶
GET /api/version-info/current¶
Retrieve current app version
Response 200 OK
{
"items": [
{
"key": "string",
"version": "string",
"releasedAt": "2022-04-13T15:42:05.901Z",
"deployedAt": "2022-04-13T15:42:05.901Z",
"description": "string"
}
],
"count": 224
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VersionInfo"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 404 Not Found
Response 500 Internal Server Error
Vocabulary¶
GET /api/vocabulary/fields-of-science¶
Returns the fields of science vocabulary
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Response 200 OK
{
"hierarchy": [
{
"ordinal": 222,
"code": "string",
"name": "string",
"children": null
}
]
}
Schema of the response body
{
"type": "object",
"properties": {
"hierarchy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VocabularyItem"
},
"nullable": true
}
},
"additionalProperties": false
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
GET /api/vocabulary/license¶
Returns the license vocabulary
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
like |
query | string | No |
Response 200 OK
{
"licenses": [
{
"name": "string",
"url": [
"string"
],
"code": "string"
}
]
}
Schema of the response body
{
"type": "object",
"properties": {
"licenses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/License"
},
"nullable": true
}
},
"additionalProperties": false
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Workflow¶
GET /api/workflow/definition/query¶
Retrieve the available workflow definitions
Request body
{
"kinds": [
86
],
"like": "string",
"excludeStaled": true,
"includePaused": true,
"lastRunState": 149,
"runStartRange": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"runEndRange": null,
"runState": null,
"page": {
"offset": 0,
"size": 10
},
"order": {
"items": [
"+name",
"-id"
]
},
"metadata": {
"countAll": true
},
"project": {
"fields": [
"id",
"name",
"foo.id",
"foo.bar.id"
]
}
}
Schema of the request body
{
"type": "object",
"properties": {
"kinds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowDefinitionKind"
},
"description": "Limit lookup to items with specific kinds. If set, the list of values must not be empty",
"nullable": true
},
"like": {
"type": "string",
"description": "Limit lookup to items whose name matches the pattern",
"nullable": true
},
"excludeStaled": {
"type": "boolean",
"description": "Limit lookup to items that are or are not staled",
"nullable": true
},
"includePaused": {
"type": "boolean",
"description": "Limit lookup to items that are or are not paused",
"nullable": true
},
"lastRunState": {
"$ref": "#/components/schemas/WorkflowRunState"
},
"runStartRange": {
"$ref": "#/components/schemas/DateOnlyNullableRangeOf"
},
"runEndRange": {
"$ref": "#/components/schemas/DateOnlyNullableRangeOf"
},
"runState": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowRunState"
},
"description": "Limit lookup to items who are at a specific state. If set, the list of values must not be empty",
"nullable": true
},
"page": {
"$ref": "#/components/schemas/Paging"
},
"order": {
"$ref": "#/components/schemas/Ordering"
},
"metadata": {
"$ref": "#/components/schemas/Header"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"items": [
{
"id": "string",
"name": "string",
"isPaused": true,
"isStale": true,
"lastParsedTime": "2022-04-13T15:42:05.901Z",
"lastExpired": "2022-04-13T15:42:05.901Z",
"bundleName": "string",
"bundleVersion": "string",
"relativeFileLocation": "string",
"fileLocation": "string",
"fileToken": "string",
"description": "string",
"timetableSummary": "string",
"timetableDescription": "string",
"tags": [
"string"
],
"maxActiveTasks": 129,
"maxActiveRuns": 253,
"maxConsecutiveFailedRuns": 126,
"hasTaskConcurrencyLimits": true,
"hasImportErrors": true,
"nextLogicalDate": "2022-04-13T15:42:05.901Z",
"nextDataIntervalStart": "2022-04-13T15:42:05.901Z",
"nextDataIntervalEnd": "2022-04-13T15:42:05.901Z",
"nextRunAfter": "2022-04-13T15:42:05.901Z",
"owners": [
"string"
]
}
],
"count": 113
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowDefinition"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
GET /api/workflow/{id}¶
Lookup workflow definition by id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No | ||
id |
path | string | No | The id of the item to lookup |
Response 200 OK
{
"items": [
{
"id": "string",
"name": "string",
"isPaused": true,
"isStale": true,
"lastParsedTime": "2022-04-13T15:42:05.901Z",
"lastExpired": "2022-04-13T15:42:05.901Z",
"bundleName": "string",
"bundleVersion": "string",
"relativeFileLocation": "string",
"fileLocation": "string",
"fileToken": "string",
"description": "string",
"timetableSummary": "string",
"timetableDescription": "string",
"tags": [
"string"
],
"maxActiveTasks": 31,
"maxActiveRuns": 81,
"maxConsecutiveFailedRuns": 193,
"hasTaskConcurrencyLimits": true,
"hasImportErrors": true,
"nextLogicalDate": "2022-04-13T15:42:05.901Z",
"nextDataIntervalStart": "2022-04-13T15:42:05.901Z",
"nextDataIntervalEnd": "2022-04-13T15:42:05.901Z",
"nextRunAfter": "2022-04-13T15:42:05.901Z",
"owners": [
"string"
]
}
],
"count": 81
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowDefinition"
},
"nullable": true
},
"count": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 400 Bad Request
Response 401 Unauthorized
Response 404 Not Found
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
Schemas¶
Account¶
| Name | Type |
|---|---|
datasetGrants |
Array<DatasetGrant> |
datasets |
Array<string> |
deferredPermissions |
Array<string> |
isAuthenticated |
boolean| null |
more |
|
permissions |
Array<string> |
principal |
PrincipalInfo |
roles |
Array<string> |
token |
TokenInfo |
Collection¶
| Name | Type |
|---|---|
code |
string| null |
datasetCount |
integer(int32)| null |
datasets |
Array<Dataset> |
id |
string(uuid)| null |
name |
string| null |
permissions |
Array<string> |
CollectionLookup¶
| Name | Type |
|---|---|
datasetIds |
Array<string(uuid)> |
excludedIds |
Array<string(uuid)> |
ids |
Array<string(uuid)> |
like |
string| null |
metadata |
Header |
order |
Ordering |
page |
Paging |
project |
FieldSet |
CollectionQueryResult¶
| Name | Type |
|---|---|
count |
integer(int32) |
items |
Array<Collection> |
Conversation¶
| Name | Type |
|---|---|
createdAt |
string(date-time)| null |
datasets |
Array<ConversationDataset> |
eTag |
string| null |
id |
string(uuid)| null |
isActive |
IsActive |
messages |
Array<ConversationMessage> |
name |
string| null |
updatedAt |
string(date-time)| null |
user |
User |
ConversationDataset¶
| Name | Type |
|---|---|
conversation |
Conversation |
createdAt |
string(date-time)| null |
dataset |
Dataset |
eTag |
string| null |
id |
string(uuid)| null |
isActive |
IsActive |
updatedAt |
string(date-time)| null |
ConversationDatasetLookup¶
| Name | Type |
|---|---|
conversationIds |
Array<string(uuid)> |
datasetIds |
Array<string(uuid)> |
excludedIds |
Array<string(uuid)> |
ids |
Array<string(uuid)> |
isActive |
Array<IsActive> |
metadata |
Header |
order |
Ordering |
page |
Paging |
project |
FieldSet |
ConversationDatasetPatch¶
| Name | Type |
|---|---|
conversationDatasets |
Array<ConversationDatasetPersist> |
eTag |
string| null |
id |
string(uuid)| null |
ConversationDatasetPersist¶
| Name | Type |
|---|---|
conversationId |
string(uuid)| null |
datasetId |
string(uuid)| null |
eTag |
string| null |
id |
string(uuid)| null |
ConversationDatasetQueryResult¶
| Name | Type |
|---|---|
count |
integer(int32) |
items |
Array<ConversationDataset> |
ConversationEntry¶
| Name | Type |
|---|---|
kind |
ConversationMessageKind |
version |
string| null |
ConversationLookup¶
| Name | Type |
|---|---|
excludedIds |
Array<string(uuid)> |
ids |
Array<string(uuid)> |
isActive |
Array<IsActive> |
like |
string| null |
metadata |
Header |
order |
Ordering |
page |
Paging |
project |
FieldSet |
userIds |
Array<string(uuid)> |
ConversationMessage¶
| Name | Type |
|---|---|
conversation |
Conversation |
createdAt |
string(date-time)| null |
data |
ConversationEntry |
id |
string(uuid)| null |
kind |
ConversationMessageKind |
ConversationMessageKind¶
Type: integer(int32)
ConversationMessageLookup¶
| Name | Type |
|---|---|
conversationIds |
Array<string(uuid)> |
excludedIds |
Array<string(uuid)> |
ids |
Array<string(uuid)> |
kinds |
Array<ConversationMessageKind> |
metadata |
Header |
order |
Ordering |
page |
Paging |
project |
FieldSet |
ConversationMessageQueryResult¶
| Name | Type |
|---|---|
count |
integer(int32) |
items |
Array<ConversationMessage> |
ConversationOptions¶
| Name | Type |
|---|---|
autoCreateConversation |
boolean| null |
autoUpdateDatasets |
boolean| null |
conversationId |
string(uuid)| null |
ConversationPersist¶
| Name | Type |
|---|---|
eTag |
string| null |
id |
string(uuid)| null |
name |
string| null |
ConversationPersistDeep¶
| Name | Type |
|---|---|
conversationDatasets |
Array<ConversationDatasetPersist> |
eTag |
string| null |
id |
string(uuid)| null |
name |
string| null |
ConversationQueryResult¶
| Name | Type |
|---|---|
count |
integer(int32) |
items |
Array<Conversation> |
CrossDatasetDiscovery¶
| Name | Type |
|---|---|
dataset |
Dataset |
hits |
Array<DatasetHits> |
maxSimilarity |
number(double)| null |
CrossDatasetDiscoveryListSearchResult¶
| Name | Type |
|---|---|
conversationId |
string(uuid)| null |
result |
Array<CrossDatasetDiscovery> |
CrossDatasetDiscoveryLookup¶
| Name | Type |
|---|---|
conversationOptions |
ConversationOptions |
project |
FieldSet |
query |
string| null |
resultCount |
integer(int32)| null |
Dataset¶
| Name | Type |
|---|---|
code |
string| null |
collections |
Array<Collection> |
country |
Array<string> |
datePublished |
string(date)| null |
description |
string| null |
fieldOfScience |
Array<string> |
headline |
string| null |
id |
string(uuid)| null |
keywords |
Array<string> |
language |
Array<string> |
license |
string| null |
mimeType |
string| null |
name |
string| null |
permissions |
Array<string> |
profileRaw |
string| null |
size |
integer(int64)| null |
url |
string| null |
version |
string| null |
DatasetGrant¶
| Name | Type |
|---|---|
access |
string| null |
code |
string| null |
type |
TargetType |
DatasetHits¶
| Name | Type |
|---|---|
content |
string| null |
objectId |
string| null |
similarity |
number(double)| null |
DatasetLookup¶
| Name | Type |
|---|---|
collectionIds |
Array<string(uuid)> |
excludedIds |
Array<string(uuid)> |
fieldsOfScience |
Array<string> |
ids |
Array<string(uuid)> |
license |
string| null |
like |
string| null |
metadata |
Header |
mimeType |
string| null |
order |
Ordering |
page |
Paging |
project |
FieldSet |
publishedRange |
DateOnlyNullableRangeOf |
sizeRange |
Int64NullableRangeOf |
DatasetQueryResult¶
| Name | Type |
|---|---|
count |
integer(int32) |
items |
Array<Dataset> |
DateOnlyNullableRangeOf¶
| Name | Type |
|---|---|
end |
string(date)| null |
start |
string(date)| null |
EntryStatus¶
Type: integer(int32)
FieldSet¶
| Name | Type |
|---|---|
fields |
Array<string> |
FieldsOfScienceVocabulary¶
| Name | Type |
|---|---|
hierarchy |
Array<VocabularyItem> |
Header¶
| Name | Type |
|---|---|
countAll |
boolean |
InDataExplorationLookup¶
| Name | Type |
|---|---|
conversationOptions |
ConversationOptions |
datasetIds |
Array<string(uuid)> |
project |
FieldSet |
query |
string| null |
InDataExplore¶
| Name | Type |
|---|---|
data |
|
entries |
Array<InDataExploreEntry> |
question |
string| null |
status |
ResponseStatus |
InDataExploreEntry¶
| Name | Type |
|---|---|
process |
InDataExploreProcessEntry |
result |
InDataExploreResultEntry |
status |
EntryStatus |
InDataExploreListSearchResult¶
| Name | Type |
|---|---|
conversationId |
string(uuid)| null |
result |
Array<InDataExplore> |
InDataExploreProcessEntry¶
| Name | Type |
|---|---|
kind |
InDataExploreProcessKind |
InDataExploreProcessKind¶
Type: integer(int32)
InDataExploreResultEntry¶
| Name | Type |
|---|---|
kind |
InDataExploreResultKind |
message |
string| null |
InDataExploreResultKind¶
Type: integer(int32)
Int64NullableRangeOf¶
| Name | Type |
|---|---|
end |
integer(int64)| null |
start |
integer(int64)| null |
IsActive¶
Type: integer(int32)
License¶
| Name | Type |
|---|---|
code |
string| null |
name |
string| null |
url |
Array<string> |
LicenseVocabulary¶
| Name | Type |
|---|---|
licenses |
Array<License> |
Ordering¶
| Name | Type |
|---|---|
isEmpty |
boolean |
items |
Array<string> |
Paging¶
| Name | Type |
|---|---|
isEmpty |
boolean |
offset |
integer(int32) |
size |
integer(int32) |
PrincipalInfo¶
| Name | Type |
|---|---|
email |
string| null |
familyName |
string| null |
givenName |
string| null |
name |
string| null |
subject |
string| null |
username |
string| null |
ResponseStatus¶
Type: integer(int32)
TargetType¶
Type: integer(int32)
TokenInfo¶
| Name | Type |
|---|---|
audience |
Array<string> |
authorizedParty |
string| null |
client |
string| null |
expiresAt |
string(date-time)| null |
issuedAt |
string(date-time)| null |
issuer |
string| null |
scope |
Array<string> |
tokenType |
string| null |
User¶
| Name | Type |
|---|---|
createdAt |
string(date-time)| null |
email |
string| null |
eTag |
string| null |
id |
string(uuid)| null |
idpSubjectId |
string| null |
name |
string| null |
updatedAt |
string(date-time)| null |
userCollections |
Array<UserCollection> |
UserCollection¶
| Name | Type |
|---|---|
createdAt |
string(date-time)| null |
eTag |
string| null |
id |
string(uuid)| null |
isActive |
IsActive |
kind |
UserCollectionKind |
name |
string| null |
updatedAt |
string(date-time)| null |
user |
User |
userDatasetCollections |
Array<UserDatasetCollection> |
UserCollectionDatasetPatch¶
| Name | Type |
|---|---|
eTag |
string| null |
id |
string(uuid)| null |
userDatasetCollections |
Array<UserDatasetCollectionPersist> |
UserCollectionKind¶
Type: integer(int32)
UserCollectionLookup¶
| Name | Type |
|---|---|
excludedIds |
Array<string(uuid)> |
ids |
Array<string(uuid)> |
isActive |
Array<IsActive> |
kind |
Array<UserCollectionKind> |
like |
string| null |
metadata |
Header |
order |
Ordering |
page |
Paging |
project |
FieldSet |
userIds |
Array<string(uuid)> |
UserCollectionPersist¶
| Name | Type |
|---|---|
eTag |
string| null |
id |
string(uuid)| null |
name |
string| null |
UserCollectionPersistDeep¶
| Name | Type |
|---|---|
eTag |
string| null |
id |
string(uuid)| null |
name |
string| null |
userDatasetCollections |
Array<UserDatasetCollectionPersist> |
UserCollectionQueryResult¶
| Name | Type |
|---|---|
count |
integer(int32) |
items |
Array<UserCollection> |
UserDatasetCollection¶
| Name | Type |
|---|---|
createdAt |
string(date-time)| null |
dataset |
Dataset |
eTag |
string| null |
id |
string(uuid)| null |
isActive |
IsActive |
updatedAt |
string(date-time)| null |
userCollection |
UserCollection |
UserDatasetCollectionLookup¶
| Name | Type |
|---|---|
datasetIds |
Array<string(uuid)> |
excludedIds |
Array<string(uuid)> |
ids |
Array<string(uuid)> |
isActive |
Array<IsActive> |
metadata |
Header |
order |
Ordering |
page |
Paging |
project |
FieldSet |
userCollectionIds |
Array<string(uuid)> |
UserDatasetCollectionPersist¶
| Name | Type |
|---|---|
datasetId |
string(uuid)| null |
eTag |
string| null |
id |
string(uuid)| null |
userCollectionId |
string(uuid)| null |
UserDatasetCollectionQueryResult¶
| Name | Type |
|---|---|
count |
integer(int32) |
items |
Array<UserDatasetCollection> |
UserLookup¶
| Name | Type |
|---|---|
excludedIds |
Array<string(uuid)> |
idpSubjectIds |
Array<string> |
ids |
Array<string(uuid)> |
like |
string| null |
metadata |
Header |
order |
Ordering |
page |
Paging |
project |
FieldSet |
UserQueryResult¶
| Name | Type |
|---|---|
count |
integer(int32) |
items |
Array<User> |
VersionInfo¶
| Name | Type |
|---|---|
deployedAt |
string(date-time)| null |
description |
string| null |
key |
string| null |
releasedAt |
string(date-time)| null |
version |
string| null |
VersionInfoQueryResult¶
| Name | Type |
|---|---|
count |
integer(int32) |
items |
Array<VersionInfo> |
VocabularyItem¶
| Name | Type |
|---|---|
children |
Array<VocabularyItem> |
code |
string| null |
name |
string| null |
ordinal |
integer(int32) |
WorkflowDefinition¶
| Name | Type |
|---|---|
bundleName |
string| null |
bundleVersion |
string| null |
description |
string| null |
fileLocation |
string| null |
fileToken |
string| null |
hasImportErrors |
boolean| null |
hasTaskConcurrencyLimits |
boolean| null |
id |
string| null |
isPaused |
boolean| null |
isStale |
boolean| null |
lastExpired |
string(date-time)| null |
lastParsedTime |
string(date-time)| null |
maxActiveRuns |
integer(int32)| null |
maxActiveTasks |
integer(int32)| null |
maxConsecutiveFailedRuns |
integer(int32)| null |
name |
string| null |
nextDataIntervalEnd |
string(date-time)| null |
nextDataIntervalStart |
string(date-time)| null |
nextLogicalDate |
string(date-time)| null |
nextRunAfter |
string(date-time)| null |
owners |
Array<string> |
relativeFileLocation |
string| null |
tags |
Array<string> |
timetableDescription |
string| null |
timetableSummary |
string| null |
WorkflowDefinitionKind¶
Type: integer(int32)
WorkflowDefinitionLookup¶
| Name | Type |
|---|---|
excludeStaled |
boolean| null |
includePaused |
boolean| null |
kinds |
Array<WorkflowDefinitionKind> |
lastRunState |
WorkflowRunState |
like |
string| null |
metadata |
Header |
order |
Ordering |
page |
Paging |
project |
FieldSet |
runEndRange |
DateOnlyNullableRangeOf |
runStartRange |
DateOnlyNullableRangeOf |
runState |
Array<WorkflowRunState> |
WorkflowDefinitionQueryResult¶
| Name | Type |
|---|---|
count |
integer(int32) |
items |
Array<WorkflowDefinition> |
WorkflowRunState¶
Type: integer(int32)
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| oauth2 | oauth2 |