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": [
"5f831962-a038-467a-a11a-b3343e03aa1d"
],
"excludedIds": [
"c909ef52-181b-4544-a284-76e906f9f9b9"
],
"datasetIds": [
"61c01a46-b87d-44c7-b606-e3f0f758f8d2"
],
"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": "6024d50a-0c8c-4f1b-ac98-c1f3e8aeb950",
"code": "string",
"name": "string",
"datasets": [
{
"id": "89a2ac18-8467-4129-913f-e6a51850b16b",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 237,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": null,
"permissions": [
"string"
]
}
],
"datasetCount": 191,
"permissions": [
"string"
]
}
],
"count": 131
}
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": "f5bb932c-69cf-4bb8-8404-5ad22cde04d8",
"code": "string",
"name": "string",
"datasets": [
{
"id": "c4e6c766-e2bb-4c5b-9eca-9f196ee2aace",
"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": 128,
"permissions": [
"string"
]
}
],
"count": 206
}
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": "3e725cdf-40fa-4fb3-9cfb-57c769582484",
"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": "2d460cca-0639-4e93-96d7-08d52b78327a",
"code": "string",
"name": "string",
"datasets": [
{
"id": "81872ab7-a3d3-4cdb-9139-5b6f9166ec23",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 281,
"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": "273bb958-f729-42b5-a5c3-a2ea8088fe36",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 133,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"datasetCount": 8,
"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": "89b71a05-5565-4c2f-aabf-6d9820514ab8",
"code": "string",
"name": "string",
"datasets": [
"3d929d7c-e576-429b-a4d8-55c6a78f82c1"
]
}
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": "cd0d18ac-515f-4425-820e-00ea2e99c5d2",
"code": "string",
"name": "string",
"datasets": [
{
"id": "73f35aed-da60-4535-a9af-84b638ef5000",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 45,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "82131aee-0073-4ca5-ae64-197667ba08b8",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 114,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"datasetCount": 45,
"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": "bd80d003-19f3-4c98-9fb9-732032f66132",
"datasets": [
"ec4bf9e0-58d7-44ac-859b-87d3816f7ef4"
]
}
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": "9c474498-1900-4d0b-9649-9f18c7db377f",
"code": "string",
"name": "string",
"datasets": [
{
"id": "1f19e653-ff02-448f-be9c-3193ed6f464d",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 191,
"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": "b303188a-0c21-4d77-ba55-9d32657568d7",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 1,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"datasetCount": 27,
"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": "5aa71a18-69de-44ae-944c-567b5de555a2",
"code": "string",
"name": "string",
"datasets": [
{
"id": "aad0e58c-372b-49da-9d3b-dd67476929e5",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 240,
"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": "71619161-ff22-43af-b7a4-da64183895ab",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 292,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"datasetCount": 98,
"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": "e74ca1a7-b69d-4d4d-a3e7-1995771d510d",
"code": "string",
"name": "string",
"datasets": [
{
"id": "1a0117dc-f788-4ea9-b02b-4580cce00479",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 251,
"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": "44704dec-a55c-43e4-bac1-da5739ad2433",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 267,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"datasetCount": 1,
"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": [
"d3a8b4bf-6fcc-4fc6-9443-c2619e12849e"
],
"userIds": [
"e95b8033-a56a-41a9-919d-737de10219e3"
],
"excludedIds": [
"1a2aa06f-024f-4dfd-a490-58f3125d2eb1"
],
"isActive": [
61
],
"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": "7b9643f3-90b1-4c33-9161-5ba6461a8df1",
"name": "string",
"user": {
"id": "135e184f-4e82-4675-91e0-2d2c70b63376",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "8691860b-66da-4c4d-b4c2-873386a49df0",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "82bf44d1-4e0c-415f-88f2-122e06f4c3f6",
"dataset": {
"id": "0e0e9c3f-c573-4af9-bc75-acfabad0efee",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 255,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "39fd5be0-901d-4003-b53e-efe1b72269dc",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 277,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 43,
"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"
},
"datasets": [
{
"id": "d4e04c6f-3856-4776-b144-01c9a489b422",
"dataset": null,
"conversation": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": [
{
"id": "a1441fa7-8e81-44d4-a273-4ebc5d9672a4",
"conversation": null,
"kind": 94,
"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": 11
}
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": [
"252c7c74-1ecf-4d46-a768-fae231cf7990"
],
"userIds": [
"6fe45de7-32d6-4e1f-bab2-98ee768ea8b0"
],
"excludedIds": [
"ca31131d-cb70-477f-9dc2-21781d8b8d9a"
],
"isActive": [
28
],
"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": "f8724c7d-38f6-4b36-ba9f-bc72518c71b9",
"name": "string",
"user": {
"id": "9f2fd366-9b11-462a-90ae-4f067b8fe726",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "05b3c761-5f73-4f89-bcc4-ed38ec457d1b",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "4fa30a2e-77b1-44f3-973c-e1215da4dbfc",
"dataset": {
"id": "3889e9d1-b66d-4067-b702-1e738ef49d94",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 284,
"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": "dc102fc8-2db2-40c4-b773-4ed749a15980",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 278,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 257,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 153,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "4363fa9e-77c3-4419-b36a-b4862646a414",
"dataset": null,
"conversation": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": [
{
"id": "39c22ee1-b5cb-470c-a6c1-37b729b13915",
"conversation": null,
"kind": 18,
"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": 8
}
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": "dcbda4c2-6d39-4d37-915e-e15eb038c100",
"name": "string",
"user": {
"id": "d83d2a0a-a843-44f8-874e-4d7c11b9038f",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "2ab58ef0-b44c-40fc-945b-f4013859d7eb",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "fe1b8031-79fd-45a5-877a-3eef355bca06",
"dataset": {
"id": "ffb8d167-db68-40ee-a60f-846de3ddd1bd",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 35,
"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": "c01147de-a025-47bd-ab14-558a9282f8e7",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 167,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 180,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 211,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "89785047-deac-48ab-8e92-53796225decd",
"dataset": null,
"conversation": null,
"isActive": null,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"messages": [
{
"id": "82de4bf0-ccb0-43cb-8ac8-df3941dd86b4",
"conversation": null,
"kind": 201,
"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": 45
}
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": "9c37dacf-4e0e-4202-8b94-2eafa415270b",
"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": "5f77ec0c-6581-4747-ac3c-e38f530feb9a",
"name": "string",
"user": {
"id": "c5ac6816-a961-415c-ad2d-8c06818c8341",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "3e39cd36-f163-411b-ba12-09d27f74e53b",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "1707b54a-bf00-4e36-a1c0-1f36509b4a1d",
"dataset": {
"id": "245345ca-fa46-48dc-8ddc-ba223ca5bf8f",
"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": "b013ba16-da40-4a83-adf6-f27ebd504874",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 96,
"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": 93,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "e83aca4c-0594-49fd-a06e-24b8b9f2b703",
"dataset": null,
"conversation": {
"id": "f935c595-28c5-483f-ba93-ec12a84ffe23",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "7c553f06-aaac-4727-ac8b-454ee26d301e",
"conversation": null,
"kind": 127,
"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": "31588eb4-aead-4614-8bdf-6a7a758f12fd",
"name": "string",
"conversationDatasets": [
{
"id": "48f16859-65c3-4834-96bd-ca52e8fc2260",
"conversationId": "d817b013-8494-48d3-b478-b0f06e32e5ae",
"datasetId": "4ee8e9c9-b212-4b7b-b15c-3b62b0a40bb4",
"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": "fe8dfb02-04d1-4837-a363-c97371fc839a",
"name": "string",
"user": {
"id": "10efda35-791a-49ae-a470-b0bb73c4c77d",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "ce6815ec-83b1-40e1-9573-ca95dcebc8f1",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "99e067a7-dea8-4c3a-a208-0cf3fd1bd8fc",
"dataset": {
"id": "6436c4bf-dcc1-45f9-83f7-7b8766f023d0",
"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": "1a861496-5588-4842-bd01-1004b0e5ee56",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 53,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 287,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 300,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "da8729da-f29b-4724-9355-81657e591fb8",
"dataset": null,
"conversation": {
"id": "ed260256-280e-4dfb-ab5e-91b8bd46bb2e",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "7fba6906-d878-44fd-823f-36385a4b24c0",
"conversation": null,
"kind": 112,
"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": "dc9f5c0b-a22e-40b6-946c-59c1dd6b6743",
"conversationDatasets": [
{
"id": "67cebe02-d09d-44c4-b2ef-125284a0af76",
"conversationId": "91aea46d-52af-42dc-9cfb-88f3266e3a4b",
"datasetId": "496005f8-91f3-45fd-aa0c-642b4b6dd8d6",
"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": "70ac812e-c124-4cac-af04-b960cc7104ce",
"name": "string",
"user": {
"id": "10597c74-fb39-47c7-9124-7fd20c0d3b2a",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "4615ef66-316d-4ff7-a813-f3e918bc293b",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "1600e962-5d7f-4806-98e8-9c3ec86d3f2e",
"dataset": {
"id": "47a2a1f2-6eef-4ca9-aa5f-9cf80cddd100",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 285,
"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": "9ab4154d-258f-476e-82bd-c859a0e94308",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 172,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 195,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 251,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "1b75a272-0947-4896-b76c-043ae13a6e2c",
"dataset": null,
"conversation": {
"id": "12cbe088-c78c-4ee6-9403-82267f7e565c",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "c0e60a96-b347-4f35-99b9-4772a22e454f",
"conversation": null,
"kind": 15,
"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": [
"15076514-8de1-491d-8f8d-192b2b5c4111"
],
"excludedIds": [
"258ddf64-2890-4861-a0e8-6b183bd5f60b"
],
"conversationIds": [
"e76f71bd-5eae-4fde-ba70-e30774cd9226"
],
"datasetIds": [
"30db50f0-5006-454e-890e-0640c2fd3c49"
],
"isActive": [
203
],
"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": "169ade60-408f-4343-b4d4-af48a6d586c2",
"dataset": {
"id": "53aa72ec-6e1c-4b2b-8a52-d0f6c5020d50",
"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": "d8e588a7-ff60-407e-ae2c-d69e8ec9963b",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 163,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"conversation": {
"id": "9b4a6467-13f0-4290-809b-7a18a6ff69d5",
"name": "string",
"user": {
"id": "8ffd0c9b-48c8-4849-943b-11545130f711",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "d94f2612-3ef3-4d9e-86e3-7fedd583ae52",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "a831a494-c42a-4c16-a781-0f78b11f9f36",
"dataset": null,
"isActive": 135,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 99,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": null,
"messages": [
{
"id": "2bb25d69-0387-4d9e-888f-233f5d9a176b",
"conversation": null,
"kind": 242,
"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": 132
}
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": [
"c2eefa6d-5319-49c4-8881-95ab532e924f"
],
"excludedIds": [
"eb57c423-9ab5-4d72-a281-4d9f7c3f603a"
],
"conversationIds": [
"8bc5e273-085c-4d64-ac30-b5797e67ae30"
],
"datasetIds": [
"1e7b5b83-b527-4ee5-acdb-f8f87dd89d95"
],
"isActive": [
238
],
"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": "cf11c78e-289b-4ca4-8a82-e2311579ed1c",
"dataset": {
"id": "5c46aee2-1616-432b-bb5c-d763317d6f7c",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 278,
"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": "d4f2e341-50d3-4667-9754-08f95f169247",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 233,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"conversation": {
"id": "39dc364f-f1ac-4bca-b1b3-0c023f281c1a",
"name": "string",
"user": {
"id": "2b50bc47-731b-4091-acdc-558907c83fe5",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "70483774-0c2f-46cd-9f38-5be2d86aec44",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "05b386e8-c98e-4c65-909a-3f20f4d04242",
"dataset": null,
"isActive": 152,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 288,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": null,
"messages": [
{
"id": "f27d0763-a66f-46d0-add5-b08915bef255",
"conversation": null,
"kind": 215,
"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": 296
}
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": "d2080904-146c-4d37-98ed-f72ef557446b",
"dataset": {
"id": "3f8930ca-681e-41fa-9e39-523ef74ec639",
"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": "66b0c0e1-245a-4cc3-995a-24765fd2d47d",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 98,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"conversation": {
"id": "9c5eb5dc-e3ca-4706-9613-f4695dc76782",
"name": "string",
"user": {
"id": "fc86324b-3293-4ef5-a2e7-5d04cf2f6344",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "1560eb0a-2566-44be-b6de-32feb3f492a6",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "cceff62a-a5a0-46c4-af73-8c6af6b8ac95",
"dataset": null,
"isActive": 114,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 220,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": null,
"messages": [
{
"id": "2a6eec10-adb9-4dd4-823f-d2d6369ffc7d",
"conversation": null,
"kind": 151,
"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": 118
}
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": "c0b12786-94b2-4d37-a2f7-3033bb7ae7b4",
"name": "string",
"user": {
"id": "47102337-faa0-4784-ad95-71ff9cc1dbdc",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "e8e61013-37b7-42d5-b208-41ea4b70e758",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "50f4f206-c7d8-4893-9d2b-daa9bbb83fd0",
"dataset": {
"id": "8dde8d82-fc71-4adc-a981-e9bc0a3b846b",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 138,
"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": "43c44ec6-5684-4c88-b0a8-74b6229d1452",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 193,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 243,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 131,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "57474e50-8415-49ed-a7b0-43500141ab09",
"dataset": null,
"conversation": {
"id": "29e641dc-194f-40b4-88d3-3d4187d9d731",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "0569c33a-9466-4e1e-b836-17ce8d035ee4",
"conversation": null,
"kind": 149,
"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": "b51fd404-55e8-4efd-8569-81034e856f93",
"name": "string",
"user": {
"id": "7cfdc244-0fc1-40bb-a096-e1fc14078e89",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "ecefc00d-b799-4fdd-93be-d5d6b8e47114",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "8e111f5c-bab3-4943-a898-058907c7dc21",
"dataset": {
"id": "d13c960d-a8b7-41f1-9882-8f5d8fb35c01",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 130,
"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": "cc76c911-fc47-4a5a-b595-69f1af704e33",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 237,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 125,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 26,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "e903bf5f-5f7a-49c5-8527-aefc679aa5b5",
"dataset": null,
"conversation": {
"id": "e4f21f06-f881-4fb1-916e-d1cd2702e41a",
"name": "string",
"user": null,
"datasets": null,
"messages": [
{
"id": "120be68f-1f8e-44ab-9313-00dc2ab92b3f",
"conversation": null,
"kind": 116,
"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": [
"bf8a0891-9913-423a-9912-cf0e9d9a3c9c"
],
"excludedIds": [
"f0b298c3-b7ab-4252-b723-6d6b9c659916"
],
"conversationIds": [
"92fbe708-0459-4f0e-b106-ae8688e5c031"
],
"kinds": [
34
],
"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": "37c0d670-dcbc-4ec2-b784-0aba6665df38",
"conversation": {
"id": "52b5fb00-54ad-4dfe-857d-e1a838f07dd9",
"name": "string",
"user": {
"id": "e1e9f2c8-d10c-4b03-9e93-6f56104501f3",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "e0e0af5c-cf97-47b8-9a07-ce5eb012dbf8",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "12df6fa7-19e4-4c7f-b1bb-870ab839f966",
"dataset": {
"id": "7f26c69f-02f6-49f9-9ca4-9a25c9891690",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 174,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "7ec9272c-2d81-4580-a9b3-a5da0d4ddb80",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 62,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 115,
"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"
},
"datasets": [
{
"id": "cbd39ed5-1acf-4b8a-b2c4-1595059071d8",
"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": 41,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"count": 219
}
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": [
"87738644-3f2b-415a-9b1b-2ccd69ed5188"
],
"excludedIds": [
"f3efd633-cc56-4597-9ce5-3774bce9d642"
],
"conversationIds": [
"b4df5810-293a-4b37-8426-9dce3f2f168b"
],
"kinds": [
120
],
"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": "27db9c16-3821-48bb-952b-bc165d59bec3",
"conversation": {
"id": "af5c8972-7208-4819-90b4-70685c0274eb",
"name": "string",
"user": {
"id": "d3d94ca9-44d0-4a50-a060-5999d3a0a914",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "c5c6ebc6-f9e3-483d-9c59-e291c0379345",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "be400a4b-b512-43cb-9082-77ebe82d7457",
"dataset": {
"id": "55de4bcb-6a89-48ff-9ae1-86e22840a80a",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 119,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "28a6628a-27f6-443a-93c9-a6c4ca6d9397",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 259,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 5,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 31,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"datasets": [
{
"id": "a1f7c4fa-b248-4c56-a24a-c81b55e1efad",
"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": 198,
"data": {
"kind": null,
"version": "string"
},
"createdAt": "2022-04-13T15:42:05.901Z"
}
],
"count": 36
}
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": [
"a5b76c1e-ad14-456e-8252-646a72dc5d98"
],
"excludedIds": [
"4b1fd75f-3923-49fa-bfca-361203f9b01b"
],
"collectionIds": [
"71cabdaa-f0d1-4065-b976-497a18a42bdb"
],
"like": "string",
"license": "string",
"mimeType": "string",
"fieldsOfScience": [
"string"
],
"publishedRange": {
"start": "2022-04-13",
"end": "2022-04-13"
},
"sizeRange": {
"start": 69,
"end": 21
},
"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": "5f51db9c-ad6f-4014-b2e3-a1f74e3f32d6",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 90,
"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": "b66248b0-39bc-4822-99bd-55e8e1f6df77",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 182,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"count": 102
}
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": "26866d64-a7a9-423a-82f5-c755f145425d",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 228,
"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": "3c5501db-11f4-4ee3-9f22-51dd1e9041d5",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 149,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
}
],
"count": 251
}
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": "208c12cb-3aef-483a-8511-a4afac45c6f7",
"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",
"dataLocations": [
{
"kind": 285,
"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
"d58b130c-8617-4ddb-9639-18f6e3d863d3"
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": "e2494e4b-2e53-4fa1-9848-7fc22e3199e8",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 74,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"dataLocations": [
{
"kind": 236,
"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
"42f0c885-d46e-4046-82c8-0109417c36b0"
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": "eaa686f0-afff-4e8f-af1d-be13b4a2a8c7",
"dataStoreKind": 219
}
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
"0ec73d27-8ab2-4b83-b232-dc77f7d49745"
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": "c7047fc4-54b4-4f23-b791-99486feca54d",
"dataStoreKind": 51
}
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
"40dbfb31-dc41-4fc7-a437-a38b0abb2979"
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": "749add40-5437-413c-abf9-9fc5188c9ba4",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 113,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"dataLocations": [
{
"kind": 144,
"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": "a698fc05-cf19-4b1d-a142-dcc69efee155",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 87,
"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": "541a8246-2b4f-4f40-aa85-a60b62f5418f",
"code": "string",
"name": "string",
"datasets": [
{
"id": "80853768-6bcc-4324-950c-c7e1520bad13",
"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": null,
"permissions": [
"string"
]
}
],
"datasetCount": 114,
"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": "41272f3d-8494-448a-bab9-b33911ced852",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 104,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"dataLocations": [
{
"kind": 273,
"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
"161bf9b8-5922-436e-9438-cd61eb16ea87"
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
"ed88ad1b-cf64-4333-b031-d882d4d4aec8"
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": [
"8dcf6cb1-8a1b-4e80-922f-0ba31d2f6501"
],
"collectionIds": [
"c2891568-b5b6-43fe-a4c3-85cccacee4ca"
],
"roles": [
"string"
],
"subjectId": "string",
"targetKinds": [
217
],
"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": 203,
"targetType": 70,
"targetId": "2d3bdb77-8f21-4313-8516-7f060053b64d",
"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": 118,
"targetType": 43,
"targetId": "ce6b8e0b-59ed-4880-97b4-9143008f61ed",
"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": 145,
"targetType": 228,
"targetId": "bacb8752-40d7-4e40-9f9b-814501fccbf2",
"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": 274,
"targetType": 294,
"targetId": "71764d56-ccb4-4033-ac0d-8017cb99d0de",
"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": 118,
"datasetIds": [
"cdaffc45-9010-44a1-9b66-aaf87a26d44b"
],
"collectionIds": [
"ad7a6fbb-a858-4273-ac64-5177df95e45e"
],
"userCollectionIds": [
"d824aa15-6111-4ffc-85fb-2cd868bb7520"
],
"conversationOptions": {
"conversationId": "1c3c8c10-dc80-426e-9c29-89c8af1c3319",
"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": "1dfa3310-6afa-46ca-af83-22f5cfdb859f",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 265,
"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": "650f4473-f104-4e57-b000-141c401f22c7",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 143,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"maxSimilarity": 10.12,
"hits": [
{
"content": "string",
"objectId": "string",
"similarity": 10.12
}
]
}
],
"conversationId": "f421f90d-24ca-4a2e-b5de-6dc81d93cba9"
}
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": [
"dd3e6c24-1072-4b03-8b40-b857039367d9"
],
"conversationOptions": {
"conversationId": "91c514af-b5e8-4453-8c82-843be3313618",
"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": 248,
"entries": [
{
"process": {
"kind": 137
},
"result": {
"kind": 138,
"message": "string"
},
"status": 210
}
]
}
],
"conversationId": "882b73bd-0311-4aba-9bb6-d41fd9664bc8"
}
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": "10bc1717-7e8c-4aad-9054-37f947eb4531",
"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": "6f804006-c055-43e0-9958-ab303ff0b4a8"
}
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": [
"5b305daa-86af-43cd-9df0-4212af4c0b30"
],
"excludedIds": [
"e77cda3e-287f-4fca-b15e-367069d5cf59"
],
"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": "e508c083-2d5b-4361-9eee-b6e3c9503588",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "388f62f8-0cbc-4327-9119-9aa6b42e18a1",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "0e54a990-a2a1-4ed8-af71-6e8c8e8ec982",
"dataset": {
"id": "084ec999-c45b-486c-a645-1e88c5057d2b",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 14,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "f8f3d779-ee65-4d0b-8e8c-7240e7d8dfd7",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 163,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 153,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 137,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
}
],
"count": 4
}
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": "178dd531-a047-4f31-a124-075bc60a06d5",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "259d5826-1465-45df-9c6d-8bb10fb08063",
"name": "string",
"user": {
"id": "db329c8d-075e-4b2d-9174-00d72ca18660",
"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": "72f017d7-4e26-4939-bc3c-05fa6a516d8d",
"dataset": {
"id": "ae0be6cb-6525-4d58-9b95-9a29e463fef3",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 23,
"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": "18d973b5-bb4b-4f54-a109-6f5194035d2c",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 158,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 161,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 157,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
}
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": 154
}
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": [
"0374ee10-fc97-4734-b578-789f925c1874"
],
"userIds": [
"5cd5eb32-4057-4a1f-9e14-655be877ad13"
],
"excludedIds": [
"1b0d6fc0-0881-42ec-9d2e-a24876cf79f0"
],
"isActive": [
172
],
"kind": [
154
],
"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": "54cb5b44-9f01-496a-9efe-0b89898f3f4f",
"name": "string",
"user": {
"id": "f817b682-efb0-43dc-b32f-65811203bd7c",
"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": "1c5a04f3-6e83-4179-a692-2d152f2a4bf4",
"dataset": {
"id": "36d98f43-e214-4359-92ad-e55540b8a8bc",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 3,
"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": "fa5d0b70-ab81-4dae-87a8-ce3746e78e38",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 278,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 4,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 28,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"count": 58
}
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": [
"d2a5ee08-8fb8-49f1-85d6-994e46a2f7c3"
],
"userIds": [
"3980fdc0-4ce5-42d8-b174-77b271a3f28a"
],
"excludedIds": [
"e0460fe0-c8c5-4e93-8ef5-a5f0b0ec5ed7"
],
"isActive": [
67
],
"kind": [
274
],
"like": "string",
"page": {
"offset": 0,
"size": 10
},
"order": {
"items": [
"+name",
"-id"
]
},
"metadata": {
"countAll": true
},
"project": {
"fields": [
"id",
"name",
"foo.id",
"foo.bar.id"
]
}
}
Schema of the request body
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"userIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Limit lookup to items belonging to specific user ids. If set, the list of ids must not be empty",
"nullable": true
},
"excludedIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Exclude from the lookup items with specific ids. If set, the list of ids must not be empty",
"nullable": true
},
"isActive": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IsActive"
},
"description": "Limit lookup to items that are active, or inactive or both. If set, the list of flags must not be empty",
"nullable": true
},
"kind": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserCollectionKind"
},
"description": "Limit lookup to items based on the collection kind. If set, the list of flags must not be empty",
"nullable": true
},
"like": {
"type": "string",
"description": "Limit lookup to items whose name or email matches the pattern",
"nullable": true
},
"page": {
"$ref": "#/components/schemas/Paging"
},
"order": {
"$ref": "#/components/schemas/Ordering"
},
"metadata": {
"$ref": "#/components/schemas/Header"
},
"project": {
"$ref": "#/components/schemas/FieldSet"
}
},
"additionalProperties": false
}
Response 200 OK
{
"items": [
{
"id": "d6e5d2bb-309d-4942-819f-25afc1d551c1",
"name": "string",
"user": {
"id": "6fececc6-dfe6-45df-ab9e-429ecd224d9a",
"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": "54816bc3-7753-4a79-a73a-6dd485e247a3",
"dataset": {
"id": "d41bca8e-d12e-488c-a308-c6f98c167a5b",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 218,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "481696be-c482-4929-b35a-69ce4d85d1aa",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 66,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 284,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 292,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"count": 133
}
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": "576eb214-4fad-42a0-a1b6-137dd51d819e",
"name": "string",
"user": {
"id": "12f89e2e-32f7-4b1d-b0d4-6b1760dd37f7",
"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": "d33840d4-234c-4803-ae57-65cfb99f4ede",
"dataset": {
"id": "120267da-0ef2-470b-9535-03a935755f2c",
"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": "d7210470-8ffc-4369-85bc-4a93215b7277",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 39,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 22,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 61,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"count": 249
}
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": "14366427-c892-4cdb-8685-30e8584069b0",
"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": "6b5be8a8-9f7c-4700-b96f-06f5155289c1",
"name": "string",
"user": {
"id": "9b6bbe64-21fe-4afe-8dff-06044f8d0e60",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "72b27ba4-5fc7-4899-987c-a47a427da77f",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "7b639f15-d9d2-492a-aa9f-c7555157e901",
"dataset": {
"id": "6dbe9a24-8c2a-448e-b8fa-3040746098e4",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 159,
"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": "ccd1151c-eb17-43e5-bf77-57bb78a48549",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 69,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 101,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 202,
"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": "18e6f970-1af6-40f0-8097-fc025383883b",
"name": "string",
"userDatasetCollections": [
{
"id": "3c40d4f7-a188-44d1-a41c-114e12a835bd",
"userCollectionId": "e83b7d84-f0b5-40e0-8b71-6f84eb685665",
"datasetId": "8127a71b-09f4-4a19-aee1-ac7651a76ba8",
"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": "9e0da701-b7ab-40e3-b23f-342f3476df60",
"name": "string",
"user": {
"id": "9f8ab863-f2f4-4253-a913-d75b328dd1a0",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "07575741-75bd-465a-b4b6-b421bace767c",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "346da0f8-fa86-42a6-bdfb-f0d13270cdcc",
"dataset": {
"id": "719cb9cf-5465-427f-8b3f-1ddc8de9c032",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 64,
"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": "46c24963-a533-4fe3-a202-8af017ab0d39",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 42,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 87,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 211,
"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": "7e9dba68-a1d2-4b17-b58c-2fb4244a08ba",
"userDatasetCollections": [
{
"id": "0a442676-12a8-4845-9832-6d1eb420a8e4",
"userCollectionId": "29d987b8-0854-4f00-929b-7c80fffc9df6",
"datasetId": "0b5be78c-c3c5-4656-84a7-f0ec871bbcf6",
"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": "e6da566d-cdf8-4c06-af9b-d8e7a3295d43",
"name": "string",
"user": {
"id": "12c45b3f-9be5-47e3-bd49-4f8f5ebf5d2d",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "bebd896a-71e0-492f-9834-2b81c7e15e95",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "82812b9a-e6d3-4692-bac7-6439d40e125b",
"dataset": {
"id": "9e140c60-746f-4f9a-8eb3-0fbc485e3a48",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 237,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "b4bfc626-84ea-4819-bf6e-98e3cd4abb76",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 148,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 107,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 123,
"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": [
"fc7a5f02-6e4a-4d86-afdc-43446f760c01"
],
"excludedIds": [
"0b5570c1-ef2d-4619-839a-2c51fe08c64b"
],
"userCollectionIds": [
"1b4f16e4-207a-448b-b1c2-5e2cfb8db5ff"
],
"datasetIds": [
"46bca1f7-05ff-40ab-955a-aaca46f9bb5b"
],
"isActive": [
123
],
"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": "90564c35-c5d6-4173-8d14-34e00d7252c7",
"dataset": {
"id": "58c96e66-8cc1-41e8-aac1-4fa070cc63f6",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 2,
"url": "string",
"version": "string",
"headline": "string",
"keywords": [
"string"
],
"fieldOfScience": [
"string"
],
"language": [
"string"
],
"country": [
"string"
],
"datePublished": "2022-04-13",
"archivedAt": "string",
"conformsTo": "string",
"citeAs": "string",
"profileRaw": "string",
"collections": [
{
"id": "f29cd0d0-45c0-47d8-9eb0-dad975841cb2",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 158,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 171,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": {
"id": "d6b9e1a3-08e7-4da7-b258-990d38ec083a",
"name": "string",
"user": {
"id": "d3b5fdb5-8dcf-455f-b0d8-7d04cca4edc0",
"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": 129,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"eTag": "string"
}
],
"count": 262
}
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": [
"bb9fd1bc-d3f6-4412-93e9-46c63e9beec7"
],
"excludedIds": [
"a11c550e-67bb-47cd-b007-a13d7903d5a5"
],
"userCollectionIds": [
"4aa7ed48-8f5c-406f-8f6a-01b14cfb33c9"
],
"datasetIds": [
"8d5c0b22-7f15-43d0-9114-a13c0082aa8f"
],
"isActive": [
157
],
"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": "b1be1724-012b-49be-bcf6-c787c12f70eb",
"dataset": {
"id": "d9f68fdb-8b10-4614-84c8-d5df4f912bbf",
"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": "12ab0e06-4c9d-4271-b59e-0c308b0fdc69",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 230,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 230,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": {
"id": "73300068-8fad-46f6-a0b6-f94393856bbe",
"name": "string",
"user": {
"id": "2bf1dc35-95c1-4623-b154-fcddc0d6bc8a",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": null,
"eTag": "string"
},
"userDatasetCollections": null,
"isActive": null,
"kind": 120,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"eTag": "string"
}
],
"count": 229
}
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": "380ce003-1177-4251-945d-958b47fe4d8b",
"dataset": {
"id": "640c0968-b440-423c-a8a0-0ed20a328428",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 213,
"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": "352434cb-5780-4467-bb77-0d01b2fb5a82",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 209,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 297,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": {
"id": "65dfecf5-6750-44e4-865e-f3d7f479862f",
"name": "string",
"user": {
"id": "e65913b8-e5b5-4806-801e-2d8c3b78badd",
"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": 239,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
},
"eTag": "string"
}
],
"count": 191
}
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": "19c101b3-e70b-4172-9fdc-4b562f902f5e",
"name": "string",
"user": {
"id": "d73769e7-96b4-4079-b8cb-e9527a3721af",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "f650fdcb-6e2e-4438-9727-0d135f52ef2e",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "2d8576c0-f2fe-4ae3-b9dc-f23d14d5b26f",
"dataset": {
"id": "481fb94f-410e-4771-990e-63e12f0d12a4",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 110,
"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": "5c21329d-85d9-4f05-aa29-4bc72241a117",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 221,
"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": 300,
"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": "a9349b51-4b28-4620-be3c-073147abd347",
"name": "string",
"user": {
"id": "e6793381-27fa-40cf-b580-cbade3f1063e",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "72448099-cea6-4af0-8aa9-e8845b7aab60",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "b091370d-3807-44bb-9a2e-b6c899d88794",
"dataset": {
"id": "ab91c0a0-d0f3-4fd5-abbc-ca734ad2e324",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 201,
"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": "9b5b674f-38e7-4464-90e7-4c1390b1241d",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 233,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 124,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 50,
"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": "04404552-aeb2-4d74-871e-5d8d9c8c9eb0",
"key": "string",
"user": {
"id": "06e9e13a-eedf-40a1-86cc-3abbce76786f",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "21b8b333-3074-46a8-b38e-cb3759236469",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "a2d9f70a-bb78-445d-b7a0-e4c92cd7d58d",
"dataset": {
"id": "5ab151a8-4e30-45d3-9959-5f0ee55a7f8a",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 182,
"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": "113a721f-6cef-4adb-afcf-b4a8f8c4595e",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 217,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 51,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 270,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
],
"eTag": "string"
},
"value": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"eTag": "string"
}
Schema of the response body
{
"type": "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": "9e4eca9f-c464-444d-8633-3f349b2ab218",
"key": "string",
"user": {
"id": "0623acc0-2a74-438e-8360-8000d995e4b6",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "64657286-dfc1-4c21-ada8-920542f16fc9",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "dab89881-373c-46d9-9558-8c16e0294e63",
"dataset": {
"id": "ff679136-f58f-405b-82e2-c7894067c391",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 118,
"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": "80166043-cf53-4164-97d5-5ef94e470547",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 228,
"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": 260,
"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": "c18c5150-af76-4c19-8622-f7275a1c934b",
"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": "434289aa-fa30-4b5a-a45e-84cfcf184e43",
"key": "string",
"user": {
"id": "6081e2ad-4162-4ab9-b23f-d2a884817d87",
"name": "string",
"email": "string",
"idpSubjectId": "string",
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollections": [
{
"id": "269eac75-45ed-492a-aee0-5cc4c13c2c69",
"name": "string",
"user": null,
"userDatasetCollections": [
{
"id": "719659ad-a64d-4299-bdd4-51b0d8bd0c20",
"dataset": {
"id": "86c608de-c481-4ad2-aa8f-8e9e885bbb87",
"code": "string",
"name": "string",
"description": "string",
"license": "string",
"mimeType": "string",
"size": 135,
"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": "c3f4070c-43ea-434f-b9a3-9b246ebbe079",
"code": "string",
"name": "string",
"datasets": null,
"datasetCount": 87,
"permissions": [
"string"
]
}
],
"permissions": [
"string"
]
},
"isActive": 136,
"createdAt": "2022-04-13T15:42:05.901Z",
"updatedAt": "2022-04-13T15:42:05.901Z",
"userCollection": null,
"eTag": "string"
}
],
"isActive": null,
"kind": 18,
"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": 21
}
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": 50,
"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": [
28
],
"like": "string",
"excludeStaled": true,
"onlyPaused": true,
"lastRunState": 104,
"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": 263,
"maxActiveRuns": 95,
"maxConsecutiveFailedRuns": 300,
"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": 30
}
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": 237,
"maxActiveRuns": 146,
"maxConsecutiveFailedRuns": 279,
"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": 277
}
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": 193,
"triggeredBy": "string",
"state": 33,
"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": 193,
"maxActiveRuns": 91,
"maxConsecutiveFailedRuns": 23,
"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": 84,
"tryNumber": 157,
"maxTries": 187,
"taskDisplayName": "string",
"hostname": "string",
"unixname": "string",
"pool": "string",
"poolSlots": 123,
"queue": "string",
"queuedWhen": "2022-04-13T15:42:05.901Z",
"scheduledWhen": "2022-04-13T15:42:05.901Z",
"priorityWeight": 148,
"operator": "string",
"pid": 210,
"executor": "string",
"executorConfig": "string",
"note": "string",
"renderedMapIndex": "string",
"renderedFields": null,
"trigger": null,
"triggererJob": null,
"dagVersion": null,
"workflow": null,
"task": null,
"workflowExecution": null
}
]
}
],
"count": 66
}
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": [
294
],
"state": [
45
],
"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": 160,
"triggeredBy": "string",
"state": 154,
"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": 22,
"maxActiveRuns": 242,
"maxConsecutiveFailedRuns": 298,
"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": 38,
"tryNumber": 134,
"maxTries": 103,
"taskDisplayName": "string",
"hostname": "string",
"unixname": "string",
"pool": "string",
"poolSlots": 46,
"queue": "string",
"queuedWhen": "2022-04-13T15:42:05.901Z",
"scheduledWhen": "2022-04-13T15:42:05.901Z",
"priorityWeight": 79,
"operator": "string",
"pid": 288,
"executor": "string",
"executorConfig": "string",
"note": "string",
"renderedMapIndex": "string",
"renderedFields": null,
"trigger": null,
"triggererJob": null,
"dagVersion": null,
"workflow": null,
"task": null,
"workflowExecution": null
}
]
}
],
"count": 275
}
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": 123,
"tryNumber": 290,
"maxTries": 87,
"taskDisplayName": "string",
"hostname": "string",
"unixname": "string",
"pool": "string",
"poolSlots": 32,
"queue": "string",
"queuedWhen": "2022-04-13T15:42:05.901Z",
"scheduledWhen": "2022-04-13T15:42:05.901Z",
"priorityWeight": 208,
"operator": "string",
"pid": 234,
"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": 128,
"maxActiveRuns": 93,
"maxConsecutiveFailedRuns": 93,
"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": 177,
"triggeredBy": "string",
"state": 280,
"note": "string",
"bundleVersion": "string",
"workflow": null,
"taskInstances": null
}
}
],
"count": 248
}
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 |