{ "openapi": "3.0.4", "info": { "title": "Digilean Public API", "version": "v2" }, "paths": { "/v2/areas": { "get": { "tags": [ "Areas" ], "operationId": "GetAreas", "parameters": [ { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/AreaPaginationResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/AreaPaginationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AreaPaginationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AreaPaginationResult" } } } } } } }, "/v2/areas/{areaId}": { "get": { "tags": [ "Areas" ], "operationId": "GetAreaByAreaId", "parameters": [ { "name": "areaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/Area" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Area" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Area" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Area" } } } } } } }, "/v2/boards": { "get": { "tags": [ "Boards" ], "operationId": "GetBoards", "parameters": [ { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/BoardPaginationResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/BoardPaginationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BoardPaginationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoardPaginationResult" } } } } } } }, "/v2/boards/{boardId}": { "get": { "tags": [ "Boards" ], "operationId": "GetBoardByBoardId", "parameters": [ { "name": "boardId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/Board" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Board" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Board" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Board" } } } } } } }, "/v2/groups": { "get": { "tags": [ "Groups" ], "operationId": "GetGroups", "parameters": [ { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/GroupPaginationResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/GroupPaginationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GroupPaginationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupPaginationResult" } } } } } } }, "/v2/groups/{groupId}": { "get": { "tags": [ "Groups" ], "operationId": "GetGroupByGroupId", "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/Group" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Group" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Group" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Group" } } } } } } }, "/v2/incidents/comments": { "get": { "tags": [ "IncidentComments" ], "operationId": "GetIncidentComments", "parameters": [ { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/IncidentCommentPaginationResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/IncidentCommentPaginationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IncidentCommentPaginationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IncidentCommentPaginationResult" } } } } } } }, "/v2/incidents/{incidentId}/comments": { "get": { "tags": [ "IncidentComments" ], "operationId": "GetIncidentCommentsByIncidentId", "parameters": [ { "name": "incidentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/IncidentCommentPaginationResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/IncidentCommentPaginationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IncidentCommentPaginationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IncidentCommentPaginationResult" } } } } } } }, "/v2/incidents/comments/{incidentCommentId}": { "get": { "tags": [ "IncidentComments" ], "operationId": "GetIncidentCommentByIncidentCommentId", "parameters": [ { "name": "incidentCommentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/IncidentComment" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/IncidentComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IncidentComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IncidentComment" } } } } } } }, "/v2/incidents/{incidentId}/comments/{incidentCommentId}": { "get": { "tags": [ "IncidentComments" ], "operationId": "GetIncidentCommentByIncidentIdAndIncidentCommentId", "parameters": [ { "name": "incidentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "incidentCommentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/IncidentComment" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/IncidentComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IncidentComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IncidentComment" } } } } } } }, "/v2/incidents": { "get": { "tags": [ "Incidents" ], "operationId": "GetIncidents", "parameters": [ { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/IncidentPaginationResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/IncidentPaginationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IncidentPaginationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IncidentPaginationResult" } } } } } } }, "/v2/incidents/{incidentId}": { "get": { "tags": [ "Incidents" ], "operationId": "GetIncidentByIncidentId", "parameters": [ { "name": "incidentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/Incident" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/Incident" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Incident" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Incident" } } } } } } }, "/v2/incidents/types": { "get": { "tags": [ "IncidentTypes" ], "operationId": "GetIncidentTypes", "parameters": [ { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/IncidentTypePaginationResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/IncidentTypePaginationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IncidentTypePaginationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IncidentTypePaginationResult" } } } } } } }, "/v2/incidents/{incidentId}/types": { "get": { "tags": [ "IncidentTypes" ], "operationId": "GetIncidentTypesByIncidentId", "parameters": [ { "name": "incidentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/IncidentTypePaginationResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/IncidentTypePaginationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IncidentTypePaginationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IncidentTypePaginationResult" } } } } } } }, "/v2/incidents/types/{incidentTypeId}": { "get": { "tags": [ "IncidentTypes" ], "operationId": "GetIncidentTypeByIncidentTypeId", "parameters": [ { "name": "incidentTypeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/IncidentType" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/IncidentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IncidentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IncidentType" } } } } } } }, "/v2/incidents/{incidentId}/types/{incidentTypeId}": { "get": { "tags": [ "IncidentTypes" ], "operationId": "GetIncidentTypeByIncidentIdAndIncidentTypeId", "parameters": [ { "name": "incidentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "incidentTypeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/IncidentType" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/IncidentType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IncidentType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IncidentType" } } } } } } }, "/v2/ping": { "get": { "tags": [ "Ping" ], "operationId": "GetPing", "parameters": [ { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "type": "string", "format": "date-time" } }, "text/plain": { "schema": { "type": "string", "format": "date-time" } }, "application/json": { "schema": { "type": "string", "format": "date-time" } }, "text/json": { "schema": { "type": "string", "format": "date-time" } } } } } } }, "/v2/tasks/{taskId}/attachments": { "post": { "tags": [ "TaskAttachments" ], "operationId": "CreateTaskAttachmentByTaskId", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/TaskAttachment" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TaskAttachment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaskAttachment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskAttachment" } } } } } } }, "/v2/tasks/{taskId}/attachments/{taskAttachmentId}": { "delete": { "tags": [ "TaskAttachments" ], "operationId": "DeleteTaskAttachmentByTaskIdAndTaskAttachmentId", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "taskAttachmentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v2/tasks/comments": { "get": { "tags": [ "TaskComments" ], "operationId": "GetTaskComments", "parameters": [ { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/TaskCommentPaginationResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TaskCommentPaginationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaskCommentPaginationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskCommentPaginationResult" } } } } } }, "post": { "tags": [ "TaskComments" ], "operationId": "CreateTaskComment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskCommentCreate" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TaskCommentCreate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskCommentCreate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TaskCommentCreate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/TaskComment" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TaskComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaskComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskComment" } } } } } } }, "/v2/tasks/{taskId}/comments": { "get": { "tags": [ "TaskComments" ], "operationId": "GetTaskCommentsByTaskId", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/TaskCommentPaginationResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TaskCommentPaginationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaskCommentPaginationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskCommentPaginationResult" } } } } } } }, "/v2/tasks/comments/{taskCommentId}": { "get": { "tags": [ "TaskComments" ], "operationId": "GetTaskCommentByTaskCommentId", "parameters": [ { "name": "taskCommentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/TaskComment" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TaskComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaskComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskComment" } } } } } }, "delete": { "tags": [ "TaskComments" ], "operationId": "DeleteTaskCommentByTaskCommentId", "parameters": [ { "name": "taskCommentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/v2/tasks/{taskId}/comments/{taskCommentId}": { "get": { "tags": [ "TaskComments" ], "operationId": "GetTaskCommentByTaskIdAndTaskCommentId", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "taskCommentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/TaskComment" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TaskComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaskComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskComment" } } } } } }, "delete": { "tags": [ "TaskComments" ], "operationId": "DeleteTaskCommentByTaskIdAndTaskCommentId", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "taskCommentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/v2/tasks": { "get": { "tags": [ "Tasks" ], "operationId": "GetTasks", "parameters": [ { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/TaskPaginationResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/TaskPaginationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaskPaginationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskPaginationResult" } } } } } }, "post": { "tags": [ "Tasks" ], "operationId": "CreateTask", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskCreate" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TaskCreate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskCreate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TaskCreate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DigiLeanTask" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DigiLeanTask" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DigiLeanTask" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DigiLeanTask" } } } } } } }, "/v2/tasks/{taskId}": { "get": { "tags": [ "Tasks" ], "operationId": "GetTaskByTaskId", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DigiLeanTask" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DigiLeanTask" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DigiLeanTask" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DigiLeanTask" } } } } } }, "patch": { "tags": [ "Tasks" ], "operationId": "UpdateTaskByTaskId", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/merge-patch+json": { "schema": { "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DigiLeanTask" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DigiLeanTask" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DigiLeanTask" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DigiLeanTask" } } } } } }, "put": { "tags": [ "Tasks" ], "operationId": "SetTaskByTaskId", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskUpdate" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TaskUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TaskUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/DigiLeanTask" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DigiLeanTask" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DigiLeanTask" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DigiLeanTask" } } } } } }, "delete": { "tags": [ "Tasks" ], "operationId": "DeleteTaskByTaskId", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "mode", "in": "query", "schema": { "$ref": "#/components/schemas/TaskDeleteMode" } } ], "responses": { "200": { "description": "OK" } } } }, "/v2/users": { "get": { "tags": [ "Users" ], "operationId": "GetUsers", "parameters": [ { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/UserPaginationResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UserPaginationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserPaginationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserPaginationResult" } } } } } }, "post": { "tags": [ "Users" ], "operationId": "CreateUser", "parameters": [ { "name": "allowRecovery", "in": "query", "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCreate" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserCreate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserCreate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserCreate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/User" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/User" } }, "application/json": { "schema": { "$ref": "#/components/schemas/User" } }, "text/json": { "schema": { "$ref": "#/components/schemas/User" } } } } } } }, "/v2/users/{userId}": { "get": { "tags": [ "Users" ], "operationId": "GetUserByUserId", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "$search", "in": "query", "description": "Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., \"1234\"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., \"this is example\").", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$filter", "in": "query", "description": "OData filter expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$select", "in": "query", "description": "OData select expression", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$top", "in": "query", "description": "OData top (limit) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$skip", "in": "query", "description": "OData skip (offset) expression", "schema": { "type": "integer", "format": "int32", "default": null } }, { "name": "$expand", "in": "query", "description": "OData expand expression to include related entities (navigation properties) in the response.", "schema": { "type": "string", "default": null, "nullable": true } }, { "name": "$count", "in": "query", "description": "OData count expression to include a count of the total number of items in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "$orderby", "in": "query", "description": "OData order by expression", "schema": { "type": "string", "default": null, "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/User" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/User" } }, "application/json": { "schema": { "$ref": "#/components/schemas/User" } }, "text/json": { "schema": { "$ref": "#/components/schemas/User" } } } } } }, "patch": { "tags": [ "Users" ], "operationId": "UpdateUserByUserId", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/merge-patch+json": { "schema": { "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/User" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/User" } }, "application/json": { "schema": { "$ref": "#/components/schemas/User" } }, "text/json": { "schema": { "$ref": "#/components/schemas/User" } } } } } }, "put": { "tags": [ "Users" ], "operationId": "SetUserByUserId", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdate" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserUpdate" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json;odata.metadata=none;odata.streaming=false": { "schema": { "$ref": "#/components/schemas/User" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/User" } }, "application/json": { "schema": { "$ref": "#/components/schemas/User" } }, "text/json": { "schema": { "$ref": "#/components/schemas/User" } } } } } }, "delete": { "tags": [ "Users" ], "operationId": "DeleteUserByUserId", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "Area": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AreaPaginationResult": { "required": [ "value" ], "type": "object", "properties": { "@odata.count": { "type": "integer", "format": "int32", "nullable": true }, "@odata.nextLink": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/Area" } } }, "additionalProperties": false }, "Board": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "boardType": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BoardType" } ] }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "isMember": { "type": "boolean" }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "isPublic": { "type": "boolean" }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "group": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Group" } ] }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/DigiLeanTask" } } }, "additionalProperties": false }, "BoardPaginationResult": { "required": [ "value" ], "type": "object", "properties": { "@odata.count": { "type": "integer", "format": "int32", "nullable": true }, "@odata.nextLink": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/Board" } } }, "additionalProperties": false }, "BoardType": { "enum": [ "Weekly", "Kanban", "SmartActionList", "Yearly" ], "type": "string" }, "DigiLeanTask": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "lastModified": { "type": "string", "format": "date-time" }, "responsibleUser": { "type": "string", "nullable": true }, "responsibleUserId": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "boardId": { "type": "integer", "format": "int32", "nullable": true }, "board": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Board" } ] }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/TaskStatus" }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "rowCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "columnCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "lastModifiedByUserId": { "type": "string", "nullable": true }, "lastModifiedByUser": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/TaskComment" } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/TaskAttachment" } } }, "additionalProperties": false }, "EvaluationStatus": { "enum": [ "Meh", "Smile", "Frown" ], "type": "string" }, "Group": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/GroupType" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "parent": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Group" } ] }, "isSystemGroup": { "type": "boolean" }, "level": { "type": "integer", "format": "int32", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "externalName": { "type": "string", "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "boards": { "type": "array", "items": { "$ref": "#/components/schemas/Board" } }, "isMember": { "type": "boolean" } }, "additionalProperties": false }, "GroupPaginationResult": { "required": [ "value" ], "type": "object", "properties": { "@odata.count": { "type": "integer", "format": "int32", "nullable": true }, "@odata.nextLink": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/Group" } } }, "additionalProperties": false }, "GroupType": { "enum": [ "GENERAL", "BUSINESSUNIT", "PROJECT", "CUSTOMIZED" ], "type": "string" }, "Incident": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "attachmentCount": { "type": "integer", "format": "int32" }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "statusModifiedDate": { "type": "string", "format": "date-time", "nullable": true }, "severity": { "$ref": "#/components/schemas/IncidentSeverity" }, "status": { "$ref": "#/components/schemas/IncidentStatus" }, "incidentDate": { "type": "string", "format": "date-time" }, "evaluationStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EvaluationStatus" } ] }, "evaluationText": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "owner": { "type": "string", "nullable": true }, "ownerDisplayName": { "type": "string", "nullable": true }, "lastModified": { "type": "string", "format": "date-time", "nullable": true }, "lastModifiedByUser": { "type": "string", "nullable": true }, "lastModifiedByUserId": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "createdByUserId": { "type": "string", "nullable": true }, "createdByUser": { "type": "string", "nullable": true }, "createdByUserDisplayName": { "type": "string", "nullable": true }, "statusNewDate": { "type": "string", "format": "date-time", "nullable": true }, "statusInProgressDate": { "type": "string", "format": "date-time", "nullable": true }, "statusImplementedDate": { "type": "string", "format": "date-time", "nullable": true }, "statusRejectedDate": { "type": "string", "format": "date-time", "nullable": true }, "archivedDate": { "type": "string", "format": "date-time", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "areaId": { "type": "integer", "format": "int32", "nullable": true }, "area": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Area" } ] }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "group": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Group" } ] }, "followUpGroupId": { "type": "integer", "format": "int32", "nullable": true }, "followUpGroup": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Group" } ] }, "ownerUserId": { "type": "string", "nullable": true }, "ownerUser": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/User" } ] }, "externalId": { "type": "string", "nullable": true }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/DigiLeanTask" } }, "actionListCount": { "type": "integer", "format": "int32" }, "latitude": { "type": "number", "format": "double", "nullable": true }, "longitude": { "type": "number", "format": "double", "nullable": true }, "accuracyInMeters": { "type": "number", "format": "double", "nullable": true }, "isAnonymous": { "type": "boolean" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentComment" } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentAttachment" } }, "typeId": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/IncidentType" } }, "additionalProperties": false }, "IncidentAttachment": { "type": "object", "properties": { "fileId": { "type": "string" }, "fileName": { "type": "string" }, "fileUrl": { "type": "string" }, "contentType": { "type": "string" }, "name": { "type": "string" }, "previewFileName": { "type": "string" }, "hasPreview": { "type": "boolean" }, "fileExtension": { "type": "string" }, "eTag": { "type": "string" }, "fileSizeInBytes": { "type": "integer", "format": "int64" }, "fileSizeInKb": { "type": "integer", "format": "int64" }, "createdDate": { "type": "string", "format": "date-time" }, "createdByUserId": { "type": "string", "nullable": true }, "createdByUser": { "type": "string" }, "lastModified": { "type": "string", "format": "date-time" }, "lastModifiedByUserId": { "type": "string", "nullable": true }, "lastModifiedByUser": { "type": "string" }, "mimeType": { "type": "string" }, "isImage": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "IncidentComment": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "commentDate": { "type": "string", "format": "date-time" }, "commentedBy": { "type": "string" }, "commentedByUserId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "parent": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IncidentComment" } ] }, "level": { "type": "integer", "format": "int32" }, "incidentId": { "type": "integer", "format": "int32" }, "incident": { "$ref": "#/components/schemas/Incident" } }, "additionalProperties": false }, "IncidentCommentPaginationResult": { "required": [ "value" ], "type": "object", "properties": { "@odata.count": { "type": "integer", "format": "int32", "nullable": true }, "@odata.nextLink": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentComment" } } }, "additionalProperties": false }, "IncidentPaginationResult": { "required": [ "value" ], "type": "object", "properties": { "@odata.count": { "type": "integer", "format": "int32", "nullable": true }, "@odata.nextLink": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/Incident" } } }, "additionalProperties": false }, "IncidentSeverity": { "enum": [ "None", "Low", "Medium", "High" ], "type": "string" }, "IncidentStatus": { "enum": [ "New", "InProgress", "Resolved", "Rejected" ], "type": "string" }, "IncidentType": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IncidentTypePaginationResult": { "required": [ "value" ], "type": "object", "properties": { "@odata.count": { "type": "integer", "format": "int32", "nullable": true }, "@odata.nextLink": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentType" } } }, "additionalProperties": false }, "TaskAttachment": { "type": "object", "properties": { "fileId": { "type": "string" }, "fileName": { "type": "string" }, "fileUrl": { "type": "string" }, "contentType": { "type": "string" }, "name": { "type": "string" }, "previewFileName": { "type": "string" }, "hasPreview": { "type": "boolean" }, "fileExtension": { "type": "string" }, "eTag": { "type": "string" }, "fileSizeInBytes": { "type": "integer", "format": "int64" }, "fileSizeInKb": { "type": "integer", "format": "int64" }, "createdDate": { "type": "string", "format": "date-time" }, "createdByUserId": { "type": "string", "nullable": true }, "createdByUser": { "type": "string" }, "lastModified": { "type": "string", "format": "date-time" }, "lastModifiedByUserId": { "type": "string", "nullable": true }, "lastModifiedByUser": { "type": "string" }, "mimeType": { "type": "string" }, "isImage": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TaskComment": { "required": [ "commentedBy", "task", "text" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "level": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "commentedBy": { "type": "string" }, "commentedByUserId": { "type": "string", "nullable": true }, "commentDate": { "type": "string", "format": "date-time" }, "taskId": { "type": "integer", "format": "int32" }, "task": { "$ref": "#/components/schemas/DigiLeanTask" }, "commentedByUserDisplayName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TaskCommentCreate": { "required": [ "comment", "taskId" ], "type": "object", "properties": { "taskId": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "comment": { "type": "string" }, "mentions": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "TaskCommentPaginationResult": { "required": [ "value" ], "type": "object", "properties": { "@odata.count": { "type": "integer", "format": "int32", "nullable": true }, "@odata.nextLink": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/TaskComment" } } }, "additionalProperties": false }, "TaskCreate": { "required": [ "status", "title" ], "type": "object", "properties": { "responsibleUserId": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "boardId": { "type": "integer", "format": "int32", "nullable": true }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/TaskStatus" }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "rowCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "columnCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "color": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "TaskDeleteMode": { "enum": [ "SINGLE", "CLONES", "RECCURING", "ALL" ], "type": "string" }, "TaskPaginationResult": { "required": [ "value" ], "type": "object", "properties": { "@odata.count": { "type": "integer", "format": "int32", "nullable": true }, "@odata.nextLink": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/DigiLeanTask" } } }, "additionalProperties": false }, "TaskStatus": { "enum": [ "NotStarted", "Completed", "Blocked" ], "type": "string" }, "TaskUpdate": { "required": [ "status", "title" ], "type": "object", "properties": { "responsibleUserId": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "boardId": { "type": "integer", "format": "int32", "nullable": true }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/TaskStatus" }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "rowCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "columnCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "color": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "TaskUpdatePartial": { "required": [ "model" ], "type": "object", "properties": { "model": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TaskUpdate" } ] }, "providedProperties": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "User": { "type": "object", "properties": { "id": { "type": "string" }, "userName": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/UserType" }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } } }, "additionalProperties": false }, "UserCreate": { "required": [ "email", "firstName", "lastName", "type", "userName" ], "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "type": { "$ref": "#/components/schemas/UserType" }, "displayName": { "type": "string", "nullable": true }, "userName": { "type": "string" }, "email": { "type": "string" }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserGroup": { "required": [ "group", "groupId", "role", "user", "userId" ], "type": "object", "properties": { "groupId": { "type": "integer", "format": "int32" }, "userId": { "type": "string" }, "role": { "$ref": "#/components/schemas/UserGroupRole" }, "group": { "$ref": "#/components/schemas/Group" }, "user": { "$ref": "#/components/schemas/User" } }, "additionalProperties": false }, "UserGroupRole": { "enum": [ "Member", "Viewer", "Owner" ], "type": "string" }, "UserPaginationResult": { "required": [ "value" ], "type": "object", "properties": { "@odata.count": { "type": "integer", "format": "int32", "nullable": true }, "@odata.nextLink": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } }, "additionalProperties": false }, "UserType": { "enum": [ "NORMAL", "MOBILE", "SCREEN" ], "type": "string" }, "UserUpdate": { "required": [ "email", "firstName", "lastName", "type", "userName" ], "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "type": { "$ref": "#/components/schemas/UserType" }, "displayName": { "maxLength": 6, "type": "string", "nullable": true }, "userName": { "type": "string", "format": "email" }, "email": { "type": "string", "format": "email" }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserUpdatePartial": { "required": [ "model" ], "type": "object", "properties": { "model": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UserUpdate" } ] }, "providedProperties": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "securitySchemes": { "ClientCredentials": { "type": "oauth2", "description": "Client Credentials flow. Authorization header with Bearer token", "flows": { "clientCredentials": { "tokenUrl": "https://auth-test.digilean.tools/connect/token", "scopes": { } } } } } }, "security": [ { "ClientCredentials": [ ] } ] }