{ "openapi": "3.0.4", "info": { "title": "ISOPlanner Service SVC", "description": "\u003Cp\u003EGlobal response codes:\u003C/p\u003E\u003Cp\u003E200 - Success\u003C/p\u003E\u003Cp\u003E204 - NoContent - When no data is returned\u003C/p\u003E\u003Cp\u003E400 - BadRequest - Any mailformed or invalid request\u003C/p\u003E\u003Cp\u003E401 - Unauthenticated - Request has no valid bearer token\u003C/p\u003E\u003Cp\u003E403 - Forbidden - User does not have the necessary authorization\u003C/p\u003E\u003Cp\u003E404 - NotFound - When a requested object is not found\u003C/p\u003E\u003Cp\u003E409 - Conflict - Database conflict, other user has modified the data", "version": "v1" }, "paths": { "/bi/v1/activities": { "get": { "tags": ["Activity"], "summary": "Get the list of activities", "parameters": [ { "name": "start", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/assets": { "get": { "tags": ["Asset"], "summary": "Get the list of assets", "responses": { "200": { "description": "OK" } } }, "post": { "tags": ["Asset"], "summary": "Create an asset", "requestBody": { "description": "The Asset", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPAsset" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPAsset" } } } }, "responses": { "200": { "description": "" } } }, "put": { "tags": ["Asset"], "summary": "Update an asset", "requestBody": { "description": "The Asset", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPAsset" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPAsset" } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/assets/types": { "get": { "tags": ["Asset"], "summary": "Get the list of asset types", "responses": { "200": { "description": "OK" } } } }, "/api/v1/assets/{assetId}": { "get": { "tags": ["Asset"], "summary": "Get an asset", "parameters": [ { "name": "assetId", "in": "path", "description": "The Id of the Asset", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "" } } }, "delete": { "tags": ["Asset"], "summary": "Delete an asset", "parameters": [ { "name": "assetId", "in": "path", "description": "The Id of the Asset", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/assets/external/{externalId}": { "get": { "tags": ["Asset"], "summary": "Get an asset for an external Id", "parameters": [ { "name": "externalId", "in": "path", "description": "The Id of the Asset", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } } }, "delete": { "tags": ["Asset"], "summary": "Delete an asset based on external Id", "parameters": [ { "name": "externalId", "in": "path", "description": "The External Id of the Asset", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } } } }, "/bi/v1/assets": { "get": { "tags": ["Asset"], "summary": "Get the list of assets", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/assets/tags": { "get": { "tags": ["Asset"], "summary": "Get the relationship between assets and tags", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/assets/risks": { "get": { "tags": ["Asset"], "summary": "Get the relationship between assets and risks", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/assets/processes": { "get": { "tags": ["Asset"], "summary": "Get the relationship between assets and processes", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/assets/tasks": { "get": { "tags": ["Asset"], "summary": "Get the relationship between assets and processes", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/assets/libraryitems": { "get": { "tags": ["Asset"], "summary": "Get the relationship between assets and library items", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/assets/classifications": { "get": { "tags": ["Asset"], "summary": "Get the relationship between assets and library items", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/auditlogs": { "get": { "tags": ["Audit"], "summary": "Get the audit logs", "parameters": [ { "name": "start", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/bi/v1/auth/schemas": { "get": { "tags": ["Auth"], "summary": "Get all authorization schemas", "responses": { "200": { "description": "" } } } }, "/bi/v1/auth/schemas/lines": { "get": { "tags": ["Auth"], "summary": "Get all authorization schema lines", "responses": { "200": { "description": "" } } } }, "/bi/v1/auth/schemas/lines/calc": { "get": { "tags": ["Auth"], "summary": "Get all authorization schema lines calculated", "responses": { "200": { "description": "" } } } }, "/bi/v1/auth/roles": { "get": { "tags": ["Auth"], "summary": "Get all authorization roles", "responses": { "200": { "description": "List of Auths" } } } }, "/bi/v1/auth/roles/users/calc": { "get": { "tags": ["Auth"], "summary": "Get all users in all roles calculated", "responses": { "200": { "description": "" } } } }, "/bi/v1/auth/roles/permissions": { "get": { "tags": ["Auth"], "summary": "Get all permissions in all roles", "responses": { "200": { "description": "" } } } }, "/bi/v1/auth/users/roles": { "get": { "tags": ["Auth"], "summary": "Get all roles of all users", "responses": { "200": { "description": "" } } } }, "/bi/v1/auth/users/groups": { "get": { "tags": ["Auth"], "summary": "Get all groups of all users", "responses": { "200": { "description": "" } } } }, "/bi/v1/auth/groups/roles": { "get": { "tags": ["Auth"], "summary": "Get all groups of all roles", "responses": { "200": { "description": "" } } } }, "/bi/v1/classifications": { "get": { "tags": ["Classification"], "summary": "Get the list of classifications", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/comments": { "get": { "tags": ["Comment"], "summary": "Get the list of comments", "parameters": [ { "name": "start", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/bi/v1/controls": { "get": { "tags": ["Control"], "summary": "Get the list of controls", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/controls/tags": { "get": { "tags": ["Control"], "summary": "Get the relationship between risks and tags", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/controls/tasks": { "get": { "tags": ["Control"], "summary": "Get the relationship between risks and tasks / events", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/controls/libraryitems": { "get": { "tags": ["Control"], "summary": "Get the relationship between controls and library items", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/dashboards": { "get": { "tags": ["Dashboard"], "summary": "Get the dashboards", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/dashboards/widgets": { "get": { "tags": ["Dashboard"], "summary": "Get the widgets", "responses": { "200": { "description": "OK" } } } }, "/api/v1/kpis/{kpiId}/data/{dataId}": { "get": { "tags": ["KPI"], "summary": "Get KPI data", "parameters": [ { "name": "kpiId", "in": "path", "description": "The Id of the KPI", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "dataId", "in": "path", "description": "KPI data Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "" } } }, "delete": { "tags": ["KPI"], "summary": "Delete KPI data", "parameters": [ { "name": "kpiId", "in": "path", "description": "The Id of the KPI", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "dataId", "in": "path", "description": "KPI data Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/kpis/{kpiId}/data": { "get": { "tags": ["KPI"], "summary": "Get all KPI data between in a specific date range", "parameters": [ { "name": "kpiId", "in": "path", "description": "The Id of the KPI", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "start", "in": "query", "description": "Start date", "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "description": "End date", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/kpis": { "get": { "tags": ["KPI"], "summary": "Get a list of KPI's", "responses": { "200": { "description": "List of KPI" } } } }, "/api/v1/kpis/{kpiId}": { "get": { "tags": ["KPI"], "summary": "Get a KPI", "parameters": [ { "name": "kpiId", "in": "path", "description": "The Id of the KPI", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "KPI" } } } }, "/api/v1/kpis/data": { "post": { "tags": ["KPI"], "summary": "Add KPI data", "requestBody": { "description": "IPKPIData", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPKPIData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPKPIData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPKPIData" } } } }, "responses": { "200": { "description": "" } } }, "put": { "tags": ["KPI"], "summary": "Update KPI data", "requestBody": { "description": "IPKPIData", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPKPIData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPKPIData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPKPIData" } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/kpis/data/context/types": { "get": { "tags": ["KPI"], "summary": "Get a list of available entity types", "responses": { "200": { "description": "" } } } }, "/api/v1/kpis/data/context": { "post": { "tags": ["KPI"], "summary": "Add context to KPI data", "requestBody": { "description": "IPKPIDataContext", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPKPIDataContext" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPKPIDataContext" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPKPIDataContext" } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/kpis/data/evidence": { "post": { "tags": ["KPI"], "summary": "Submit evidence to a KPI", "requestBody": { "description": "IKPIEvidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPKPIEvidence" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPKPIEvidence" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPKPIEvidence" } } } }, "responses": { "200": { "description": "" } } } }, "/bi/v1/kpis": { "get": { "tags": ["KPI"], "summary": "Get a list of KPI's", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/kpis/{kpiId}/data": { "get": { "tags": ["KPI"], "summary": "Get all KPI data for a KPI and between in a specific date range", "parameters": [ { "name": "kpiId", "in": "path", "description": "The Id of the KPI", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "start", "in": "query", "description": "Start date", "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "description": "End date", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/bi/v1/kpis/{kpiId}/data/contexts": { "get": { "tags": ["KPI"], "summary": "Get all KPI data contexts for a KPI and between in a specific date range", "parameters": [ { "name": "kpiId", "in": "path", "description": "The Id of the KPI", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "start", "in": "query", "description": "Start date", "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "description": "End date", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/bi/v1/kpis/tags": { "get": { "tags": ["KPI"], "summary": "Get the relationship between risks and tags", "responses": { "200": { "description": "OK" } } } }, "/api/v1/library/categories": { "get": { "tags": ["Library"], "summary": "Get the list of categories in the Library", "responses": { "200": { "description": "" } } } }, "/api/v1/library/content/{libraryItemId}/task/{taskId}": { "post": { "tags": ["Library"], "summary": "Adds an existing library item to a task", "parameters": [ { "name": "libraryItemId", "in": "path", "description": "The Id of the library item", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "taskId", "in": "path", "description": "The Id of the task", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Link" } } } }, "/api/v1/library/content/{libraryItemId}": { "get": { "tags": ["Library"], "summary": "Get a Library item", "parameters": [ { "name": "libraryItemId", "in": "path", "description": "The Id of the library item", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Link" } } } }, "/api/v1/library/content/filter/url": { "get": { "tags": ["Library"], "summary": "Get a Library item by url", "parameters": [ { "name": "value", "in": "query", "description": "The Url of the library item", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Link" } } } }, "/api/v1/library/content/{libraryItemId}/event/{eventId}": { "post": { "tags": ["Library"], "summary": "Adds an existing library item to a task", "parameters": [ { "name": "libraryItemId", "in": "path", "description": "The Id of the library item", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "eventId", "in": "path", "description": "The Id of the event", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Link" } } } }, "/api/v1/library/content": { "post": { "tags": ["Library"], "summary": "Creates or updates an item in the library", "requestBody": { "description": "The library item model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPLibraryItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPLibraryItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPLibraryItem" } } } }, "responses": { "200": { "description": "Link" } } } }, "/bi/v1/library/categories": { "get": { "tags": ["Library"], "summary": "Get Categories in the Library", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/library/content": { "get": { "tags": ["Library"], "summary": "Get Library items", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/navigation": { "get": { "tags": ["Nav"], "summary": "Get BI navigation", "responses": { "200": { "description": "" } } } }, "/bi/v1/documentation": { "get": { "tags": ["Nav"], "summary": "Get BI documentation", "responses": { "200": { "description": "" } } } }, "/bi/v1/objectives": { "get": { "tags": ["Objective"], "summary": "Get the list of objectives", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/objectives/tags": { "get": { "tags": ["Objective"], "summary": "Get the relationship between objectives and tags", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/objectives/tasks": { "get": { "tags": ["Objective"], "summary": "Get the relationship between objectives and tasks / events", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/objectives/controls": { "get": { "tags": ["Objective"], "summary": "Get the relationship between objectives and controls", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/objectives/libraryitems": { "get": { "tags": ["Objective"], "summary": "Get the relationship between objectives and library items", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/objectives/kpis": { "get": { "tags": ["Objective"], "summary": "Get the relationship between objectives and KPIs", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/processes": { "get": { "tags": ["Process"], "summary": "Get the list of processs", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/processes/objectives": { "get": { "tags": ["Process"], "summary": "Get the relationship between processes and objectives", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/processes/controls": { "get": { "tags": ["Process"], "summary": "Get the relationship between processes and controls", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/processes/tags": { "get": { "tags": ["Process"], "summary": "Get the relationship between objectives and tags", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/processes/libraryitems": { "get": { "tags": ["Process"], "summary": "Get the relationship between processes and library items", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/processes/tasks": { "get": { "tags": ["Process"], "summary": "Get the relationship between processes and tasks", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/processingactivities": { "get": { "tags": ["ProcessingActivity"], "summary": "Get the list of processing activities", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/processingactivities/assets": { "get": { "tags": ["ProcessingActivity"], "summary": "Get the relationship between processing activities and assets", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/processingactivities/referencedata": { "get": { "tags": ["ProcessingActivity"], "summary": "Get the relationship between processing activities and reference data", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/processingactivities/tags": { "get": { "tags": ["ProcessingActivity"], "summary": "Get the relationship between processing activities and tags", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/processingactivities/risks": { "get": { "tags": ["ProcessingActivity"], "summary": "Get the relationship between processing activities and risks", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/processingactivities/processes": { "get": { "tags": ["ProcessingActivity"], "summary": "Get the relationship between processing activities and processes", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/processingactivities/tasks": { "get": { "tags": ["ProcessingActivity"], "summary": "Get the relationship between processing activities and tasks", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/processingactivities/libraryitems": { "get": { "tags": ["ProcessingActivity"], "summary": "Get the relationship between processing activities and library items (links)", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/processingactivities/controls": { "get": { "tags": ["ProcessingActivity"], "summary": "Get the relationship between processing activities and controls", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/requirements": { "get": { "tags": ["Requirement"], "summary": "Get the list of requirements", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/requirements/tags": { "get": { "tags": ["Requirement"], "summary": "Get the relationship between requirements and tags", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/requirements/tasks": { "get": { "tags": ["Requirement"], "summary": "Get the relationship between requirements and tasks / events", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/requirements/libraryitems": { "get": { "tags": ["Requirement"], "summary": "Get the relationship between requirements and library items", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/risks": { "get": { "tags": ["Risk"], "summary": "Get the list of risks", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/risks/tags": { "get": { "tags": ["Risk"], "summary": "Get the relationship between risks and tags", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/risks/tasks": { "get": { "tags": ["Risk"], "summary": "Get the relationship between risks and tasks / events", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/risks/controls": { "get": { "tags": ["Risk"], "summary": "Get the relationship between risks and controls", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/risks/libraryitems": { "get": { "tags": ["Risk"], "summary": "Get the relationship between risks and library items", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/risks/objectives": { "get": { "tags": ["Risk"], "summary": "Get the relationship between risks and objectives", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/risks/processes": { "get": { "tags": ["Risk"], "summary": "Get the relationship between risks and processes", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/standards": { "get": { "tags": ["Standard"], "summary": "Get standards", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/standards/controls": { "get": { "tags": ["Standard"], "summary": "Get the relationship between standards and controls", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/standards/assets": { "get": { "tags": ["Standard"], "summary": "Get the relationship between standards and controls", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/standards/libraryitems": { "get": { "tags": ["Standard"], "summary": "Get the relationship between standards and library items", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/referencedata": { "get": { "tags": ["StringValue"], "summary": "Get the list of reference data", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/tags": { "get": { "tags": ["Tag"], "summary": "Get tags", "responses": { "200": { "description": "OK" } } } }, "/api/v1/tasks": { "post": { "tags": ["Task"], "summary": "Create a task", "requestBody": { "description": "IPTask model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPTask" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPTask" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPTask" } } } }, "responses": { "200": { "description": "" } } }, "put": { "tags": ["Task"], "summary": "Update a task", "requestBody": { "description": "IPTask model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPTask" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPTask" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPTask" } } } }, "responses": { "200": { "description": "" } } }, "get": { "tags": ["Task"], "summary": "Get tasks", "parameters": [ { "name": "filter", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/events": { "post": { "tags": ["Task"], "summary": "Create an event", "requestBody": { "description": "IPEvent model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPEvent" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPEvent" } } } }, "responses": { "200": { "description": "" } } }, "put": { "tags": ["Task"], "summary": "Update an event", "requestBody": { "description": "IPEvent model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPEvent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPEvent" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPEvent" } } } }, "responses": { "200": { "description": "" } } }, "get": { "tags": ["Task"], "summary": "Get events", "parameters": [ { "name": "filter", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/events/approval": { "post": { "tags": ["Task"], "summary": "Create an approval", "requestBody": { "description": "IPApproval model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPApproval" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPApproval" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPApproval" } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/tasks/templates/{type}": { "get": { "tags": ["Task"], "summary": "Get task templates", "parameters": [ { "name": "type", "in": "path", "description": "Type:\r\n- 1: all active task and event templates\r\n- 2: all active task templates\r\n- 3: all active event templates\r\n- 4: all active approval templates\r\n- 5: all active monitoring task templates", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/events/{id}/approval": { "put": { "tags": ["Task"], "summary": "Update an event from approval result", "parameters": [ { "name": "id", "in": "path", "description": "Id of the event", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "final", "in": "query", "description": "Indicates whether this is the final result for this event. Set to True to mark this event as done. Set to false to allow upload of more results later in the workflow.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "IPApprovalResult model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPApprovalResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPApprovalResult" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPApprovalResult" } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/events/{eventId}/subtasks/{taskId}": { "get": { "tags": ["Task"], "summary": "Get a subtask of an event", "parameters": [ { "name": "eventId", "in": "path", "description": "Id of the event", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "taskId", "in": "path", "description": "Id of the subtask", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "" } } }, "delete": { "tags": ["Task"], "summary": "Delete a subtask of an event", "parameters": [ { "name": "eventId", "in": "path", "description": "Id of the event", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "taskId", "in": "path", "description": "IPTask model", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/events/{eventId}/subtasks/name/{taskName}": { "get": { "tags": ["Task"], "summary": "Get a subtask of an event based on the name of the subtask", "parameters": [ { "name": "eventId", "in": "path", "description": "Id of the event", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "taskName", "in": "path", "description": "Id of the subtask", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/events/{eventId}/subtasks": { "post": { "tags": ["Task"], "summary": "Create a subtask for an event", "parameters": [ { "name": "eventId", "in": "path", "description": "Id of the event", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "IPTask model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPTask" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPTask" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPTask" } } } }, "responses": { "200": { "description": "" } } }, "put": { "tags": ["Task"], "summary": "Update a subtask of an event", "parameters": [ { "name": "eventId", "in": "path", "description": "Id of the event", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "IPTask model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPTask" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPTask" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPTask" } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/tasks/{taskId}": { "delete": { "tags": ["Task"], "summary": "Delete a task", "parameters": [ { "name": "taskId", "in": "path", "description": "Id of the task", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/events/{eventId}": { "delete": { "tags": ["Task"], "summary": "Delete an event", "parameters": [ { "name": "eventId", "in": "path", "description": "Id of the event", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/tasks/forms": { "get": { "tags": ["Task"], "summary": "Get all task forms", "responses": { "200": { "description": "OK" } } } }, "/api/v1/checklist/{id}/items": { "get": { "tags": ["Task"], "summary": "Get checklist items for a task or event", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/checklist/items": { "post": { "tags": ["Task"], "summary": "Add checklist item to a task or event", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPCheckListItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPCheckListItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPCheckListItem" } } } }, "responses": { "200": { "description": "OK" } } }, "put": { "tags": ["Task"], "summary": "Update checklist item for a task or event", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPCheckListItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPCheckListItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPCheckListItem" } } } }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": ["Task"], "summary": "Delete checklist item for a task or event", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPCheckListItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPCheckListItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPCheckListItem" } } } }, "responses": { "200": { "description": "OK" } } } }, "/bi/v1/tasks/templates": { "get": { "tags": ["Task"], "summary": "Get task templates", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/events/templates": { "get": { "tags": ["Task"], "summary": "Get event templates", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/tasks": { "get": { "tags": ["Task"], "summary": "Get tasks", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/events": { "get": { "tags": ["Task"], "summary": "Get events", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/forms": { "get": { "tags": ["Task"], "summary": "Get forms", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/tasks/libraryitems": { "get": { "tags": ["Task"], "summary": "Get the relationship between tasks and library items", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/tasks/tags": { "get": { "tags": ["Task"], "summary": "Get the relationship between tasks and tags", "responses": { "200": { "description": "OK" } } } }, "/api/v1/users": { "get": { "tags": ["User"], "summary": "Get all users", "responses": { "200": { "description": "List of User" } } } }, "/api/v1/roles": { "get": { "tags": ["User"], "summary": "Get all users", "responses": { "200": { "description": "List of User" } } } }, "/api/v1/me": { "get": { "tags": ["User"], "summary": "Get the current user", "responses": { "200": { "description": "User" } } } }, "/api/v1/users/orgunits": { "get": { "tags": ["User"], "summary": "Get organizational units for user", "responses": { "200": { "description": "List of Tenant" } } } }, "/bi/v1/users": { "get": { "tags": ["User"], "summary": "Get all users", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/groups": { "get": { "tags": ["User"], "summary": "Get all groups", "responses": { "200": { "description": "OK" } } } }, "/bi/v1/users/orgunits": { "get": { "tags": ["User"], "summary": "Get organizational units for user", "responses": { "200": { "description": "OK" } } } }, "/api/v1/hooks": { "post": { "tags": ["Webhook"], "summary": "Create a Webhook", "requestBody": { "description": "Webhook model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPWebhook" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPWebhook" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPWebhook" } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/hooks/triggers/{type}": { "post": { "tags": ["Webhook"], "summary": "Create a Webhook with a unique trigger endpoint", "parameters": [ { "name": "type", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Webhook model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPWebhook" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPWebhook" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPWebhook" } } } }, "responses": { "200": { "description": "" } } } }, "/api/v1/hooks/orgunit/{ouid}/{id}": { "delete": { "tags": ["Webhook"], "summary": "Delete a webhook in an organizational unit", "parameters": [ { "name": "ouid", "in": "path", "description": "The id of the organizational unit", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Id of the webhook", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/hooks/{id}": { "delete": { "tags": ["Webhook"], "summary": "Delete a webhook", "parameters": [ { "name": "id", "in": "path", "description": "Id of the webhook", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "" } } } }, "/api/v1/hooks/triggers": { "get": { "tags": ["Webhook"], "summary": "Get a list of available webhook trigger types", "responses": { "200": { "description": "" } } } } }, "components": { "schemas": { "ISOPlanner.Sdk.API.V1.DataModels.IPApproval": { "type": "object", "properties": { "orgUnitId": { "type": "string", "format": "uuid", "nullable": true }, "eventId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "comment": { "maxLength": 4000, "minLength": 0, "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "templateId": { "type": "integer", "format": "int32", "nullable": true }, "users": { "type": "string", "nullable": true }, "libraryItemId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ISOPlanner.Sdk.API.V1.DataModels.IPApprovalResult": { "type": "object", "properties": { "responses": { "type": "array", "items": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPApprovalResultResponse" }, "nullable": true }, "responseSummary": { "type": "string", "nullable": true }, "completionDate": { "type": "string", "nullable": true }, "outcome": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ISOPlanner.Sdk.API.V1.DataModels.IPApprovalResultResponder": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "userPrincipalName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ISOPlanner.Sdk.API.V1.DataModels.IPApprovalResultResponse": { "type": "object", "properties": { "responder": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPApprovalResultResponder" }, "responseDate": { "type": "string", "nullable": true }, "approverResponse": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ISOPlanner.Sdk.API.V1.DataModels.IPAsset": { "type": "object", "properties": { "orgUnitId": { "type": "string", "format": "uuid", "nullable": true }, "assetId": { "type": "integer", "format": "int32", "nullable": true }, "code": { "maxLength": 32, "minLength": 0, "type": "string", "nullable": true }, "externalId": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "externalContainerIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "owner": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPOwner" }, "state": { "type": "string", "nullable": true }, "libraryCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "integer", "format": "int32", "nullable": true }, "lifeCycleStart": { "type": "string", "format": "date-time", "nullable": true }, "lifeCycleEnd": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPTag" }, "nullable": true }, "auditTrailId": { "type": "integer", "format": "int32", "nullable": true }, "authSchemaId": { "type": "integer", "format": "int32", "nullable": true }, "location": { "type": "string", "nullable": true }, "dataZone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ISOPlanner.Sdk.API.V1.DataModels.IPCheckListItem": { "type": "object", "properties": { "taskId": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "string", "format": "uuid", "nullable": true }, "state": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPCheckListItem.TaskCheckListItemState" }, "description": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ISOPlanner.Sdk.API.V1.DataModels.IPCheckListItem.TaskCheckListItemState": { "enum": [0, 1, 2], "type": "integer", "format": "int32" }, "ISOPlanner.Sdk.API.V1.DataModels.IPChecklistStats": { "type": "object", "properties": { "itemCount": { "type": "integer", "format": "int32" }, "successCount": { "type": "integer", "format": "int32" }, "failedCount": { "type": "integer", "format": "int32" }, "notSetCount": { "type": "integer", "format": "int32" }, "setCount": { "type": "integer", "format": "int32" }, "successPercentage": { "type": "number", "format": "double" }, "failedPercentage": { "type": "number", "format": "double" }, "notSetPercentage": { "type": "number", "format": "double" }, "setPercentage": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ISOPlanner.Sdk.API.V1.DataModels.IPEvent": { "type": "object", "properties": { "orgUnitId": { "type": "string", "format": "uuid", "nullable": true }, "eventId": { "type": "integer", "format": "int32", "nullable": true }, "formId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "startDateTime": { "type": "string", "format": "date-time", "nullable": true }, "templateId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "maxLength": 8000, "minLength": 0, "type": "string", "nullable": true }, "descriptionHtml": { "maxLength": 8000, "minLength": 0, "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "nullable": true }, "creator": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPUser" }, "owner": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPUser" }, "library": { "type": "array", "items": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPLibraryItem" }, "nullable": true }, "taskAssigneeEmailAddresses": { "type": "string", "nullable": true }, "firstLibraryItemId": { "type": "integer", "format": "int32", "nullable": true }, "firstLibraryItemUrl": { "type": "string", "nullable": true }, "firstLibraryItemName": { "type": "string", "nullable": true }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPTask" }, "nullable": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPTag" }, "nullable": true }, "externalId": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "startDateTimePassed": { "type": "boolean" }, "checklistStats": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPChecklistStats" }, "auditTrailId": { "type": "integer", "format": "int32" }, "commentTrailId": { "type": "integer", "format": "int32" }, "authSchemaId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ISOPlanner.Sdk.API.V1.DataModels.IPKPIData": { "required": ["kpiId"], "type": "object", "properties": { "orgUnitId": { "type": "string", "format": "uuid", "nullable": true }, "kpiId": { "type": "integer", "format": "int32" }, "kpiDataId": { "type": "integer", "format": "int32", "nullable": true }, "created": { "type": "string", "format": "date-time", "nullable": true }, "createdBy": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "createdById": { "type": "string", "format": "uuid", "nullable": true }, "modified": { "type": "string", "format": "date-time", "nullable": true }, "modifiedBy": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "modifiedById": { "type": "string", "format": "uuid", "nullable": true }, "resultNumber": { "type": "number", "format": "double", "nullable": true }, "resultDate": { "type": "string", "format": "date-time", "nullable": true }, "resultText": { "maxLength": 1024, "minLength": 0, "type": "string", "nullable": true }, "resultComment": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "taskId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ISOPlanner.Sdk.API.V1.DataModels.IPKPIDataContext": { "type": "object", "properties": { "orgUnitId": { "type": "string", "format": "uuid", "nullable": true }, "kpiId": { "type": "integer", "format": "int32" }, "kpiDataId": { "type": "integer", "format": "int32" }, "entityType": { "type": "integer", "format": "int32" }, "entityTypeName": { "type": "string", "nullable": true }, "entityId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ISOPlanner.Sdk.API.V1.DataModels.IPKPIEvidence": { "required": ["kpiId"], "type": "object", "properties": { "orgUnitId": { "type": "string", "format": "uuid", "nullable": true }, "kpiId": { "type": "integer", "format": "int32" }, "taskId": { "type": "integer", "format": "int32", "nullable": true }, "evidence": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "nullable": true }, "createdBy": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "createdById": { "type": "string", "format": "uuid", "nullable": true }, "resultComment": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "kpiDataId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ISOPlanner.Sdk.API.V1.DataModels.IPLibraryItem": { "type": "object", "properties": { "orgUnitId": { "type": "string", "format": "uuid", "nullable": true }, "libraryCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "libraryCategoryName": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "libraryCategoryType": { "type": "integer", "format": "int32", "nullable": true }, "libraryCategoryTypeName": { "type": "string", "nullable": true }, "libraryCategorySiteId": { "type": "string", "nullable": true }, "libraryCategoryUrl": { "maxLength": 2048, "minLength": 0, "type": "string", "nullable": true }, "libraryItemId": { "type": "integer", "format": "int32", "nullable": true }, "libraryItemName": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "libraryItemUrl": { "maxLength": 800, "minLength": 0, "type": "string", "nullable": true }, "libraryItemOwner": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPOwner" }, "libraryItemSPItemId": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "libraryItemListItemId": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "libraryItemDriveItemId": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "libraryItemPageItemId": { "maxLength": 128, "minLength": 0, "type": "string", "nullable": true }, "libraryItemSPListItemId": { "type": "integer", "format": "int64" }, "libraryItemSPListETag": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ISOPlanner.Sdk.API.V1.DataModels.IPOwner": { "type": "object", "properties": { "orgUnitId": { "type": "string", "format": "uuid", "nullable": true }, "userId": { "type": "string", "format": "uuid", "nullable": true }, "roleId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "email": { "type": "string", "format": "email", "nullable": true } }, "additionalProperties": false }, "ISOPlanner.Sdk.API.V1.DataModels.IPTag": { "type": "object", "properties": { "orgUnitId": { "type": "string", "format": "uuid", "nullable": true }, "tagId": { "type": "integer", "format": "int32", "nullable": true }, "tagName": { "maxLength": 32, "minLength": 0, "type": "string", "nullable": true }, "tagValue": { "maxLength": 64, "minLength": 0, "type": "string", "nullable": true }, "tagColor": { "maxLength": 7, "minLength": 0, "type": "string", "nullable": true }, "tagInfo": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "ISOPlanner.Sdk.API.V1.DataModels.IPTask": { "type": "object", "properties": { "orgUnitId": { "type": "string", "format": "uuid", "nullable": true }, "taskId": { "type": "integer", "format": "int32", "nullable": true }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "taskType": { "type": "integer", "format": "int32", "nullable": true }, "formId": { "type": "integer", "format": "int32", "nullable": true }, "status": { "type": "string", "nullable": true }, "templateId": { "type": "integer", "format": "int32", "nullable": true }, "externalId": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "name": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "description": { "maxLength": 8000, "minLength": 0, "type": "string", "nullable": true }, "descriptionHtml": { "maxLength": 8000, "minLength": 0, "type": "string", "nullable": true }, "assigneeId": { "type": "string", "format": "uuid", "nullable": true }, "assigneeName": { "type": "string", "nullable": true }, "assigneeEmail": { "type": "string", "nullable": true }, "isScheduled": { "type": "boolean" }, "calendarEventId": { "type": "string", "nullable": true }, "calendarEventUID": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "nullable": true }, "creator": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPUser" }, "owner": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPUser" }, "startDateTime": { "type": "string", "format": "date-time", "nullable": true }, "endDateTime": { "type": "string", "format": "date-time", "nullable": true }, "deadline": { "type": "string", "format": "date-time", "nullable": true }, "hidden": { "type": "boolean", "nullable": true }, "library": { "type": "array", "items": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPLibraryItem" }, "nullable": true }, "url": { "type": "string", "nullable": true }, "startDateTimePassed": { "type": "boolean" }, "endDateTimePassed": { "type": "boolean" }, "deadlinePassed": { "type": "boolean" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPTag" }, "nullable": true }, "checklistStats": { "$ref": "#/components/schemas/ISOPlanner.Sdk.API.V1.DataModels.IPChecklistStats" }, "auditTrailId": { "type": "integer", "format": "int32" }, "commentTrailId": { "type": "integer", "format": "int32" }, "authSchemaId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ISOPlanner.Sdk.API.V1.DataModels.IPUser": { "type": "object", "properties": { "orgUnitId": { "type": "string", "format": "uuid", "nullable": true }, "userKey": { "type": "string", "nullable": true, "readOnly": true }, "userId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "email": { "type": "string", "format": "email", "nullable": true } }, "additionalProperties": false }, "ISOPlanner.Sdk.API.V1.DataModels.IPWebhook": { "type": "object", "properties": { "orgUnitId": { "type": "string", "format": "uuid", "nullable": true }, "secret": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "eventType": { "maxLength": 32, "minLength": 0, "type": "string", "nullable": true }, "eventTypeId": { "type": "integer", "format": "int32", "nullable": true }, "url": { "maxLength": 1024, "minLength": 0, "type": "string", "nullable": true }, "workflowName": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "location": { "type": "string", "nullable": true }, "payload": { "nullable": true } }, "additionalProperties": false } } } }