The OC automation API is a high level collection of APIs that allows the direct interaction with main focus on the work item operations. It is meant to make it easy to integrate with OC. Drawback is that operations might not be present immediately after being exposed in the core API or that not all performance optimizations can be done.
Endpoints are written in a way to make use of operations, but without the need to know about the underlying event system.
Access
Click here for access to the automation API
The automation API can be used with the same authentication methods as the OC Power automate API.
{
"basePath": "/automate",
"swagger": "2.0",
"info": {
"title": "Automate Api Service 1.0",
"description": "Genetec Operations Center - Automate Api Service",
"version": "1.0"
},
"paths": {
"/v1/tenants/{tenantId}/attachments/{attachmentHash}": {
"get": {
"tags": [
"Attachments"
],
"summary": "Returns the attachment data of the given attachment hash",
"operationId": "GetAttachment",
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "attachmentHash",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "extension",
"type": "string"
}
],
"responses": {
"301": {
"description": "Redirect"
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/v1/tenants/{tenantId}/attachments": {
"put": {
"tags": [
"Attachments"
],
"summary": "Uploads a file from the given url",
"operationId": "UploadFromUrl",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/AttachmentFromUrlRequest"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/PutChunkedResultModel"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v1/tenants/{tenantId}/boards/{id}": {
"get": {
"tags": [
"Boards"
],
"summary": "Get layout",
"operationId": "GetBoard",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "id",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetBoardIdsAndTitles",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Board"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v1/tenants/{tenantId}/boards/{id}/work-items": {
"get": {
"tags": [
"Boards"
],
"summary": "Get active work items",
"operationId": "GetOpenWorkItems",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "id",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetBoardIdsAndTitles",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/WorkItem"
}
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/boards": {
"get": {
"tags": [
"Boards"
],
"summary": "Get layouts",
"operationId": "GetBoardIdsAndTitles",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/IdAndTitle"
}
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v1/tenants/{tenantId}/boards/{id}/columns": {
"get": {
"tags": [
"Boards"
],
"summary": "Get columns and states",
"operationId": "GetBoardColumnsAndStates",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "id",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetBoardIdsAndTitles",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
},
{
"in": "query",
"name": "onlyAllowCreate",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/BoardColumn"
}
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v1/tenants/{tenantId}/boards/{boardId}/columns/{columnId}": {
"get": {
"tags": [
"Boards"
],
"summary": "Get column",
"operationId": "GetBoardColumn",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "boardId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetBoardIdsAndTitles",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
},
{
"in": "path",
"name": "columnId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetBoardColumnsAndStates",
"value-path": "id",
"value-title": "fullTitle",
"parameters": {
"tenantId": {
"parameter": "tenantId"
},
"id": {
"parameter": "boardId"
},
"onlyAllowCreate": false
}
},
"x-ms-dynamic-list": {
"operationId": "GetBoardColumnsAndStates",
"itemValuePath": "id",
"itemTitlePath": "fullTitle",
"parameters": {
"tenantId": {
"parameterReference": "tenantId"
},
"id": {
"parameterReference": "boardId"
},
"onlyAllowCreate": {
"value": false
}
}
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/BoardColumn"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v1/tenants/{tenantId}/boards/{id}/swimlanes": {
"get": {
"tags": [
"Boards"
],
"summary": "Get swimlanes",
"operationId": "GetBoardSwimlanes",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "id",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetBoardIdsAndTitles",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/BoardColumn"
}
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v1/guids": {
"get": {
"tags": [
"Guids"
],
"summary": "Create Guid",
"operationId": "GetSingle",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"responses": {
"200": {
"description": "Success",
"schema": {
"format": "uuid",
"type": "string"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/resources/states/{id}": {
"get": {
"tags": [
"Resources"
],
"summary": "Get resource state",
"operationId": "GetResourceState",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "id",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ResourceState"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v1/tenants/{tenantId}/resources/staff/{id}": {
"get": {
"tags": [
"Resources"
],
"summary": "Get staff",
"operationId": "GetStaff",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "id",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/StaffResource"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v1/tenants/{tenantId}/resources/places/{id}": {
"get": {
"tags": [
"Resources"
],
"summary": "Get place",
"operationId": "GetPlace",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "id",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/PlaceResource"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v1/tenants": {
"get": {
"tags": [
"Tenants"
],
"summary": "Get tenants",
"operationId": "GetTenants",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Tenant"
}
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/webhooks/{webhookId}": {
"get": {
"tags": [
"Webhooks"
],
"summary": "Get Webhook",
"operationId": "GetById",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "webhookId",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/WebhookConfiguration"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
},
"delete": {
"tags": [
"Webhooks"
],
"summary": "Delete Webhook",
"operationId": "Delete",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "webhookId",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"204": {
"description": "No Content",
"schema": {
"format": "uuid",
"type": "string"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/webhooks": {
"post": {
"tags": [
"Webhooks"
],
"summary": "Create Webhook",
"operationId": "Create",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/WebhookCreationRequest"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/ConfigurationViewModel"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
},
"x-ms-trigger": "single"
},
"x-ms-notification-content": {
"description": "Webhook callback response",
"schema": {
"$ref": "#/definitions/HookViewModel"
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}": {
"get": {
"tags": [
"WorkItems"
],
"summary": "Get work item",
"operationId": "GetWorkItemInformation",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/WorkItem"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
},
"post": {
"tags": [
"WorkItemsOperations"
],
"summary": "Create work item",
"operationId": "WorkItemCreated",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/WorkItemCreatedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/correlation/{correlation}": {
"get": {
"tags": [
"WorkItems"
],
"summary": "Get work item by correlation",
"description": "Must be unique and only return 1 work item, otherwise it is not deterministic which workitem is returned.",
"operationId": "GetWorkItemByCorrelation",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "correlation",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/WorkItemSearchResult"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/event-names": {
"get": {
"tags": [
"WorkItems"
],
"summary": "Get all work item events names",
"operationId": "GetEventNames",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "string"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/categories": {
"get": {
"tags": [
"WorkItems"
],
"summary": "Get work item categories",
"operationId": "GetWorkItemCategories",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "query",
"name": "boardId",
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetBoardIdsAndTitles",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/IdAndTitle"
}
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/link-categories": {
"get": {
"tags": [
"WorkItems"
],
"summary": "Get work item link categories",
"operationId": "GetWorkItemLinkCategories",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/IdAndTitle"
}
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/categories/{id}": {
"get": {
"tags": [
"WorkItems"
],
"summary": "Get work item category",
"operationId": "GetWorkItemCategory",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "id",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Category"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/categories/title/{title}": {
"get": {
"tags": [
"WorkItems"
],
"summary": "Get work item category by title",
"operationId": "GetWorkItemCategoryByName",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "title",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Category"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/tags": {
"get": {
"tags": [
"WorkItems"
],
"summary": "Get work item tags",
"operationId": "GetWorkItemTags",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "query",
"name": "boardId",
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetBoardIdsAndTitles",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/IdAndTitle"
}
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/tags/{id}": {
"get": {
"tags": [
"WorkItems"
],
"summary": "Get work item tag",
"operationId": "GetWorkItemTag",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "id",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Tag"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/states": {
"get": {
"tags": [
"WorkItems"
],
"summary": "Get work item states",
"operationId": "GetWorkItemStates",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "query",
"name": "boardId",
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetBoardIdsAndTitles",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/IdAndTitle"
}
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/states/{id}": {
"get": {
"tags": [
"WorkItems"
],
"summary": "Get work item state",
"operationId": "GetWorkItemState",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "id",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/WorkItemBoardState"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/checklist-templates": {
"get": {
"tags": [
"WorkItems"
],
"summary": "Get checklist templates",
"operationId": "GetChecklistTemplates",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "query",
"name": "boardId",
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetBoardIdsAndTitles",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/IdAndTitle"
}
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/checklist-templates/{id}": {
"get": {
"tags": [
"WorkItems"
],
"summary": "Get checklist template",
"operationId": "GetChecklistTemplate",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "id",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/WorkItemChecklistTemplate"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/checklist-item-states": {
"get": {
"tags": [
"WorkItems"
],
"summary": "Get the names and values of the checklist item states",
"operationId": "GetChecklistItemStates",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NumberAndTitle"
}
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/follow-states": {
"get": {
"tags": [
"WorkItems"
],
"summary": "Get names and values of the follow card states",
"operationId": "GetFollowStates",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NumberAndTitle"
}
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/attachments": {
"post": {
"tags": [
"WorkItemsOperations"
],
"summary": "Assign attachment",
"operationId": "AttachmentAssigned",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/AttachmentAssignedRequest"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/EntityCreatedResponse"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/attachments/description": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change attachment description",
"operationId": "AttachmentDescriptionChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/AttachmentDescriptionChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/attachments/name": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change attachment name",
"operationId": "AttachmentNameChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/AttachmentNameChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/attachments/unassign": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Unassign attachment",
"operationId": "AttachmentUnassigned",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/AttachmentUnassignedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/boardposition": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change board position",
"operationId": "BoardPositionChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/BoardPositionChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/budgettimespan": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change budget timespan",
"operationId": "BudgetTimeSpanChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/BudgetTimeSpanChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/check-list-items/archive": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Archive checklist item",
"operationId": "PushChecklistItemArchived",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/ChecklistItemArchivedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"type": "string"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/check-list-items": {
"post": {
"tags": [
"WorkItemsOperations"
],
"summary": "Create checklist item on work item",
"operationId": "PushChecklistItemCreated",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/ChecklistItemCreatedRequest"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/EntityCreatedResponse"
}
},
"default": {
"description": "Error",
"schema": {
"type": "string"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/check-list-items/description": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change checklist item description",
"operationId": "PushChecklistItemDescriptionChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/ChecklistItemDescriptionChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"type": "string"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/check-list-items/status": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change checklist item status",
"operationId": "PushChecklistItemStatusChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/ChecklistItemStatusChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"type": "string"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/check-list-items/title": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change checklist item title",
"operationId": "PushChecklistItemTitleChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/ChecklistItemTitleChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"type": "string"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/check-list-templates/assigned": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Assign checklist template",
"operationId": "PushChecklistTemplateAssigned",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/ChecklistTemplateAssignedRequest"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/EntityCreatedResponse"
}
},
"default": {
"description": "Error",
"schema": {
"type": "string"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/check-list-templates/unassigned": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Unassign checklist template",
"operationId": "PushChecklistTemplateUnassigned",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/ChecklistTemplateUnassignedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"type": "string"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/category": {
"post": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change category",
"operationId": "CategoryChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/CategoryChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/description": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change description",
"operationId": "DescriptionChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/DescriptionChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/duedate": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change due date",
"operationId": "DueDateChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/DueDateChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/externalreporter": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change external reporter",
"operationId": "ExternalReporterChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/ExternalReporterChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/externalrequester": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change external requester",
"operationId": "ExternalRequesterChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/ExternalRequesterChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/correlation": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change correlation string",
"operationId": "CorrelationChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/CorrelationChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/fields/change": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change field value",
"operationId": "FieldChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/FieldChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/gpsmaplocation": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change map location",
"operationId": "GpsMapLocationChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/GpsMapLocationChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/gpsmaplocation/clear": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Clear map location",
"operationId": "GpsMapLocationCleared",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/internalreporter": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change internal reporter",
"operationId": "InternalReporterChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/InternalReporterChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/internalrequester": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change internal requester",
"operationId": "InternalRequesterChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/InternalRequesterChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/locationinfo": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change location information",
"operationId": "LocationInfoChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/LocationInfoChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/place": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change place",
"operationId": "PlaceChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/PlaceChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/priority": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change priority",
"operationId": "PriorityChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/PriorityChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/resources": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Assign resource",
"operationId": "ResourceAssigned",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/ResourceAssignedRequest"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/EntityCreatedResponse"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/resources/unassign": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Unassign resource",
"operationId": "ResourceUnassigned",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/ResourceUnassignedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/tags": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Assign tag",
"operationId": "TagAssigned",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/TagAssignedRequest"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/EntityCreatedResponse"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/tags/unassign": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Unassign tag",
"operationId": "TagUnassigned",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/TagUnassignedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/title": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change title",
"operationId": "TitleChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/TitleChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/user-comments/remove": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Remove user comment",
"operationId": "UserCommentRemoved",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/UserCommentRemovedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/user-comments/change": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change user comment",
"operationId": "UserCommentChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/UserCommentChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/user-comments": {
"post": {
"tags": [
"WorkItemsOperations"
],
"summary": "Create user comment",
"operationId": "UserCommentCreated",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/UserCommentCreatedRequest"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/EntityCreatedResponse"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/archive": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Archive work item",
"operationId": "WorkItemArchived",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/follow": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Change follow work item state",
"operationId": "WorkItemFollowed",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/WorkItemFollowingRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items": {
"post": {
"tags": [
"WorkItemsOperations"
],
"summary": "Create work item (simple)",
"operationId": "WorkItemCreatedNoWorkItemIdGiven",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/SimpleWorkItemCreatedRequest"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/WorkItemCreatedResponse"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/links/assigned": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Assign work item link",
"operationId": "WorkItemLinkAssigned",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/WorkItemLinkAssignedRequest"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/EntityCreatedResponse"
}
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/links/unassigned": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Unassign work item link",
"operationId": "WorkItemLinkUnassigned",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/WorkItemLinkUnassignedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/remove": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Remove work item",
"operationId": "WorkItemRemoved",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/WorkItemRemovedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/restore": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Restore work item",
"operationId": "WorkItemRestored",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/unarchive": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Unarchive user comment",
"operationId": "WorkItemUnarchived",
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/planned-start": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Planned start changed",
"operationId": "PlannedStartChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/PlannedStartChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/planned-end": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Planned end changed",
"operationId": "PlannedEndChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/PlannedEndChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
},
"/v1/tenants/{tenantId}/work-items/{workItemId}/planned-start-end": {
"put": {
"tags": [
"WorkItemsOperations"
],
"summary": "Planned start end changed",
"operationId": "PlannedStartEndChanged",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"in": "path",
"name": "tenantId",
"required": true,
"type": "string",
"format": "uuid",
"x-ms-dynamic-values": {
"operationId": "GetTenants",
"value-path": "id",
"value-title": "name"
}
},
{
"in": "path",
"name": "workItemId",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/PlannedStartEndChangedRequest"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Error",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
}
},
"definitions": {
"AdHocChecklistItem": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"position": {
"format": "double",
"type": "number"
},
"color": {
"type": "string"
},
"image": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
}
}
},
"AdHocChecklistItemViewModel": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"position": {
"format": "double",
"type": "number"
},
"color": {
"type": "string"
},
"image": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
}
}
},
"AssignedChecklistTemplate": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"checklistTemplateId": {
"format": "uuid",
"type": "string"
},
"checklistEventId": {
"format": "uuid",
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/HierarchicalChecklistItem"
}
}
}
},
"AssignedChecklistTemplateViewModel": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"checklistTemplateId": {
"format": "uuid",
"type": "string"
},
"checklistEventId": {
"format": "uuid",
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/HierarchicalChecklistItemViewModel"
}
}
}
},
"AssignedResource": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"resourceId": {
"format": "uuid",
"type": "string"
}
}
},
"AssignedResourceViewModel": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"resourceId": {
"format": "uuid",
"type": "string"
},
"resourceRoleId": {
"format": "uuid",
"type": "string"
},
"resourceCategory": {
"format": "int32",
"type": "integer"
}
}
},
"AssignedTag": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"tagId": {
"format": "uuid",
"type": "string"
}
}
},
"Attachment": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"hash": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"extension": {
"type": "string"
},
"thumbnailHash": {
"type": "string"
},
"thumbnailExtension": {
"type": "string"
},
"createdOn": {
"format": "date-time",
"type": "string"
},
"createdById": {
"format": "uuid",
"type": "string"
},
"changedById": {
"format": "uuid",
"type": "string"
}
}
},
"AttachmentAssignedRequest": {
"required": [
"contentHash",
"extension",
"name"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"assignmentId": {
"format": "uuid",
"type": "string"
},
"name": {
"minLength": 1,
"type": "string"
},
"extension": {
"minLength": 1,
"type": "string"
},
"contentHash": {
"minLength": 1,
"type": "string"
},
"description": {
"type": "string"
},
"thumbnailHash": {
"type": "string"
},
"thumbnailExtension": {
"type": "string"
},
"bigThumbnailHash": {
"type": "string"
},
"bigThumbnailExtension": {
"type": "string"
}
}
},
"AttachmentDescriptionChangedRequest": {
"required": [
"assignmentId",
"description"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"assignmentId": {
"format": "uuid",
"type": "string"
},
"description": {
"minLength": 1,
"type": "string"
}
}
},
"AttachmentFromUrlRequest": {
"type": "object",
"properties": {
"uri": {
"type": "string"
}
}
},
"AttachmentNameChangedRequest": {
"required": [
"assignmentId",
"name"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"assignmentId": {
"format": "uuid",
"type": "string"
},
"name": {
"minLength": 1,
"type": "string"
}
}
},
"AttachmentUnassignedRequest": {
"required": [
"assignmentId"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"assignmentId": {
"format": "uuid",
"type": "string"
}
}
},
"AttachmentViewModel": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"hash": {
"type": "string"
},
"name": {
"type": "string"
},
"extension": {
"type": "string"
},
"description": {
"type": "string"
},
"thumbnailHash": {
"type": "string"
},
"thumbnailExtension": {
"type": "string"
},
"bigThumbnailHash": {
"type": "string"
},
"bigThumbnailExtension": {
"type": "string"
}
}
},
"AutomateLocation": {
"type": "object",
"properties": {
"longitude": {
"format": "double",
"type": "number"
},
"latitude": {
"format": "double",
"type": "number"
}
}
},
"Board": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"changedOn": {
"format": "date-time",
"type": "string"
},
"removedOn": {
"format": "date-time",
"type": "string"
},
"archivedOn": {
"format": "date-time",
"type": "string"
},
"tenantId": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"defaultCategoryId": {
"format": "uuid",
"type": "string"
},
"defaultWorkItemColumnId": {
"format": "uuid",
"type": "string"
}
}
},
"BoardColumn": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"boardStateId": {
"format": "uuid",
"type": "string"
},
"parentId": {
"format": "uuid",
"type": "string"
},
"allowAddNew": {
"type": "boolean"
},
"hideHeader": {
"type": "boolean"
},
"fullTitle": {
"type": "string"
}
}
},
"BoardPositionChangedRequest": {
"required": [
"boardStateId",
"columnId"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"boardStateId": {
"format": "uuid",
"type": "string",
"x-ms-dynamic-values": {
"operationId": "GetWorkItemStates",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
},
"columnId": {
"format": "uuid",
"type": "string"
},
"swimlaneId": {
"format": "uuid",
"type": "string"
},
"columnPosition": {
"format": "double",
"type": "number"
},
"isParked": {
"type": "boolean"
}
}
},
"BudgetTimeSpanChangedRequest": {
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"duration": {
"$ref": "#/definitions/TimeSpan"
}
}
},
"BudgetViewModel": {
"type": "object",
"properties": {
"currencyId": {
"format": "uuid",
"type": "string"
},
"amount": {
"format": "double",
"type": "number"
}
}
},
"Category": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"changedOn": {
"format": "date-time",
"type": "string"
},
"removedOn": {
"format": "date-time",
"type": "string"
},
"archivedOn": {
"format": "date-time",
"type": "string"
},
"tenantId": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"color": {
"type": "string"
},
"image": {
"type": "string"
},
"latestEventHash": {
"type": "string"
}
}
},
"CategoryChangedRequest": {
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"categoryId": {
"format": "uuid",
"type": "string",
"x-ms-dynamic-values": {
"operationId": "GetWorkItemCategories",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
}
}
},
"ChecklistItemArchivedRequest": {
"required": [
"checklistItemId"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"checklistItemId": {
"format": "uuid",
"type": "string"
}
}
},
"ChecklistItemCreatedRequest": {
"required": [
"title"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"checklistItemId": {
"format": "uuid",
"type": "string"
},
"title": {
"minLength": 1,
"type": "string"
},
"description": {
"type": "string"
},
"position": {
"format": "double",
"type": "number"
},
"color": {
"type": "string"
},
"image": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer",
"x-ms-dynamic-values": {
"operationId": "GetChecklistItemStates",
"value-path": "number",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
}
}
},
"ChecklistItemDescriptionChangedRequest": {
"required": [
"checklistItemId"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"checklistItemId": {
"format": "uuid",
"type": "string"
},
"description": {
"type": "string"
}
}
},
"ChecklistItemStatusChangedRequest": {
"required": [
"checklistItemId",
"status"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"checklistItemId": {
"format": "uuid",
"type": "string"
},
"status": {
"format": "int32",
"type": "integer",
"x-ms-dynamic-values": {
"operationId": "GetChecklistItemStates",
"value-path": "number",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
}
}
},
"ChecklistItemTitleChangedRequest": {
"required": [
"checklistItemId",
"title"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"checklistItemId": {
"format": "uuid",
"type": "string"
},
"title": {
"minLength": 1,
"type": "string"
}
}
},
"ChecklistTemplateAssignedRequest": {
"required": [
"checklistTemplateId"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"assignmentId": {
"format": "uuid",
"type": "string"
},
"checklistTemplateId": {
"format": "uuid",
"type": "string",
"x-ms-dynamic-values": {
"operationId": "GetChecklistTemplates",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
},
"checklistEventId": {
"format": "uuid",
"type": "string"
}
}
},
"ChecklistTemplateUnassignedRequest": {
"required": [
"assignmentId"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"assignmentId": {
"format": "uuid",
"type": "string"
}
}
},
"ConfigurationViewModel": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"tenantId": {
"format": "uuid",
"type": "string"
},
"boardId": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"hookUrl": {
"type": "string"
}
}
},
"CorrelationChangedRequest": {
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"correlation": {
"type": "string"
}
}
},
"DescriptionChangedRequest": {
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
}
}
},
"DueDateChangedRequest": {
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"dueDateOffset": {
"format": "date-time",
"type": "string"
}
}
},
"EntityCreatedResponse": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"hash": {
"type": "string"
}
}
},
"ErrorResponse": {
"type": "object",
"properties": {
"correlationId": {
"type": "string"
},
"errorMessage": {
"type": "string"
}
}
},
"ExternalReporterChangedRequest": {
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"reporter": {
"type": "string"
}
}
},
"ExternalRequesterChangedRequest": {
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"requester": {
"type": "string"
}
}
},
"FieldChangedRequest": {
"required": [
"fieldId",
"value"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"fieldId": {
"format": "uuid",
"type": "string"
},
"value": {
"minLength": 1,
"type": "string"
}
}
},
"GpsMapLocationChangedRequest": {
"required": [
"latitude",
"longitude",
"srid"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"srid": {
"format": "int32",
"type": "integer"
},
"latitude": {
"format": "double",
"type": "number"
},
"longitude": {
"format": "double",
"type": "number"
},
"gpsMapZoomLevel": {
"format": "float",
"type": "number"
}
}
},
"HierarchicalChecklistItem": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"position": {
"format": "double",
"type": "number"
},
"color": {
"type": "string"
},
"image": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
},
"parentId": {
"format": "uuid",
"type": "string"
}
}
},
"HierarchicalChecklistItemViewModel": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"position": {
"format": "double",
"type": "number"
},
"color": {
"type": "string"
},
"image": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/HierarchicalChecklistItemViewModel"
}
}
}
},
"HookViewModel": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"tenantId": {
"format": "uuid",
"type": "string"
},
"eventName": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/TagLinkViewModel"
}
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/definitions/AttachmentViewModel"
}
},
"assignedResources": {
"type": "array",
"items": {
"$ref": "#/definitions/AssignedResourceViewModel"
}
},
"userComments": {
"type": "array",
"items": {
"$ref": "#/definitions/UserCommentViewModel"
}
},
"assignedChecklistTemplates": {
"type": "array",
"items": {
"$ref": "#/definitions/AssignedChecklistTemplateViewModel"
}
},
"adHocChecklistItems": {
"type": "array",
"items": {
"$ref": "#/definitions/AdHocChecklistItemViewModel"
}
},
"createdOnOffset": {
"format": "date-time",
"type": "string"
},
"createdById": {
"format": "uuid",
"type": "string"
},
"changedOnOffset": {
"format": "date-time",
"type": "string"
},
"changedById": {
"format": "uuid",
"type": "string"
},
"removedOnOffset": {
"format": "date-time",
"type": "string"
},
"removedById": {
"format": "uuid",
"type": "string"
},
"archivedOnOffset": {
"format": "date-time",
"type": "string"
},
"archivedById": {
"format": "uuid",
"type": "string"
},
"removedReason": {
"type": "string"
},
"latestEventHash": {
"type": "string"
},
"latestEventId": {
"format": "uuid",
"type": "string"
},
"referenceNumber": {
"type": "string"
},
"boardId": {
"format": "uuid",
"type": "string"
},
"categoryId": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"boardStateId": {
"format": "uuid",
"type": "string"
},
"locationInfo": {
"type": "string"
},
"gpsMapLocationX": {
"format": "double",
"type": "number"
},
"gpsMapLocationY": {
"format": "double",
"type": "number"
},
"gpsMapZoomLevel": {
"format": "float",
"type": "number"
},
"dueDateOffset": {
"format": "date-time",
"type": "string"
},
"priority": {
"format": "int32",
"type": "integer"
},
"columnId": {
"format": "uuid",
"type": "string"
},
"swimlaneId": {
"format": "uuid",
"type": "string"
},
"columnPosition": {
"format": "double",
"type": "number"
},
"internalReporterResourceId": {
"format": "uuid",
"description": "The \"internal\" resource which reported the issue",
"type": "string"
},
"internalReporterResourceCategory": {
"format": "int32",
"description": "The type of the resource (comes from the ResourceCategory enum in the resource service)",
"type": "integer"
},
"externalReporter": {
"description": "The external person who reported the issue (we don't know its resource id)",
"type": "string"
},
"locationPresetId": {
"format": "uuid",
"type": "string"
},
"isParked": {
"type": "boolean"
},
"internalRequesterResourceId": {
"format": "uuid",
"description": "The \"internal\" resource which requested the work item",
"type": "string"
},
"internalRequesterResourceCategory": {
"format": "int32",
"description": "The type of the resource (comes from the ResourceCategory enum in the resource service)",
"type": "integer"
},
"externalRequester": {
"type": "string"
},
"budgetAmount": {
"$ref": "#/definitions/BudgetViewModel"
},
"budgetTimeSpan": {
"$ref": "#/definitions/TimeSpan"
}
}
},
"IdAndTitle": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
}
}
},
"InternalReporterChangedRequest": {
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"resourceId": {
"format": "uuid",
"type": "string"
},
"resourceCategory": {
"format": "int32",
"type": "integer"
}
}
},
"InternalRequesterChangedRequest": {
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"resourceId": {
"format": "uuid",
"type": "string"
},
"resourceCategory": {
"format": "int32",
"type": "integer"
}
}
},
"Link": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"linkedWorkItemId": {
"format": "uuid",
"type": "string"
},
"linkedBoardId": {
"format": "uuid",
"type": "string"
},
"linkCategoryId": {
"format": "uuid",
"type": "string"
}
}
},
"LocationInfoChangedRequest": {
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"locationInfo": {
"type": "string"
}
}
},
"NumberAndTitle": {
"type": "object",
"properties": {
"number": {
"format": "int32",
"type": "integer"
},
"title": {
"type": "string"
}
}
},
"PlaceChangedRequest": {
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"placeResourceId": {
"format": "uuid",
"type": "string"
}
}
},
"PlaceResource": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"changedOn": {
"format": "date-time",
"type": "string"
},
"removedOn": {
"format": "date-time",
"type": "string"
},
"archivedOn": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"alias": {
"type": "string"
},
"avatar": {
"type": "string"
},
"department": {
"type": "string"
},
"latestEventHash": {
"type": "string"
},
"state": {
"$ref": "#/definitions/ResourceState"
},
"location": {
"$ref": "#/definitions/AutomateLocation"
},
"resourceCategory": {
"format": "int32",
"enum": [
0,
100,
200,
300,
400
],
"type": "integer"
},
"title": {
"type": "string"
}
}
},
"PlannedEndChangedRequest": {
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"plannedEndOffset": {
"format": "date-time",
"type": "string"
}
}
},
"PlannedStartChangedRequest": {
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"plannedStartOffset": {
"format": "date-time",
"type": "string"
}
}
},
"PlannedStartEndChangedRequest": {
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"plannedStartOffset": {
"format": "date-time",
"type": "string"
},
"plannedEndOffset": {
"format": "date-time",
"type": "string"
}
}
},
"PriorityChangedRequest": {
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"priority": {
"format": "int32",
"type": "integer"
}
}
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
}
},
"additionalProperties": {}
},
"PutChunkedResultModel": {
"type": "object",
"properties": {
"containerName": {
"type": "string"
},
"extension": {
"type": "string"
},
"hash": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"smallThumbnail": {
"$ref": "#/definitions/ThumbnailData"
},
"bigThumbnail": {
"$ref": "#/definitions/ThumbnailData"
}
}
},
"ResourceAssignedRequest": {
"required": [
"assignmentId",
"resourceId",
"resourceRoleId"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"assignmentId": {
"format": "uuid",
"type": "string"
},
"resourceId": {
"format": "uuid",
"type": "string"
},
"resourceRoleId": {
"format": "uuid",
"type": "string"
},
"resourceCategory": {
"format": "int32",
"type": "integer"
}
}
},
"ResourceState": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"changedOn": {
"format": "date-time",
"type": "string"
},
"removedOn": {
"format": "date-time",
"type": "string"
},
"archivedOn": {
"format": "date-time",
"type": "string"
},
"tenantId": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"color": {
"type": "string"
},
"image": {
"type": "string"
},
"latestEventHash": {
"type": "string"
}
}
},
"ResourceUnassignedRequest": {
"required": [
"assignmentId"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"assignmentId": {
"format": "uuid",
"type": "string"
}
}
},
"SimpleWorkItemCreatedRequest": {
"required": [
"boardId"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"boardId": {
"format": "uuid",
"type": "string",
"x-ms-dynamic-values": {
"operationId": "GetBoardIdsAndTitles",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
},
"title": {
"type": "string"
},
"categoryId": {
"format": "uuid",
"type": "string",
"x-ms-dynamic-values": {
"operationId": "GetWorkItemCategories",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
},
"columnId": {
"format": "uuid",
"type": "string",
"x-ms-dynamic-values": {
"operationId": "GetBoardColumnsAndStates",
"value-path": "id",
"value-title": "fullTitle",
"parameters": {
"tenantId": {
"parameter": "tenantId"
},
"id": {
"parameter": "boardId"
},
"onlyAllowCreate": true
}
},
"x-ms-dynamic-list": {
"operationId": "GetBoardColumnsAndStates",
"itemValuePath": "id",
"itemTitlePath": "fullTitle",
"parameters": {
"tenantId": {
"parameterReference": "tenantId"
},
"id": {
"parameterReference": "body/boardId"
},
"onlyAllowCreate": {
"value": true
}
}
}
}
}
},
"StaffResource": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"changedOn": {
"format": "date-time",
"type": "string"
},
"removedOn": {
"format": "date-time",
"type": "string"
},
"archivedOn": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"alias": {
"type": "string"
},
"avatar": {
"type": "string"
},
"department": {
"type": "string"
},
"latestEventHash": {
"type": "string"
},
"state": {
"$ref": "#/definitions/ResourceState"
},
"location": {
"$ref": "#/definitions/AutomateLocation"
},
"resourceCategory": {
"format": "int32",
"enum": [
0,
100,
200,
300,
400
],
"type": "integer"
},
"firstName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"lastName": {
"type": "string"
}
}
},
"Tag": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"changedOn": {
"format": "date-time",
"type": "string"
},
"removedOn": {
"format": "date-time",
"type": "string"
},
"archivedOn": {
"format": "date-time",
"type": "string"
},
"tenantId": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"color": {
"type": "string"
},
"image": {
"type": "string"
}
}
},
"TagAssignedRequest": {
"required": [
"tagId"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"assignmentId": {
"format": "uuid",
"type": "string"
},
"tagId": {
"format": "uuid",
"type": "string",
"x-ms-dynamic-values": {
"operationId": "GetWorkItemTags",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
}
}
},
"TagLinkViewModel": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"tagId": {
"format": "uuid",
"type": "string"
}
}
},
"TagUnassignedRequest": {
"required": [
"assignmentId"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"assignmentId": {
"format": "uuid",
"type": "string"
}
}
},
"Tenant": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"ThumbnailData": {
"type": "object",
"properties": {
"hash": {
"type": "string"
},
"extension": {
"type": "string"
}
}
},
"TimeSpan": {
"type": "object",
"properties": {
"ticks": {
"format": "int64",
"type": "integer"
},
"days": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"hours": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"milliseconds": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"microseconds": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"nanoseconds": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"minutes": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"seconds": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"totalDays": {
"format": "double",
"type": "number",
"readOnly": true
},
"totalHours": {
"format": "double",
"type": "number",
"readOnly": true
},
"totalMilliseconds": {
"format": "double",
"type": "number",
"readOnly": true
},
"totalMicroseconds": {
"format": "double",
"type": "number",
"readOnly": true
},
"totalNanoseconds": {
"format": "double",
"type": "number",
"readOnly": true
},
"totalMinutes": {
"format": "double",
"type": "number",
"readOnly": true
},
"totalSeconds": {
"format": "double",
"type": "number",
"readOnly": true
}
}
},
"TitleChangedRequest": {
"required": [
"title"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"title": {
"minLength": 1,
"type": "string"
}
}
},
"UserComment": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"changedOn": {
"format": "date-time",
"type": "string"
},
"removedOn": {
"format": "date-time",
"type": "string"
},
"archivedOn": {
"format": "date-time",
"type": "string"
},
"comment": {
"type": "string"
},
"createdOn": {
"format": "date-time",
"type": "string"
},
"createdById": {
"format": "uuid",
"type": "string"
},
"changedById": {
"format": "uuid",
"type": "string"
}
}
},
"UserCommentChangedRequest": {
"required": [
"comment",
"id"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"comment": {
"minLength": 1,
"type": "string"
}
}
},
"UserCommentCreatedRequest": {
"required": [
"comment"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"comment": {
"minLength": 1,
"type": "string"
},
"categoryId": {
"format": "uuid",
"type": "string"
}
}
},
"UserCommentRemovedRequest": {
"required": [
"id"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
}
}
},
"UserCommentViewModel": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"comment": {
"type": "string"
},
"authorId": {
"format": "uuid",
"type": "string"
},
"publishTimeOffset": {
"format": "date-time",
"type": "string"
}
}
},
"WebhookConfiguration": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"tenantId": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"hookUrl": {
"type": "string"
},
"boardId": {
"format": "uuid",
"type": "string"
}
}
},
"WebhookCreationRequest": {
"required": [
"hookUrl",
"name"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"boardId": {
"format": "uuid",
"type": "string",
"x-ms-dynamic-values": {
"operationId": "GetBoardIdsAndTitles",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
},
"name": {
"minLength": 1,
"type": "string"
},
"hookUrl": {
"minLength": 1,
"type": "string",
"x-ms-notification-url": true,
"x-ms-visibility": "internal"
}
}
},
"WorkItem": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"changedOn": {
"format": "date-time",
"type": "string"
},
"removedOn": {
"format": "date-time",
"type": "string"
},
"archivedOn": {
"format": "date-time",
"type": "string"
},
"createdOn": {
"format": "date-time",
"type": "string"
},
"dueDate": {
"format": "date-time",
"type": "string"
},
"plannedStart": {
"format": "date-time",
"type": "string"
},
"plannedEnd": {
"format": "date-time",
"type": "string"
},
"referenceNumber": {
"type": "string"
},
"boardId": {
"format": "uuid",
"type": "string"
},
"latestEventHash": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"stateId": {
"format": "uuid",
"type": "string"
},
"categoryId": {
"format": "uuid",
"type": "string"
},
"columnId": {
"format": "uuid",
"type": "string"
},
"locationInfo": {
"type": "string"
},
"locationPresetId": {
"format": "uuid",
"type": "string"
},
"priority": {
"format": "int32",
"type": "integer"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/AssignedTag"
}
},
"assignedResources": {
"type": "array",
"items": {
"$ref": "#/definitions/AssignedResource"
}
},
"assignedChecklistTemplates": {
"type": "array",
"items": {
"$ref": "#/definitions/AssignedChecklistTemplate"
}
},
"adHocChecklistItems": {
"type": "array",
"items": {
"$ref": "#/definitions/AdHocChecklistItem"
}
},
"links": {
"type": "array",
"items": {
"$ref": "#/definitions/Link"
}
},
"createdById": {
"format": "uuid",
"type": "string"
},
"changedById": {
"format": "uuid",
"type": "string"
},
"removedById": {
"format": "uuid",
"type": "string"
},
"archivedById": {
"format": "uuid",
"type": "string"
},
"externalReporter": {
"type": "string"
},
"internalReporterId": {
"format": "uuid",
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/definitions/Attachment"
}
},
"userComments": {
"type": "array",
"items": {
"$ref": "#/definitions/UserComment"
}
}
}
},
"WorkItemBoardState": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"changedOn": {
"format": "date-time",
"type": "string"
},
"removedOn": {
"format": "date-time",
"type": "string"
},
"archivedOn": {
"format": "date-time",
"type": "string"
},
"tenantId": {
"format": "uuid",
"type": "string"
},
"boardId": {
"format": "uuid",
"type": "string"
},
"parentId": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"color": {
"type": "string"
},
"image": {
"type": "string"
}
}
},
"WorkItemChecklistTemplate": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"changedOn": {
"format": "date-time",
"type": "string"
},
"removedOn": {
"format": "date-time",
"type": "string"
},
"archivedOn": {
"format": "date-time",
"type": "string"
},
"tenantId": {
"format": "uuid",
"type": "string"
},
"parentId": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"color": {
"type": "string"
},
"image": {
"type": "string"
},
"metadata": {
"type": "string"
},
"items": {
"type": "string"
}
}
},
"WorkItemCreatedRequest": {
"required": [
"boardId",
"boardStateId",
"categoryId",
"columnId",
"title"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"title": {
"minLength": 1,
"type": "string"
},
"boardId": {
"format": "uuid",
"type": "string",
"x-ms-dynamic-values": {
"operationId": "GetBoardIdsAndTitles",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
},
"boardStateId": {
"format": "uuid",
"type": "string",
"x-ms-dynamic-values": {
"operationId": "GetWorkItemStates",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
},
"categoryId": {
"format": "uuid",
"type": "string",
"x-ms-dynamic-values": {
"operationId": "GetWorkItemCategories",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
},
"columnId": {
"format": "uuid",
"type": "string",
"x-ms-dynamic-values": {
"operationId": "GetBoardColumnsAndStates",
"value-path": "id",
"value-title": "fullTitle",
"parameters": {
"tenantId": {
"parameter": "tenantId"
},
"id": {
"parameter": "boardId"
},
"onlyAllowCreate": true
}
},
"x-ms-dynamic-list": {
"operationId": "GetBoardColumnsAndStates",
"itemValuePath": "id",
"itemTitlePath": "fullTitle",
"parameters": {
"tenantId": {
"parameterReference": "tenantId"
},
"id": {
"parameterReference": "body/boardId"
},
"onlyAllowCreate": {
"value": true
}
}
}
},
"swimlaneId": {
"format": "uuid",
"type": "string",
"x-ms-dynamic-values": {
"operationId": "GetBoardSwimlanes",
"value-path": "id",
"value-title": "fullTitle",
"parameters": {
"tenantId": {
"parameter": "tenantId"
},
"id": {
"parameter": "boardId"
}
}
},
"x-ms-dynamic-list": {
"operationId": "GetBoardSwimlanes",
"itemValuePath": "id",
"itemTitlePath": "fullTitle",
"parameters": {
"tenantId": {
"parameterReference": "tenantId"
},
"id": {
"parameterReference": "body/boardId"
}
}
}
},
"columnPosition": {
"format": "double",
"type": "number"
}
}
},
"WorkItemCreatedResponse": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"hash": {
"type": "string"
},
"referenceNumber": {
"type": "string"
}
}
},
"WorkItemFollowingRequest": {
"required": [
"status"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"status": {
"format": "int32",
"type": "integer",
"x-ms-dynamic-values": {
"operationId": "GetFollowStates",
"value-path": "number",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
}
}
},
"WorkItemLinkAssignedRequest": {
"required": [
"linkCategoryId",
"linkedBoardId",
"linkedWorkItemId"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"assignmentId": {
"format": "uuid",
"type": "string"
},
"linkedBoardId": {
"format": "uuid",
"type": "string",
"x-ms-dynamic-values": {
"operationId": "GetBoardIdsAndTitles",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
},
"linkedWorkItemId": {
"format": "uuid",
"type": "string"
},
"linkCategoryId": {
"format": "uuid",
"type": "string",
"x-ms-dynamic-values": {
"operationId": "GetWorkItemLinkCategories",
"value-path": "id",
"value-title": "title",
"parameters": {
"tenantId": {
"parameter": "tenantId"
}
}
}
}
}
},
"WorkItemLinkUnassignedRequest": {
"required": [
"assignmentId"
],
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"assignmentId": {
"format": "uuid",
"type": "string"
}
}
},
"WorkItemRemovedRequest": {
"type": "object",
"properties": {
"timeOfFactOffset": {
"format": "date-time",
"type": "string"
},
"reason": {
"type": "string"
}
}
},
"WorkItemSearchResult": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"changedOn": {
"format": "date-time",
"type": "string"
},
"removedOn": {
"format": "date-time",
"type": "string"
},
"archivedOn": {
"format": "date-time",
"type": "string"
},
"createdOn": {
"format": "date-time",
"type": "string"
},
"dueDate": {
"format": "date-time",
"type": "string"
},
"plannedStart": {
"format": "date-time",
"type": "string"
},
"plannedEnd": {
"format": "date-time",
"type": "string"
},
"referenceNumber": {
"type": "string"
},
"boardId": {
"format": "uuid",
"type": "string"
},
"latestEventHash": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"stateId": {
"format": "uuid",
"type": "string"
},
"categoryId": {
"format": "uuid",
"type": "string"
},
"columnId": {
"format": "uuid",
"type": "string"
},
"locationInfo": {
"type": "string"
},
"locationPresetId": {
"format": "uuid",
"type": "string"
},
"priority": {
"format": "int32",
"type": "integer"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/AssignedTag"
}
},
"assignedResources": {
"type": "array",
"items": {
"$ref": "#/definitions/AssignedResource"
}
},
"assignedChecklistTemplates": {
"type": "array",
"items": {
"$ref": "#/definitions/AssignedChecklistTemplate"
}
},
"adHocChecklistItems": {
"type": "array",
"items": {
"$ref": "#/definitions/AdHocChecklistItem"
}
},
"links": {
"type": "array",
"items": {
"$ref": "#/definitions/Link"
}
},
"createdById": {
"format": "uuid",
"type": "string"
},
"changedById": {
"format": "uuid",
"type": "string"
},
"removedById": {
"format": "uuid",
"type": "string"
},
"archivedById": {
"format": "uuid",
"type": "string"
},
"externalReporter": {
"type": "string"
},
"internalReporterId": {
"format": "uuid",
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/definitions/Attachment"
}
},
"userComments": {
"type": "array",
"items": {
"$ref": "#/definitions/UserComment"
}
},
"found": {
"type": "boolean"
}
}
}
},
"securityDefinitions": {
"GenetecSts": {
"type": "oauth2",
"flow": "accessCode",
"authorizationUrl": "https://login.genetec.com/connect/authorize",
"tokenUrl": "https://login.genetec.com/connect/token",
"scopes": {
"openid": "",
"profile": "",
"groups": "",
"source_iss": "",
"oc.services": "",
"sso.provisioning": ""
}
}
},
"security": {
"oauth2_auth": [
"openid",
"profile",
"groups",
"oc.services",
"source_iss",
"offline_access"
]
}
}