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": [
"30df654a-1882-46e9-b198-e9d59e1fbbdf"
],
"excludedIds": [
"3261d38f-5499-43a0-b5e8-fb2f6d8cdc5c"
],
"datasetIds": [
"c5ffe712-a4ed-4fb9-95bf-72237943d4f0"
],
"like": "string",
"contextRoles": [
"string"
],
"contextRoleSubjectId": "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
},
"contextRoles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Limit lookup to items that the provided user has explicit access kind. If set, the list of values must not be empty",
"nullable": true
},
"contextRoleSubjectId": {
"type": "string",
"description": "Limit lookup to items that the provided user has explicit access kind. This should only be set in combination with ContextRoles. If left empty, the current user is used",
"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": "6aa6a8f1-5067-455b-9027-c48a45eb9935",
"code": "string",
"name": "string",
"datasets": [
{
"id": "ca7e85fd-f539-4a8e-adb7-973d1c01e539",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 279,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": null,
"permissions": [
"string"
]
}
],
"datasetCount": 43,
"permissions": [
"string"
]
}
],
"count": 85
}
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": "26002ae8-5bbb-4dd8-8b7a-97798b1445d7",
"code": "string",
"name": "string",
"datasets": [
{
"id": "d641c207-82f7-4934-b7e2-9f33daf7acc4",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 117,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": null,
"permissions": [
"string"
]
}
],
"datasetCount": 297,
"permissions": [
"string"
]
}
],
"count": 283
}
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": "aa0f86b6-2b86-4522-9d72-a44a0935bf7e",
"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": "2a015b10-ebd4-4c27-b776-b3b9f440d1a3",
"code": "string",
"name": "string",
"datasets": [
{
"id": "4b2d1d1e-6a0e-42f7-ab60-5eacd918ae2e",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 102,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "20415565-d99e-4db8-846f-a718ab6f5e4a",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 14,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"datasetCount": 220,
"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": "f7ba270c-16bb-42ab-8055-e14b7281297d",
"code": "string",
"name": "string",
"datasets": [
"c8e5fa52-03c6-4b46-98a3-bdb120594a05"
]
}
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": "b5fc6a4e-f469-4f1b-bdf6-539a7dde5170",
"code": "string",
"name": "string",
"datasets": [
{
"id": "2de628ff-e7ef-482f-9a55-abf580d82cff",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 25,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "85ef2454-dabe-4f5c-b216-32e418e1b7e2",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 147,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"datasetCount": 151,
"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": "dcbe0a18-5f93-46f7-bd39-529a274e5b2c",
"datasets": [
"f59a9c26-05bb-431f-aa8e-752461fb4616"
]
}
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": "c5eb65b8-056a-458a-8184-d47928d64a44",
"code": "string",
"name": "string",
"datasets": [
{
"id": "2deed373-33bf-4b8f-8e64-9c99b205256e",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 232,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "373ace01-c314-434f-800e-008b0393da90",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 269,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"datasetCount": 68,
"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": "023851e4-1695-486b-9030-141fa31c7f5a",
"code": "string",
"name": "string",
"datasets": [
{
"id": "84daa4ad-b343-4fab-8dc2-eaa4e3517a81",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 88,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "5286c2ae-c0b8-4fa0-b27c-eaaa2e8fcdf7",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 252,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"datasetCount": 251,
"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": "83e94434-e240-4bac-bde2-f73a3741f7b7",
"code": "string",
"name": "string",
"datasets": [
{
"id": "7c7ba2f6-6db9-40d5-bf5c-9bc90f8d0eb1",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 108,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "f56fcdd1-8b69-42d6-b762-05cd121720a2",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 38,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"datasetCount": 82,
"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": [
"be273f7e-f0e3-439b-8fee-26276e58d4cb"
],
"userIds": [
"d209eaa9-ddf9-408a-b65e-0fb16af06c51"
],
"excludedIds": [
"a95187ef-5e61-4d7b-a390-6b5975aeacb1"
],
"isActive": [
27
],
"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": "3dd896b7-8952-4a17-aafb-f02c3bf06abb",
"name": "string",
"user": {
"id": "bcdfeefe-22b3-4ce3-b5d9-b4186cade334",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "aa402ef9-ac6a-4733-b942-4765911f352f",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "05becc7f-7c79-4be6-9bf6-523a52016e3c",
"dataset": {
"id": "a429e689-c2ff-41b8-8081-dd1b1f8d96e4",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 193,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "f8506762-a101-4538-a470-cbcbad5a67a2",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 72,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 191,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 92,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "ac3ce9e2-0454-4be7-bcdb-e51656198d9a",
"dataset": null,
"conversation": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": [
{
"id": "65e30982-d39c-4e7d-a418-6f981707ccb3",
"conversation": null,
"kind": 277,
"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": 132
}
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": [
"5cc83a9d-d9df-4b50-9585-28b6f51dc9d8"
],
"userIds": [
"d5e48ef5-6a8c-475c-8c53-f7b6ab4bd2a7"
],
"excludedIds": [
"ae189439-36bd-49ec-96db-e5c96f577569"
],
"isActive": [
203
],
"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": "08210291-8f70-4247-b198-0c3c0e16b073",
"name": "string",
"user": {
"id": "872a47e1-2308-467c-b475-df9f8f21377f",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "a175a8d2-c7e7-45c7-9010-e8a45fbbbe02",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "a6d539b1-106e-44df-933e-67d4431a12fc",
"dataset": {
"id": "25f48a6a-ae24-4cfb-a47c-1a92afb1a322",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 71,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "42ced0b6-e8d0-41ac-89dd-2cb67888e241",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 100,
"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": 255,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "023258f6-8627-45bc-8ebd-ada9e5341f5f",
"dataset": null,
"conversation": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": [
{
"id": "5c69b8a6-08ab-463f-b5c3-60899b160910",
"conversation": null,
"kind": 183,
"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": 297
}
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": "ba3aa7e9-da52-4b82-81a1-feebb4f57290",
"name": "string",
"user": {
"id": "50541525-8ee7-49e2-95a5-a25083ba2cc7",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "b41564cf-4ed5-45d6-92ed-9b95d938ee01",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "9a4afec4-e6b4-420a-8e30-9eb1e80a0148",
"dataset": {
"id": "84a65adc-5308-4e48-b2dd-296439d4364f",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 144,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "b82e07a9-8b15-44a9-8b39-ee9ac2196971",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 218,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 179,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 262,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "3b83b737-d9f6-41bd-b3e6-d8ad8ceb78f0",
"dataset": null,
"conversation": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": [
{
"id": "67ec60b0-633f-43b1-acf8-54725bfc3bc5",
"conversation": null,
"kind": 41,
"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": 238
}
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": "b74a487b-3647-47f3-bbc2-e9511bf0ba41",
"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": "14fb4629-54e9-45ba-9193-bcc30e7dd418",
"name": "string",
"user": {
"id": "0c8ddff7-225e-42c6-b3dd-df1d76954060",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "a2023f08-bdb0-42e3-8bb7-6b853a25ae74",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "72fda97e-98ed-4218-9c91-da3068ef18cf",
"dataset": {
"id": "d19bba12-01d4-464f-821c-dfde17820d94",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 200,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "bbe1d6e9-a63b-4eb0-839c-ed1a6dd81b7a",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 252,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 58,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 186,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "9483ab13-3c34-46dc-92b4-253000fb741a",
"dataset": null,
"conversation": {
"id": "945dc23b-b0d2-4188-b227-73015633f521",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "a0f2ee6d-a939-42e3-bd09-c36ea4caa266",
"conversation": null,
"kind": 165,
"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": "ef6c778c-ac4f-4d48-9284-8fbb01985623",
"name": "string",
"conversationDatasets": [
{
"id": "36858f85-c05d-4e7e-95a0-c318f9028be0",
"conversationId": "9fd5c0d7-a768-4551-bad0-e97ead4b543b",
"datasetId": "d8311b4e-7c86-41b9-96c6-bfbfad739ddb",
"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": "3a511623-68d2-419f-903a-54bfcde64b86",
"name": "string",
"user": {
"id": "51f54aa7-572b-48e7-91ff-300107b12b5a",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "912271b1-be18-476e-ba5a-0a96544339b9",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "b31514f9-30ae-4705-83a7-b1cd975ddd83",
"dataset": {
"id": "e3b015c5-4855-4bec-8d30-c6d33caee609",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 277,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "d24aa4f6-0992-4f1a-95bf-134b67660746",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 108,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 139,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 280,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "5b54805b-9cc3-4022-83fb-968ece265fdb",
"dataset": null,
"conversation": {
"id": "01536ed7-5bf5-4921-9b3e-4aaf20bf9932",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "a8865e00-75b8-4b4a-9109-3c8f6b445eaa",
"conversation": null,
"kind": 262,
"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": "8fb2acff-c002-4943-bfe9-5b6324aba7ee",
"conversationDatasets": [
{
"id": "d64ea1ec-6f77-41c4-84f0-e132d41ebae5",
"conversationId": "f24cffc0-f9c4-43b9-aa98-e24ef1bb012f",
"datasetId": "5dea1948-20a3-4018-bbec-60b9ec03b76d",
"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": "44722ca1-50ef-49d0-87dd-606f3e55cb0e",
"name": "string",
"user": {
"id": "8bf1fcc4-5766-4c74-9c27-5ac47b358b74",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "b8c7cb68-cc92-4fe0-8ccd-3f49da56d960",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "3c16313c-5d62-4f99-a01e-187aff31fed7",
"dataset": {
"id": "4f7875bc-5d26-4ee0-ab67-a3e106f2f0c1",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 115,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "f623ec8c-4ec4-44f9-9603-48c37487be36",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 160,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 230,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 153,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "10545374-f0f2-4d4a-af13-d7abf60f56c1",
"dataset": null,
"conversation": {
"id": "b761773e-6d09-46d9-80a6-ebdef4e3eb62",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "a2bad500-9240-4d2f-af1c-87a9b1a4bbc5",
"conversation": null,
"kind": 33,
"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": [
"e39abd28-f04a-4da4-883b-f9c7f4096eaf"
],
"excludedIds": [
"25940a46-b015-4a01-b87d-6e54817e0e85"
],
"conversationIds": [
"a3a5bfe9-7363-459a-9af3-cc56cf25ff42"
],
"datasetIds": [
"f9804515-1589-4061-982c-b169ece02491"
],
"isActive": [
137
],
"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": "efd7eec0-a7c3-419e-8373-49522784f9c3",
"dataset": {
"id": "89ba31c6-0c90-4994-b2e2-564c64c03d96",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 83,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "06a89544-681a-4efb-ba8f-380e3f966994",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 11,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"conversation": {
"id": "238243d7-eff4-4e40-ab02-30b8d053516e",
"name": "string",
"user": {
"id": "e3117b69-f630-4fd2-b2b6-17fd2a4b4ef0",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "f52df80c-cd62-443d-a6ac-37c02c939be4",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "a69e3d52-bc31-4c17-bd0f-0476eaf75d6f",
"dataset": null,
"isActive": 49,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 36,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": null,
"messages": [
{
"id": "c5ebb0d0-38a5-4b83-afc2-4353f57aa8eb",
"conversation": null,
"kind": 176,
"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": 276
}
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": [
"ba14fe88-67e3-4fae-8363-c02e7c0bfe89"
],
"excludedIds": [
"ef3e0d6c-9b4b-414c-890b-908beefe155d"
],
"conversationIds": [
"110033e1-b400-42c7-80f0-5b03a2e31906"
],
"datasetIds": [
"6b834ad0-431d-45cf-b962-06bb6021af9c"
],
"isActive": [
183
],
"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": "988e4b68-3c50-4abe-80de-232c405ab42c",
"dataset": {
"id": "3ee129bb-c395-4701-b3a9-1e5b8478232b",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 114,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "5f444a10-33cb-49f2-b16d-08f623d16fa7",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 212,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"conversation": {
"id": "db6d96a3-4470-4d2c-92a2-28716669ab07",
"name": "string",
"user": {
"id": "63ddf8f9-e113-4c61-846f-171efe0efcc3",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "5d8b95d5-cbfe-4756-93d4-8a0fed1c2220",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "e6721c8a-4df7-4e60-9490-989136f5b30b",
"dataset": null,
"isActive": 131,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 231,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": null,
"messages": [
{
"id": "fc737359-80f4-4547-a13c-7731d40b4c53",
"conversation": null,
"kind": 42,
"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": 246
}
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": "b7e06bb6-6c96-4a83-bf5f-3b36e19da6c2",
"dataset": {
"id": "df7d5d6f-1ab2-4918-b69b-c4d15422e15f",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 50,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "7e74a12f-c944-4425-ae01-c24b90db77d2",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 292,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"conversation": {
"id": "0431e400-73e9-4858-83a5-a837a763f56f",
"name": "string",
"user": {
"id": "1ef114b7-b8e4-4d7c-b589-b9b270189c90",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "f8417330-f271-42d2-9086-a5046545b124",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "db2bc049-ff00-4893-965c-8f1438bd7a35",
"dataset": null,
"isActive": 196,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 191,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": null,
"messages": [
{
"id": "e76f3602-24b2-4771-820d-655f53f251d3",
"conversation": null,
"kind": 111,
"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": 274
}
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": "340acce0-123e-4e17-b8e3-a45f58b77e99",
"name": "string",
"user": {
"id": "048f6b39-30e5-4134-a478-bef013673282",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "fb2ca8e4-30d6-46d0-a566-d1c7ea889650",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "f8df1a9d-35d2-4f99-a6c2-df6d59104a26",
"dataset": {
"id": "d03dc205-889e-4f2e-b437-14b34d3194ba",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 172,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "56eb9bae-f8e6-4c20-bf48-e8ae464f9632",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 125,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 34,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 108,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "0dc3c3b7-4066-4343-a5bf-5d36cdb2840e",
"dataset": null,
"conversation": {
"id": "4b1982cf-f40f-4cb6-bf3e-ce9b5a534078",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "b7d6c858-5938-4152-bfae-ae5f91608b7a",
"conversation": null,
"kind": 162,
"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": "4843fed4-9c8b-4eb8-89a7-2c9b96f976b5",
"name": "string",
"user": {
"id": "f3569fc5-f844-4ada-bd05-7e3197734397",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "b9cf9c7c-2f05-4f34-8ca0-c7c6cf93d2e9",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "bdc0fcfd-d68e-45cf-b857-07d2ba269f01",
"dataset": {
"id": "b63c8e36-3b5f-4da4-ac9a-6bb1b9f43313",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 80,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "e0f6fc2f-3937-4306-bc66-f992d17cfa80",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 124,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 227,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 216,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "271185ea-01fc-4ff5-bea1-b9177a2940b7",
"dataset": null,
"conversation": {
"id": "3c6c3061-f231-47ad-9301-ce82f07647bc",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "cceacb71-d577-446e-9754-1e220b597ec6",
"conversation": null,
"kind": 181,
"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": [
"c1dbf5dc-58df-49ac-abd0-bcf7eef117f3"
],
"excludedIds": [
"01548600-f0f7-410f-a4c4-f38772da663b"
],
"conversationIds": [
"57722e2a-58ab-47dd-98a8-1320bf8031c7"
],
"kinds": [
72
],
"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": "2f428fb3-a9d5-4340-815d-5feacbf413b8",
"conversation": {
"id": "c453de48-43d5-4e83-8cf1-d2d897fd42c2",
"name": "string",
"user": {
"id": "d28276aa-a015-411f-9bc6-7aa8f300a240",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "5189633d-7618-434c-9cc3-cb63187b7561",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "9f4fa4a6-a269-4759-8ffc-63b19ae25040",
"dataset": {
"id": "a19b7bd8-d121-46e1-85df-5c135e627509",
"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",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "20600cb3-2945-4575-ba69-27a2ef75d82a",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 45,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 49,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 286,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "508c719d-a31a-415b-887c-daa494b3ac4b",
"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": 66,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"count": 163
}
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": [
"96ebe0f9-f031-472a-9687-e648d65c285d"
],
"excludedIds": [
"001f9c56-c979-455f-9b3d-9e0f57935af5"
],
"conversationIds": [
"7d6b0729-b4fa-4724-8e80-0a100f436d9a"
],
"kinds": [
209
],
"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": "e6ee22ba-f950-4602-be52-a030665f10c2",
"conversation": {
"id": "3006a039-db70-470c-aa85-bc99d0124169",
"name": "string",
"user": {
"id": "41edd669-6346-4f2b-99ca-3287407aaf8c",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "0f545031-6e9b-4114-ad6e-143843d54376",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "3faed6a3-c8a6-482f-af10-d9e60aa028e2",
"dataset": {
"id": "8988ef3c-9d3b-48cd-a587-4e5f965c3c7a",
"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",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "ae6f66ef-8e8f-4cf1-81c3-e2f3158a31cd",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 35,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 69,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 6,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "f3cc954e-82c0-4a63-95d4-620137364767",
"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": 31,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"count": 179
}
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": [
"d80f2f1b-5810-4e4c-b3ac-4debc69dbba1"
],
"excludedIds": [
"4571a94a-82ac-4aa0-ab9e-16612f5fcd30"
],
"collectionIds": [
"84b6e069-d0cb-4cf9-9b5e-e55f482cfe5d"
],
"like": "string",
"license": "string",
"mimeType": "string",
"fieldsOfScience": [
"string"
],
"publishedRange": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"sizeRange": {
"start": 293,
"end": 298
},
"contextRoles": [
"string"
],
"contextRoleSubjectId": "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
},
"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"
},
"contextRoles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Limit lookup to items that the provided user has explicit access kind. If set, the list of values must not be empty",
"nullable": true
},
"contextRoleSubjectId": {
"type": "string",
"description": "Limit lookup to items that the provided user has explicit access kind. This should only be set in combination with ContextRoles. If left empty, the current user is used",
"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": "05e6264f-422b-458e-94ef-4999f0db06bd",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 49,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "6a91f16d-46e5-4d9b-b869-77d485219e9a",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 182,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"count": 41
}
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": "e9311544-eee5-4c76-b050-76a05b982b18",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 263,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "9264a2d4-b72f-4f27-af79-e31e442a8361",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 196,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"count": 151
}
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": "9158f3b7-6b92-4bfb-a806-8d047b02e5d8",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 163,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"dataLocations": [
{
"kind": 208,
"location": "string"
}
],
"citeAs": "string",
"conformsTo": "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
},
"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
},
"dataLocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataLocation"
},
"nullable": true
},
"citeAs": {
"type": "string",
"nullable": true
},
"conformsTo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 200 OK
"618fdad8-96e7-4000-b61e-f9dfee75c996"
Schema of the response body
{
"type": "string",
"format": "uuid"
}
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/future-onboard¶
Onboard dataset
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
f |
query | array | No |
Request body
{
"id": "504d9410-3c9a-4f73-b579-45d5b1b9e840",
"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",
"dataLocations": [
{
"kind": 57,
"location": "string"
}
],
"citeAs": "string",
"conformsTo": "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
},
"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
},
"dataLocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataLocation"
},
"nullable": true
},
"citeAs": {
"type": "string",
"nullable": true
},
"conformsTo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 200 OK
"7b4dcfb5-fe90-47d9-bae6-dfe98fab89f1"
Schema of the response body
{
"type": "string",
"format": "uuid"
}
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/profile¶
Profile dataset
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"id": "588acf10-a442-441a-98bb-ca7f8f1111dc",
"dataStoreKind": 198
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"dataStoreKind": {
"$ref": "#/components/schemas/DataStoreKind"
}
},
"additionalProperties": false
}
Response 200 OK
"a4578815-e6b3-4991-8880-6a829a539c82"
Schema of the response body
{
"type": "string",
"format": "uuid"
}
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/future-profile¶
Profile dataset
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"id": "8c67d681-7f2e-42d2-95ac-8c79224a0b2f",
"dataStoreKind": 134
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"dataStoreKind": {
"$ref": "#/components/schemas/DataStoreKind"
}
},
"additionalProperties": false
}
Response 200 OK
"0f535b62-79f4-4d35-b5e7-b55c7b8bd545"
Schema of the response body
{
"type": "string",
"format": "uuid"
}
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": "c954d65f-7de5-4fab-8956-360556055f77",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 292,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"dataLocations": [
{
"kind": 101,
"location": "string"
}
],
"citeAs": "string",
"conformsTo": "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
},
"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
},
"dataLocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataLocation"
},
"nullable": true
},
"citeAs": {
"type": "string",
"nullable": true
},
"conformsTo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 200 OK
{
"id": "7aef8506-b7ce-4bcf-8dfc-c83468678ac2",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 9,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "9688a16d-f78b-4794-860a-cf3d7947d14c",
"code": "string",
"name": "string",
"datasets": [
{
"id": "9e15003a-ca7a-49be-9df7-9be584faa0d1",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 24,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": null,
"permissions": [
"string"
]
}
],
"datasetCount": 139,
"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
},
"archivedAt": {
"type": "string",
"nullable": true
},
"conformsTo": {
"type": "string",
"nullable": true
},
"citeAs": {
"type": "string",
"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/as/data-management/onboard¶
Persist dataset as data management service
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"id": "f64f8e60-20d5-46c4-ad34-2788f4b35120",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 32,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"dataLocations": [
{
"kind": 123,
"location": "string"
}
],
"citeAs": "string",
"conformsTo": "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
},
"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
},
"dataLocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataLocation"
},
"nullable": true
},
"citeAs": {
"type": "string",
"nullable": true
},
"conformsTo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
Response 200 OK
"57368aa0-3055-4812-93e1-bdc20cbc3815"
Schema of the response body
{
"type": "string",
"format": "uuid"
}
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/as/data-management/profile/{id}¶
Persist dataset profile as data management service
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
id |
path | string | No | The id of the dataset to update |
Request body
"string"
Schema of the request body
{
"type": "string"
}
Response 200 OK
"15cbd056-5318-4ba3-b6d8-ffb2da1a8cfb"
Schema of the response body
{
"type": "string",
"format": "uuid"
}
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
POST /api/principal/context-grants/query¶
Query context grants
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"datasetIds": [
"9ff03d08-0405-4687-81ac-40756118ff42"
],
"collectionIds": [
"5242e471-b43b-470a-8c4e-9a0c76701c86"
],
"roles": [
"string"
],
"subjectId": "string",
"targetKinds": [
274
],
"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": {
"datasetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items target specific dataset 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 target specific collection ids. If set, the list of ids must not be empty",
"nullable": true
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Limit lookup to items granting specific roles. If set, the list of roles must not be empty",
"nullable": true
},
"subjectId": {
"type": "string",
"description": "Limit lookup to items granting access to specific subject. If empty, use current user",
"nullable": true
},
"targetKinds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TargetKind"
},
"description": "Limit lookup to items of specific kind. If set, the list of roles 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
{
"principalId": "string",
"principalType": 55,
"targetType": 42,
"targetId": "5fdf2be3-aa1c-43ee-9a87-6a1a57f23961",
"role": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"principalId": {
"type": "string",
"nullable": true
},
"principalType": {
"$ref": "#/components/schemas/PrincipalKind"
},
"targetType": {
"$ref": "#/components/schemas/TargetKind"
},
"targetId": {
"type": "string",
"format": "uuid"
},
"role": {
"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
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": 52,
"targetType": 159,
"targetId": "b0295eec-0fd3-4eae-b781-4b87c75c0cdf",
"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": 71,
"targetType": 216,
"targetId": "b4f52ff0-69f9-4641-81a3-c191810aeb50",
"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": 126,
"targetType": 111,
"targetId": "142ed09f-148e-4a78-99a4-0a38651c3a84",
"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": 150,
"datasetIds": [
"a558fdce-17c6-4245-b0d3-2d07fa13169d"
],
"collectionIds": [
"c9bc53dd-a302-47af-98a5-0b1db7462868"
],
"userCollectionIds": [
"ec8d3349-b27a-48b1-9213-869884fdfc4a"
],
"conversationOptions": {
"conversationId": "40720a80-786c-431e-bff5-da560c375b83",
"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": "4438be1f-8ccc-475e-bda7-4b26e06f2db7",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 229,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "8adb1e07-b9eb-4b2e-8c99-e63fbcd1f57f",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 275,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"maxSimilarity": 10.12,
"hits": [
{
"content": "string",
"objectId": "string",
"similarity": 10.12
}
]
}
],
"conversationId": "ac086e05-7d4c-4aae-8ef4-9321e1fda6ea"
}
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": [
"7abee00e-fc7c-406e-b2d5-cef79f802e30"
],
"conversationOptions": {
"conversationId": "74385204-8ba4-40e8-984e-5106e8d2f5e5",
"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": 161,
"entries": [
{
"process": {
"kind": 276
},
"result": {
"kind": 178,
"message": "string"
},
"status": 71
}
]
}
],
"conversationId": "1cd62970-bf33-480f-a97b-17fd8f737d60"
}
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
POST /api/search/recommend¶
Recommend possible queries
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Request body
{
"query": "string",
"conversationOptions": {
"conversationId": "d6360043-1616-4cfc-be4b-6ab6befa45b6",
"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 query the recommendation will be based on",
"nullable": true
},
"conversationOptions": {
"$ref": "#/components/schemas/ConversationOptions"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"result": [
{
"query": "string"
}
],
"conversationId": "6302a516-417b-4638-bc99-c61d08f33bcb"
}
Schema of the response body
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryRecommendation"
},
"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
Storage¶
GET /api/storage/upload/allowed-extension¶
Retrieve allowed extensions for upload
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Response 200 OK
[
"string"
]
Schema of the response body
{
"type": "array",
"items": {
"type": "string"
}
}
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/storage/upload/dataset¶
Upload dataset files
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No |
Response 200 OK
[
"string"
]
Schema of the response body
{
"type": "array",
"items": {
"type": "string"
}
}
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": [
"5053c3e6-e22a-4f66-9bb9-9c826ec859a6"
],
"excludedIds": [
"369a0d3a-7ee4-49b8-9f79-c72c702d78f2"
],
"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": "e377bdad-0683-4595-8850-c3bd153e53b1",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "4a715de2-e4ce-428b-9e41-2f472c143ff3",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "934194a2-f89f-43db-8f15-e11dd726d257",
"dataset": {
"id": "09833cf2-ccc0-4cf7-a238-903132de1414",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 186,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "99d51387-957c-4cac-8d1d-18d10a8ec78b",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 257,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 155,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 159,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
}
],
"count": 171
}
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": "2e8dd05a-ea7a-4fa2-aa3c-f760637df6f4",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "28138958-f544-4f03-8682-3feaaf05ccaa",
"name": "string",
"user": {
"id": "60ced753-3e42-4ab5-8b5c-40187ac87953",
"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": "982b1f8e-9656-48d9-92cb-d1b1c157415b",
"dataset": {
"id": "2b87f181-f9b5-4775-a4e2-637e7895ab80",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 122,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "7ca85b33-f70b-4504-bc8a-17f3f227e715",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 263,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 148,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 128,
"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"
],
"semantics": [
"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
},
"semantics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Limit lookup to items with specific semantics",
"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",
"semantics": [
"string"
]
}
],
"count": 142
}
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": [
"8b3810da-57fd-4291-8bcb-dd8635de2d78"
],
"userIds": [
"a214bc9a-c785-4588-8d78-ad6363298859"
],
"excludedIds": [
"68bf2a6f-9ebc-46a2-9ce3-eab6b5c5e18b"
],
"isActive": [
87
],
"kind": [
123
],
"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": "701f80ff-e86a-45fc-b503-43bbec2b4fe6",
"name": "string",
"user": {
"id": "78e18e75-1fb2-4148-bc61-4eac32c862b6",
"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": "fcf600fa-e0b9-4f95-b134-763d3436f116",
"dataset": {
"id": "0d99aa53-a7e5-440a-b144-ee591329b0a4",
"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",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "b150a80c-27e6-4cba-a02d-095e6ea88af7",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 233,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 293,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 126,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"count": 209
}
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": [
"6fa89d61-4e9d-414c-9fdc-266e1e85ce08"
],
"userIds": [
"4c2b5f14-7e30-4ff0-994e-59295263d2df"
],
"excludedIds": [
"44e64989-933d-4736-a255-ce8bb1df353c"
],
"isActive": [
118
],
"kind": [
285
],
"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": "b848d702-f5a1-406b-b10d-fe4afa7cdf91",
"name": "string",
"user": {
"id": "543b02bc-502f-433a-af7a-1642dc5c8d00",
"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": "33a7ad6e-c986-476d-b0bd-e1ddb949ab77",
"dataset": {
"id": "d330d3a7-c934-497c-a641-2b3b19e26ff5",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 122,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "70728d6f-3ce3-49e8-aa85-867c17843e9a",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 90,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 286,
"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"
}
],
"count": 75
}
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": "75783d38-ec79-46b1-839c-83503a065cf1",
"name": "string",
"user": {
"id": "ebf62768-2606-430d-a009-858586aef0e2",
"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": "b2b52deb-b1af-4769-82a4-e9ca8b4a18c9",
"dataset": {
"id": "1c85d656-7e4e-4d0b-b9e6-3ebe491c9e29",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 242,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "e358fe2b-d73f-4d89-954b-60c765c2c097",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 241,
"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": 126,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"count": 236
}
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": "f4fc3f78-971b-4403-8799-8e92a5adde9a",
"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": "0862debb-c620-4d04-b36e-c2abef56f11d",
"name": "string",
"user": {
"id": "1a0855f1-8f22-43be-90e7-ab2196758521",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "22415547-5c72-4eb5-9a29-e6286b1b6f9a",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "7a6e5547-b88a-44d6-bc20-48bb0e379038",
"dataset": {
"id": "742b2f3f-2b40-4870-bd92-2ea061392af7",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 273,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "807c2af8-0550-4de8-8026-42500faeb422",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 132,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 99,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 239,
"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": "915024a9-93f8-43f4-b43b-9f33ff2589ff",
"name": "string",
"userDatasetCollections": [
{
"id": "b8a1f5ae-31a1-4922-b88a-8c342eeb2c53",
"userCollectionId": "12e8b7bf-d3b3-4289-a1bb-306256360c62",
"datasetId": "e45698c7-00f8-4b4d-9bb7-42e9b2ec9ea7",
"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": "f54b914b-7d85-4533-b2af-f47feb75407b",
"name": "string",
"user": {
"id": "4f183cde-1b2c-4ee8-bb8d-f4e3c40d2048",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "68a404cb-4420-4a13-b502-c80813055e17",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "da35503d-3e5f-44c8-bd08-5c152eb0951d",
"dataset": {
"id": "a44f1af8-2de4-4b7e-8203-a7c7ea84a0fd",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 236,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "f33aa3f0-c363-4901-a091-60a5313a4d22",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 156,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 97,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 296,
"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": "332ee162-6803-4dbe-b8b2-7f18121366af",
"userDatasetCollections": [
{
"id": "4b925b71-d5db-4e7b-af64-38d4ff66dafd",
"userCollectionId": "1a551179-98f8-4bba-8a2b-417c49c8218c",
"datasetId": "cc27ccfa-1d0a-4a28-979a-518eca6f8bd3",
"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": "01f51e53-9a33-4399-8528-9fc2e988bd8b",
"name": "string",
"user": {
"id": "15d9bbc4-23b2-4dde-8991-a026e31d7f0b",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "28e15c14-38a0-4e87-89cf-ff0c8ab6f7db",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "f587f24a-27c7-4f8b-9f48-427c496b77a7",
"dataset": {
"id": "976a976b-6755-4f5d-9c8e-2e008979fe35",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 103,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "2fe0cdbb-3d3e-44bc-ad2f-80b22d193b66",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 199,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 131,
"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"
},
"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": [
"971d9313-6e2e-4a71-9fc5-f04a088f664f"
],
"excludedIds": [
"0da7aef8-2ee5-418c-9cbf-8a3811b80608"
],
"userCollectionIds": [
"79c721b6-fc7c-4428-8dc9-70bbbe9ded20"
],
"datasetIds": [
"8e6ea00c-dfcd-4a11-872c-b29642c32e18"
],
"isActive": [
285
],
"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": "15c45ebf-37dc-435d-a2b7-c5bf5ac8344f",
"dataset": {
"id": "e5fdbe46-d0b7-4b00-85fc-4e9364412f41",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 27,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "7d599cb3-c253-49df-bd6b-0c5cc2f137d2",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 126,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 113,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": {
"id": "32c50b4a-f4bb-49fd-9d37-52909f33cff5",
"name": "string",
"user": {
"id": "7f4ded61-cc9f-40c2-8cae-714cc074a8bc",
"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": 226,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"eTag": "string"
}
],
"count": 130
}
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": [
"fd90a254-abfd-46db-809c-b18cab668e42"
],
"excludedIds": [
"a5d1f624-0929-4de6-a6f6-d3248a8e6819"
],
"userCollectionIds": [
"d9b148f5-5e8e-48a0-b21e-d240a817a4af"
],
"datasetIds": [
"39f5b9cb-3c0b-41c6-b6a1-730079001103"
],
"isActive": [
269
],
"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": "eda9ef64-332d-44fc-ae4c-210b4b756242",
"dataset": {
"id": "405b01a6-e841-466c-bacd-5993abf3ab75",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 247,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "ad1bc315-7646-489e-a300-8b77ee888dfa",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 215,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 300,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": {
"id": "bfe3e74c-62ff-4691-9125-b6fc7cccc957",
"name": "string",
"user": {
"id": "64679d1a-5096-4301-acb7-b113f9c4e1c3",
"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": 208,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"eTag": "string"
}
],
"count": 33
}
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": "9b89b8ab-ad8e-4ac8-99fe-8dd1819240b8",
"dataset": {
"id": "9a7c6776-76a7-4c22-a3ff-c1155f027757",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 83,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "09202807-7343-4fde-9df5-bfdd3b7dd131",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 2,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 167,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": {
"id": "3afaaa4c-5e1b-46b1-8556-5e71d16aeb0f",
"name": "string",
"user": {
"id": "255b26d7-3f87-443a-81c5-60faf09e5f43",
"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": 246,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"eTag": "string"
}
],
"count": 34
}
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": "0f93c629-0a14-46f7-b325-2114477983f1",
"name": "string",
"user": {
"id": "c82eb05e-93f7-433e-a08e-b8b3e5e19dab",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "38813497-6616-4fb3-bbc6-16b23d8a7b20",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "715c6641-44dc-43bb-87c5-645eda7592f4",
"dataset": {
"id": "75d50a31-021e-471f-8805-69e4b0c16281",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 107,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "642600a2-a8f6-465a-992b-9ea703b5cdc0",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 150,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 300,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 165,
"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": "02db7c8d-7c6d-44f7-9e1e-e28f4a3dc4a8",
"name": "string",
"user": {
"id": "10b8247c-959c-4267-9583-6b0f59510ad1",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "6e6eee4a-6c01-452d-8c5f-4e70c36d824c",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "7412e724-c919-40ee-b9c8-bd06e7a4289c",
"dataset": {
"id": "87b61ac0-00aa-4a3e-9e3a-b6b8026a2b44",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 47,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "93e500f8-fd91-4e30-9f6d-1dcf586abc63",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 212,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 242,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 198,
"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": "a6760114-a09c-4214-8f1d-9b8539cd38d8",
"key": "string",
"user": {
"id": "dc07f62f-17a8-4f1c-ad59-71685e22bcf4",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "4c6b77c1-01a6-4ed6-91c5-88a327ecddea",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "e3042ace-90c5-4db6-855b-486512a9b9b3",
"dataset": {
"id": "25357051-0c4f-4d4b-aeaa-e68440fbdc4e",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 288,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "b377e519-6f02-4b49-b72c-3924fa3faa9f",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 157,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 117,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 276,
"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": "2a84af3e-37b7-46f5-8eed-0872090a7edb",
"key": "string",
"user": {
"id": "392aeb3d-eb9e-4edf-9162-0ee9ed023319",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "ed466931-7983-47e4-afce-edc88b1c964f",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "d321dd1d-fe9f-4634-9c3d-29f71a4a3f3e",
"dataset": {
"id": "61889462-8ef3-401d-85ac-1d294cafb862",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 248,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "be2438a8-f241-45ea-9f80-eab8ea9b1537",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 228,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 91,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 164,
"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": "bab326af-eb41-4ac8-a60e-d9d1689492c2",
"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": "6ed29068-8009-4303-a68b-1c2216edebcc",
"key": "string",
"user": {
"id": "d843f00f-31c9-4dfc-a3dd-98f2dd6ed02e",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "07ef22d9-566d-49a1-94c2-4de8a93a82b9",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "134a85cb-2fdf-4e5d-8c67-e6bc8cde27e6",
"dataset": {
"id": "bbf4a271-a14d-4c26-a4a2-7a2f63d6ad8b",
"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",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "5a8d088c-f1e3-4b30-bd92-f6ec7494371c",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 264,
"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": 37,
"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": 6
}
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": 270,
"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": [
290
],
"like": "string",
"excludeStaled": true,
"onlyPaused": true,
"lastRunState": 62,
"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
},
"onlyPaused": {
"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": 292,
"maxActiveRuns": 168,
"maxConsecutiveFailedRuns": 68,
"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 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": 3,
"maxActiveRuns": 155,
"maxConsecutiveFailedRuns": 232,
"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": 240
}
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": 138,
"triggeredBy": "string",
"state": 284,
"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": 5,
"maxActiveRuns": 124,
"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"
]
}
]
},
"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": 53,
"tryNumber": 214,
"maxTries": 77,
"taskDisplayName": "string",
"hostname": "string",
"unixname": "string",
"pool": "string",
"poolSlots": 225,
"queue": "string",
"queuedWhen": "2022-04-13T15:42:05.901Z",
"scheduledWhen": "2022-04-13T15:42:05.901Z",
"priorityWeight": 4,
"operator": "string",
"pid": 177,
"executor": "string",
"executorConfig": "string",
"note": "string",
"renderedMapIndex": "string",
"renderedFields": null,
"trigger": null,
"triggererJob": null,
"dagVersion": null,
"workflow": null,
"task": null,
"workflowExecution": null
}
]
}
],
"count": 26
}
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": [
126
],
"state": [
112
],
"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": 167,
"triggeredBy": "string",
"state": 132,
"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": 214,
"maxActiveRuns": 195,
"maxConsecutiveFailedRuns": 190,
"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": 192,
"tryNumber": 38,
"maxTries": 264,
"taskDisplayName": "string",
"hostname": "string",
"unixname": "string",
"pool": "string",
"poolSlots": 181,
"queue": "string",
"queuedWhen": "2022-04-13T15:42:05.901Z",
"scheduledWhen": "2022-04-13T15:42:05.901Z",
"priorityWeight": 23,
"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": 213
}
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": 4,
"tryNumber": 59,
"maxTries": 24,
"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": 265,
"operator": "string",
"pid": 239,
"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": 215,
"maxActiveRuns": 265,
"maxConsecutiveFailedRuns": 157,
"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": 33,
"triggeredBy": "string",
"state": 104,
"note": "string",
"bundleVersion": "string",
"workflow": null,
"taskInstances": null
}
}
],
"count": 234
}
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 |
|---|---|
contextRoles |
Array<string> |
contextRoleSubjectId |
string| null |
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 |
ContextGrantLookup¶
| Name | Type |
|---|---|
collectionIds |
Array<string(uuid)> |
datasetIds |
Array<string(uuid)> |
metadata |
Header |
order |
Ordering |
page |
Paging |
project |
FieldSet |
roles |
Array<string> |
subjectId |
string| null |
targetKinds |
Array<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)> |
DataLocation¶
| Name | Type |
|---|---|
kind |
DataLocationKind |
location |
string| null |
DataLocationKind¶
Type: integer(int32)
Dataset¶
| Name | Type |
|---|---|
archivedAt |
string| null |
citeAs |
string| null |
code |
string| null |
collections |
Array<Collection> |
conformsTo |
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 |
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)> |
contextRoles |
Array<string> |
contextRoleSubjectId |
string| null |
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 |
|---|---|
citeAs |
string| null |
code |
string| null |
conformsTo |
string| null |
country |
Array<string> |
dataLocations |
Array<DataLocation> |
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 |
DatasetProfiling¶
| Name | Type |
|---|---|
dataStoreKind |
DataStoreKind |
id |
string(uuid)| null |
DatasetQueryResult¶
| Name | Type |
|---|---|
count |
integer(int32) |
items |
Array<Dataset> |
DataStoreKind¶
Type: integer(int32)
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)
QueryRecommendation¶
| Name | Type |
|---|---|
query |
string| null |
QueryRecommendationListSearchResult¶
| Name | Type |
|---|---|
conversationId |
string(uuid)| null |
result |
Array<QueryRecommendation> |
QueryRecommendationLookup¶
| Name | Type |
|---|---|
conversationOptions |
ConversationOptions |
project |
FieldSet |
query |
string| null |
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 |
semantics |
Array<string> |
UserGroupLookup¶
| Name | Type |
|---|---|
excludedIds |
Array<string> |
ids |
Array<string> |
like |
string| null |
metadata |
Header |
order |
Ordering |
page |
Paging |
project |
FieldSet |
semantics |
Array<string> |
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 |
kinds |
Array<WorkflowDefinitionKind> |
lastRunState |
WorkflowRunState |
like |
string| null |
metadata |
Header |
onlyPaused |
boolean| null |
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 |
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 |