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
Collection¶
POST /api/collection/query¶
Query collections
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"ids": [
"2231de64-be10-4766-bdb7-943fd7ef623d"
],
"excludedIds": [
"493b05ac-7380-4e81-b1d9-f330aa89eeda"
],
"datasetIds": [
"0bedfa92-b16f-4972-a75d-c5ef51cd76b7"
],
"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": "fa9884be-6950-4bb7-ab49-f5036cf86b80",
"code": "string",
"name": "string",
"datasets": [
{
"id": "11762319-f55d-4c4c-97ec-630b2c4fb235",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 165,
"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": 240,
"permissions": [
"string"
]
}
],
"count": 141
}
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": "61132711-7094-40e8-947e-707f516b54d9",
"code": "string",
"name": "string",
"datasets": [
{
"id": "ea06fe52-f845-4b4e-a776-d19c47dc7205",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 82,
"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": 130,
"permissions": [
"string"
]
}
],
"count": 236
}
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
DELETE /api/collection/{id}¶
Deletes the 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/collection/persist¶
Persist collection
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No |
Request body
{
"id": "5e2d3578-0ae8-4954-bbc6-115a84c2b1c0",
"code": "string",
"name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 200 OK
{
"id": "5e00f2e1-b869-4582-83bf-5ceb4f1d289d",
"code": "string",
"name": "string",
"datasets": [
{
"id": "3fa42010-7b09-4d1d-8040-79d404820cb3",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 10,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "3f1f4a92-90a8-4bcf-bbdf-4466540525cd",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 144,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"datasetCount": 95,
"permissions": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dataset"
},
"nullable": true
},
"datasetCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"permissions": {
"type": "array",
"items": {
"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/collection/persist/deep¶
Persist 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": "f919f6d7-b7cc-4dab-91e5-00cd345d7841",
"code": "string",
"name": "string",
"datasets": [
"69e36885-146b-44e0-9835-e77647b3bd7f"
]
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"datasets": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
}
},
"additionalProperties": false
}
Response 200 OK
{
"id": "bee50e38-631d-460f-a43d-f476d153a154",
"code": "string",
"name": "string",
"datasets": [
{
"id": "6197737c-6989-4c23-942d-34a705900013",
"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": "0547aad3-fb5d-4cfd-883d-5f963b4f49a2",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 73,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"datasetCount": 273,
"permissions": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dataset"
},
"nullable": true
},
"datasetCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"permissions": {
"type": "array",
"items": {
"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/collection/patch/dataset¶
Patch 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": "75848761-6274-4e44-90a9-ffe5cc6b545a",
"datasets": [
"4c0fdbee-0c93-41e0-bc5d-e333e30ed045"
]
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"datasets": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
}
},
"additionalProperties": false
}
Response 200 OK
{
"id": "434db8bb-bb80-4790-a668-9a8ab49b52a6",
"code": "string",
"name": "string",
"datasets": [
{
"id": "17c6786f-4b7a-4fc5-a636-6070ee1bc36f",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 181,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "e10c6f27-6606-44d2-b9b9-c1c1626ad287",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 205,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"datasetCount": 179,
"permissions": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dataset"
},
"nullable": true
},
"datasetCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"permissions": {
"type": "array",
"items": {
"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/collection/{collectionId}/dataset/{datasetId}¶
Add dataset in collection
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
collectionId |
path | string | No | The collection id to add the provided dataset | |
datasetId |
path | string | No | The dataset id to add the provided collection | |
f |
query | array | No |
Response 200 OK
{
"id": "e8a72fac-dcda-49cf-b598-d5b901410417",
"code": "string",
"name": "string",
"datasets": [
{
"id": "248b6750-a1c3-417b-abfa-3d14b7c4ce5f",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 179,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "571edede-3a05-403e-a89d-ee73ac795c35",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 189,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"datasetCount": 141,
"permissions": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dataset"
},
"nullable": true
},
"datasetCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"permissions": {
"type": "array",
"items": {
"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/collection/{collectionId}/dataset/{datasetId}¶
Remove dataset from collection
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
collectionId |
path | string | No | The collection id from which to remove the provided dataset | |
datasetId |
path | string | No | The dataset id to remove from the provided collection | |
f |
query | array | No |
Response 200 OK
{
"id": "19804ae5-301b-4b08-98a2-5526424050ed",
"code": "string",
"name": "string",
"datasets": [
{
"id": "101c13e9-b7c0-4225-b62b-6df1e306ecb8",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 296,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "2d472879-ec76-4f27-8de9-b06de94e9aab",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 260,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"datasetCount": 3,
"permissions": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dataset"
},
"nullable": true
},
"datasetCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"permissions": {
"type": "array",
"items": {
"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
Conversation¶
POST /api/conversation/query¶
Query conversations
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"ids": [
"1e6a4541-9da9-4dac-8f6f-4fe3b9af3b7a"
],
"userIds": [
"381c2e68-5f4e-426e-a07d-44c8a6565e25"
],
"excludedIds": [
"068505e6-b4a4-459f-a10b-c2dd17935322"
],
"isActive": [
51
],
"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": "cab3af7d-7189-4da0-8dbf-77eead7fc832",
"name": "string",
"user": {
"id": "53696548-cfb1-4610-bb24-100735c29604",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "e88d785b-26fe-4cda-9bae-338469f803c5",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "c5f3acb5-6e47-46cc-a525-a5c1f1a0d106",
"dataset": {
"id": "e148ceab-275c-4fcf-8ef9-c9a6bd93fe60",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 43,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "a8abd261-8e44-4cac-80b4-947cc279977e",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 234,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 285,
"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"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "b9f48b52-6744-4a78-8814-d9ac5c32b5a9",
"dataset": null,
"conversation": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": [
{
"id": "479c9810-9d34-473e-b2d4-8241ee780930",
"conversation": null,
"kind": 250,
"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": 282
}
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": [
"9d83f334-bf71-41cd-aaf5-470a85e31bb4"
],
"userIds": [
"3a3d187e-62a2-4f48-a61f-837d306b5b94"
],
"excludedIds": [
"88c7882f-05ef-4a03-b65c-eccc0f1b159d"
],
"isActive": [
219
],
"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": "cfa150c2-6cb4-44a3-8485-40d133dabe13",
"name": "string",
"user": {
"id": "8f12f652-5c1e-496b-8be2-6994b9b81c9d",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "cb48b0c5-dae0-4ce1-bcc2-8c1dfed7569f",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "36360b5d-3f57-4c3c-8cd2-4d103a16fa4b",
"dataset": {
"id": "6820ac6b-af95-497d-ace8-825a11741852",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 157,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "9318cd2d-ef8c-42e0-b21b-54607e99f775",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 278,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 257,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 19,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "b8306a94-9bbf-408e-8e63-7f6a7f48c291",
"dataset": null,
"conversation": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": [
{
"id": "636fa3bf-2108-4c79-a4fb-b14f0a1180bc",
"conversation": null,
"kind": 134,
"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": 112
}
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": "09eb8278-7deb-4a26-a298-a5d79f875433",
"name": "string",
"user": {
"id": "9e4e6ea6-7232-4077-87c3-fcf3c21e92a3",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "ee1925f8-3298-4429-b0e4-377cee6370bc",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "6c47cf6b-f426-41a8-8dfb-e6090ac04e18",
"dataset": {
"id": "1b29c1c2-5d5f-4357-ac05-fd7d4f89f712",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 269,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "e79b872b-2b4e-4e59-91a7-c2a202b9d277",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 96,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 175,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 43,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "a869e638-3734-44c0-be34-0231da78e237",
"dataset": null,
"conversation": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": [
{
"id": "bb5b745c-be1f-4a94-b9b1-14ece713e883",
"conversation": null,
"kind": 205,
"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": 39
}
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": "9d828a3c-b82b-42ac-9f3c-f01d71bf30b8",
"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": "93e74c53-b9c7-44ca-bc1e-1413fb98e33e",
"name": "string",
"user": {
"id": "41cb0fbf-5505-45f2-80d6-55882b2b7047",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "a55b26dc-8e3b-41c6-9ac0-46ec18369542",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "d8bb35e9-c907-4174-806f-eb0afd0f7135",
"dataset": {
"id": "b26434d5-1fd0-4691-9210-362f17164d29",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 289,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "699d4490-eab8-47e3-a002-2b32f511ee64",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 235,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 21,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 64,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "cd40d6cd-7670-4189-8c70-b59d5a04e645",
"dataset": null,
"conversation": {
"id": "ae3ef6ed-ad44-4ef5-90fe-241ba03b6fb8",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "6e01aaf8-3ab1-4da5-b88e-bf007692c483",
"conversation": null,
"kind": 285,
"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": "8b8b8b50-b2dd-4473-91cf-54296756cffa",
"name": "string",
"conversationDatasets": [
{
"id": "34362c77-f2c2-42cc-96b6-3635341527f9",
"conversationId": "0eee0262-e422-4c8c-bde5-033489ad169b",
"datasetId": "9b0b849e-be35-4bbc-bc6d-3b30ac4ba3f7",
"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": "59180389-9c68-4115-b6aa-46802af6fa05",
"name": "string",
"user": {
"id": "8240cf0d-b8c5-455d-b9ab-0d0728478d4e",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "9d23639b-6cfd-43b9-bd3b-ee58e76abc53",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "d56677cc-e34d-418d-bbf0-38e488369cad",
"dataset": {
"id": "02f8a969-dc26-48a0-a708-e13784ba35da",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 174,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "13666116-4e3c-482c-b1dc-066f18bd3de6",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 81,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 260,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 110,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "56e31b2b-969f-4e9e-b76d-3defabf408e7",
"dataset": null,
"conversation": {
"id": "d9885be3-d5ae-4561-b5d7-3a818afd56f7",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "20f88686-0e8b-412f-bf9c-4c8cf46555bc",
"conversation": null,
"kind": 292,
"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": "6110b034-decc-40fc-ab4f-dcdd5cdf2a86",
"conversationDatasets": [
{
"id": "250603a7-5e5b-4ebe-952d-84e039abc600",
"conversationId": "f977211b-621d-4661-84fe-8a5d38d7cb64",
"datasetId": "5ce7e31c-4617-4c4a-b016-21e05810de20",
"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": "80950756-6037-4f32-b04a-9527070465d0",
"name": "string",
"user": {
"id": "0dc57293-d959-4d37-8465-d421069d1aec",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "a31162fe-a3c8-4438-9a56-8107692b675b",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "7e433d89-211f-4a1f-bdda-26e9307f2d50",
"dataset": {
"id": "b96f9e4d-df84-4445-a803-693be8c5d6d2",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 189,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "60e90098-3fec-4a32-b40f-c76a8935f16a",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 41,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 100,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 17,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "af3b8ed9-dcbf-4f25-9e60-94b060449588",
"dataset": null,
"conversation": {
"id": "b656f19c-7af2-4f34-a8f2-d7b871beba56",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "7b7e3431-32d2-4abe-9449-08eeca6c958c",
"conversation": null,
"kind": 191,
"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": [
"cbdb51ef-8e9d-42cf-9934-fcd523638173"
],
"excludedIds": [
"659953b6-7748-4fb7-9891-75c113c02222"
],
"conversationIds": [
"e8387e21-f91d-437d-95cb-926ba09dc35d"
],
"datasetIds": [
"026649ad-5669-4786-bbb4-d3c943ed6616"
],
"isActive": [
24
],
"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": "1c74156d-8798-4907-88f9-b656539818b8",
"dataset": {
"id": "f436ec9b-5b6c-40c5-8454-a4fb18664dbe",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 67,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "a8eb84c9-ba90-4400-a6ad-2d31271fc3f7",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 241,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"conversation": {
"id": "4b250afe-ae1f-4ca5-93ac-ec901c6233e5",
"name": "string",
"user": {
"id": "aaaa13b8-6f25-4846-b761-89f4aa51f0b9",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "a83bc250-a0ee-488f-b249-ec3123686106",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "f289c342-45d9-4ed0-8f0f-dd23c08d2070",
"dataset": null,
"isActive": 39,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 170,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": null,
"messages": [
{
"id": "707931cd-b716-4fa7-8089-efb55bd0edde",
"conversation": null,
"kind": 160,
"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": 195
}
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": [
"34ea20e9-3785-47d5-885f-32abe48c4e0a"
],
"excludedIds": [
"5ff0c0c3-4d9f-44fc-b78f-137f52173c68"
],
"conversationIds": [
"27c11dd8-6066-45ef-8521-b1abffa4c03c"
],
"datasetIds": [
"edb6c7fb-a6cb-4617-afa8-c44e1389af59"
],
"isActive": [
166
],
"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": "f73cdad8-472c-4bac-ba96-e0895ee1a53d",
"dataset": {
"id": "48f95da2-61b7-430d-b208-2ef01579a7b8",
"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": "9a7f2426-76ab-4b15-887e-48cd57b201f9",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 241,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"conversation": {
"id": "a6344a4c-2e08-40bd-9eda-d1f5f7c7b2aa",
"name": "string",
"user": {
"id": "0e674d37-c0e3-40cf-8697-8f1d299589c1",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "7ff6c61d-38a0-4e0b-bbb6-2c3b03e852c9",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "bc536ce1-abbf-49a4-a42f-e11bf609cd53",
"dataset": null,
"isActive": 238,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 34,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": null,
"messages": [
{
"id": "d10608f3-bf90-44ef-9a54-3e82a7bfcffc",
"conversation": null,
"kind": 182,
"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": 12
}
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": "04d933e4-ebf9-467e-b626-0c06580ac947",
"dataset": {
"id": "335cc01b-0161-4da3-9cb7-1ed53d123c55",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 300,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "97dffc9b-f7e0-4cd5-843a-d1d8161d4c15",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 231,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"conversation": {
"id": "284ee4fc-ec41-4227-be9f-b51002354e57",
"name": "string",
"user": {
"id": "b40db178-1d7b-4b9e-981e-ea3b033613e3",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "f83b942c-0b3c-4b38-bb3b-3cbb05db13e8",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "fe6d0fda-8d80-4ac4-86e7-2bfcf03387e9",
"dataset": null,
"isActive": 170,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 10,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": null,
"messages": [
{
"id": "da1cc8c9-fade-4546-ad3e-12bc60dccf7f",
"conversation": null,
"kind": 121,
"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": 51
}
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": "45de534e-fd1d-4e3d-ab9e-c5261e589f44",
"name": "string",
"user": {
"id": "16f3d299-f188-4ed4-b00c-934c9d123ff3",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "87d19d20-4310-4d6a-8ac5-c266cba5c391",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "e2aa6545-3833-4703-b579-9714b5a74779",
"dataset": {
"id": "2d0ae0ab-f001-4eff-a181-de5c00bdda84",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 178,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "86c28ddb-7e6e-417c-bbd6-62671c528d04",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 41,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 61,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 181,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "e6be0c3d-57ff-49bd-ab4c-d97988d23720",
"dataset": null,
"conversation": {
"id": "71be2cca-24e7-41c0-a41f-b86ed224119f",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "4ce3f2ac-ccc0-4938-a65c-ef75b26719e2",
"conversation": null,
"kind": 1,
"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": "f4927c5e-da8f-4ba2-9f49-8dd4e4a5fa06",
"name": "string",
"user": {
"id": "0ae93ec8-456d-4506-8480-1a7d5c59bccf",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "582c5afd-615e-431f-b0e4-4e9b77cf4d47",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "79a9b0e1-d595-47dd-af30-e9ab1bd9b302",
"dataset": {
"id": "82c28244-4ba2-4972-8607-8304b2e3c778",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 181,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "02b935e5-8e15-4e5c-a773-5a3d98e61386",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 291,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 132,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 32,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "6aa25984-223b-4844-97be-020d6d892782",
"dataset": null,
"conversation": {
"id": "d043b2ab-6e86-420d-afb1-8ed63ce57226",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "a1969d38-9cfd-4423-bbe9-cc15306d7898",
"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"
}
],
"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": [
"d250ad23-96ac-4529-9a0e-7cb6fb81eacd"
],
"excludedIds": [
"1616c036-db24-4b07-a169-719f6e364b8f"
],
"conversationIds": [
"48098209-e885-4a89-86b9-aba1f852eddc"
],
"kinds": [
17
],
"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": "dac2f992-a208-4c3e-b010-985a7c7b34a5",
"conversation": {
"id": "36c2734b-a8fc-4e93-bd52-f244a2311a6c",
"name": "string",
"user": {
"id": "e946574a-ae93-40f7-96b5-224517146013",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "3a62e16e-995f-4c85-b6b8-71eeaeed78ef",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "1cb630b6-29c6-4760-9a0d-f3a434b8d339",
"dataset": {
"id": "79293368-5401-4ed4-86db-2fd2c1c3363b",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 188,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "5970d672-0d54-40a5-ae05-00e49ee8a1ee",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 213,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 80,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 8,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "c2f2a7f1-2e0c-4358-8818-a1b17e054a3f",
"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": 34,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"count": 289
}
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": [
"c7bb1cb8-969f-4a90-9802-c2477e43433e"
],
"excludedIds": [
"d527bfc8-fb77-4f39-9c79-9eb7b2d92dda"
],
"conversationIds": [
"3aad050d-2f2d-4c1f-9d91-c8978abb63a2"
],
"kinds": [
54
],
"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": "7faf3635-928c-483f-8e67-cd35f56a4b2a",
"conversation": {
"id": "b362ad1e-83a3-4a07-a0c1-cf665b8f8d40",
"name": "string",
"user": {
"id": "a4328bd8-c659-4464-8404-e21337940cd3",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "752ace6c-32ba-4715-b585-dc35672227e4",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "956f42d3-9016-4b9b-b171-4e84938a7251",
"dataset": {
"id": "0e6934f9-f6d1-4365-86bc-da63924e9f78",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 219,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "9b9490e4-58ab-485d-b70f-ae0355785e69",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 265,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 160,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 190,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "51a64e96-fac8-479b-870e-515162d8d82b",
"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": 123,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"count": 47
}
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": [
"9f13e4d4-ff3f-42d1-a830-09d2b40c59d9"
],
"excludedIds": [
"583c258d-65f7-4d7d-aea5-a679c451a53a"
],
"collectionIds": [
"b314d44f-e31a-420a-bd92-e52a1f1f1f0d"
],
"like": "string",
"license": "string",
"mimeType": "string",
"fieldsOfScience": [
"string"
],
"publishedRange": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"sizeRange": {
"start": 253,
"end": 181
},
"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": "d0434e2e-7ef1-4e39-a4f2-76ad3cf5f24e",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 208,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "0b839e00-74b0-42c1-a0e9-073fa6680e0e",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 175,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"count": 197
}
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": "6e39c482-e9f9-4260-aa0e-888127ff9777",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 54,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "77fe7794-b4fe-4968-8780-5f582f3d75f2",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 280,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"count": 218
}
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
DELETE /api/dataset/{id}¶
Deletes the dataset 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/dataset/onboard¶
Onboard dataset
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No |
Request body
{
"id": "0042c170-1929-4086-85a8-f1dddad77ed6",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 74,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"license": {
"type": "string",
"nullable": true
},
"mimeType": {
"type": "string",
"nullable": true
},
"size": {
"type": "integer",
"format": "int64",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"version": {
"type": "string",
"nullable": true
},
"headline": {
"type": "string",
"nullable": true
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"fieldOfScience": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"language": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"country": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"datePublished": {
"type": "string",
"format": "date",
"nullable": true
}
},
"additionalProperties": false
}
Response 200 OK
{
"id": "843d28b1-b3c2-4eb8-9486-009b75b3acea",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 121,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "7b525357-4f7f-46fb-87a4-36365cbf0d81",
"code": "string",
"name": "string",
"datasets": [
{
"id": "c55d9967-2c84-4224-a162-5c67c0c5ce9f",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 221,
"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": 225,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"license": {
"type": "string",
"nullable": true
},
"mimeType": {
"type": "string",
"nullable": true
},
"size": {
"type": "integer",
"format": "int64",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"version": {
"type": "string",
"nullable": true
},
"headline": {
"type": "string",
"nullable": true
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"fieldOfScience": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"language": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"country": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"datePublished": {
"type": "string",
"format": "date",
"nullable": true
},
"profileRaw": {
"type": "string",
"nullable": true
},
"collections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Collection"
},
"nullable": true
},
"permissions": {
"type": "array",
"items": {
"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/dataset/persist¶
Persist dataset
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No |
Request body
{
"id": "118eb1e8-4013-4a15-a319-8618cc563b9e",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 112,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"license": {
"type": "string",
"nullable": true
},
"mimeType": {
"type": "string",
"nullable": true
},
"size": {
"type": "integer",
"format": "int64",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"version": {
"type": "string",
"nullable": true
},
"headline": {
"type": "string",
"nullable": true
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"fieldOfScience": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"language": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"country": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"datePublished": {
"type": "string",
"format": "date",
"nullable": true
}
},
"additionalProperties": false
}
Response 200 OK
{
"id": "4958780b-82c8-4c30-b52e-2921fe9097a8",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 16,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "03d24d0f-9353-4f32-b728-7fc90d48d913",
"code": "string",
"name": "string",
"datasets": [
{
"id": "bd9e5e4c-f5cb-4606-9231-67333b613ace",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 296,
"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": 113,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"license": {
"type": "string",
"nullable": true
},
"mimeType": {
"type": "string",
"nullable": true
},
"size": {
"type": "integer",
"format": "int64",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"version": {
"type": "string",
"nullable": true
},
"headline": {
"type": "string",
"nullable": true
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"fieldOfScience": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"language": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"country": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"datePublished": {
"type": "string",
"format": "date",
"nullable": true
},
"profileRaw": {
"type": "string",
"nullable": true
},
"collections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Collection"
},
"nullable": true
},
"permissions": {
"type": "array",
"items": {
"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
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"
],
"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
},
"more": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
}
Response 401 Unauthorized
Response 500 Internal Server Error
Response 503 Service Unavailable
GET /api/principal/me/context-grants¶
Retrieve the assigned context grants for the logged in user
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Response 200 OK
[
{
"principalId": "string",
"principalType": 17,
"targetType": 267,
"targetId": "13aa2382-890f-4347-ba46-ebfff65a7f2a",
"role": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ContextGrant"
}
}
Response 401 Unauthorized
Response 500 Internal Server Error
Response 503 Service Unavailable
GET /api/principal/me/context-grants/collection¶
Retrieve the assigned context grants for the logged in user relevant to the provided collections
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
id |
query | array | No | The collection id to retrieve context grants for |
Response 200 OK
Schema of the response body
{
"type": "object",
"additionalProperties": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
}
Response 401 Unauthorized
Response 500 Internal Server Error
Response 503 Service Unavailable
GET /api/principal/me/context-grants/dataset¶
Retrieve the assigned context grants for the logged in user relevant to the provided datasets
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
id |
query | array | No | The dataset id to retrieve context grants for |
Response 200 OK
Schema of the response body
{
"type": "object",
"additionalProperties": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
}
Response 401 Unauthorized
Response 500 Internal Server Error
Response 503 Service Unavailable
GET /api/principal/user/{subjectId}/context-grants¶
Retrieve the assigned context grants for the provided user
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
subjectId |
path | string | No | The subject id of the user to retrieve context grants for |
Response 200 OK
[
{
"principalId": "string",
"principalType": 283,
"targetType": 56,
"targetId": "cac84411-02e9-472f-800d-c28952df5525",
"role": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ContextGrant"
}
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
GET /api/principal/group/{groupId}/context-grants¶
Retrieve the assigned context grants for the provided group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
groupId |
path | string | No | The group id of the user to retrieve context grants for |
Response 200 OK
[
{
"principalId": "string",
"principalType": 218,
"targetType": 138,
"targetId": "4e7d7d83-239f-4ce9-95ac-5fa19a920001",
"role": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ContextGrant"
}
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
GET /api/principal/user/{subjectId}/context-grants/collection¶
Retrieve the assigned context grants for the provided user relevant to the provided collections
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
id |
query | array | No | The collection id to retrieve context grants for | |
subjectId |
path | string | No | The subject id of the user to retrieve context grants for |
Response 200 OK
Schema of the response body
{
"type": "object",
"additionalProperties": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
GET /api/principal/group/{groupId}/context-grants/collection¶
Retrieve the assigned context grants for the provided user group relevant to the provided collections
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
groupId |
path | string | No | The group id of the group to retrieve context grants for | |
id |
query | array | No | The collection id to retrieve context grants for |
Response 200 OK
Schema of the response body
{
"type": "object",
"additionalProperties": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
GET /api/principal/user/{subjectId}/context-grants/dataset¶
Retrieve the assigned context grants for the provided user relevant to the provided datasets
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
id |
query | array | No | The dataset id to retrieve context grants for | |
subjectId |
path | string | No | The subject id of the user to retrieve context grants for |
Response 200 OK
Schema of the response body
{
"type": "object",
"additionalProperties": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
GET /api/principal/group/{groupId}/context-grants/dataset¶
Retrieve the assigned context grants for the provided user group relevant to the provided datasets
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
groupId |
path | string | No | The group id of the user group to retrieve context grants for | |
id |
query | array | No | The dataset id to retrieve context grants for |
Response 200 OK
Schema of the response body
{
"type": "object",
"additionalProperties": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
}
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/principal/context-grants/user/{userId}/dataset/{datasetId}/role/{role}¶
Add user to dataset context grant group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
datasetId |
path | string | No | The context grant dataset to add | |
role |
path | string | No | The context grant role to add | |
userId |
path | string | No | The user id to add to the provided context grant group |
Response 200 OK
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
DELETE /api/principal/context-grants/user/{userId}/dataset/{datasetId}/role/{role}¶
Remove user from dataset context grant group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
datasetId |
path | string | No | The context grant dataset to remove | |
role |
path | string | No | The context grant role to add | |
userId |
path | string | No | The user id to remove from the provided context grant group |
Response 200 OK
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/principal/context-grants/group/{groupId}/dataset/{datasetId}/role/{role}¶
Add user group to dataset context grant group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
datasetId |
path | string | No | The context grant dataset to add | |
groupId |
path | string | No | The user group id to add to the provided context grant group | |
role |
path | string | No | The context grant role to add |
Response 200 OK
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
DELETE /api/principal/context-grants/group/{groupId}/dataset/{datasetId}/role/{role}¶
Remove user group from dataset context grant group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
datasetId |
path | string | No | The context grant dataset to remove | |
groupId |
path | string | No | The user group id to remove from the provided context grant group | |
role |
path | string | No | The context grant role to add |
Response 200 OK
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/principal/context-grants/user/{userId}/collection/{collectionId}/role/{role}¶
Add user to collection context grant group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
collectionId |
path | string | No | The context grant collection to add | |
role |
path | string | No | The context grant role to add | |
userId |
path | string | No | The user id to add to the provided context grant group |
Response 200 OK
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
DELETE /api/principal/context-grants/user/{userId}/collection/{collectionId}/role/{role}¶
Remove user from collection context grant group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
collectionId |
path | string | No | The context grant collection to remove | |
role |
path | string | No | The context grant role to add | |
userId |
path | string | No | The user id to remove from the provided context grant group |
Response 200 OK
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
POST /api/principal/context-grants/group/{groupId}/collection/{collectionId}/role/{role}¶
Add user group to collection context grant group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
collectionId |
path | string | No | The context grant collection to add | |
groupId |
path | string | No | The user group id to add to the provided context grant group | |
role |
path | string | No | The context grant role to add |
Response 200 OK
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
DELETE /api/principal/context-grants/group/{groupId}/collection/{collectionId}/role/{role}¶
Remove user group from collection context grant group
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
collectionId |
path | string | No | The context grant collection to remove | |
groupId |
path | string | No | The user group id to remove from the provided context grant group | |
role |
path | string | No | The context grant role to add |
Response 200 OK
Response 400 Bad Request
Response 401 Unauthorized
Response 403 Forbidden
Response 500 Internal Server Error
Response 503 Service Unavailable
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": 200,
"datasetIds": [
"dfbc932c-20a3-4967-9d9a-954aaf70a756"
],
"collectionIds": [
"526fa2e5-de67-4170-ae98-f5420a258134"
],
"userCollectionIds": [
"82f85f08-be30-4595-b3cc-1dc6c64a1c8e"
],
"conversationOptions": {
"conversationId": "ea52af75-5ef0-4f28-a791-5a6a717aadce",
"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
},
"datasetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to datasets from the 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 datasets from the specific collections 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 datasets from the specific user collections Ids. If set, the list of ids must not be empty",
"nullable": true
},
"conversationOptions": {
"$ref": "#/components/schemas/ConversationOptions"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"result": [
{
"dataset": {
"id": "2275b8c9-8ace-4b8c-b274-c5b2d68f30f9",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 109,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "df011776-0c3e-4907-a627-52edf14eee12",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 109,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"maxSimilarity": 10.12,
"hits": [
{
"content": "string",
"objectId": "string",
"similarity": 10.12
}
]
}
],
"conversationId": "9db3a222-c156-4381-a3c6-461dda9012e5"
}
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": [
"8b204b54-c4d8-409a-be31-f2421fc7f75f"
],
"conversationOptions": {
"conversationId": "732a5cff-d945-4465-ae13-a225a90eb3c4",
"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": 57,
"entries": [
{
"process": {
"kind": 79
},
"result": {
"kind": 182,
"message": "string"
},
"status": 107
}
]
}
],
"conversationId": "ed93ae2d-c193-49ae-9db7-24b0285330e7"
}
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": [
"b95beaa9-490f-492b-8626-83439d09bc2b"
],
"excludedIds": [
"0f3d3133-ad1a-492f-abd6-fad87cfd5411"
],
"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": "5176aa9d-93d1-4070-8920-f0b1a361e128",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "547682cd-9ec2-4fd2-8b31-596b876c94fa",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "f6b77982-9f28-4c6e-bb11-1992292fea67",
"dataset": {
"id": "9f03858d-de24-4eae-beab-34564475bf0c",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 209,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "fb153410-dbb1-455f-8c9d-43a24fd135a7",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 219,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 10,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 104,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
}
],
"count": 142
}
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
{
"id": "4f1112db-71d9-44d3-9058-9695b3ef4090",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "c244d193-8da5-4db4-91ed-67900e923ddb",
"name": "string",
"user": {
"id": "ee6d274c-01f0-4c2b-99d5-56987a58bf1f",
"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": "661cc033-17e9-4aab-9cf0-b2e042f3158d",
"dataset": {
"id": "24f221a3-995c-4bad-b07c-aed97570283c",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 233,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "fad98a79-6608-4df0-9e3c-a493051acd29",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 141,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 98,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 49,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"idpSubjectId": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"userCollections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollection"
},
"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/group/query¶
Query user groups
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"ids": [
"string"
],
"excludedIds": [
"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"
},
"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"
},
"description": "Exclude from the lookup items with specific 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": "string",
"name": "string"
}
],
"count": 85
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserGroup"
},
"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
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": [
"2a1cf047-b3bc-44a4-9d73-6fea898993e5"
],
"userIds": [
"607bb2f3-6725-440e-a00d-2fb0fe0524cb"
],
"excludedIds": [
"db1f6bc1-2dc5-4e40-9f48-ec3f39f76604"
],
"isActive": [
242
],
"kind": [
274
],
"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": "265a958f-9a8e-4e3d-85bf-ac655e1ab571",
"name": "string",
"user": {
"id": "179ba347-7ca1-46b3-af2e-8e4253dbabe5",
"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": "df0cc69f-915f-4c3a-8b17-7df2dcc0657d",
"dataset": {
"id": "2e02397c-cde1-4f97-8a98-454883c37470",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 244,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "f72b22b0-dabe-4ceb-b508-7c4214ca0ed8",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 89,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 122,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 130,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"count": 298
}
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": [
"fd6684d8-f3dd-46eb-99dd-073bb1c18ecc"
],
"userIds": [
"a2de0310-c3c7-4cca-99a0-4dc31759ad30"
],
"excludedIds": [
"dd4c16d1-d9d2-426c-ad68-4e0252a436f1"
],
"isActive": [
84
],
"kind": [
281
],
"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": "da8b00da-bded-496a-a543-79426da54c06",
"name": "string",
"user": {
"id": "cd0be0d8-78c6-4eae-87cc-94ed0f6c69b8",
"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": "cf9cb67b-4f19-43cb-ade7-730c20ff4444",
"dataset": {
"id": "a6064aa6-9544-4a17-ae91-3d123269de8c",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 119,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "c7c7f6fe-acc8-4ed1-829d-3338f587277f",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 162,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 257,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 270,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"count": 245
}
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": "d5276940-ce1e-4b1a-8cac-26c02b48a364",
"name": "string",
"user": {
"id": "b2788e83-cfea-41b2-a3a2-b498d93147c8",
"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": "51726ab2-01cb-4c05-ae04-a6af110dfb9a",
"dataset": {
"id": "68871a58-a017-47df-b2b2-bbb430d3f977",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 126,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "0288954b-005b-40b2-bfc5-c93b0aed11ef",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 2,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 296,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 99,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"count": 144
}
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": "27eb50b9-4164-4c9e-8b7a-761919ef7ed3",
"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": "a4fe152f-1ad2-4938-a649-957ec0d75c7a",
"name": "string",
"user": {
"id": "e7f1feee-c84d-44e8-b2b2-061eddbf6121",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "4fb50db1-ab17-4240-a414-1c67d965abaa",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "9cd9ec89-c4d6-4244-9eb6-9abcdd5eeec3",
"dataset": {
"id": "73faa1fb-47f1-4e61-a231-d1b3e266d720",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 137,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "674b21bc-be0a-4a34-b43a-e73e8f4b6326",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 104,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 299,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 274,
"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": "b41ae978-320b-4565-9b4a-0629c6ae34e5",
"name": "string",
"userDatasetCollections": [
{
"id": "a0c75e6f-fa5c-488e-a9db-5cbb7e069844",
"userCollectionId": "b0f184db-4ed4-45cd-9689-3b2b61b66ebb",
"datasetId": "046f8790-8cfe-407b-914d-f3c011d9b4b7",
"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": "57884b2d-02d2-4c05-9a06-dd46384e2f5c",
"name": "string",
"user": {
"id": "24dd27b0-f761-4d0b-9ade-b81af110b314",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "66913015-f6a1-4e01-8e87-f596c9fbd0f8",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "47b4f526-76ce-4d3e-81b1-383bd80cb2e0",
"dataset": {
"id": "20b61cce-3f82-4853-a810-73f2762b6fe6",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 40,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "8df93fab-f865-4a55-ba8c-47f619649261",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 110,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 62,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 11,
"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": "722f1c4d-a572-409f-b3a5-5a384eea2568",
"userDatasetCollections": [
{
"id": "be9b36d9-d0d4-4128-913c-c4015b03844a",
"userCollectionId": "e7315e0c-bcfd-4ce4-9395-0e7bbba038be",
"datasetId": "bf18e620-6d61-4971-bfa5-b39d1aa76658",
"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": "34d089f1-4817-4d9b-8de9-1f1089530609",
"name": "string",
"user": {
"id": "7dc21f77-fd85-4509-a584-a82dcbd17a97",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "fabe6d74-5bcb-48ee-8f7a-6c90c72accdb",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "9924feb8-09f8-4d5b-8b9a-0b0a241f5491",
"dataset": {
"id": "3d3c31b2-2a07-4c1e-a62d-0fdc055a6005",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 194,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "778a6c43-8d41-4637-87f3-fe468517fd1e",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 168,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 134,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 289,
"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": [
"de680300-5e63-49d7-906e-d173dd2a84b7"
],
"excludedIds": [
"66725972-3ba3-431b-801c-8ea58423c664"
],
"userCollectionIds": [
"83d73bf5-18c7-4117-bc05-2b6b058fe795"
],
"datasetIds": [
"c16290dd-9f54-4bcd-b888-51a24a193010"
],
"isActive": [
234
],
"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": "221c5b3a-114d-4bbe-94d1-2c7805549710",
"dataset": {
"id": "bb17b881-ca2b-43de-a0ba-4062d4de1404",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 43,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "bd108170-044d-464a-b8c5-fd1a0e1d94b5",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 228,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 138,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": {
"id": "4399bb97-50f0-476e-88f9-5734d0d5e5f9",
"name": "string",
"user": {
"id": "5c453a66-af88-4a30-8408-6e2f2e0600b6",
"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": 219,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"eTag": "string"
}
],
"count": 159
}
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": [
"72e65afd-9dbd-43fe-b752-efb5b856b67d"
],
"excludedIds": [
"0d318c2c-5443-4579-b421-09fc0da3909b"
],
"userCollectionIds": [
"9363e5c2-fd36-455e-973a-22934ed5fa09"
],
"datasetIds": [
"d138793e-1fe3-4bbd-9d66-c3c4b110f73e"
],
"isActive": [
268
],
"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": "d18a89c6-9b23-4eb9-9ae6-d9a99281c653",
"dataset": {
"id": "10c3c111-2a81-4537-92af-76859cd860a3",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 145,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "4511b6c9-81f3-4f12-b407-89e02fd21836",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 150,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 226,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": {
"id": "67acbe01-3fc2-4416-a9fe-4ddef49ca959",
"name": "string",
"user": {
"id": "ff9947fa-834d-4859-94bf-480395a7c829",
"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": 88,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"eTag": "string"
}
],
"count": 32
}
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": "428c55bc-9ec3-4cb6-bb29-2d238c880481",
"dataset": {
"id": "097147e1-117e-48cf-8439-a99468d9743e",
"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": "8ba96315-9b7d-4f4e-b42f-49461e5c810c",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 230,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 34,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": {
"id": "d6d236cf-22f0-4c2d-80f3-737cd4084637",
"name": "string",
"user": {
"id": "4c39ebd8-2fa5-4be8-8ac9-4d7078708f60",
"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": 156,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"eTag": "string"
}
],
"count": 251
}
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": "0422da84-8842-4a63-a849-a08cfc9c403b",
"name": "string",
"user": {
"id": "4c8894da-1a55-4ff0-965f-426c3527b465",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "5df591ec-e8f4-4dbc-8ef4-7e9e6918e91b",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "d3ea1ae5-19b4-4b7c-afcd-130871feb870",
"dataset": {
"id": "6540a22a-55fc-4f6f-824c-1b9e6b50e089",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 2,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "6e906548-f7ce-453d-9be6-ab1629a351ea",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 197,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 165,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 163,
"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": "d82bb26b-a033-485b-a21b-f8eb10d3109b",
"name": "string",
"user": {
"id": "c4e1a7c7-514e-4ebd-8b57-5be88de01859",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "b9177a17-8c08-42c7-ae22-1387fcd4daeb",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "1b7558b0-6312-423e-999e-65f69cc9f63a",
"dataset": {
"id": "d1ccb7ad-99c8-4e2a-a5ba-1a3cdf8707f3",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 255,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "800e91ce-8408-48de-a886-adb17f0ff6b9",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 24,
"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": 176,
"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
UserSettings¶
GET /api/user/settings/id/{id}¶
Lookup user settings 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
{
"id": "e9350155-cfc7-4017-8d57-24c9003fa93d",
"key": "string",
"user": {
"id": "aa01d15f-a6b7-4ff1-b8c4-d4a85bcade6a",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "f9cb6271-6612-44f0-a460-45da341fc4ce",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "04286636-6b8c-4557-a149-da70896be6ae",
"dataset": {
"id": "79584002-bb13-44f8-9fc0-e72c808d8378",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 39,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "236c26da-0315-4e54-bebd-7fe0513b051b",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 256,
"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": 157,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"value": "string",
"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
},
"key": {
"type": "string",
"nullable": true
},
"user": {
"$ref": "#/components/schemas/User"
},
"value": {
"type": "string",
"nullable": true
},
"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
DELETE /api/user/settings/id/{id}¶
Deletes the user settings 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
GET /api/user/settings/key/{key}¶
Lookup user settings by key
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No | ||
key |
path | string | No | The key of the item to lookup |
Response 200 OK
[
{
"id": "716db7d1-0be0-451e-9456-4be38a611ecd",
"key": "string",
"user": {
"id": "3450d1d8-cc84-4576-b2ba-e1a9f7445498",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "90ed497b-e37b-4f76-a1c3-cd98b3331355",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "520fa633-7682-4151-a29a-693e555cd08d",
"dataset": {
"id": "fee0549c-762b-424d-bd4f-05021154d2e9",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 93,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "c5d5f8c8-9cde-4d0c-b3c8-4434d0349c6b",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 33,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 47,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 270,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"value": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSettings"
}
}
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/settings/key/{key}¶
Deletes the user settings by key
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
key |
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/settings/persist¶
Persist user settings
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No |
Request body
{
"id": "4a360c41-1441-41df-ae58-1ebc95e17a2e",
"key": "string",
"value": "string",
"eTag": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"key": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
},
"eTag": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 200 OK
{
"id": "cffc9f0e-11ca-428b-9abb-f92383be156b",
"key": "string",
"user": {
"id": "c5a36583-cd3b-4eab-85a3-9297b81a6faf",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "c8bd0ffe-995f-4e77-964a-b90d1b5cc4c0",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "691d1a62-eeb1-4d0c-b8ea-38e8dd662bd7",
"dataset": {
"id": "c1613083-eaa3-485a-8fcf-f4df0021f83c",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 170,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"profileRaw": "string",
"collections": [
{
"id": "97cb6804-9c27-4ad7-99cd-31abbbdf8e87",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 231,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 276,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 121,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"value": "string",
"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
},
"key": {
"type": "string",
"nullable": true
},
"user": {
"$ref": "#/components/schemas/User"
},
"value": {
"type": "string",
"nullable": true
},
"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
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": 119
}
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": 251,
"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¶
POST /api/workflow/definition/query¶
Retrieve the available workflow definitions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"kinds": [
233
],
"like": "string",
"excludeStaled": true,
"includePaused": true,
"lastRunState": 174,
"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": 66,
"maxActiveRuns": 228,
"maxConsecutiveFailedRuns": 35,
"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"
],
"tasks": [
{
"id": "string",
"taskDisplayName": "string",
"owner": "string",
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z",
"triggerRule": "string",
"dependsOnPast": true,
"waitForDownstream": true,
"retries": 10.12,
"queue": "string",
"pool": "string",
"poolSlots": 10.12,
"executionTimeout": null,
"retryDelay": null,
"retryExponentialBackoff": true,
"priorityWeight": 10.12,
"weightRule": "string",
"uiColor": "string",
"uifgColor": "string",
"templateFields": [
"string"
],
"downstreamTaskIds": [
"string"
],
"docMd": "string",
"operatorName": "string",
"params": null,
"classRef": null,
"isMapped": true,
"extraLinks": [
"string"
]
}
]
}
],
"count": 77
}
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/definition/{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": 145,
"maxActiveRuns": 209,
"maxConsecutiveFailedRuns": 78,
"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"
],
"tasks": [
{
"id": "string",
"taskDisplayName": "string",
"owner": "string",
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z",
"triggerRule": "string",
"dependsOnPast": true,
"waitForDownstream": true,
"retries": 10.12,
"queue": "string",
"pool": "string",
"poolSlots": 10.12,
"executionTimeout": null,
"retryDelay": null,
"retryExponentialBackoff": true,
"priorityWeight": 10.12,
"weightRule": "string",
"uiColor": "string",
"uifgColor": "string",
"templateFields": [
"string"
],
"downstreamTaskIds": [
"string"
],
"docMd": "string",
"operatorName": "string",
"params": null,
"classRef": null,
"isMapped": true,
"extraLinks": [
"string"
]
}
]
}
],
"count": 114
}
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
POST /api/workflow/execute¶
Lookup workflow definition by id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No |
Request body
{
"workflowId": "string"
}
Other accepted types: application/*+json, application/json-patch+json, text/json
Schema of the request body
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"nullable": true
}
},
"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": 90,
"maxActiveRuns": 237,
"maxConsecutiveFailedRuns": 244,
"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"
],
"tasks": [
{
"id": "string",
"taskDisplayName": "string",
"owner": "string",
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z",
"triggerRule": "string",
"dependsOnPast": true,
"waitForDownstream": true,
"retries": 10.12,
"queue": "string",
"pool": "string",
"poolSlots": 10.12,
"executionTimeout": null,
"retryDelay": null,
"retryExponentialBackoff": true,
"priorityWeight": 10.12,
"weightRule": "string",
"uiColor": "string",
"uifgColor": "string",
"templateFields": [
"string"
],
"downstreamTaskIds": [
"string"
],
"docMd": "string",
"operatorName": "string",
"params": null,
"classRef": null,
"isMapped": true,
"extraLinks": [
"string"
]
}
]
}
],
"count": 275
}
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
GET /api/workflow/definition/{workflowId}/execution/{executionId}¶
Lookup workflow exection by id of definition by id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
executionId |
path | string | No | The execution id of the item to lookup | |
f |
query | array | No | ||
workflowId |
path | string | No | The workflow id of the item to lookup |
Response 200 OK
{
"items": [
{
"id": "string",
"workflowId": "string",
"logicalDate": "2022-04-13T15:42:05.901Z",
"queuedAt": "2022-04-13T15:42:05.901Z",
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z",
"dataIntervalStart": "2022-04-13T15:42:05.901Z",
"dataIntervalEnd": "2022-04-13T15:42:05.901Z",
"runAfter": "2022-04-13T15:42:05.901Z",
"lastSchedulingDecision": "2022-04-13T15:42:05.901Z",
"runType": 258,
"triggeredBy": "string",
"state": 160,
"note": "string",
"bundleVersion": "string",
"workflow": {
"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": 207,
"maxActiveRuns": 100,
"maxConsecutiveFailedRuns": 234,
"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"
],
"tasks": [
{
"id": "string",
"taskDisplayName": "string",
"owner": "string",
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z",
"triggerRule": "string",
"dependsOnPast": true,
"waitForDownstream": true,
"retries": 10.12,
"queue": "string",
"pool": "string",
"poolSlots": 10.12,
"executionTimeout": null,
"retryDelay": null,
"retryExponentialBackoff": true,
"priorityWeight": 10.12,
"weightRule": "string",
"uiColor": "string",
"uifgColor": "string",
"templateFields": [
"string"
],
"downstreamTaskIds": [
"string"
],
"docMd": "string",
"operatorName": "string",
"params": null,
"classRef": null,
"isMapped": true,
"extraLinks": [
"string"
]
}
]
},
"taskInstances": [
{
"id": "string",
"workflowId": "string",
"workflowTaskId": "string",
"workflowExecutionId": "string",
"mapIndex": "string",
"logicalDate": "2022-04-13T15:42:05.901Z",
"runAfter": "2022-04-13T15:42:05.901Z",
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z",
"duration": 10.12,
"state": 17,
"tryNumber": 18,
"maxTries": 275,
"taskDisplayName": "string",
"hostname": "string",
"unixname": "string",
"pool": "string",
"poolSlots": 234,
"queue": "string",
"queuedWhen": "2022-04-13T15:42:05.901Z",
"scheduledWhen": "2022-04-13T15:42:05.901Z",
"priorityWeight": 138,
"operator": "string",
"pid": 16,
"executor": "string",
"executorConfig": "string",
"note": "string",
"renderedMapIndex": "string",
"renderedFields": null,
"trigger": null,
"triggererJob": null,
"dagVersion": null,
"workflow": null,
"task": null,
"workflowExecution": null
}
]
}
],
"count": 88
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowExecution"
},
"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/workflow/execution/query¶
Retrieve the available workflow executions
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"workflowIds": [
"string"
],
"logicalDateRange": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"startDateRange": null,
"endDateRange": null,
"runAfterRange": null,
"runType": [
249
],
"state": [
161
],
"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": {
"workflowIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Limit lookup to items that are in the Workflow Id List",
"nullable": true
},
"logicalDateRange": {
"$ref": "#/components/schemas/DateOnlyNullableRangeOf"
},
"startDateRange": {
"$ref": "#/components/schemas/DateOnlyNullableRangeOf"
},
"endDateRange": {
"$ref": "#/components/schemas/DateOnlyNullableRangeOf"
},
"runAfterRange": {
"$ref": "#/components/schemas/DateOnlyNullableRangeOf"
},
"runType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowRunType"
},
"description": "Limit lookup to items that are specifically triggered by that exact run type",
"nullable": true
},
"state": {
"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",
"workflowId": "string",
"logicalDate": "2022-04-13T15:42:05.901Z",
"queuedAt": "2022-04-13T15:42:05.901Z",
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z",
"dataIntervalStart": "2022-04-13T15:42:05.901Z",
"dataIntervalEnd": "2022-04-13T15:42:05.901Z",
"runAfter": "2022-04-13T15:42:05.901Z",
"lastSchedulingDecision": "2022-04-13T15:42:05.901Z",
"runType": 73,
"triggeredBy": "string",
"state": 290,
"note": "string",
"bundleVersion": "string",
"workflow": {
"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": 258,
"maxActiveRuns": 188,
"maxConsecutiveFailedRuns": 109,
"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"
],
"tasks": [
{
"id": "string",
"taskDisplayName": "string",
"owner": "string",
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z",
"triggerRule": "string",
"dependsOnPast": true,
"waitForDownstream": true,
"retries": 10.12,
"queue": "string",
"pool": "string",
"poolSlots": 10.12,
"executionTimeout": null,
"retryDelay": null,
"retryExponentialBackoff": true,
"priorityWeight": 10.12,
"weightRule": "string",
"uiColor": "string",
"uifgColor": "string",
"templateFields": [
"string"
],
"downstreamTaskIds": [
"string"
],
"docMd": "string",
"operatorName": "string",
"params": null,
"classRef": null,
"isMapped": true,
"extraLinks": [
"string"
]
}
]
},
"taskInstances": [
{
"id": "string",
"workflowId": "string",
"workflowTaskId": "string",
"workflowExecutionId": "string",
"mapIndex": "string",
"logicalDate": "2022-04-13T15:42:05.901Z",
"runAfter": "2022-04-13T15:42:05.901Z",
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z",
"duration": 10.12,
"state": 245,
"tryNumber": 244,
"maxTries": 48,
"taskDisplayName": "string",
"hostname": "string",
"unixname": "string",
"pool": "string",
"poolSlots": 192,
"queue": "string",
"queuedWhen": "2022-04-13T15:42:05.901Z",
"scheduledWhen": "2022-04-13T15:42:05.901Z",
"priorityWeight": 0,
"operator": "string",
"pid": 150,
"executor": "string",
"executorConfig": "string",
"note": "string",
"renderedMapIndex": "string",
"renderedFields": null,
"trigger": null,
"triggererJob": null,
"dagVersion": null,
"workflow": null,
"task": null,
"workflowExecution": null
}
]
}
],
"count": 205
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowExecution"
},
"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/definition/{workflowId}/execution/{executionId}/task/{taskId}¶
Lookup workflow task instance by id
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
executionId |
path | string | No | The execution id of the item to lookup | |
f |
query | array | No | ||
taskId |
path | string | No | The task id of the item to lookup | |
workflowId |
path | string | No | The workflow id of the item to lookup |
Response 200 OK
{
"items": [
{
"id": "string",
"workflowId": "string",
"workflowTaskId": "string",
"workflowExecutionId": "string",
"mapIndex": "string",
"logicalDate": "2022-04-13T15:42:05.901Z",
"runAfter": "2022-04-13T15:42:05.901Z",
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z",
"duration": 10.12,
"state": 181,
"tryNumber": 251,
"maxTries": 254,
"taskDisplayName": "string",
"hostname": "string",
"unixname": "string",
"pool": "string",
"poolSlots": 217,
"queue": "string",
"queuedWhen": "2022-04-13T15:42:05.901Z",
"scheduledWhen": "2022-04-13T15:42:05.901Z",
"priorityWeight": 263,
"operator": "string",
"pid": 274,
"executor": "string",
"executorConfig": "string",
"note": "string",
"renderedMapIndex": "string",
"renderedFields": null,
"trigger": null,
"triggererJob": null,
"dagVersion": null,
"workflow": {
"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": 39,
"maxActiveRuns": 135,
"maxConsecutiveFailedRuns": 44,
"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"
],
"tasks": [
{
"id": "string",
"taskDisplayName": "string",
"owner": "string",
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z",
"triggerRule": "string",
"dependsOnPast": true,
"waitForDownstream": true,
"retries": 10.12,
"queue": "string",
"pool": "string",
"poolSlots": 10.12,
"executionTimeout": null,
"retryDelay": null,
"retryExponentialBackoff": true,
"priorityWeight": 10.12,
"weightRule": "string",
"uiColor": "string",
"uifgColor": "string",
"templateFields": [
"string"
],
"downstreamTaskIds": [
"string"
],
"docMd": "string",
"operatorName": "string",
"params": null,
"classRef": null,
"isMapped": true,
"extraLinks": [
"string"
]
}
]
},
"task": null,
"workflowExecution": {
"id": "string",
"workflowId": "string",
"logicalDate": "2022-04-13T15:42:05.901Z",
"queuedAt": "2022-04-13T15:42:05.901Z",
"start": "2022-04-13T15:42:05.901Z",
"end": "2022-04-13T15:42:05.901Z",
"dataIntervalStart": "2022-04-13T15:42:05.901Z",
"dataIntervalEnd": "2022-04-13T15:42:05.901Z",
"runAfter": "2022-04-13T15:42:05.901Z",
"lastSchedulingDecision": "2022-04-13T15:42:05.901Z",
"runType": 197,
"triggeredBy": "string",
"state": 295,
"note": "string",
"bundleVersion": "string",
"workflow": null,
"taskInstances": null
}
}
],
"count": 276
}
Schema of the response body
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowTaskInstance"
},
"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
GET /api/workflow/definition/{workflowId}/execution/{workflowExecutionId}/taskinstance/{workflowTaskId}/logs/{tryNumber}¶
The workflow log by taskid, workflowid, executionid and tryNumber
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No | ||
tryNumber |
path | integer | No | The execution try number of the item to lookup | |
workflowExecutionId |
path | string | No | The workflow id of the item to lookup | |
workflowId |
path | string | No | The workflow execution id of the item to lookup | |
workflowTaskId |
path | string | No | The workflow task id of the item to lookup |
Response 200 OK
[
{
"timestamp": "2022-04-13T15:42:05.901Z",
"event": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowTaskLog"
}
}
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 |
|---|---|
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> |
CollectionDatasetPatch¶
| Name | Type |
|---|---|
datasets |
Array<string(uuid)> |
id |
string(uuid)| null |
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 |
CollectionPersist¶
| Name | Type |
|---|---|
code |
string| null |
id |
string(uuid)| null |
name |
string| null |
CollectionPersistDeep¶
| Name | Type |
|---|---|
code |
string| null |
datasets |
Array<string(uuid)> |
id |
string(uuid)| null |
name |
string| null |
CollectionQueryResult¶
| Name | Type |
|---|---|
count |
integer(int32) |
items |
Array<Collection> |
ContextGrant¶
| Name | Type |
|---|---|
principalId |
string| null |
principalType |
PrincipalKind |
role |
string| null |
targetId |
string(uuid) |
targetType |
TargetKind |
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 |
|---|---|
collectionIds |
Array<string(uuid)> |
conversationOptions |
ConversationOptions |
datasetIds |
Array<string(uuid)> |
project |
FieldSet |
query |
string| null |
resultCount |
integer(int32)| null |
userCollectionIds |
Array<string(uuid)> |
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 |
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 |
DatasetPersist¶
| Name | Type |
|---|---|
code |
string| null |
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 |
size |
integer(int64)| null |
url |
string| null |
version |
string| null |
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 |
PrincipalKind¶
Type: integer(int32)
ResponseStatus¶
Type: integer(int32)
TargetKind¶
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> |
UserGroup¶
| Name | Type |
|---|---|
id |
string| null |
name |
string| null |
UserGroupLookup¶
| Name | Type |
|---|---|
excludedIds |
Array<string> |
ids |
Array<string> |
like |
string| null |
metadata |
Header |
order |
Ordering |
page |
Paging |
project |
FieldSet |
UserGroupQueryResult¶
| Name | Type |
|---|---|
count |
integer(int32) |
items |
Array<UserGroup> |
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> |
UserSettings¶
| Name | Type |
|---|---|
createdAt |
string(date-time)| null |
eTag |
string| null |
id |
string(uuid)| null |
key |
string| null |
updatedAt |
string(date-time)| null |
user |
User |
value |
string| null |
UserSettingsPersist¶
| Name | Type |
|---|---|
eTag |
string| null |
id |
string(uuid)| null |
key |
string| null |
value |
string| null |
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> |
tasks |
Array<WorkflowTask> |
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> |
WorkflowExecution¶
| Name | Type |
|---|---|
bundleVersion |
string| null |
dataIntervalEnd |
string(date-time)| null |
dataIntervalStart |
string(date-time)| null |
end |
string(date-time)| null |
id |
string| null |
lastSchedulingDecision |
string(date-time)| null |
logicalDate |
string(date-time)| null |
note |
string| null |
queuedAt |
string(date-time)| null |
runAfter |
string(date-time)| null |
runType |
WorkflowRunType |
start |
string(date-time)| null |
state |
WorkflowRunState |
taskInstances |
Array<WorkflowTaskInstance> |
triggeredBy |
string| null |
workflow |
WorkflowDefinition |
workflowId |
string| null |
WorkflowExecutionArgs¶
| Name | Type |
|---|---|
workflowId |
string| null |
WorkflowExecutionLookup¶
| Name | Type |
|---|---|
endDateRange |
DateOnlyNullableRangeOf |
logicalDateRange |
DateOnlyNullableRangeOf |
metadata |
Header |
order |
Ordering |
page |
Paging |
project |
FieldSet |
runAfterRange |
DateOnlyNullableRangeOf |
runType |
Array<WorkflowRunType> |
startDateRange |
DateOnlyNullableRangeOf |
state |
Array<WorkflowRunState> |
workflowIds |
Array<string> |
WorkflowExecutionQueryResult¶
| Name | Type |
|---|---|
count |
integer(int32) |
items |
Array<WorkflowExecution> |
WorkflowRunState¶
Type: integer(int32)
WorkflowRunType¶
Type: integer(int32)
WorkflowTask¶
| Name | Type |
|---|---|
classRef |
|
dependsOnPast |
boolean| null |
docMd |
string| null |
downstreamTaskIds |
Array<string> |
end |
string(date-time)| null |
executionTimeout |
|
extraLinks |
Array<string> |
id |
string| null |
isMapped |
boolean| null |
operatorName |
string| null |
owner |
string| null |
params |
|
pool |
string| null |
poolSlots |
number(double)| null |
priorityWeight |
number(double)| null |
queue |
string| null |
retries |
number(double)| null |
retryDelay |
|
retryExponentialBackoff |
boolean| null |
start |
string(date-time)| null |
taskDisplayName |
string| null |
templateFields |
Array<string> |
triggerRule |
string| null |
uiColor |
string| null |
uifgColor |
string| null |
waitForDownstream |
boolean| null |
weightRule |
string| null |
WorkflowTaskInstance¶
| Name | Type |
|---|---|
dagVersion |
|
duration |
number(double)| null |
end |
string(date-time)| null |
executor |
string| null |
executorConfig |
string| null |
hostname |
string| null |
id |
string| null |
logicalDate |
string(date-time)| null |
mapIndex |
string| null |
maxTries |
integer(int32)| null |
note |
string| null |
operator |
string| null |
pid |
integer(int32)| null |
pool |
string| null |
poolSlots |
integer(int32)| null |
priorityWeight |
integer(int32)| null |
queue |
string| null |
queuedWhen |
string(date-time)| null |
renderedFields |
|
renderedMapIndex |
string| null |
runAfter |
string(date-time)| null |
scheduledWhen |
string(date-time)| null |
start |
string(date-time)| null |
state |
WorkflowTaskInstanceState |
task |
WorkflowTask |
taskDisplayName |
string| null |
trigger |
|
triggererJob |
|
tryNumber |
integer(int32)| null |
unixname |
string| null |
workflow |
WorkflowDefinition |
workflowExecution |
WorkflowExecution |
workflowExecutionId |
string| null |
workflowId |
string| null |
workflowTaskId |
string| null |
WorkflowTaskInstanceQueryResult¶
| Name | Type |
|---|---|
count |
integer(int32) |
items |
Array<WorkflowTaskInstance> |
WorkflowTaskInstanceState¶
Type: integer(int32)
WorkflowTaskLog¶
| Name | Type |
|---|---|
event |
string| null |
timestamp |
string(date-time)| null |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| oauth2 | oauth2 |