{
"openapi": "3.0.1",
"info": {
"title": "Sticker Public API 1.0",
"version": "1.0"
},
"paths": {
"/api/Datasets": {
"get": {
"tags": [
"Datasets"
],
"summary": "Gets all the datasets.",
"operationId": "GetDatasets",
"parameters": [
{
"name": "workspaceId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns list of datasets.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfDatasetInfoDtos"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfDatasetInfoDtos"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfDatasetInfoDtos"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Datasets/create": {
"post": {
"tags": [
"Datasets"
],
"summary": "Creates a dataset.",
"operationId": "CreateDataset",
"parameters": [
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDatasetDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateDatasetDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateDatasetDto"
}
}
}
},
"responses": {
"200": {
"description": "Dataset was created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfNullableGuid"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfNullableGuid"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfNullableGuid"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Datasets/update": {
"post": {
"tags": [
"Datasets"
],
"summary": "Updates a dataset.",
"operationId": "UpdateDataset",
"parameters": [
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDatasetDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDatasetDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateDatasetDto"
}
}
}
},
"responses": {
"200": {
"description": "Dataset was updated.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Datasets/delete": {
"post": {
"tags": [
"Datasets"
],
"summary": "Deletes dataset.",
"operationId": "DeleteDataset",
"parameters": [
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteDatasetDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteDatasetDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteDatasetDto"
}
}
}
},
"responses": {
"200": {
"description": "Dataset was deleted.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Datasets/publish": {
"post": {
"tags": [
"Datasets"
],
"summary": "Publishes dataset.",
"operationId": "PublishDataset",
"parameters": [
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublishDatasetDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublishDatasetDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PublishDatasetDto"
}
}
}
},
"responses": {
"200": {
"description": "Dataset was published.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Datasets/images": {
"get": {
"tags": [
"Datasets"
],
"summary": "Gets dataset images.",
"operationId": "GetImages",
"parameters": [
{
"name": "DatasetId",
"in": "query",
"description": "Id of the dataset.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "PageSize",
"in": "query",
"description": "Number of images per page.\r\nAccepted values: 1 - 1000.",
"required": true,
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "PageNumber",
"in": "query",
"description": "Number of the page.",
"required": true,
"schema": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns list of dataset images.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfPagedQueryResultDtoOfDatasetImageDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfPagedQueryResultDtoOfDatasetImageDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfPagedQueryResultDtoOfDatasetImageDto"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Export": {
"get": {
"tags": [
"Export"
],
"summary": "Gets all project exports.",
"operationId": "GetProjectExports",
"parameters": [
{
"name": "projectId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "List of all project exports is returned.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfProjectExportDtos"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfProjectExportDtos"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfProjectExportDtos"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Export/ExportProject": {
"post": {
"tags": [
"Export"
],
"summary": "Exports project.",
"operationId": "ExportProject",
"parameters": [
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportProjectFromPublicApiCommand"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ExportProjectFromPublicApiCommand"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ExportProjectFromPublicApiCommand"
}
}
}
},
"responses": {
"200": {
"description": "Export job Id."
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Export/GetExportProjectStatus": {
"get": {
"tags": [
"Export"
],
"summary": "Gets export project status.",
"operationId": "GetExportProjectStatus",
"parameters": [
{
"name": "taskId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns export project status.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfString"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfString"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfString"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Export/downloadProjectExport": {
"get": {
"tags": [
"Export"
],
"summary": "Downloads export file.",
"operationId": "DownloadProjectExport",
"parameters": [
{
"name": "exportId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "dataFilterType",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Export file is downloaded.",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Images/addImage": {
"post": {
"tags": [
"Images"
],
"summary": "Uploads image.",
"description": "For unencrypted workspaces, provide just `Image`, `FileName` and `DatasetId`. The thumbnail will be generated automatically.
\r\nFor encrypted workspaces, additionally provide `Thumbnail` (270x200 pixels), and original `Width` and `Height` of the `Image`.
\r\nBoth `Image` and `Thumbnail` have to be already encrypted with the workspace key.
\r\nYou should use AES-256 in CBC mode and prefix the encrypted file with the IV used.
\r\nYou can prepare the compatible file with OpenSSL as follows:
```\r\nIV=$(openssl rand -hex 16)
\r\ncat <(echo -n $IV | xxd -r -ps) <(openssl enc -aes-256-cbc -K $(cat workspace.key) -iv $IV -in image.jpg) > image.enc.jpg\r\n```",
"operationId": "UploadImage",
"parameters": [
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"DatasetId",
"FileName",
"Image"
],
"type": "object",
"properties": {
"Image": {
"type": "string",
"description": "Image.",
"format": "binary"
},
"Thumbnail": {
"type": "string",
"description": "Thumbnail of the Image. Necessary only in encrypted workspaces.",
"format": "binary"
},
"FileName": {
"type": "string",
"description": "File name."
},
"DatasetId": {
"type": "string",
"description": "Id of the dataset that image will be uploaded to.",
"format": "uuid"
},
"Width": {
"type": "integer",
"description": "Width of the Image. Necessary only in encrypted workspaces.",
"format": "int32"
},
"Height": {
"type": "integer",
"description": "Height of the Image. Necessary only in encrypted workspaces.",
"format": "int32"
}
}
},
"encoding": {
"Image": {
"style": "form"
},
"Thumbnail": {
"style": "form"
},
"FileName": {
"style": "form"
},
"DatasetId": {
"style": "form"
},
"Width": {
"style": "form"
},
"Height": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "Image was uploaded.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Images/addImageFromUrl": {
"post": {
"tags": [
"Images"
],
"summary": "Uploads image from url.",
"operationId": "UploadImageByUrl",
"parameters": [
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"DatasetId",
"URL"
],
"type": "object",
"properties": {
"URL": {
"type": "string",
"description": "URL of the image that should be uploaded."
},
"DatasetId": {
"type": "string",
"description": "Id of the dataset that image will be uploaded to.",
"format": "uuid"
}
}
},
"encoding": {
"URL": {
"style": "form"
},
"DatasetId": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "Image was uploaded.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Images/delete": {
"post": {
"tags": [
"Images"
],
"summary": "Deletes image.",
"operationId": "DeleteImage",
"parameters": [
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteImageDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteImageDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteImageDto"
}
}
}
},
"responses": {
"200": {
"description": "Image was deleted.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Images/download": {
"get": {
"tags": [
"Images"
],
"summary": "Downloads image.",
"operationId": "DownloadImage",
"parameters": [
{
"name": "imageId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Image was downloaded.",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Images/downloadThumb": {
"get": {
"tags": [
"Images"
],
"summary": "Downloads thumbnail.",
"operationId": "DownloadThumb",
"parameters": [
{
"name": "imageId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Thumb was downloaded.",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Imports/ImportProject": {
"post": {
"tags": [
"Imports"
],
"summary": "Imports project.",
"operationId": "ImportProject",
"parameters": [
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportProjectDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportProjectDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ImportProjectDto"
}
}
}
},
"responses": {
"200": {
"description": "Import job Id."
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Imports/GetImportProjectStatus": {
"get": {
"tags": [
"Imports"
],
"summary": "Gets import project status.",
"operationId": "GetImportProjectStatus",
"parameters": [
{
"name": "importId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns import project status.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfImportProjectStatusDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfImportProjectStatusDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfImportProjectStatusDto"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Imports/ImportAnnotations": {
"post": {
"tags": [
"Imports"
],
"summary": "Imports annotations.",
"operationId": "ImportAnnotations",
"parameters": [
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportAnnotationsDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ImportAnnotationsDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ImportAnnotationsDto"
}
}
}
},
"responses": {
"200": {
"description": "Import job Id."
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Imports/GetImportAnnotationsStatus": {
"get": {
"tags": [
"Imports"
],
"summary": "Gets import annotations status.",
"operationId": "GetImportAnnotationsStatus",
"parameters": [
{
"name": "importId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns import annotations status.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfImportAnnotationsStatusDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfImportAnnotationsStatusDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfImportAnnotationsStatusDto"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Projects": {
"get": {
"tags": [
"Projects"
],
"summary": "Gets all projects.",
"operationId": "GetProjects",
"parameters": [
{
"name": "workspaceId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "List of all projects is returned.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfProjectInfoDtos"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfProjectInfoDtos"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfProjectInfoDtos"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Projects/AssignDataset": {
"post": {
"tags": [
"Projects"
],
"summary": "Assigns dataset to project.",
"operationId": "AssignDataset",
"parameters": [
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignDatasetToProjectDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AssignDatasetToProjectDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AssignDatasetToProjectDto"
}
}
}
},
"responses": {
"200": {
"description": "Dataset has been assigned.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Projects/UnlinkDataset": {
"post": {
"tags": [
"Projects"
],
"summary": "Unassigns dataset from project.",
"operationId": "UnlinkDataset",
"parameters": [
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnassignDatasetFromProjectDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UnassignDatasetFromProjectDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UnassignDatasetFromProjectDto"
}
}
}
},
"responses": {
"200": {
"description": "Dataset has been unassigned.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Projects/PublishProject": {
"post": {
"tags": [
"Projects"
],
"summary": "Publishes project.",
"operationId": "PublishProject",
"parameters": [
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublishProjectDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublishProjectDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PublishProjectDto"
}
}
}
},
"responses": {
"200": {
"description": "Project has been published.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Workspaces": {
"get": {
"tags": [
"Workspaces"
],
"summary": "Gets all workspaces.",
"operationId": "GetWorkspaces",
"parameters": [
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "List of all workspaces is returned.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfWorkspaceInfoDtos"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfWorkspaceInfoDtos"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfWorkspaceInfoDtos"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Workspaces/create": {
"post": {
"tags": [
"Workspaces"
],
"summary": "Creates a workspace.",
"operationId": "CreateWorkspaces",
"parameters": [
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWorkspaceDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateWorkspaceDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateWorkspaceDto"
}
}
}
},
"responses": {
"200": {
"description": "Workspace was created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfNullableGuid"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfNullableGuid"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfNullableGuid"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Workspaces/enableEncryption": {
"post": {
"tags": [
"Workspaces"
],
"summary": "Marks the workspace as encrypted and attaches the key checksum to it.",
"description": "Encrypted workspaces use AES-256. Zillin uses a key checksum to verify\r\nthe proper key is provided when opening the workspace.
``` $ openssl enc -aes-256-cbc -P -k \"correct horse battery staple\" -pbkdf2 | sed -n 2p | sed 's/key=//' > my.key ```
\r\nFrom the key you can generate the checksum as follows:
``` IV=00000000000000000000000000000000 ```
``` WORKSPACE_ID=\"bd81654c-6ac8-4ece-8234-0e0c4265d761\" # lowercase hex representation! ```
``` cat <(echo -n $IV | xxd -r -ps) <(echo -n $WORKSPACE_ID | openssl enc -aes-256-cbc -K $(cat my.key) -iv $IV) | openssl sha256 -binary | openssl base64 ```
",
"operationId": "EnableEncryption",
"parameters": [
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnableEncryptionDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EnableEncryptionDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/EnableEncryptionDto"
}
}
}
},
"responses": {
"200": {
"description": "Key checksum has been registered.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
},
"/api/Workspaces/delete": {
"post": {
"tags": [
"Workspaces"
],
"summary": "Deletes workspace.",
"operationId": "DeleteWorkspace",
"parameters": [
{
"name": "api-version",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteWorkspaceDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteWorkspaceDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteWorkspaceDto"
}
}
}
},
"responses": {
"200": {
"description": "Workspace was deleted.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PublicApiResponseOfObject"
}
}
}
},
"400": {
"description": "Bad request (Error code in response).",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"500": {
"description": "Internal server error."
}
}
}
}
},
"components": {
"schemas": {
"AssignDatasetToProjectDto": {
"required": [
"datasetId",
"projectId"
],
"type": "object",
"properties": {
"projectId": {
"type": "string",
"description": "Id of the project to which the dataset will be assigned.",
"format": "uuid"
},
"datasetId": {
"type": "string",
"description": "Id of the dataset that will be assigned.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "Assign dataset to project model."
},
"CreateDatasetDto": {
"required": [
"name",
"workspaceId"
],
"type": "object",
"properties": {
"name": {
"minLength": 1,
"type": "string",
"description": "Name of the dataset."
},
"description": {
"type": "string",
"description": "Description of the dataset.",
"nullable": true
},
"workspaceId": {
"type": "string",
"description": "Id of the workspace.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "Dataset creation model."
},
"CreateWorkspaceDto": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"minLength": 1,
"type": "string",
"description": "Name of the dataset."
},
"timeZoneOffset": {
"type": "integer",
"description": "Name of Timezone in IANA standard.\r\nDefault value is UTC Timezone.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Dataset creation model."
},
"DatasetImageDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"width": {
"type": "integer",
"format": "int32"
},
"height": {
"type": "integer",
"format": "int32"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"hasAnnotations": {
"type": "boolean"
}
},
"additionalProperties": false
},
"DatasetInfoDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the dataset.",
"format": "uuid"
},
"name": {
"type": "string",
"description": "Name of the dataset.",
"nullable": true
},
"description": {
"type": "string",
"description": "Description of the dataset.",
"nullable": true
},
"imagesCount": {
"type": "integer",
"description": "Count of images in dataset.",
"format": "int32"
},
"projectsCount": {
"type": "integer",
"description": "Count of projects the dataset is assigned to.",
"format": "int32"
},
"status": {
"type": "string",
"description": "Status determining current dataset state.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Dataset information model."
},
"DeleteDatasetDto": {
"required": [
"datasetId"
],
"type": "object",
"properties": {
"datasetId": {
"type": "string",
"description": "Id of the dataset to delete.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "Delete dataset model."
},
"DeleteImageDto": {
"required": [
"imageId"
],
"type": "object",
"properties": {
"imageId": {
"type": "string",
"description": "Id of the image to delete.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "Delete image model."
},
"DeleteWorkspaceDto": {
"required": [
"workspaceId"
],
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"description": "Id of the dataset to delete.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "Delete dataset model."
},
"EnableEncryptionDto": {
"required": [
"checksum",
"workspaceId"
],
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"description": "Id of the workspace to protect.",
"format": "uuid"
},
"checksum": {
"maxLength": 44,
"minLength": 44,
"type": "string",
"description": "Encryption key checksum.",
"default": "M/UXbiSAMj0DYxfNqImitCmgNAg5dFfdg9rGpZM3wt0="
}
},
"additionalProperties": false,
"description": "Workspace encryption model."
},
"ExportProjectFromPublicApiCommand": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"ImportAnnotationDataDto": {
"type": "object",
"properties": {
"annotationsAuthor": {
"type": "string",
"nullable": true
},
"annotationDuration": {
"type": "string",
"format": "date-span"
},
"annotationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"reviewStatus": {
"type": "string",
"nullable": true
},
"reviewer": {
"type": "string",
"nullable": true
},
"reviewDuration": {
"type": "string",
"format": "date-span"
},
"reviewDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"correctionDuration": {
"type": "string",
"format": "date-span"
},
"wasImageCorrected": {
"type": "boolean"
},
"questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportQuestionDataDto"
},
"nullable": true
},
"segmentation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportSegmentationDataDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ImportAnnotationRejectionDto": {
"type": "object",
"properties": {
"datasetName": {
"type": "string",
"nullable": true
},
"imageName": {
"type": "string",
"nullable": true
},
"reason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ImportAnnotationUnregisteredUserDto": {
"type": "object",
"properties": {
"email": {
"type": "string",
"nullable": true
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"ImportAnnotationsDto": {
"required": [
"projectData",
"projectId"
],
"type": "object",
"properties": {
"projectId": {
"type": "string",
"description": "Id of the project where annotations will be imported.",
"format": "uuid"
},
"projectData": {
"$ref": "#/components/schemas/ImportProjectDataDto"
}
},
"additionalProperties": false,
"description": "Import project model."
},
"ImportAnnotationsReportDto": {
"type": "object",
"properties": {
"importedAnnotationsCount": {
"type": "integer",
"format": "int32"
},
"skippedAnnotationsCount": {
"type": "integer",
"format": "int32"
},
"rejectedAnnotations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportAnnotationRejectionDto"
},
"nullable": true
},
"unregisteredUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportAnnotationUnregisteredUserDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ImportAnnotationsStatusDto": {
"type": "object",
"properties": {
"status": {
"type": "string",
"nullable": true
},
"annotationsReport": {
"$ref": "#/components/schemas/ImportAnnotationsReportDto"
}
},
"additionalProperties": false
},
"ImportDataSetDataDto": {
"type": "object",
"properties": {
"dataSetName": {
"type": "string",
"nullable": true
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportImageDataDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ImportImageDataDto": {
"type": "object",
"properties": {
"imageId": {
"type": "string",
"nullable": true
},
"imageName": {
"type": "string",
"nullable": true
},
"imageURL": {
"type": "string",
"nullable": true
},
"set": {
"type": "string",
"nullable": true
},
"annotations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportAnnotationDataDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ImportProjectDataDto": {
"type": "object",
"properties": {
"exportFileSchemeVersion": {
"type": "string",
"nullable": true
},
"configurationVersion": {
"type": "integer",
"format": "int32"
},
"annotationVersion": {
"type": "integer",
"format": "int32"
},
"setVersion": {
"type": "integer",
"format": "int32"
},
"projectName": {
"type": "string",
"nullable": true
},
"versionGenerated": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dataFilterType": {
"type": "string",
"nullable": true
},
"tools": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportToolDataDto"
},
"nullable": true
},
"questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportQuestionDefinitionDataDto"
},
"nullable": true
},
"dataSets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportDataSetDataDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ImportProjectDto": {
"required": [
"projectData",
"workspaceId"
],
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"description": "Id of the workspace where project will be imported.",
"format": "uuid"
},
"importAnnotations": {
"type": "boolean"
},
"importImageSets": {
"type": "boolean"
},
"projectData": {
"$ref": "#/components/schemas/ImportProjectDataDto"
}
},
"additionalProperties": false,
"description": "Import project model."
},
"ImportProjectReportDto": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"format": "uuid"
},
"importedQuestionsCount": {
"type": "integer",
"format": "int32"
},
"skippedQuestionsCount": {
"type": "integer",
"format": "int32"
},
"rejectedQuestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportQuestionRejectionDto"
},
"nullable": true
},
"importedAttributesCount": {
"type": "integer",
"format": "int32"
},
"skippedAttributesCount": {
"type": "integer",
"format": "int32"
},
"rejectedAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportQuestionRejectionDto"
},
"nullable": true
},
"importedToolsCount": {
"type": "integer",
"format": "int32"
},
"skippedToolsCount": {
"type": "integer",
"format": "int32"
},
"rejectedTools": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportToolRejectionDto"
},
"nullable": true
},
"importedImageSetsCount": {
"type": "integer",
"format": "int32"
},
"skippedImageSetsCount": {
"type": "integer",
"format": "int32"
},
"assignedDatasetNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"rejectedDatasetNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"rejectedImageSets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportSetRejectionDto"
},
"nullable": true
},
"importedAnnotationsCount": {
"type": "integer",
"format": "int32"
},
"skippedAnnotationsCount": {
"type": "integer",
"format": "int32"
},
"rejectedAnnotations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportAnnotationRejectionDto"
},
"nullable": true
},
"unregisteredUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportAnnotationUnregisteredUserDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ImportProjectStatusDto": {
"type": "object",
"properties": {
"status": {
"type": "string",
"nullable": true
},
"importReport": {
"$ref": "#/components/schemas/ImportProjectReportDto"
}
},
"additionalProperties": false
},
"ImportQuestionDataDto": {
"type": "object",
"properties": {
"question": {
"type": "string",
"nullable": true
},
"answer": {
"type": "string",
"nullable": true
},
"answers": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"ImportQuestionDefinitionDataDto": {
"type": "object",
"properties": {
"text": {
"type": "string",
"nullable": true
},
"answerType": {
"type": "string",
"nullable": true
},
"possibleAnswers": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"isRequired": {
"type": "boolean"
},
"isUsed": {
"type": "boolean"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"ImportQuestionRejectionDto": {
"type": "object",
"properties": {
"text": {
"type": "string",
"nullable": true
},
"hasImageScope": {
"type": "boolean"
},
"reason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ImportSegmentationDataDto": {
"type": "object",
"properties": {
"className": {
"type": "string",
"nullable": true
},
"selection": {
"type": "string",
"nullable": true
},
"questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportQuestionDataDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ImportSetRejectionDto": {
"type": "object",
"properties": {
"datasetName": {
"type": "string",
"nullable": true
},
"imageName": {
"type": "string",
"nullable": true
},
"reason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ImportToolDataDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"color": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"isUsed": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ImportToolRejectionDto": {
"type": "object",
"properties": {
"toolName": {
"type": "string",
"nullable": true
},
"reason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PagedQueryResultDtoOfDatasetImageDto": {
"type": "object",
"properties": {
"pagesCount": {
"type": "integer",
"format": "int32"
},
"pageNumber": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatasetImageDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"ProjectExportDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "string",
"nullable": true
},
"fileSchemeVersion": {
"type": "string",
"nullable": true
},
"configurationVersion": {
"type": "integer",
"format": "int32"
},
"annotationsVersion": {
"type": "integer",
"format": "int32"
},
"setVersion": {
"type": "integer",
"format": "int32"
},
"lastDatasetsModifiedDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"ProjectInfoDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the project.",
"format": "uuid"
},
"name": {
"type": "string",
"description": "Name.",
"nullable": true
},
"status": {
"type": "string",
"description": "Status determining whether project has been published.",
"nullable": true
},
"description": {
"type": "string",
"description": "Description.",
"nullable": true
},
"imageCount": {
"type": "integer",
"description": "Count of images in datasets assigned to the project.",
"format": "int32"
},
"usersCount": {
"type": "integer",
"description": "Count of users assigned to the project.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Project information model."
},
"PublicApiResponseOfDatasetInfoDtos": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatasetInfoDto"
},
"description": "Data object of type T containing response data.",
"nullable": true
},
"errorMessage": {
"type": "string",
"description": "Error message.",
"nullable": true
},
"errorCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of error codes.",
"nullable": true
},
"isSuccess": {
"type": "boolean",
"description": "Property defining whether response is successful.",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Public api response model."
},
"PublicApiResponseOfImportAnnotationsStatusDto": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ImportAnnotationsStatusDto"
},
"errorMessage": {
"type": "string",
"description": "Error message.",
"nullable": true
},
"errorCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of error codes.",
"nullable": true
},
"isSuccess": {
"type": "boolean",
"description": "Property defining whether response is successful.",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Public api response model."
},
"PublicApiResponseOfImportProjectStatusDto": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ImportProjectStatusDto"
},
"errorMessage": {
"type": "string",
"description": "Error message.",
"nullable": true
},
"errorCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of error codes.",
"nullable": true
},
"isSuccess": {
"type": "boolean",
"description": "Property defining whether response is successful.",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Public api response model."
},
"PublicApiResponseOfNullableGuid": {
"type": "object",
"properties": {
"data": {
"type": "string",
"description": "Data object of type T containing response data.",
"format": "uuid",
"nullable": true
},
"errorMessage": {
"type": "string",
"description": "Error message.",
"nullable": true
},
"errorCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of error codes.",
"nullable": true
},
"isSuccess": {
"type": "boolean",
"description": "Property defining whether response is successful.",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Public api response model."
},
"PublicApiResponseOfObject": {
"type": "object",
"properties": {
"data": {
"description": "Data object of type T containing response data.",
"nullable": true
},
"errorMessage": {
"type": "string",
"description": "Error message.",
"nullable": true
},
"errorCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of error codes.",
"nullable": true
},
"isSuccess": {
"type": "boolean",
"description": "Property defining whether response is successful.",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Public api response model."
},
"PublicApiResponseOfPagedQueryResultDtoOfDatasetImageDto": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PagedQueryResultDtoOfDatasetImageDto"
},
"errorMessage": {
"type": "string",
"description": "Error message.",
"nullable": true
},
"errorCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of error codes.",
"nullable": true
},
"isSuccess": {
"type": "boolean",
"description": "Property defining whether response is successful.",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Public api response model."
},
"PublicApiResponseOfProjectExportDtos": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectExportDto"
},
"description": "Data object of type T containing response data.",
"nullable": true
},
"errorMessage": {
"type": "string",
"description": "Error message.",
"nullable": true
},
"errorCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of error codes.",
"nullable": true
},
"isSuccess": {
"type": "boolean",
"description": "Property defining whether response is successful.",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Public api response model."
},
"PublicApiResponseOfProjectInfoDtos": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectInfoDto"
},
"description": "Data object of type T containing response data.",
"nullable": true
},
"errorMessage": {
"type": "string",
"description": "Error message.",
"nullable": true
},
"errorCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of error codes.",
"nullable": true
},
"isSuccess": {
"type": "boolean",
"description": "Property defining whether response is successful.",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Public api response model."
},
"PublicApiResponseOfString": {
"type": "object",
"properties": {
"data": {
"type": "string",
"description": "Data object of type T containing response data.",
"nullable": true
},
"errorMessage": {
"type": "string",
"description": "Error message.",
"nullable": true
},
"errorCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of error codes.",
"nullable": true
},
"isSuccess": {
"type": "boolean",
"description": "Property defining whether response is successful.",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Public api response model."
},
"PublicApiResponseOfWorkspaceInfoDtos": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkspaceInfoDto"
},
"description": "Data object of type T containing response data.",
"nullable": true
},
"errorMessage": {
"type": "string",
"description": "Error message.",
"nullable": true
},
"errorCodes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of error codes.",
"nullable": true
},
"isSuccess": {
"type": "boolean",
"description": "Property defining whether response is successful.",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Public api response model."
},
"PublishDatasetDto": {
"required": [
"datasetId"
],
"type": "object",
"properties": {
"datasetId": {
"type": "string",
"description": "Id of the dataset to publish.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "Publish dataset model."
},
"PublishProjectDto": {
"required": [
"projectId"
],
"type": "object",
"properties": {
"projectId": {
"type": "string",
"description": "Id of the project to publish.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "Publish project model."
},
"UnassignDatasetFromProjectDto": {
"required": [
"datasetId",
"projectId"
],
"type": "object",
"properties": {
"projectId": {
"type": "string",
"description": "Id of the project that dataset will be unassigned from.",
"format": "uuid"
},
"datasetId": {
"type": "string",
"description": "Id of dataset to unassign.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "Unassign dataset from project model."
},
"UpdateDatasetDto": {
"required": [
"datasetId",
"name"
],
"type": "object",
"properties": {
"datasetId": {
"type": "string",
"description": "Id of the dataset to update.",
"format": "uuid"
},
"name": {
"minLength": 1,
"type": "string",
"description": "New name for the dataset."
},
"description": {
"type": "string",
"description": "New description for the dataset.",
"nullable": true
},
"author": {
"type": "string",
"description": "New author for the dataset.",
"nullable": true
},
"termsOfUse": {
"type": "string",
"description": "New terms of use for the dataset.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Update dataset model."
},
"WorkspaceInfoDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of the workspace.",
"format": "uuid"
},
"name": {
"type": "string",
"description": "Name of the workspace.",
"nullable": true
},
"encrypted": {
"type": "boolean",
"description": "Indicates whether the workspace is encrypted."
}
},
"additionalProperties": false,
"description": "Workspace information model."
}
},
"securitySchemes": {
"ApiKey": {
"type": "apiKey",
"description": "Please enter your API Key. It will be sent via request header",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"ApiKey": [ ]
}
]
}