{ "x-generator": "On Key REST API Docs Generator", "openapi": "3.0.0", "info": { "title": "On Key IDENTITY API Specification", "description": "Better and smarter enterprise asset management with one of the world's leading Enterprise Asset Management (EAM) systems.", "termsOfService": "https://www.onkey.com/", "contact": { "name": "On Key Support", "url": "https://www.onkey.com/", "email": "onkey.support@pragmaworld.net" }, "license": { "name": "On Key Licence", "url": "https://www.onkey.com/" }, "version": "1.0.0" }, "servers": [ { "url": "{scheme}://{server}:{port}/api/tenants/{client}/{connection}", "description": "On Key API Server", "variables": { "scheme": { "default": "https", "description": "HTTP scheme" }, "server": { "default": "", "description": "Server host" }, "port": { "default": "443", "description": "Port" }, "client": { "default": "", "description": "Client" }, "connection": { "default": "", "description": "Connection/Environment (i.e. prod, qa)" } } } ], "paths": { "/Modules/IDENTITY/Localisations/Sets/{name}/Translations": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of translations for the Localisation Set", "description": "", "operationId": "GetLocalisationSetTranslations", "parameters": [ { "name": "name", "in": "path", "required": true, "description": "Name of Localisation Set", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "langId", "in": "query", "description": "Language Id (default=0)", "schema": { "type": "integer", "format": "int64" } }, { "name": "lang", "in": "query", "description": "Language Code (default=en)", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success response - body contains Translation Set definition", "content": { "application/vnd.onkey.translationset+json": { "schema": { "$ref": "#/components/schemas/TranslationSetSchema" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/BackgroundTasks/Summary": { "get": { "tags": [ "My Identity" ], "summary": "Get a summary of my Background Task resources for the last 24 hours.", "description": "", "operationId": "GetMyBackgroundTasksSummary", "parameters": [ { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMyBackgroundTasksSummaryResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/Options/AMPC": { "get": { "tags": [ "My Identity" ], "summary": "Get a My Identity resource.", "description": "", "operationId": "GetMyDefaultAMPCUserOptions", "parameters": [ { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMyDefaultAMPCUserOptionsResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/Options/FIN": { "get": { "tags": [ "My Identity" ], "summary": "Get a My Identity resource.", "description": "", "operationId": "GetMyDefaultFINUserOptions", "parameters": [ { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMyDefaultFINUserOptionsResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/Options/MM": { "get": { "tags": [ "My Identity" ], "summary": "Get a My Identity resource.", "description": "", "operationId": "GetMyDefaultMMUserOptions", "parameters": [ { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMyDefaultMMUserOptionsResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/Options": { "get": { "tags": [ "My Identity" ], "summary": "Get a My Identity resource.", "description": "", "operationId": "GetMyDefaultUserOptions", "parameters": [ { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMyDefaultUserOptionsResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/Options/WM": { "get": { "tags": [ "My Identity" ], "summary": "Get a My Identity resource.", "description": "", "operationId": "GetMyDefaultWMUserOptions", "parameters": [ { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMyDefaultWMUserOptionsResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/OperationalRoles/{id}/Resources/{resourceName}/{resourceActionName}/{resourceActionCustomisationId}": { "get": { "tags": [ "My Identity" ], "summary": "Get my customised User Operational Role Resource resource for the Operational Role Resource resource", "description": "", "operationId": "GetMyOperationalRoleResourceCustomisationForOperationalRole", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Operational Role Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "name": "resourceName", "in": "path", "required": true, "description": "Name of Resource", "schema": { "type": "string", "nullable": true }, "x-position": 2 }, { "name": "resourceActionName", "in": "path", "required": true, "description": "Name of Resource Action", "schema": { "type": "string", "nullable": true }, "x-position": 3 }, { "name": "resourceActionCustomisationId", "in": "path", "required": true, "description": "API Resource Action Customisation Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 4 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMyOperationalRoleResourceCustomisationForOperationalRoleResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/OperationalRoles/{id}/Resources/{resourceName}/{resourceActionName}": { "get": { "tags": [ "My Identity" ], "summary": "Get my system defined User Operational Role Resource resource for the Operational Role Resource resource", "description": "", "operationId": "GetMyOperationalRoleResourceForOperationalRole", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Operational Role Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "name": "resourceName", "in": "path", "required": true, "description": "Name of Resource", "schema": { "type": "string", "nullable": true }, "x-position": 2 }, { "name": "resourceActionName", "in": "path", "required": true, "description": "Name of Resource Action", "schema": { "type": "string", "nullable": true }, "x-position": 3 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMyOperationalRoleResourceForOperationalRoleResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/OperationalRoles/Resources/{resourceName}/{resourceActionName}/{id}": { "get": { "tags": [ "My Identity" ], "summary": "Get my User Operational Role Resource resource.", "description": "", "operationId": "GetMyOperationalRoleResource", "parameters": [ { "name": "resourceName", "in": "path", "required": true, "description": "Name of Resource", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "resourceActionName", "in": "path", "required": true, "description": "Name of Resource Action", "schema": { "type": "string", "nullable": true }, "x-position": 2 }, { "name": "id", "in": "path", "required": true, "description": "User Operational Role Resource Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 3 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMyOperationalRoleResourceResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "My Identity" ], "summary": "Delete my User Operational Role Resource resource.", "description": "", "operationId": "DeleteMyOperationalRoleResource", "parameters": [ { "name": "resourceName", "in": "path", "required": true, "description": "Name of Resource", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "resourceActionName", "in": "path", "required": true, "description": "Name of Resource Action", "schema": { "type": "string", "nullable": true }, "x-position": 2 }, { "name": "id", "in": "path", "required": true, "description": "User Operational Role Resource Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 3 } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMyOperationalRoleResourceResourceActionRequest" } } }, "required": true, "x-position": 4 }, "responses": { "204": { "description": "Success response - My Identity was successfully deleted" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/OperationalRoles/Templates/{templateName}/{id}": { "get": { "tags": [ "My Identity" ], "summary": "Get my User Operational Role Template resource.", "description": "", "operationId": "GetMyOperationalRoleTemplate", "parameters": [ { "name": "templateName", "in": "path", "required": true, "description": "Name of Template", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "id", "in": "path", "required": true, "description": "User Operational Role Template Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 2 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMyOperationalRoleTemplateResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "My Identity" ], "summary": "Delete my User Operational Role Template resource.", "description": "", "operationId": "DeleteMyOperationalRoleTemplate", "parameters": [ { "name": "templateName", "in": "path", "required": true, "description": "Name of Template", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "id", "in": "path", "required": true, "description": "User Operational Role Template Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 2 } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMyOperationalRoleTemplateResourceActionRequest" } } }, "required": true, "x-position": 3 }, "responses": { "204": { "description": "Success response - My Identity was successfully deleted" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/TermsAndConditions/{id}": { "get": { "tags": [ "My Identity" ], "summary": "Get my User Terms And Conditions Version resource.", "description": "", "operationId": "GetMyTermsAndCondition", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "User Terms And Conditions Version Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMyTermsAndConditionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY": { "get": { "tags": [ "My Identity" ], "summary": "Get a summary of my User information.", "description": "", "operationId": "GetMyUserSummary", "parameters": [ { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMyUserSummaryResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "My Identity" ], "summary": "Set my user settings.", "description": "", "operationId": "UpdateMyUserSummary", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateMyUserSummaryResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/BackgroundTasks/{id}/Errors": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my Background Task Error resources for the Background Task.", "description": "", "operationId": "GetMyBackgroundTaskErrorList", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Background Task Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 } ], "responses": { "200": { "description": "Success response - body contains My Identity collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/GetMyBackgroundTaskErrorListResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/Approvals/Requisitions": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my My Identity resources.", "description": "", "operationId": "GetMyApprovalForRequisitionCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable My Identity collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMyApprovalForRequisitionCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/Approvals/Requisitions/Items": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my My Identity resources.", "description": "", "operationId": "GetMyApprovalForRequisitionItemCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable My Identity collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMyApprovalForRequisitionItemCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/BackgroundTasks": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my Background Task resources.", "description": "", "operationId": "GetMyBackgroundTaskCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable My Identity collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMyBackgroundTaskCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/BackgroundTasks/{id}/Steps": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of Background Task Step resources for my Background Task resource.", "description": "", "operationId": "GetMyBackgroundTaskStepForBackgroundTaskCollection", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Background Task Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable My Identity collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMyBackgroundTaskStepForBackgroundTaskCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/Languages": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my Languages.", "description": "", "operationId": "GetMyLanguageCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable My Identity collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMyLanguageCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/OperationalRoles": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my User Operational Role resources.", "description": "", "operationId": "GetMyOperationalRoleCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable My Identity collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMyOperationalRoleCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/OperationalRoles/Resources": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my User Operational Role Resource resources.", "description": "", "operationId": "GetMyOperationalRoleResourceCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable My Identity collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMyOperationalRoleResourceCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/OperationalRoles/Templates": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my User Operational Role Template resources.", "description": "", "operationId": "GetMyOperationalRoleTemplateCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable My Identity collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMyOperationalRoleTemplateCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/ScheduledBackgroundTasks": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my Scheduled Background Task resources.", "description": "", "operationId": "GetMyScheduledBackgroundTaskCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable My Identity collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMyScheduledBackgroundTaskCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/TermsAndConditions": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my User Terms And Conditions Version resources.", "description": "", "operationId": "GetMyTermsAndConditionCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable My Identity collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMyTermsAndConditionCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/TermsAndConditions/Pending": { "get": { "tags": [ "My Identity" ], "summary": "Get a collection of my User Terms And Conditions Version resources.", "description": "", "operationId": "GetMyTermsAndConditionPendingCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable My Identity collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMyTermsAndConditionPendingCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/BackgroundTasks/{id}": { "delete": { "tags": [ "My Identity" ], "summary": "Delete the work registered for my Background Task resource.", "description": "", "operationId": "DeleteMyBackgroundTask", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Background Task Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMyBackgroundTaskResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - My Identity was successfully deleted" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/ScheduledBackgroundTasks/{id}": { "delete": { "tags": [ "My Identity" ], "summary": "Delete the work registered for my Scheduled Background Task resource.", "description": "", "operationId": "DeleteMyScheduledBackgroundTask", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Scheduled Background Task Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMyScheduledBackgroundTaskResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - My Identity was successfully deleted" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/BackgroundTasks/Batch": { "delete": { "tags": [ "My Identity" ], "summary": "Delete the work registered for the collection of my Background Task resources.", "description": "", "operationId": "BatchDeleteMyBackgroundTask", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMyBackgroundTaskResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - My Identity batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/ScheduledBackgroundTasks/Batch": { "delete": { "tags": [ "My Identity" ], "summary": "Delete the work registered for the collection of my Scheduled Background Task resources.", "description": "", "operationId": "BatchDeleteMyScheduledBackgroundTask", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMyScheduledBackgroundTaskResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - My Identity batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/TermsAndConditions/{id}/Accept": { "post": { "tags": [ "My Identity" ], "summary": "Accept my User Terms And Conditions Version.", "description": "", "operationId": "AcceptMyTermsAndCondition", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "User Terms And Conditions Version Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 } ], "responses": { "204": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/AcceptMyTermsAndConditionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/OperationalRoles/{roleId}/Resources/{resourceId}": { "post": { "tags": [ "My Identity" ], "summary": "Add resource action to my User Operational Role.", "description": "", "operationId": "AddResourceActionToUserOperationalRole", "parameters": [ { "name": "roleId", "in": "path", "required": true, "description": "User Operational Role Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "name": "resourceId", "in": "path", "required": true, "description": "API Resource Action Customisation Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 2 } ], "responses": { "204": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/AddResourceActionToUserOperationalRoleResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/OperationalRoles/{roleId}/Templates/{templateId}": { "post": { "tags": [ "My Identity" ], "summary": "Add template to my User Operational Role.", "description": "", "operationId": "AddTemplateToUserOperationalRole", "parameters": [ { "name": "roleId", "in": "path", "required": true, "description": "User Operational Role Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "name": "templateId", "in": "path", "required": true, "description": "Template Customisation Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 2 } ], "responses": { "204": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/AddTemplateToUserOperationalRoleResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/Approvals/Approve/{id}": { "patch": { "tags": [ "My Identity" ], "summary": "Approve My Approval.", "description": "", "operationId": "ApproveMyApproval", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Approval Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ApproveApprovalResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/Approvals/Reject/Batch": { "patch": { "tags": [ "My Identity" ], "summary": "Batch Reject My Approval.", "description": "", "operationId": "BatchRejectMyApproval", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchRejectApprovalResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/BackgroundTasks/{id}/Cancel": { "post": { "tags": [ "My Identity" ], "summary": "Cancel the work registered for my Background Task resource.", "description": "", "operationId": "CancelMyBackgroundTask", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" } ], "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/Approvals/Reject/{id}": { "patch": { "tags": [ "My Identity" ], "summary": "Reject My Approval.", "description": "", "operationId": "RejectMyApproval", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Approval Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/RejectApprovalResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/OperationalRoles/{id}/Default": { "post": { "tags": [ "My Identity" ], "summary": "Set my default User Operational Role.", "description": "", "operationId": "SetMyDefaultOperationalRole", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "User Operational Role Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 } ], "responses": { "204": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/SetMyDefaultOperationalRoleResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/OperationalRoles/Resources/{resourceName}/{resourceActionName}/{id}/Default": { "post": { "tags": [ "My Identity" ], "summary": "Set my default User Operational Role Resource.", "description": "", "operationId": "SetMyDefaultOperationalRoleResource", "parameters": [ { "name": "resourceName", "in": "path", "required": true, "description": "Name of Resource", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "resourceActionName", "in": "path", "required": true, "description": "Name of Resource Action", "schema": { "type": "string", "nullable": true }, "x-position": 2 }, { "name": "id", "in": "path", "required": true, "description": "User Operational Role Resource Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 3 } ], "responses": { "204": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/SetMyDefaultOperationalRoleResourceResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/OperationalRoles/Templates/{templateName}/{id}/Default": { "post": { "tags": [ "My Identity" ], "summary": "Set my default User Operational Role Template.", "description": "", "operationId": "SetMyDefaultOperationalRoleTemplate", "parameters": [ { "name": "templateName", "in": "path", "required": true, "description": "Name of Template", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "id", "in": "path", "required": true, "description": "User Operational Role Template Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 2 } ], "responses": { "204": { "description": "Success response - body contains My Identity", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/SetMyDefaultOperationalRoleTemplateResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/Approvals/Approve/Batch": { "patch": { "tags": [ "My Identity" ], "summary": "Batch Approve My Approvals.", "description": "", "operationId": "BatchApproveMyApproval", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchApproveMyApprovalResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/IDENTITY/BackgroundTasks/Batch/{ids}/Cancel": { "post": { "tags": [ "My Identity" ], "summary": "Cancel the work registered for the collection of my Background Task resources.", "description": "", "operationId": "BatchCancelMyBackgroundTask", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of My Identity id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } } }, "components": { "schemas": { "OperationExecutionMode": { "type": "string", "description": "", "x-enumNames": [ "AllOrNone", "PerRecord" ], "enum": [ "AllOrNone", "PerRecord" ] }, "SeverityType": { "type": "string", "description": "", "nullable": false, "x-enumNames": [ "Error", "Warning", "Information" ], "enum": [ "error", "warning", "information" ] }, "NotificationItemSchema": { "title": "NotificationItemSchema", "type": "object", "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "description": "Unique code for message", "nullable": false }, "message": { "title": "message", "type": "string", "nullable": false }, "objectId": { "title": "objectId", "type": "string", "description": "Optional id of record to which the message applies", "nullable": true }, "objectType": { "title": "objectType", "type": "string", "format": "enum", "nullable": true, "x-formatSpecifier": "EntityType" }, "properties": { "title": "properties", "type": "array", "description": "Collection of properties referenced by the message using property path syntax", "nullable": true, "example": [ "Asset->Code" ], "items": { "type": "string" } }, "severity": { "$ref": "#/components/schemas/SeverityType" }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Optional provided unique external record identifier to echo back with message", "nullable": true } } }, "NotificationSchema": { "title": "NotificationSchema", "type": "object", "additionalProperties": false, "properties": { "messages": { "title": "messages", "type": "array", "description": "Collection of messages", "nullable": false, "items": { "$ref": "#/components/schemas/NotificationItemSchema" } } } }, "TranslationSetSchema": { "type": "object", "additionalProperties": false, "required": [ "items" ], "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "langId": { "type": "integer", "format": "int64", "nullable": true }, "lang": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationSchema" } } } }, "TranslationSchema": { "type": "object", "additionalProperties": false, "required": [ "name", "value", "source" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "source": { "$ref": "#/components/schemas/TranslationSource" } } }, "TranslationSource": { "type": "string", "description": "", "x-enumNames": [ "System", "User" ], "enum": [ "System", "User" ] }, "EntityPermissionViolationSchema": { "type": "object", "additionalProperties": false, "required": [ "permissionTreeId" ], "properties": { "permissionId": { "type": "integer", "format": "int64" }, "permissionTreeId": { "type": "integer", "format": "int64", "nullable": true }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "EntityPhraseTranslationSchema": { "type": "object", "additionalProperties": false, "required": [ "translation" ], "properties": { "phrase": { "type": "string" }, "translation": { "type": "string", "nullable": true }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "Link": { "type": "object", "additionalProperties": false, "required": [ "href", "method" ], "properties": { "doc": { "type": "string", "description": "Documentation endpoint that describes the link", "nullable": true }, "href": { "type": "string", "description": "Endpoint to invoke link", "minLength": 1 }, "mapping": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "method": { "type": "string", "description": "HTTP method used for link", "minLength": 1 }, "module": { "type": "string", "description": "Module used by link", "nullable": true }, "rel": { "type": "string", "nullable": true }, "resource": { "type": "string", "description": "Resource used by link", "nullable": true }, "resourceAction": { "type": "string", "description": "Resource Action used by link", "nullable": true }, "title": { "type": "string", "description": "Title", "nullable": true }, "type": { "description": "Type of link", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ResourceLinkType" } ] } } }, "LinkMapping": { "type": "object", "additionalProperties": false, "required": [ "source" ], "properties": { "source": { "type": "string" }, "target": { "type": "string", "nullable": true } } }, "ResourceLinkType": { "type": "string", "description": "", "x-enumNames": [ "Association", "PrimaryAction", "CustomAction", "Collection", "Detail", "Lookup", "Documentation", "Navigation", "Specification" ], "enum": [ "association", "primaryAction", "customAction", "collection", "detail", "lookup", "documentation", "navigation", "specification" ] }, "GetMyBackgroundTasksSummaryResourceActionResponse": { "title": "GetMyBackgroundTasksSummaryResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMyBackgroundTasksSummaryResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "abortedCount": { "title": "abortedCount", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "BackgroundTasksSummary->AbortedCount" }, "cancelledCount": { "title": "cancelledCount", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "BackgroundTasksSummary->CancelledCount" }, "completedCount": { "title": "completedCount", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "BackgroundTasksSummary->CompletedCount" }, "notStartedCount": { "title": "notStartedCount", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "BackgroundTasksSummary->NotStartedCount" }, "runningCount": { "title": "runningCount", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "BackgroundTasksSummary->RunningCount" }, "totalCount": { "title": "totalCount", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "BackgroundTasksSummary->TotalCount" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMyDefaultAMPCUserOptionsResourceActionResponse": { "title": "GetMyDefaultAMPCUserOptionsResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMyDefaultAMPCUserOptionsResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "taskResponsibleSectionId": { "title": "taskResponsibleSectionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultAMPCUserOptionsValues->TaskResponsibleSectionId" }, "taskResponsibleStaffId": { "title": "taskResponsibleStaffId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultAMPCUserOptionsValues->TaskResponsibleStaffId" }, "taskResponsibleTradeId": { "title": "taskResponsibleTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultAMPCUserOptionsValues->TaskResponsibleTradeId" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMyDefaultFINUserOptionsResourceActionResponse": { "title": "GetMyDefaultFINUserOptionsResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMyDefaultFINUserOptionsResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "enableCosting": { "title": "enableCosting", "type": "boolean", "nullable": true, "x-propertyPath": "GetMyDefaultFINUserOptionsValues->EnableCosting" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMyDefaultMMUserOptionsResourceActionResponse": { "title": "GetMyDefaultMMUserOptionsResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMyDefaultMMUserOptionsResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "enableRequisitions": { "title": "enableRequisitions", "type": "boolean", "nullable": true, "x-propertyPath": "GetMyDefaultMMUserOptionsValues->EnableRequisitions" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMyDefaultUserOptionsResourceActionResponse": { "title": "GetMyDefaultUserOptionsResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMyDefaultUserOptionsResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "enableCosting": { "title": "enableCosting", "type": "boolean", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->EnableCosting" }, "enableRequisitions": { "title": "enableRequisitions", "type": "boolean", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->EnableRequisitions" }, "applyWorkOrderStatusRules": { "title": "applyWorkOrderStatusRules", "type": "boolean", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->ApplyWorkOrderStatusRules" }, "defaultWorkOrderTaskResourceCostElementId": { "title": "defaultWorkOrderTaskResourceCostElementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->DefaultWorkOrderTaskResourceCostElementId" }, "taskResponsibleSectionId": { "title": "taskResponsibleSectionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->TaskResponsibleSectionId" }, "taskResponsibleStaffId": { "title": "taskResponsibleStaffId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->TaskResponsibleStaffId" }, "taskResponsibleTradeId": { "title": "taskResponsibleTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->TaskResponsibleTradeId" }, "workClassification1Id": { "title": "workClassification1Id", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkClassification1Id" }, "workClassification2Id": { "title": "workClassification2Id", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkClassification2Id" }, "workClassification3Id": { "title": "workClassification3Id", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkClassification3Id" }, "workClassification4Id": { "title": "workClassification4Id", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkClassification4Id" }, "workClassification5Id": { "title": "workClassification5Id", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkClassification5Id" }, "workOrderCanBeQueued": { "title": "workOrderCanBeQueued", "type": "boolean", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkOrderCanBeQueued" }, "workOrderImportanceId": { "title": "workOrderImportanceId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkOrderImportanceId" }, "workOrderLimit": { "title": "workOrderLimit", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkOrderLimit" }, "workOrderResponsibleSectionId": { "title": "workOrderResponsibleSectionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkOrderResponsibleSectionId" }, "workOrderResponsibleStaffId": { "title": "workOrderResponsibleStaffId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkOrderResponsibleStaffId" }, "workOrderResponsibleTradeId": { "title": "workOrderResponsibleTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkOrderResponsibleTradeId" }, "workOrderTypeOfWorkForConditionMonitoringId": { "title": "workOrderTypeOfWorkForConditionMonitoringId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkOrderTypeOfWorkForConditionMonitoringId" }, "workOrderTypeOfWorkId": { "title": "workOrderTypeOfWorkId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultUserOptionsValues->WorkOrderTypeOfWorkId" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMyDefaultWMUserOptionsResourceActionResponse": { "title": "GetMyDefaultWMUserOptionsResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMyDefaultWMUserOptionsResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "applyWorkOrderStatusRules": { "title": "applyWorkOrderStatusRules", "type": "boolean", "nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->ApplyWorkOrderStatusRules" }, "defaultWorkOrderTaskResourceCostElementId": { "title": "defaultWorkOrderTaskResourceCostElementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->DefaultWorkOrderTaskResourceCostElementId" }, "workClassification1Id": { "title": "workClassification1Id", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkClassification1Id" }, "workClassification2Id": { "title": "workClassification2Id", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkClassification2Id" }, "workClassification3Id": { "title": "workClassification3Id", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkClassification3Id" }, "workClassification4Id": { "title": "workClassification4Id", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkClassification4Id" }, "workClassification5Id": { "title": "workClassification5Id", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkClassification5Id" }, "workOrderCanBeQueued": { "title": "workOrderCanBeQueued", "type": "boolean", "nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkOrderCanBeQueued" }, "workOrderImportanceId": { "title": "workOrderImportanceId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkOrderImportanceId" }, "workOrderLimit": { "title": "workOrderLimit", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkOrderLimit" }, "workOrderResponsibleSectionId": { "title": "workOrderResponsibleSectionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkOrderResponsibleSectionId" }, "workOrderResponsibleStaffId": { "title": "workOrderResponsibleStaffId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkOrderResponsibleStaffId" }, "workOrderResponsibleTradeId": { "title": "workOrderResponsibleTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkOrderResponsibleTradeId" }, "workOrderTypeOfWorkForConditionMonitoringId": { "title": "workOrderTypeOfWorkForConditionMonitoringId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkOrderTypeOfWorkForConditionMonitoringId" }, "workOrderTypeOfWorkId": { "title": "workOrderTypeOfWorkId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "GetMyDefaultWMUserOptionsValues->WorkOrderTypeOfWorkId" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMyOperationalRoleResourceCustomisationForOperationalRoleResourceActionResponse": { "title": "GetMyOperationalRoleResourceCustomisationForOperationalRoleResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMyOperationalRoleResourceCustomisationForOperationalRoleResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMyOperationalRoleResourceForOperationalRoleResourceActionResponse": { "title": "GetMyOperationalRoleResourceForOperationalRoleResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMyOperationalRoleResourceForOperationalRoleResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMyOperationalRoleResourceResourceActionResponse": { "title": "GetMyOperationalRoleResourceResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMyOperationalRoleResourceResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMyOperationalRoleTemplateResourceActionResponse": { "title": "GetMyOperationalRoleTemplateResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMyOperationalRoleTemplateResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMyTermsAndConditionResourceActionResponse": { "title": "GetMyTermsAndConditionResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMyTermsAndConditionResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserTermsAndConditionVersion->CreatedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->PermissionTree_Description" }, "accepted": { "title": "accepted", "type": "boolean", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Accepted" }, "acceptedDate": { "title": "acceptedDate", "type": "string", "format": "date", "nullable": true, "example": "2005-04-20", "x-propertyPath": "UserTermsAndConditionVersion->AcceptedDate" }, "deprecated": { "title": "deprecated", "type": "boolean", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Deprecated" }, "termsAndConditionVersionId": { "title": "termsAndConditionVersionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Id" }, "termsAndConditionVersionContentVersion": { "title": "termsAndConditionVersionContentVersion", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_ContentVersion" }, "termsAndConditionVersionLanguageId": { "title": "termsAndConditionVersionLanguageId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Id" }, "termsAndConditionVersionLanguageCode": { "title": "termsAndConditionVersionLanguageCode", "type": "string", "nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Code" }, "termsAndConditionVersionTermsAndConditionId": { "title": "termsAndConditionVersionTermsAndConditionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Id" }, "termsAndConditionVersionTermsAndConditionName": { "title": "termsAndConditionVersionTermsAndConditionName", "type": "string", "nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Name" }, "termsAndConditionVersionContent": { "title": "termsAndConditionVersionContent", "type": "string", "nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Content" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->User_Id" }, "userCode": { "title": "userCode", "type": "string", "nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->User_Code" }, "userFullName": { "title": "userFullName", "type": "string", "nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->User_FullName" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMyUserSummaryResourceActionResponse": { "title": "GetMyUserSummaryResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMyUserSummaryResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "allowWorkOrdersWithoutAssets": { "title": "allowWorkOrdersWithoutAssets", "type": "boolean", "nullable": true, "x-propertyPath": "MyUserSummary->AllowWorkOrdersWithoutAssets" }, "applyWorkOrderStatusRules": { "title": "applyWorkOrderStatusRules", "type": "boolean", "nullable": true, "x-propertyPath": "MyUserSummary->ApplyWorkOrderStatusRules" }, "autoPopulateStartOnAndCompleteByDates": { "title": "autoPopulateStartOnAndCompleteByDates", "type": "boolean", "nullable": true, "x-propertyPath": "MyUserSummary->AutoPopulateStartOnAndCompleteByDates" }, "code": { "title": "code", "type": "string", "nullable": true, "x-propertyPath": "MyUserSummary->Code" }, "contentTranslate": { "title": "contentTranslate", "type": "boolean", "nullable": true, "x-propertyPath": "MyUserSummary->ContentTranslate" }, "dateFormat": { "title": "dateFormat", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->DateFormat", "x-formatSpecifier": "SystemDateFormat" }, "dateSeparator": { "title": "dateSeparator", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->DateSeparator", "x-formatSpecifier": "SystemDateSeparator" }, "defaultAssetDevelopmentStatusApplyToChildren": { "title": "defaultAssetDevelopmentStatusApplyToChildren", "type": "boolean", "nullable": true, "x-propertyPath": "MyUserSummary->DefaultAssetDevelopmentStatusApplyToChildren" }, "defaultAssetTypeDevelopmentStatusApplyToChildren": { "title": "defaultAssetTypeDevelopmentStatusApplyToChildren", "type": "boolean", "nullable": true, "x-propertyPath": "MyUserSummary->DefaultAssetTypeDevelopmentStatusApplyToChildren" }, "defaultAssetTypeDevelopmentStatusApplyToDescendants": { "title": "defaultAssetTypeDevelopmentStatusApplyToDescendants", "type": "boolean", "nullable": true, "x-propertyPath": "MyUserSummary->DefaultAssetTypeDevelopmentStatusApplyToDescendants" }, "defaultCreateSaveAction": { "title": "defaultCreateSaveAction", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->DefaultCreateSaveAction", "x-formatSpecifier": "DefaultCreateSaveAction" }, "defaultIsActiveApplyToChildren": { "title": "defaultIsActiveApplyToChildren", "type": "boolean", "nullable": true, "x-propertyPath": "MyUserSummary->DefaultIsActiveApplyToChildren" }, "defaultIsActiveApplyToDescendants": { "title": "defaultIsActiveApplyToDescendants", "type": "boolean", "nullable": true, "x-propertyPath": "MyUserSummary->DefaultIsActiveApplyToDescendants" }, "defaultIsActiveApplyToDetails": { "title": "defaultIsActiveApplyToDetails", "type": "boolean", "nullable": true, "x-propertyPath": "MyUserSummary->DefaultIsActiveApplyToDetails" }, "defaultLanguageId": { "title": "defaultLanguageId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MyUserSummary->DefaultLanguage_Id" }, "defaultLanguageCode": { "title": "defaultLanguageCode", "type": "string", "nullable": true, "x-propertyPath": "MyUserSummary->DefaultLanguage_Code" }, "defaultLanguageDescription": { "title": "defaultLanguageDescription", "type": "string", "nullable": true, "x-propertyPath": "MyUserSummary->DefaultLanguage_Description" }, "defaultSyncDevelopmentStatusApplyToChildren": { "title": "defaultSyncDevelopmentStatusApplyToChildren", "type": "boolean", "nullable": true, "x-propertyPath": "MyUserSummary->DefaultSyncDevelopmentStatusApplyToChildren" }, "defaultTradeLookup": { "title": "defaultTradeLookup", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->DefaultTradeLookup", "x-formatSpecifier": "DefaultTradeLookup" }, "defaultUpdateSaveAction": { "title": "defaultUpdateSaveAction", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->DefaultUpdateSaveAction", "x-formatSpecifier": "DefaultUpdateSaveAction" }, "enforceAssetWarranty": { "title": "enforceAssetWarranty", "type": "boolean", "nullable": true, "x-propertyPath": "MyUserSummary->EnforceAssetWarranty" }, "fullName": { "title": "fullName", "type": "string", "nullable": true, "x-propertyPath": "MyUserSummary->FullName" }, "isReportUser": { "title": "isReportUser", "type": "boolean", "nullable": true, "x-propertyPath": "MyUserSummary->IsReportUser" }, "mergeAllowedWorkOrderStatus": { "title": "mergeAllowedWorkOrderStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->MergeAllowedWorkOrderStatus", "x-formatSpecifier": "SystemOptionMergeAllowedWorkOrderStatus" }, "mergeTypeOfWorkOption": { "title": "mergeTypeOfWorkOption", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->MergeTypeOfWorkOption", "x-formatSpecifier": "SystemOptionMergeTypeOfWorkOption" }, "operationalRoleRule": { "title": "operationalRoleRule", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->OperationalRoleRule", "x-formatSpecifier": "OperationalRoleRuleType" }, "primaryEmail": { "title": "primaryEmail", "type": "string", "format": "email", "nullable": true, "x-propertyPath": "MyUserSummary->PrimaryEmail" }, "reportServerReportLanguage": { "title": "reportServerReportLanguage", "type": "string", "nullable": true, "x-propertyPath": "MyUserSummary->ReportServerReportLanguage" }, "reportServerUILanguage": { "title": "reportServerUILanguage", "type": "string", "nullable": true, "x-propertyPath": "MyUserSummary->ReportServerUILanguage" }, "reportUserName": { "title": "reportUserName", "type": "string", "nullable": true, "x-propertyPath": "MyUserSummary->ReportUserName" }, "reportUserOrganizations": { "title": "reportUserOrganizations", "type": "array", "format": "array", "nullable": true, "items": { "type": "string" }, "x-propertyPath": "MyUserSummary->ReportUserOrganizations", "x-formatSpecifier": "String" }, "reportUserRoles": { "title": "reportUserRoles", "type": "array", "format": "array", "nullable": true, "items": { "type": "string" }, "x-propertyPath": "MyUserSummary->ReportUserRoles", "x-formatSpecifier": "String" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MyUserSummary->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "nullable": true, "x-propertyPath": "MyUserSummary->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "nullable": true, "x-propertyPath": "MyUserSummary->Site_Description" }, "systemDateFormat": { "title": "systemDateFormat", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->SystemDateFormat", "x-formatSpecifier": "SystemDateFormat" }, "systemDateSeparator": { "title": "systemDateSeparator", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->SystemDateSeparator", "x-formatSpecifier": "SystemDateSeparator" }, "systemDefaultCreateSaveAction": { "title": "systemDefaultCreateSaveAction", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->SystemDefaultCreateSaveAction", "x-formatSpecifier": "DefaultCreateSaveAction" }, "systemDefaultLanguageId": { "title": "systemDefaultLanguageId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MyUserSummary->SystemDefaultLanguage_Id" }, "systemDefaultLanguageCode": { "title": "systemDefaultLanguageCode", "type": "string", "nullable": true, "x-propertyPath": "MyUserSummary->SystemDefaultLanguage_Code" }, "systemDefaultLanguageDescription": { "title": "systemDefaultLanguageDescription", "type": "string", "nullable": true, "x-propertyPath": "MyUserSummary->SystemDefaultLanguage_Description" }, "systemDefaultUpdateSaveAction": { "title": "systemDefaultUpdateSaveAction", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->SystemDefaultUpdateSaveAction", "x-formatSpecifier": "DefaultUpdateSaveAction" }, "systemTimeFormat": { "title": "systemTimeFormat", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->SystemTimeFormat", "x-formatSpecifier": "SystemTimeFormat" }, "timeFormat": { "title": "timeFormat", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->TimeFormat", "x-formatSpecifier": "SystemTimeFormat" }, "workPerformedEditableBaseStatus": { "title": "workPerformedEditableBaseStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->WorkPerformedEditableBaseStatus", "x-formatSpecifier": "WorkPerformedEditableBaseStatus" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMyBackgroundTaskErrorListResourceActionResponse": { "title": "GetMyBackgroundTaskErrorListResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "BackgroundTaskError->Id" }, "code": { "title": "code", "type": "string", "nullable": true, "x-propertyPath": "BackgroundTaskError->Code" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskError->CompletedOn" }, "objectType": { "title": "objectType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "BackgroundTaskError->ObjectType", "x-formatSpecifier": "EntityType" }, "message": { "title": "message", "type": "string", "format": "memo", "nullable": true, "x-propertyPath": "BackgroundTaskError->Message" }, "type": { "title": "type", "type": "string", "nullable": true, "x-propertyPath": "BackgroundTaskError->Type" }, "objectId": { "title": "objectId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "BackgroundTaskError->ObjectId" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "BackgroundTaskError->SequenceNumber" }, "severity": { "title": "severity", "type": "string", "nullable": true, "x-propertyPath": "BackgroundTaskError->Severity" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskError->StartedOn" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "BackgroundTaskError->CreatedByUserId" } } }, "GetMyBackgroundTaskErrorListResourceAction": { "title": "GetMyBackgroundTaskErrorListResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of My Identity entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of My Identity entities", "items": { "$ref": "#/components/schemas/GetMyBackgroundTaskErrorListResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMyApprovalForRequisitionCollectionResourceActionResponse": { "title": "GetMyApprovalForRequisitionCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMyApprovalForRequisitionCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMyApprovalForRequisitionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Requisition->Code" }, "workOrderCode": { "title": "workOrderCode", "type": "string", "nullable": false, "x-propertyPath": "Requisition->WorkOrder_Code" }, "workOrderDescription": { "title": "workOrderDescription", "type": "string", "nullable": false, "x-propertyPath": "Requisition->WorkOrder_Description" }, "totalItemCost": { "title": "totalItemCost", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "Requisition->TotalItemCost" }, "idApprovalEntityIdEntityId": { "title": "idApprovalEntityIdEntityId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_EntityId" }, "idApprovalEntityIdSequenceNumber": { "title": "idApprovalEntityIdSequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_SequenceNumber" }, "idApprovalEntityIdExpressionId": { "title": "idApprovalEntityIdExpressionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Expression_Id" }, "idApprovalEntityIdExpressionApprovalWorkflowId": { "title": "idApprovalEntityIdExpressionApprovalWorkflowId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Expression_ApprovalWorkflow_Id" }, "idApprovalEntityIdExpressionApprovalWorkflowCode": { "title": "idApprovalEntityIdExpressionApprovalWorkflowCode", "type": "string", "nullable": false, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Expression_ApprovalWorkflow_Code" }, "idApprovalEntityIdExpressionDescription": { "title": "idApprovalEntityIdExpressionDescription", "type": "string", "nullable": false, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Expression_Description" }, "idApprovalEntityIdId": { "title": "idApprovalEntityIdId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Id" }, "idApprovalEntityIdIsLocked": { "title": "idApprovalEntityIdIsLocked", "type": "boolean", "nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_IsLocked" }, "idApprovalEntityIdEntityType": { "title": "idApprovalEntityIdEntityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Requisition->*Id.Approval.EntityId_EntityType", "x-formatSpecifier": "EntityType" }, "idApprovalEntityIdRemark": { "title": "idApprovalEntityIdRemark", "type": "string", "nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Remark" }, "idApprovalEntityIdRoleId": { "title": "idApprovalEntityIdRoleId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Role_Id" }, "idApprovalEntityIdRoleCode": { "title": "idApprovalEntityIdRoleCode", "type": "string", "nullable": false, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Role_Code" }, "idApprovalEntityIdRoleDescription": { "title": "idApprovalEntityIdRoleDescription", "type": "string", "nullable": false, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Role_Description" }, "idApprovalEntityIdStatus": { "title": "idApprovalEntityIdStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "Requisition->*Id.Approval.EntityId_Status", "x-formatSpecifier": "ApprovalStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMyApprovalForRequisitionItemCollectionResourceActionResponse": { "title": "GetMyApprovalForRequisitionItemCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMyApprovalForRequisitionItemCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMyApprovalForRequisitionItemCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->Code" }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->Description" }, "requisitionId": { "title": "requisitionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->Requisition_Id" }, "requisitionCode": { "title": "requisitionCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->Requisition_Code" }, "requisitionWorkOrderCode": { "title": "requisitionWorkOrderCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->Requisition_WorkOrder_Code" }, "requisitionWorkOrderDescription": { "title": "requisitionWorkOrderDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->Requisition_WorkOrder_Description" }, "totalCostInSiteCurrency": { "title": "totalCostInSiteCurrency", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "RequisitionItem->TotalCostInSiteCurrency" }, "workOrderTaskSpareSpareType": { "title": "workOrderTaskSpareSpareType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionItem->WorkOrderTaskSpare_SpareType", "x-formatSpecifier": "WorkOrderTaskSpareType" }, "idApprovalEntityIdEntityId": { "title": "idApprovalEntityIdEntityId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_EntityId" }, "idApprovalEntityIdSequenceNumber": { "title": "idApprovalEntityIdSequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_SequenceNumber" }, "idApprovalEntityIdExpressionId": { "title": "idApprovalEntityIdExpressionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Expression_Id" }, "idApprovalEntityIdExpressionApprovalWorkflowId": { "title": "idApprovalEntityIdExpressionApprovalWorkflowId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Expression_ApprovalWorkflow_Id" }, "idApprovalEntityIdExpressionApprovalWorkflowCode": { "title": "idApprovalEntityIdExpressionApprovalWorkflowCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Expression_ApprovalWorkflow_Code" }, "idApprovalEntityIdExpressionDescription": { "title": "idApprovalEntityIdExpressionDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Expression_Description" }, "idApprovalEntityIdId": { "title": "idApprovalEntityIdId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Id" }, "idApprovalEntityIdIsLocked": { "title": "idApprovalEntityIdIsLocked", "type": "boolean", "nullable": true, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_IsLocked" }, "idApprovalEntityIdEntityType": { "title": "idApprovalEntityIdEntityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_EntityType", "x-formatSpecifier": "EntityType" }, "idApprovalEntityIdRemark": { "title": "idApprovalEntityIdRemark", "type": "string", "nullable": true, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Remark" }, "idApprovalEntityIdRoleCode": { "title": "idApprovalEntityIdRoleCode", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Role_Code" }, "idApprovalEntityIdRoleDescription": { "title": "idApprovalEntityIdRoleDescription", "type": "string", "nullable": false, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Role_Description" }, "idApprovalEntityIdStatus": { "title": "idApprovalEntityIdStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "RequisitionItem->*Id.Approval.EntityId_Status", "x-formatSpecifier": "ApprovalStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMyBackgroundTaskCollectionResourceActionResponse": { "title": "GetMyBackgroundTaskCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMyBackgroundTaskCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMyBackgroundTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "nullable": true, "x-propertyPath": "BackgroundTask->Name" }, "type": { "title": "type", "type": "string", "nullable": true, "x-propertyPath": "BackgroundTask->Type" }, "origin": { "title": "origin", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "BackgroundTask->Origin", "x-formatSpecifier": "BackgroundTaskOrigin" }, "priority": { "title": "priority", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "BackgroundTask->Priority" }, "status": { "title": "status", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "BackgroundTask->Status", "x-formatSpecifier": "BackgroundTaskStatus" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->ModifiedOn" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->StartedOn" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->CompletedOn" }, "totalSteps": { "title": "totalSteps", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "BackgroundTask->TotalSteps" }, "failedSteps": { "title": "failedSteps", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "BackgroundTask->FailedSteps" }, "completedSteps": { "title": "completedSteps", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "BackgroundTask->CompletedSteps" }, "remainingSteps": { "title": "remainingSteps", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "BackgroundTask->RemainingSteps" }, "skippedSteps": { "title": "skippedSteps", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "BackgroundTask->SkippedSteps" }, "elapsedTime": { "title": "elapsedTime", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "BackgroundTask->ElapsedTime" }, "averageTimePerStep": { "title": "averageTimePerStep", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "BackgroundTask->AverageTimePerStep" }, "estimatedTimeRemaining": { "title": "estimatedTimeRemaining", "type": "string", "format": "duration", "nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "BackgroundTask->EstimatedTimeRemaining" }, "estimatedCompletion": { "title": "estimatedCompletion", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTask->EstimatedCompletion" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMyBackgroundTaskStepForBackgroundTaskCollectionResourceActionResponse": { "title": "GetMyBackgroundTaskStepForBackgroundTaskCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMyBackgroundTaskStepForBackgroundTaskCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMyBackgroundTaskStepForBackgroundTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "nullable": true, "x-propertyPath": "BackgroundTaskStep->Name" }, "backgroundTaskId": { "title": "backgroundTaskId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Id" }, "backgroundTaskName": { "title": "backgroundTaskName", "type": "string", "nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Name" }, "backgroundTaskType": { "title": "backgroundTaskType", "type": "string", "nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Type" }, "backgroundTaskStatus": { "title": "backgroundTaskStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Status", "x-formatSpecifier": "BackgroundTaskStatus" }, "backgroundTaskOrigin": { "title": "backgroundTaskOrigin", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "BackgroundTaskStep->BackgroundTask_Origin", "x-formatSpecifier": "BackgroundTaskOrigin" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->ModifiedOn" }, "startedOn": { "title": "startedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->StartedOn" }, "completedOn": { "title": "completedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "BackgroundTaskStep->CompletedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "BackgroundTaskStep->SequenceNumber" }, "response": { "title": "response", "nullable": true, "$ref": "#/components/schemas/NotificationSchema", "x-propertyPath": "BackgroundTaskStep->Response" }, "isValid": { "title": "isValid", "type": "boolean", "nullable": true, "x-propertyPath": "BackgroundTaskStep->IsValid" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMyLanguageCollectionResourceActionResponse": { "title": "GetMyLanguageCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMyLanguageCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMyLanguageCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Language->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Language->Description" }, "languageCode": { "title": "languageCode", "type": "string", "nullable": false, "x-propertyPath": "Language->LanguageCode" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Language->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "Language->IsActive" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMyOperationalRoleCollectionResourceActionResponse": { "title": "GetMyOperationalRoleCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMyOperationalRoleCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMyOperationalRoleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "operationalRoleId": { "title": "operationalRoleId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "UserOperationalRole->OperationalRole_Id" }, "operationalRoleCode": { "title": "operationalRoleCode", "type": "string", "nullable": false, "x-propertyPath": "UserOperationalRole->OperationalRole_Code" }, "operationalRoleDescription": { "title": "operationalRoleDescription", "type": "string", "nullable": false, "x-propertyPath": "UserOperationalRole->OperationalRole_Description" }, "isDefault": { "title": "isDefault", "type": "boolean", "nullable": true, "x-propertyPath": "UserOperationalRole->IsDefault" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "UserOperationalRole->SequenceNumber" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMyOperationalRoleResourceCollectionResourceActionResponse": { "title": "GetMyOperationalRoleResourceCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMyOperationalRoleResourceCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMyOperationalRoleResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "userOperationalRoleId": { "title": "userOperationalRoleId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_Id" }, "userOperationalRoleOperationalRoleId": { "title": "userOperationalRoleOperationalRoleId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_OperationalRole_Id" }, "userOperationalRoleOperationalRoleCode": { "title": "userOperationalRoleOperationalRoleCode", "type": "string", "nullable": false, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_OperationalRole_Code" }, "userOperationalRoleOperationalRoleDescription": { "title": "userOperationalRoleOperationalRoleDescription", "type": "string", "nullable": false, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_OperationalRole_Description" }, "userOperationalRoleUserId": { "title": "userOperationalRoleUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_User_Id" }, "userOperationalRoleUserFullName": { "title": "userOperationalRoleUserFullName", "type": "string", "nullable": false, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_User_FullName" }, "resourceActionCustomisationId": { "title": "resourceActionCustomisationId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "UserOperationalRoleResource->ResourceActionCustomisation_Id" }, "resourceActionCustomisationName": { "title": "resourceActionCustomisationName", "type": "string", "nullable": false, "x-propertyPath": "UserOperationalRoleResource->ResourceActionCustomisation_Name" }, "module": { "title": "module", "type": "string", "nullable": false, "x-propertyPath": "UserOperationalRoleResource->Module" }, "resource": { "title": "resource", "type": "string", "nullable": false, "x-propertyPath": "UserOperationalRoleResource->Resource" }, "resourceAction": { "title": "resourceAction", "type": "string", "nullable": false, "x-propertyPath": "UserOperationalRoleResource->ResourceAction" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "UserOperationalRoleResource->SequenceNumber" }, "isDefault": { "title": "isDefault", "type": "boolean", "nullable": false, "x-propertyPath": "UserOperationalRoleResource->IsDefault" }, "isUserDefault": { "title": "isUserDefault", "type": "boolean", "nullable": false, "x-propertyPath": "UserOperationalRoleResource->IsUserDefault" }, "isInherited": { "title": "isInherited", "type": "boolean", "nullable": true, "x-propertyPath": "UserOperationalRoleResource->IsInherited" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMyOperationalRoleTemplateCollectionResourceActionResponse": { "title": "GetMyOperationalRoleTemplateCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMyOperationalRoleTemplateCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMyOperationalRoleTemplateCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "userOperationalRoleId": { "title": "userOperationalRoleId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_Id" }, "userOperationalRoleOperationalRoleId": { "title": "userOperationalRoleOperationalRoleId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Id" }, "userOperationalRoleOperationalRoleCode": { "title": "userOperationalRoleOperationalRoleCode", "type": "string", "nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Code" }, "userOperationalRoleOperationalRoleDescription": { "title": "userOperationalRoleOperationalRoleDescription", "type": "string", "nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Description" }, "templateCustomisationId": { "title": "templateCustomisationId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_Id" }, "templateCustomisationName": { "title": "templateCustomisationName", "type": "string", "nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_Name" }, "templateCustomisationDescription": { "title": "templateCustomisationDescription", "type": "string", "nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_Description" }, "templateCustomisationRestrictionLevel": { "title": "templateCustomisationRestrictionLevel", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "module": { "title": "module", "type": "string", "nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Module" }, "template": { "title": "template", "type": "string", "nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Template" }, "type": { "title": "type", "type": "string", "nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Type" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->SequenceNumber" }, "isDefault": { "title": "isDefault", "type": "boolean", "nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->IsDefault" }, "isUserDefault": { "title": "isUserDefault", "type": "boolean", "nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->IsUserDefault" }, "isInherited": { "title": "isInherited", "type": "boolean", "nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->IsInherited" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMyScheduledBackgroundTaskCollectionResourceActionResponse": { "title": "GetMyScheduledBackgroundTaskCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMyScheduledBackgroundTaskCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMyScheduledBackgroundTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "nullable": false, "x-propertyPath": "ScheduledBackgroundTask->Name" }, "type": { "title": "type", "type": "string", "nullable": true, "x-propertyPath": "ScheduledBackgroundTask->Type" }, "jobId": { "title": "jobId", "type": "string", "format": "uuid", "nullable": false, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "ScheduledBackgroundTask->JobId" }, "schedule": { "title": "schedule", "type": "string", "nullable": true, "x-propertyPath": "ScheduledBackgroundTask->Schedule" }, "executionMode": { "title": "executionMode", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "ScheduledBackgroundTask->ExecutionMode", "x-formatSpecifier": "OperationExecutionMode" }, "startFrom": { "title": "startFrom", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledBackgroundTask->StartFrom" }, "requestType": { "title": "requestType", "type": "string", "nullable": false, "x-propertyPath": "ScheduledBackgroundTask->RequestType" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ScheduledBackgroundTask->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledBackgroundTask->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ScheduledBackgroundTask->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMyTermsAndConditionCollectionResourceActionResponse": { "title": "GetMyTermsAndConditionCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMyTermsAndConditionCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMyTermsAndConditionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "userCode": { "title": "userCode", "type": "string", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->User_Code" }, "termsAndConditionVersionTermsAndConditionCode": { "title": "termsAndConditionVersionTermsAndConditionCode", "type": "string", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Code" }, "termsAndConditionVersionTermsAndConditionName": { "title": "termsAndConditionVersionTermsAndConditionName", "type": "string", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Name" }, "termsAndConditionVersionLanguageCode": { "title": "termsAndConditionVersionLanguageCode", "type": "string", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Code" }, "termsAndConditionVersionPublished": { "title": "termsAndConditionVersionPublished", "type": "boolean", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Published" }, "termsAndConditionVersionContentVersion": { "title": "termsAndConditionVersionContentVersion", "type": "integer", "format": "int32", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_ContentVersion" }, "deprecated": { "title": "deprecated", "type": "boolean", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Deprecated" }, "accepted": { "title": "accepted", "type": "boolean", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Accepted" }, "acceptedDate": { "title": "acceptedDate", "type": "string", "format": "date", "nullable": true, "example": "2005-04-20", "x-propertyPath": "UserTermsAndConditionVersion->AcceptedDate" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMyTermsAndConditionPendingCollectionResourceActionResponse": { "title": "GetMyTermsAndConditionPendingCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMyTermsAndConditionPendingCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMyTermsAndConditionPendingCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "userCode": { "title": "userCode", "type": "string", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->User_Code" }, "termsAndConditionVersionTermsAndConditionCode": { "title": "termsAndConditionVersionTermsAndConditionCode", "type": "string", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Code" }, "termsAndConditionVersionTermsAndConditionName": { "title": "termsAndConditionVersionTermsAndConditionName", "type": "string", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Name" }, "termsAndConditionVersionTermsAndConditionCompulsory": { "title": "termsAndConditionVersionTermsAndConditionCompulsory", "type": "boolean", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Compulsory" }, "termsAndConditionVersionLanguageCode": { "title": "termsAndConditionVersionLanguageCode", "type": "string", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Code" }, "termsAndConditionVersionPublished": { "title": "termsAndConditionVersionPublished", "type": "boolean", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Published" }, "termsAndConditionVersionContentVersion": { "title": "termsAndConditionVersionContentVersion", "type": "integer", "format": "int32", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_ContentVersion" }, "deprecated": { "title": "deprecated", "type": "boolean", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Deprecated" }, "accepted": { "title": "accepted", "type": "boolean", "nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Accepted" }, "acceptedDate": { "title": "acceptedDate", "type": "string", "format": "date", "nullable": true, "example": "2005-04-20", "x-propertyPath": "UserTermsAndConditionVersion->AcceptedDate" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "DeleteMyBackgroundTaskResourceActionRequest": { "title": "DeleteMyBackgroundTaskResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "DeleteMyOperationalRoleResourceResourceActionRequest": { "title": "DeleteMyOperationalRoleResourceResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "DeleteMyOperationalRoleTemplateResourceActionRequest": { "title": "DeleteMyOperationalRoleTemplateResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "DeleteMyScheduledBackgroundTaskResourceActionRequest": { "title": "DeleteMyScheduledBackgroundTaskResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchDeleteMyBackgroundTaskResourceActionRequest": { "title": "BatchDeleteMyBackgroundTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMyBackgroundTaskResourceActionRequest" } }, "BatchDeleteMyScheduledBackgroundTaskResourceActionRequest": { "title": "BatchDeleteMyScheduledBackgroundTaskResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMyScheduledBackgroundTaskResourceActionRequest" } }, "AcceptMyTermsAndConditionResourceActionResponse": { "title": "AcceptMyTermsAndConditionResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "AcceptMyTermsAndConditionResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "AddResourceActionToUserOperationalRoleResourceActionResponse": { "title": "AddResourceActionToUserOperationalRoleResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "AddResourceActionToUserOperationalRoleResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "AddTemplateToUserOperationalRoleResourceActionResponse": { "title": "AddTemplateToUserOperationalRoleResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "AddTemplateToUserOperationalRoleResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "PatchOperationType": { "type": "string", "description": "", "nullable": true, "x-enumNames": [ "Replace", "Add", "Remove" ], "enum": [ "replace", "add", "remove" ] }, "EntityPatchOperationSchema": { "type": "object", "additionalProperties": false, "required": [ "path", "value" ], "properties": { "op": { "title": "op", "description": "Type of operation to apply", "example": "replace", "$ref": "#/components/schemas/PatchOperationType" }, "path": { "title": "path", "type": "string", "description": "Property path for the property being updated", "nullable": false, "example": "Asset->Code" }, "value": { "title": "value", "type": "object", "description": "Value for the property being updated", "nullable": true, "example": "BOILER", "additionalProperties": false } } }, "ApproveApprovalResourceActionRequest": { "title": "ApproveApprovalResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "comment", "type": "string", "nullable": true, "x-propertyPath": "MyApproval->Comment" } ] } } }, "RejectApprovalResourceActionRequest": { "title": "RejectApprovalResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "comment", "type": "string", "nullable": true, "x-propertyPath": "MyApproval->Comment" } ] } } }, "BatchRejectApprovalResourceActionRequest": { "title": "BatchRejectApprovalResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/RejectApprovalResourceActionRequest" } }, "SetMyDefaultOperationalRoleResourceActionResponse": { "title": "SetMyDefaultOperationalRoleResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "SetMyDefaultOperationalRoleResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "SetMyDefaultOperationalRoleResourceResourceActionResponse": { "title": "SetMyDefaultOperationalRoleResourceResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "SetMyDefaultOperationalRoleResourceResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "SetMyDefaultOperationalRoleTemplateResourceActionResponse": { "title": "SetMyDefaultOperationalRoleTemplateResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "SetMyDefaultOperationalRoleTemplateResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "UpdateMyUserSummaryResourceActionRequest": { "title": "UpdateMyUserSummaryResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "dateFormat", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->DateFormat", "x-formatSpecifier": "SystemDateFormat" }, { "title": "dateSeparator", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->DateSeparator", "x-formatSpecifier": "SystemDateSeparator" }, { "title": "timeFormat", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->TimeFormat", "x-formatSpecifier": "SystemTimeFormat" }, { "title": "defaultLanguageId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MyUserSummary->DefaultLanguage_Id" }, { "title": "defaultCreateSaveAction", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->DefaultCreateSaveAction", "x-formatSpecifier": "DefaultCreateSaveAction" }, { "title": "defaultUpdateSaveAction", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MyUserSummary->DefaultUpdateSaveAction", "x-formatSpecifier": "DefaultUpdateSaveAction" } ] } } }, "BatchApproveMyApprovalResourceActionRequest": { "title": "BatchApproveMyApprovalResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ApproveApprovalResourceActionRequest" } } }, "responses": { "default": { "description": "Error response - operation failed" }, "created": { "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "description": "Id of the resource created", "schema": { "type": "integer", "format": "Int64" }, "example": 1582413583401002 }, "OnKey-Resource-Location": { "description": "Uri to fetch the created resource", "schema": { "type": "string" }, "example": "/api/tenants/{client}/{connection}/Modules/GEN/Languages/1582413583401002" } } }, "accepted": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "description": "Request id for the Background Task created", "schema": { "type": "integer", "format": "Int64" }, "example": 1582413583401002 }, "OnKey-Request-Location": { "description": "URI to poll for the asynchronous execution status of the request", "schema": { "type": "string" }, "example": "/api/tenants/{client}/{connection}/Modules/System/BackgroundTasks/1582413583401002" } } }, "scheduled": { "description": "Request was successfully scheduled for asynchronous execution using a Scheduled Background Task", "headers": { "OnKey-Resource-Id": { "description": "Id of the Scheduled Background Task resource created", "schema": { "type": "integer", "format": "Int64" }, "example": 1582413583401002 }, "OnKey-Resource-Location": { "description": "Uri to fetch the Scheduled Background Task resource", "schema": { "type": "string" }, "example": "/api/tenants/{client}/{connection}/Modules/System/ScheduledBackgroundTasks/1582413583401002" }, "OnKey-Job-Id": { "description": "Job id of the job schedule created", "schema": { "type": "string", "format": "Uuid" }, "example": "cc4820be-e990-4161-85ff-eec4bbde2acb" }, "OnKey-Job-Schedule-Location": { "description": "URI to fetch the job schedule for the asynchronous execution of the request", "schema": { "type": "string" }, "example": "/api/tenants/{client}/{connection}/Modules/System/Jobs/cc4820be-e990-4161-85ff-eec4bbde2acb/Schedule" } } } }, "parameters": { "ExecutionMode": { "name": "mode", "in": "query", "description": "Execution mode to use for executing the batch operation", "schema": { "$ref": "#/components/schemas/OperationExecutionMode" } }, "Async": { "name": "async", "in": "query", "description": "Enqueue the operation asynchronously using a Background Task.", "schema": { "type": "boolean" } }, "AsyncDescription": { "name": "description", "in": "query", "description": "Optional description for the asynchronous execution of the Background Task.", "schema": { "type": "string", "nullable": true } }, "Schedule": { "name": "schedule", "in": "query", "description": "Optional cron expression to schedule the asynchronous execution of the Background Task.", "schema": { "type": "string", "nullable": true } }, "ScheduleFrom": { "name": "from", "in": "query", "description": "Optional future date at which a recurring schedule for the asynchronous execution of the Background Task should start. If no value is provided the current UTC date and time is used.", "schema": { "type": "string", "nullable": true } }, "Filter": { "name": "$filter", "in": "query", "description": "Filter expression to apply on the resource to limit the response data returned, e.g. $filter=id gt 0 and code startswith 'ABCD'", "schema": { "type": "string", "nullable": true } }, "OrderBy": { "name": "$orderby", "in": "query", "description": "Comma separated list of the data properties on the resource to order the response data returned, e.g. $orderby=id DESC,code ASC", "schema": { "type": "string", "nullable": true } }, "Param": { "name": "$param", "in": "query", "description": "Comma separated list of key/value pairs to parameterise `$filter` expressions to limit the response data returned, e.g. $param=@code:'JUMA'", "schema": { "type": "string", "nullable": true } }, "Select": { "name": "$select", "in": "query", "description": "Comma separated list of the data properties on the resource to return, e.g. $select=id,code,description", "schema": { "type": "string", "nullable": true } }, "Skip": { "name": "$skip", "in": "query", "description": "Number of items to skip. Use in combination with `$top` to page through the response data returned, e.g. $skip=20", "schema": { "type": "string", "nullable": true } }, "Top": { "name": "$top", "in": "query", "description": "Number of items to return in the response data, e.g. $top=20", "schema": { "type": "string", "nullable": true } } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Use the JWT access token received by authenticating with your configured On Key Identity Provider", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "Bearer": [] } ], "tags": [ { "name": "My Identity" } ], "x-tagGroups": [ { "name": "IDENTITY", "tags": [ "My Identity" ] } ] }