{ "x-generator": "On Key REST API Docs Generator", "openapi": "3.0.0", "info": { "title": "On Key RES 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/RES/Competencies/{id}": { "get": { "tags": [ "Competency" ], "summary": "Get a Competency resource.", "description": "", "operationId": "GetCompetency", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Competency Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Competency", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetCompetencyResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Competency" ], "summary": "Update an existing Competency resource.", "description": "", "operationId": "UpdateCompetency", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Competency 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/UpdateCompetencyResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Competency was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Competency" ], "summary": "Delete an existing Competency resource.", "description": "", "operationId": "DeleteCompetency", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Competency Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteCompetencyResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Competency was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Competencies": { "get": { "tags": [ "Competency" ], "summary": "Get a collection of Competency resources.", "description": "", "operationId": "GetCompetencyCollection", "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 Competency collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetCompetencyCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Competency" ], "summary": "Create a new Competency resource.", "description": "", "operationId": "CreateCompetency", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateCompetencyResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Competencies/Lookups/LookupCompetencyChangePermissionTree": { "get": { "tags": [ "Competency" ], "summary": "Lookup the permission set for changing the Competency.", "description": "", "operationId": "LookupCompetencyChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/CompetencyChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Competencies/Lookups/LookupCompetencyInsertPermissionTree": { "get": { "tags": [ "Competency" ], "summary": "Lookup the permission set for creating the Competency.", "description": "", "operationId": "LookupCompetencyInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/CompetencyInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Competencies/Batch/{ids}": { "get": { "tags": [ "Competency" ], "summary": "Get a collection of Competency resources for the set of id's.", "description": "", "operationId": "BatchGetCompetency", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Competency id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Competency collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetCompetencyResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Competencies/Batch": { "post": { "tags": [ "Competency" ], "summary": "Create a new collection of Competency resources.", "description": "", "operationId": "BatchCreateCompetency", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateCompetencyResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Competency batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Competency" ], "summary": "Update a collection of existing Competency resources.", "description": "", "operationId": "BatchUpdateCompetency", "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/BatchUpdateCompetencyResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Competency batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Competency" ], "summary": "Delete a collection of existing Competency resources.", "description": "", "operationId": "BatchDeleteCompetency", "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/BatchDeleteCompetencyResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Competency batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Competencies/{id}/Active": { "patch": { "tags": [ "Competency" ], "summary": "Change the IsActive status for an existing Competency resource.", "description": "", "operationId": "ChangeCompetencyIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Competency 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/ChangeCompetencyIsActiveResourceActionRequest" } } }, "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/RES/Competencies/{id}/PermissionTree": { "patch": { "tags": [ "Competency" ], "summary": "Change the PermissionTree for an existing Competency resource.", "description": "", "operationId": "ChangeCompetencyPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Competency 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/ChangeCompetencyPermissionTreeResourceActionRequest" } } }, "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/RES/Competencies/Batch/Active": { "patch": { "tags": [ "Competency" ], "summary": "Change the IsActive status for a collection of existing Competency resources.", "description": "", "operationId": "BatchChangeCompetencyIsActive", "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/BatchChangeCompetencyIsActiveResourceActionRequest" } } }, "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/RES/Competencies/Batch/PermissionTree": { "patch": { "tags": [ "Competency" ], "summary": "Change the PermissionTree status for a collection of existing Competency resources.", "description": "", "operationId": "BatchChangeCompetencyPermissionTree", "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/BatchChangeCompetencyPermissionTreeResourceActionRequest" } } }, "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/RES/Resources/{id}": { "get": { "tags": [ "Resource" ], "summary": "Get a Resource resource.", "description": "", "operationId": "GetResource", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetResourceResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource" ], "summary": "Update an existing Resource resource.", "description": "", "operationId": "UpdateResource", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource 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/UpdateResourceResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource" ], "summary": "Delete an existing Resource resource.", "description": "", "operationId": "DeleteResource", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteResourceResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources": { "get": { "tags": [ "Resource" ], "summary": "Get a collection of Resource resources.", "description": "", "operationId": "GetResourceCollection", "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 Resource collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Resource" ], "summary": "Create a new Resource resource.", "description": "", "operationId": "CreateResource", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateResourceResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Lookups/LookupResourceChangePermissionTree": { "get": { "tags": [ "Resource" ], "summary": "Lookup the permission set for changing the Resource.", "description": "", "operationId": "LookupResourceChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Lookups/LookupResourceClassification": { "get": { "tags": [ "Resource" ], "summary": "Lookup the Resource Classification for the Resource.", "description": "", "operationId": "LookupResourceClassification", "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 Resource Classification collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceClassificationLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Lookups/LookupResourceCostElement": { "get": { "tags": [ "Resource" ], "summary": "Lookup the Cost Element for the Resource.", "description": "", "operationId": "LookupResourceCostElement", "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 Cost Element collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceCostElementLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Lookups/LookupResourceDefaultResourceTrade": { "get": { "tags": [ "Resource" ], "summary": "Lookup the Resource Trade for the Resource.", "description": "", "operationId": "LookupResourceDefaultResourceTrade", "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 Resource Trade collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceDefaultResourceTradeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Lookups/LookupResourceInsertPermissionTree": { "get": { "tags": [ "Resource" ], "summary": "Lookup the permission set for creating the Resource.", "description": "", "operationId": "LookupResourceInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Lookups/LookupResourceSection": { "get": { "tags": [ "Resource" ], "summary": "Lookup the Section for the Resource.", "description": "", "operationId": "LookupResourceSection", "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 Section collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceSectionLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Lookups/LookupResourceSite": { "get": { "tags": [ "Resource" ], "summary": "Lookup the Site for the Resource.", "description": "", "operationId": "LookupResourceSite", "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 Site collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceSiteLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Batch/{ids}": { "get": { "tags": [ "Resource" ], "summary": "Get a collection of Resource resources for the set of id's.", "description": "", "operationId": "BatchGetResource", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Resource id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetResourceResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Batch": { "post": { "tags": [ "Resource" ], "summary": "Create a new collection of Resource resources.", "description": "", "operationId": "BatchCreateResource", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateResourceResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Resource batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource" ], "summary": "Update a collection of existing Resource resources.", "description": "", "operationId": "BatchUpdateResource", "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/BatchUpdateResourceResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource" ], "summary": "Delete a collection of existing Resource resources.", "description": "", "operationId": "BatchDeleteResource", "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/BatchDeleteResourceResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/{id}/Active": { "patch": { "tags": [ "Resource" ], "summary": "Change the IsActive status for an existing Resource resource.", "description": "", "operationId": "ChangeResourceIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource 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/ChangeResourceIsActiveResourceActionRequest" } } }, "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/RES/Resources/{id}/PermissionTree": { "patch": { "tags": [ "Resource" ], "summary": "Change the PermissionTree for an existing Resource resource.", "description": "", "operationId": "ChangeResourcePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource 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/ChangeResourcePermissionTreeResourceActionRequest" } } }, "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/RES/Resources/{id}/Site": { "patch": { "tags": [ "Resource" ], "summary": "Change the Site status for an existing Resource resource.", "description": "", "operationId": "ChangeResourceSite", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource 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/ChangeResourceSiteResourceActionRequest" } } }, "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/RES/Resources/Batch/Active": { "patch": { "tags": [ "Resource" ], "summary": "Change the IsActive status for a collection of existing Resource resources.", "description": "", "operationId": "BatchChangeResourceIsActive", "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/BatchChangeResourceIsActiveResourceActionRequest" } } }, "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/RES/Resources/Batch/PermissionTree": { "patch": { "tags": [ "Resource" ], "summary": "Change the PermissionTree status for a collection of existing Resource resources.", "description": "", "operationId": "BatchChangeResourcePermissionTree", "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/BatchChangeResourcePermissionTreeResourceActionRequest" } } }, "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/RES/Resources/Batch/Site": { "patch": { "tags": [ "Resource" ], "summary": "Change the Site status for a collection of existing Resource resources.", "description": "", "operationId": "BatchChangeResourceSite", "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/BatchChangeResourceSiteResourceActionRequest" } } }, "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/RES/Resources/MatchBatch": { "patch": { "tags": [ "Resource" ], "summary": "Update a collection of existing Resource resources to have the same value(s).", "description": "", "operationId": "MatchUpdateResource", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "matchUpdate", "description": "Request Body content", "content": { "application/vnd.onkey.entitymatchupdatecollection+json": { "schema": { "$ref": "#/components/schemas/MatchUpdateResourceResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Addresses/{id}": { "get": { "tags": [ "Resource Address" ], "summary": "Get a Resource Address resource.", "description": "", "operationId": "GetResourceAddress", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Address Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Address", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetResourceAddressResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Address" ], "summary": "Update an existing Resource Address resource.", "description": "", "operationId": "UpdateResourceAddress", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Address 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/UpdateResourceAddressResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Address was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Address" ], "summary": "Delete an existing Resource Address resource.", "description": "", "operationId": "DeleteResourceAddress", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Address Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteResourceAddressResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Address was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Addresses": { "get": { "tags": [ "Resource Address" ], "summary": "Get a collection of Resource Address resources.", "description": "", "operationId": "GetResourceAddressCollection", "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 Resource Address collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceAddressCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Resource Address" ], "summary": "Create a new Resource Address resource.", "description": "", "operationId": "CreateResourceAddress", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateResourceAddressResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/{resourceId}/Addresses": { "get": { "tags": [ "Resource Address" ], "summary": "Get a collection of Resource Address resources for the Resource.", "description": "", "operationId": "GetResourceAddressForResourceCollection", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "description": "Resource 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 Resource Address collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceAddressForResourceCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Addresses/Lookups/LookupResourceAddressAddressType": { "get": { "tags": [ "Resource Address" ], "summary": "Lookup the Resource for the Resource Address.", "description": "", "operationId": "LookupResourceAddressAddressType", "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 Address Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceAddressAddressTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Addresses/Lookups/LookupResourceAddressChangePermissionTree": { "get": { "tags": [ "Resource Address" ], "summary": "Lookup the permission set for changing the Resource Address.", "description": "", "operationId": "LookupResourceAddressChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceAddressChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Addresses/Lookups/LookupResourceAddressInsertPermissionTree": { "get": { "tags": [ "Resource Address" ], "summary": "Lookup the permission set for creating the Resource Address.", "description": "", "operationId": "LookupResourceAddressInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceAddressInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Addresses/Lookups/LookupResourceAddressResource": { "get": { "tags": [ "Resource Address" ], "summary": "Lookup the Resource for the Resource Address.", "description": "", "operationId": "LookupResourceAddressResource", "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 Resource collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceAddressResourceLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Addresses/Batch/{ids}": { "get": { "tags": [ "Resource Address" ], "summary": "Get a collection of Resource Address resources for the set of id's.", "description": "", "operationId": "BatchGetResourceAddress", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Resource Address id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Address collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetResourceAddressResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Addresses/Batch": { "post": { "tags": [ "Resource Address" ], "summary": "Create a new collection of Resource Address resources.", "description": "", "operationId": "BatchCreateResourceAddress", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateResourceAddressResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Resource Address batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Address" ], "summary": "Update a collection of existing Resource Address resources.", "description": "", "operationId": "BatchUpdateResourceAddress", "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/BatchUpdateResourceAddressResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Address batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Address" ], "summary": "Delete a collection of existing Resource Address resources.", "description": "", "operationId": "BatchDeleteResourceAddress", "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/BatchDeleteResourceAddressResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Address batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Addresses/{id}/Active": { "patch": { "tags": [ "Resource Address" ], "summary": "Change the IsActive status for an existing Resource Address resource.", "description": "", "operationId": "ChangeResourceAddressIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Address 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/ChangeResourceAddressIsActiveResourceActionRequest" } } }, "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/RES/Resources/Addresses/{id}/PermissionTree": { "patch": { "tags": [ "Resource Address" ], "summary": "Change the PermissionTree for an existing Resource Address resource.", "description": "", "operationId": "ChangeResourceAddressPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Address 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/ChangeResourceAddressPermissionTreeResourceActionRequest" } } }, "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/RES/Resources/Addresses/Batch/Active": { "patch": { "tags": [ "Resource Address" ], "summary": "Change the IsActive status for a collection of existing Resource Address resources.", "description": "", "operationId": "BatchChangeResourceAddressIsActive", "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/BatchChangeResourceAddressIsActiveResourceActionRequest" } } }, "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/RES/Resources/Addresses/Batch/PermissionTree": { "patch": { "tags": [ "Resource Address" ], "summary": "Change the PermissionTree status for a collection of existing Resource Address resources.", "description": "", "operationId": "BatchChangeResourceAddressPermissionTree", "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/BatchChangeResourceAddressPermissionTreeResourceActionRequest" } } }, "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/RES/Resources/Attributes/{id}": { "get": { "tags": [ "Resource Attribute" ], "summary": "Get a Resource Attribute resource.", "description": "", "operationId": "GetResourceAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Attribute", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetResourceAttributeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Attribute" ], "summary": "Update an existing Resource Attribute resource.", "description": "", "operationId": "UpdateResourceAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Attribute 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/UpdateResourceAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Attribute was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Attribute" ], "summary": "Delete an existing Resource Attribute resource.", "description": "", "operationId": "DeleteResourceAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteResourceAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Attribute was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/{resourceId}/Attributes": { "get": { "tags": [ "Resource Attribute" ], "summary": "Get a collection of Resource Attribute resources for the Resource.", "description": "", "operationId": "GetResourceAttributeCollectionForResource", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "description": "Resource 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 Resource Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceAttributeCollectionForResourceResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Attributes": { "get": { "tags": [ "Resource Attribute" ], "summary": "Get a collection of Resource Attribute resources.", "description": "", "operationId": "GetResourceAttributeCollection", "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 Resource Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceAttributeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Resource Attribute" ], "summary": "Create a new Resource Attribute resource.", "description": "", "operationId": "CreateResourceAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateResourceAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Attributes/Lookups/LookupResourceAttributeAllowedValue": { "get": { "tags": [ "Resource Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Resource Attribute.", "description": "", "operationId": "LookupResourceAttributeAllowedValue", "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 Attribute Allowed Value collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceAttributeAttributeAllowedValueLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Attributes/Lookups/LookupResourceAttribute": { "get": { "tags": [ "Resource Attribute" ], "summary": "Lookup the Attribute for the Resource Attribute.", "description": "", "operationId": "LookupResourceAttribute", "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 Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceAttributeAttributeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Attributes/Lookups/LookupResourceAttributeInsertPermissionTree": { "get": { "tags": [ "Resource Attribute" ], "summary": "Lookup the permission set for creating the Resource Attribute.", "description": "", "operationId": "LookupResourceAttributeInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceAttributeInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Attributes/Lookups/LookupResourceAttributeResource": { "get": { "tags": [ "Resource Attribute" ], "summary": "Lookup the Resource Attribute for the Resource Attribute.", "description": "", "operationId": "LookupResourceAttributeResource", "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 Resource collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceAttributeResourceLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Attributes/Batch/{ids}": { "get": { "tags": [ "Resource Attribute" ], "summary": "Get a collection of Resource Attribute resources for the set of id's.", "description": "", "operationId": "BatchGetResourceAttribute", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Resource Attribute id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Attribute collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetResourceAttributeResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Attributes/Batch": { "post": { "tags": [ "Resource Attribute" ], "summary": "Create a new collection of Resource Attribute resources.", "description": "", "operationId": "BatchCreateResourceAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateResourceAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Resource Attribute batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Attribute" ], "summary": "Update a collection of existing Resource Attribute resources.", "description": "", "operationId": "BatchUpdateResourceAttribute", "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/BatchUpdateResourceAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Attribute batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Attribute" ], "summary": "Delete a collection of existing Resource Attribute resources.", "description": "", "operationId": "BatchDeleteResourceAttribute", "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/BatchDeleteResourceAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Attribute batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Attributes/{id}/Active": { "patch": { "tags": [ "Resource Attribute" ], "summary": "Change the IsActive status for an existing Resource Attribute resource.", "description": "", "operationId": "ChangeResourceAttributeIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Attribute 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/ChangeResourceAttributeIsActiveResourceActionRequest" } } }, "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/RES/Resources/Attributes/Batch/Active": { "patch": { "tags": [ "Resource Attribute" ], "summary": "Change the IsActive status for a collection of existing Resource Attribute resources.", "description": "", "operationId": "BatchChangeResourceAttributeIsActive", "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/BatchChangeResourceAttributeIsActiveResourceActionRequest" } } }, "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/RES/ResourceClassifications/{id}": { "get": { "tags": [ "Resource Classification" ], "summary": "Get a Resource Classification resource.", "description": "", "operationId": "GetResourceClassification", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Classification Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Classification", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetResourceClassificationResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Classification" ], "summary": "Update an existing Resource Classification resource.", "description": "", "operationId": "UpdateResourceClassification", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Classification 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/UpdateResourceClassificationResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Classification was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Classification" ], "summary": "Delete an existing Resource Classification resource.", "description": "", "operationId": "DeleteResourceClassification", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Classification Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteResourceClassificationResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Classification was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/ResourceClassifications": { "get": { "tags": [ "Resource Classification" ], "summary": "Get a collection of Resource Classification resources.", "description": "", "operationId": "GetResourceClassificationCollection", "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 Resource Classification collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceClassificationCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Resource Classification" ], "summary": "Create a new Resource Classification resource.", "description": "", "operationId": "CreateResourceClassification", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateResourceClassificationResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/ResourceClassifications/Lookups/LookupResourceClassificationChangePermissionTree": { "get": { "tags": [ "Resource Classification" ], "summary": "Lookup the permission set for changing the Resource Classification.", "description": "", "operationId": "LookupResourceClassificationChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceClassificationChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/ResourceClassifications/Lookups/LookupResourceClassificationInsertPermissionTree": { "get": { "tags": [ "Resource Classification" ], "summary": "Lookup the permission set for creating the Resource Classification.", "description": "", "operationId": "LookupResourceClassificationInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceClassificationInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/ResourceClassifications/Batch/{ids}": { "get": { "tags": [ "Resource Classification" ], "summary": "Get a collection of Resource Classification resources for the set of id's.", "description": "", "operationId": "BatchGetResourceClassification", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Resource Classification id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Classification collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetResourceClassificationResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/ResourceClassifications/Batch": { "post": { "tags": [ "Resource Classification" ], "summary": "Create a new collection of Resource Classification resources.", "description": "", "operationId": "BatchCreateResourceClassification", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateResourceClassificationResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Resource Classification batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Classification" ], "summary": "Update a collection of existing Resource Classification resources.", "description": "", "operationId": "BatchUpdateResourceClassification", "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/BatchUpdateResourceClassificationResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Classification batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Classification" ], "summary": "Delete a collection of existing Resource Classification resources.", "description": "", "operationId": "BatchDeleteResourceClassification", "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/BatchDeleteResourceClassificationResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Classification batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/ResourceClassifications/{id}/Active": { "patch": { "tags": [ "Resource Classification" ], "summary": "Change the IsActive status for an existing Resource Classification resource.", "description": "", "operationId": "ChangeResourceClassificationIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Classification 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/ChangeResourceClassificationIsActiveResourceActionRequest" } } }, "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/RES/ResourceClassifications/{id}/PermissionTree": { "patch": { "tags": [ "Resource Classification" ], "summary": "Change the PermissionTree for an existing Resource Classification resource.", "description": "", "operationId": "ChangeResourceClassificationPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Classification 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/ChangeResourceClassificationPermissionTreeResourceActionRequest" } } }, "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/RES/ResourceClassifications/Batch/Active": { "patch": { "tags": [ "Resource Classification" ], "summary": "Change the IsActive status for a collection of existing Resource Classification resources.", "description": "", "operationId": "BatchChangeResourceClassificationIsActive", "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/BatchChangeResourceClassificationIsActiveResourceActionRequest" } } }, "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/RES/ResourceClassifications/Batch/PermissionTree": { "patch": { "tags": [ "Resource Classification" ], "summary": "Change the PermissionTree status for a collection of existing Resource Classification resources.", "description": "", "operationId": "BatchChangeResourceClassificationPermissionTree", "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/BatchChangeResourceClassificationPermissionTreeResourceActionRequest" } } }, "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/RES/Resources/Competencies/{id}": { "get": { "tags": [ "Resource Competency" ], "summary": "Get a Resource Competency resource.", "description": "", "operationId": "GetResourceCompetency", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Competency Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Competency", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetResourceCompetencyResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Competency" ], "summary": "Update an existing Resource Competency resource.", "description": "", "operationId": "UpdateResourceCompetency", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Competency 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/UpdateResourceCompetencyResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Competency was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Competency" ], "summary": "Delete an existing Resource Competency resource.", "description": "", "operationId": "DeleteResourceCompetency", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Competency Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteResourceCompetencyResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Competency was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Competencies": { "get": { "tags": [ "Resource Competency" ], "summary": "Get a collection of Resource Competency resources.", "description": "", "operationId": "GetResourceCompetencyCollection", "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 Resource Competency collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceCompetencyCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Resource Competency" ], "summary": "Create a new Resource Competency resource.", "description": "", "operationId": "CreateResourceCompetency", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateResourceCompetencyResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/{resourceId}/Competencies": { "get": { "tags": [ "Resource Competency" ], "summary": "Get a collection of Resource Competency resources for the Resource.", "description": "", "operationId": "GetResourceCompetencyForResourceCollection", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "description": "Resource 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 Resource Competency collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceCompetencyForResourceCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Competencies/Lookups/LookupResourceCompetencyChangePermissionTree": { "get": { "tags": [ "Resource Competency" ], "summary": "Lookup the permission set for changing the Resource Competency.", "description": "", "operationId": "LookupResourceCompetencyChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceCompetencyChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Competencies/Lookups/LookupResourceCompetencyCompetency": { "get": { "tags": [ "Resource Competency" ], "summary": "Lookup the Competency for the Resource Competency.", "description": "", "operationId": "LookupResourceCompetencyCompetency", "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 Competency collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceCompetencyCompetencyLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Competencies/Lookups/LookupResourceCompetencyInsertPermissionTree": { "get": { "tags": [ "Resource Competency" ], "summary": "Lookup the permission set for creating the Resource Competency.", "description": "", "operationId": "LookupResourceCompetencyInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceCompetencyInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Competencies/Lookups/LookupResourceCompetencyResource": { "get": { "tags": [ "Resource Competency" ], "summary": "Lookup the Resource for the Resource Competency.", "description": "", "operationId": "LookupResourceCompetencyResource", "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 Resource collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceCompetencyResourceLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Competencies/Batch/{ids}": { "get": { "tags": [ "Resource Competency" ], "summary": "Get a collection of Resource Competency resources for the set of id's.", "description": "", "operationId": "BatchGetResourceCompetency", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Resource Competency id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Competency collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetResourceCompetencyResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Competencies/Batch": { "post": { "tags": [ "Resource Competency" ], "summary": "Create a new collection of Resource Competency resources.", "description": "", "operationId": "BatchCreateResourceCompetency", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateResourceCompetencyResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Resource Competency batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Competency" ], "summary": "Update a collection of existing Resource Competency resources.", "description": "", "operationId": "BatchUpdateResourceCompetency", "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/BatchUpdateResourceCompetencyResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Competency batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Competency" ], "summary": "Delete a collection of existing Resource Competency resources.", "description": "", "operationId": "BatchDeleteResourceCompetency", "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/BatchDeleteResourceCompetencyResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Competency batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Competencies/{id}/Active": { "patch": { "tags": [ "Resource Competency" ], "summary": "Change the IsActive status for an existing Resource Competency resource.", "description": "", "operationId": "ChangeResourceCompetencyIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Competency 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/ChangeResourceCompetencyIsActiveResourceActionRequest" } } }, "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/RES/Resources/Competencies/{id}/PermissionTree": { "patch": { "tags": [ "Resource Competency" ], "summary": "Change the PermissionTree for an existing Resource Competency resource.", "description": "", "operationId": "ChangeResourceCompetencyPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Competency 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/ChangeResourceCompetencyPermissionTreeResourceActionRequest" } } }, "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/RES/Resources/Competencies/Batch/Active": { "patch": { "tags": [ "Resource Competency" ], "summary": "Change the IsActive status for a collection of existing Resource Competency resources.", "description": "", "operationId": "BatchChangeResourceCompetencyIsActive", "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/BatchChangeResourceCompetencyIsActiveResourceActionRequest" } } }, "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/RES/Resources/Competencies/Batch/PermissionTree": { "patch": { "tags": [ "Resource Competency" ], "summary": "Change the PermissionTree status for a collection of existing Resource Competency resources.", "description": "", "operationId": "BatchChangeResourceCompetencyPermissionTree", "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/BatchChangeResourceCompetencyPermissionTreeResourceActionRequest" } } }, "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/RES/ResourceContexts/{id}": { "get": { "tags": [ "Resource Context" ], "summary": "Get a Resource Context resource.", "description": "", "operationId": "GetResourceContext", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Context Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Context", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetResourceContextResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Context" ], "summary": "Update an existing Resource Context resource.", "description": "", "operationId": "UpdateResourceContext", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Context 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/UpdateResourceContextResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Context was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Context" ], "summary": "Delete an existing Resource Context resource.", "description": "", "operationId": "DeleteResourceContext", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Context Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteResourceContextResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Context was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/ResourceContexts": { "get": { "tags": [ "Resource Context" ], "summary": "Get a collection of Resource Context resources.", "description": "", "operationId": "GetResourceContextCollection", "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 Resource Context collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceContextCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Resource Context" ], "summary": "Create a new Resource Context resource.", "description": "", "operationId": "CreateResourceContext", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateResourceContextResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/ResourceContexts/Lookups/LookupResourceContextChangePermissionTree": { "get": { "tags": [ "Resource Context" ], "summary": "Lookup the permission set for changing the Resource Context.", "description": "", "operationId": "LookupResourceContextChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceContextChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/ResourceContexts/Lookups/LookupResourceContextInsertPermissionTree": { "get": { "tags": [ "Resource Context" ], "summary": "Lookup the permission set for creating the Resource Context.", "description": "", "operationId": "LookupResourceContextInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceContextInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/ResourceContexts/Batch/{ids}": { "get": { "tags": [ "Resource Context" ], "summary": "Get a collection of Resource Context resources for the set of id's.", "description": "", "operationId": "BatchGetResourceContext", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Resource Context id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Context collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetResourceContextResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/ResourceContexts/Batch": { "post": { "tags": [ "Resource Context" ], "summary": "Create a new collection of Resource Context resources.", "description": "", "operationId": "BatchCreateResourceContext", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateResourceContextResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Resource Context batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Context" ], "summary": "Update a collection of existing Resource Context resources.", "description": "", "operationId": "BatchUpdateResourceContext", "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/BatchUpdateResourceContextResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Context batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Context" ], "summary": "Delete a collection of existing Resource Context resources.", "description": "", "operationId": "BatchDeleteResourceContext", "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/BatchDeleteResourceContextResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Context batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/ResourceContexts/{id}/Active": { "patch": { "tags": [ "Resource Context" ], "summary": "Change the IsActive status for an existing Resource Context resource.", "description": "", "operationId": "ChangeResourceContextIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Context 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/ChangeResourceContextIsActiveResourceActionRequest" } } }, "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/RES/ResourceContexts/{id}/PermissionTree": { "patch": { "tags": [ "Resource Context" ], "summary": "Change the PermissionTree for an existing Resource Context resource.", "description": "", "operationId": "ChangeResourceContextPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Context 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/ChangeResourceContextPermissionTreeResourceActionRequest" } } }, "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/RES/ResourceContexts/Batch/Active": { "patch": { "tags": [ "Resource Context" ], "summary": "Change the IsActive status for a collection of existing Resource Context resources.", "description": "", "operationId": "BatchChangeResourceContextIsActive", "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/BatchChangeResourceContextIsActiveResourceActionRequest" } } }, "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/RES/ResourceContexts/Batch/PermissionTree": { "patch": { "tags": [ "Resource Context" ], "summary": "Change the PermissionTree status for a collection of existing Resource Context resources.", "description": "", "operationId": "BatchChangeResourceContextPermissionTree", "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/BatchChangeResourceContextPermissionTreeResourceActionRequest" } } }, "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/RES/Resources/Documents/{id}": { "get": { "tags": [ "Resource Document" ], "summary": "Get a Resource Document resource.", "description": "", "operationId": "GetResourceDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Document", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetResourceDocumentResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Document" ], "summary": "Update an existing Resource Document resource.", "description": "", "operationId": "UpdateResourceDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Document 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/UpdateResourceDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Document was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Document" ], "summary": "Delete an existing Resource Document resource.", "description": "", "operationId": "DeleteResourceDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteResourceDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Document was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/{id}/Documents": { "get": { "tags": [ "Resource Document" ], "summary": "Get a collection of Resource Document resources for the Resource.", "description": "", "operationId": "GetResourceDocumentCollectionForResource", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource 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 Resource Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceDocumentCollectionForResourceResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Documents": { "get": { "tags": [ "Resource Document" ], "summary": "Get a collection of Resource Document resources.", "description": "", "operationId": "GetResourceDocumentCollection", "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 Resource Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceDocumentCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Resource Document" ], "summary": "Create a new Resource Document resource.", "description": "", "operationId": "CreateResourceDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateResourceDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Documents/Lookups/LookupResourceDocumentChangePermissionTree": { "get": { "tags": [ "Resource Document" ], "summary": "Lookup the permission set for changing the Resource Document.", "description": "", "operationId": "LookupResourceDocumentChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceDocumentChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Documents/Lookups/LookupResourceDocument": { "get": { "tags": [ "Resource Document" ], "summary": "Resource Document", "description": "", "operationId": "LookupResourceDocument", "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 Document Record collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceDocumentDocumentLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Documents/Lookups/LookupResourceDocumentInsertPermissionTree": { "get": { "tags": [ "Resource Document" ], "summary": "Lookup the permission set for creating the Resource Document.", "description": "", "operationId": "LookupResourceDocumentInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceDocumentInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Documents/Lookups/LookupResourceDocumentResource": { "get": { "tags": [ "Resource Document" ], "summary": "Lookup the Resource Document for the Resource Document.", "description": "", "operationId": "LookupResourceDocumentResource", "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 Resource collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceDocumentResourceLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Documents/Batch/{ids}": { "get": { "tags": [ "Resource Document" ], "summary": "Get a collection of Resource Document resources for the set of id's.", "description": "", "operationId": "BatchGetResourceDocument", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Resource Document id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Document collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetResourceDocumentResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Documents/Batch": { "post": { "tags": [ "Resource Document" ], "summary": "Create a new collection of Resource Document resources.", "description": "", "operationId": "BatchCreateResourceDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateResourceDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Resource Document batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Document" ], "summary": "Update a collection of existing Resource Document resources.", "description": "", "operationId": "BatchUpdateResourceDocument", "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/BatchUpdateResourceDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Document batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Document" ], "summary": "Delete a collection of existing Resource Document resources.", "description": "", "operationId": "BatchDeleteResourceDocument", "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/BatchDeleteResourceDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Document batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Documents/{id}/Active": { "patch": { "tags": [ "Resource Document" ], "summary": "Change the IsActive status for an existing Resource Document resource.", "description": "", "operationId": "ChangeResourceDocumentIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Document 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/ChangeResourceDocumentIsActiveResourceActionRequest" } } }, "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/RES/Resources/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Resource Document" ], "summary": "Change the PermissionTree for an existing Resource Document resource.", "description": "", "operationId": "ChangeResourceDocumentPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Document 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/ChangeResourceDocumentPermissionTreeResourceActionRequest" } } }, "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/RES/Resources/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Resource Document" ], "summary": "Change the PermissionTree status for a collection of existing Resource Document resources.", "description": "", "operationId": "BatchChangeResourceDocumentPermissionTree", "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/BatchChangeResourceDocumentPermissionTreeResourceActionRequest" } } }, "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/RES/Resources/Documents/Batch/Active": { "patch": { "tags": [ "Resource Document" ], "summary": "Change the IsActive status for a collection of existing Resource Document resources.", "description": "", "operationId": "BatchChangeResourceDocumentIsActive", "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/BatchChangeResourceDocumentIsActiveResourceActionRequest" } } }, "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/RES/Resources/Emails/{id}": { "get": { "tags": [ "Resource Email" ], "summary": "Get a Resource Email resource.", "description": "", "operationId": "GetResourceEmail", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Email Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Email", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetResourceEmailResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Email" ], "summary": "Update an existing Resource Email resource.", "description": "", "operationId": "UpdateResourceEmail", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Email 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/UpdateResourceEmailResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Email was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Email" ], "summary": "Delete an existing Resource Email resource.", "description": "", "operationId": "DeleteResourceEmail", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Email Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteResourceEmailResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Email was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Emails": { "get": { "tags": [ "Resource Email" ], "summary": "Get a collection of Resource Email resources.", "description": "", "operationId": "GetResourceEmailCollection", "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 Resource Email collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceEmailCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Resource Email" ], "summary": "Create a new Resource Email resource.", "description": "", "operationId": "CreateResourceEmail", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateResourceEmailResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/{resourceId}/Emails": { "get": { "tags": [ "Resource Email" ], "summary": "Get a collection of Resource Email resources for the Resource.", "description": "", "operationId": "GetResourceEmailForResourceCollection", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "description": "Resource 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 Resource Email collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceEmailForResourceCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Emails/Lookups/LookupResourceEmailChangePermissionTree": { "get": { "tags": [ "Resource Email" ], "summary": "Resource Email", "description": "", "operationId": "LookupResourceEmailChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceEmailChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Emails/Lookups/LookupResourceEmailEmailType": { "get": { "tags": [ "Resource Email" ], "summary": "Lookup the Email Type for the Resource Email.", "description": "", "operationId": "LookupResourceEmailEmailType", "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 Email Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceEmailEmailTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Emails/Lookups/LookupResourceEmailInsertPermissionTree": { "get": { "tags": [ "Resource Email" ], "summary": "Resource Email", "description": "", "operationId": "LookupResourceEmailInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceEmailInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Emails/Lookups/LookupResourceEmailResource": { "get": { "tags": [ "Resource Email" ], "summary": "Lookup the Resource for the Resource Email.", "description": "", "operationId": "LookupResourceEmailResource", "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 Resource collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceEmailResourceLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Emails/Batch/{ids}": { "get": { "tags": [ "Resource Email" ], "summary": "Get a collection of Resource Email resources for the set of id's.", "description": "", "operationId": "BatchGetResourceEmail", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Resource Email id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Email collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetResourceEmailResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Emails/Batch": { "post": { "tags": [ "Resource Email" ], "summary": "Create a new collection of Resource Email resources.", "description": "", "operationId": "BatchCreateResourceEmail", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateResourceEmailResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Resource Email batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Email" ], "summary": "Update a collection of existing Resource Email resources.", "description": "", "operationId": "BatchUpdateResourceEmail", "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/BatchUpdateResourceEmailResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Email batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Email" ], "summary": "Delete a collection of existing Resource Email resources.", "description": "", "operationId": "BatchDeleteResourceEmail", "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/BatchDeleteResourceEmailResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Email batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Emails/{id}/Active": { "patch": { "tags": [ "Resource Email" ], "summary": "Change the IsActive status for an existing Resource Email resource.", "description": "", "operationId": "ChangeResourceEmailIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Email 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/ChangeResourceEmailIsActiveResourceActionRequest" } } }, "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/RES/Resources/Emails/{id}/PermissionTree": { "patch": { "tags": [ "Resource Email" ], "summary": "Change the PermissionTree for an existing Resource Email resource.", "description": "", "operationId": "ChangeResourceEmailPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Email 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/ChangeResourceEmailPermissionTreeResourceActionRequest" } } }, "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/RES/Resources/Emails/Batch/Active": { "patch": { "tags": [ "Resource Email" ], "summary": "Change the IsActive status for a collection of existing Resource Email resources.", "description": "", "operationId": "BatchChangeResourceEmailIsActive", "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/BatchChangeResourceEmailIsActiveResourceActionRequest" } } }, "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/RES/Resources/Emails/Batch/PermissionTree": { "patch": { "tags": [ "Resource Email" ], "summary": "Change the PermissionTree status for a collection of existing Resource Email resources.", "description": "", "operationId": "BatchChangeResourceEmailPermissionTree", "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/BatchChangeResourceEmailPermissionTreeResourceActionRequest" } } }, "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/RES/Resources/FileAttachments/{id}/Download": { "get": { "tags": [ "Resource File Attachment" ], "summary": "Download the content for a Resource File Attachment resource.", "description": "", "operationId": "GetResourceFileAttachmentContent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "name": "cv", "in": "query", "description": "Return older version of attachment content", "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "responses": { "200": { "description": "Success response - body contains file content", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/FileAttachments/{id}": { "get": { "tags": [ "Resource File Attachment" ], "summary": "Get a Resource File Attachment resource.", "description": "", "operationId": "GetResourceFileAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource File Attachment", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetResourceFileAttachmentResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource File Attachment" ], "summary": "Update an existing Resource File Attachment resource.", "description": "", "operationId": "UpdateResourceFileAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "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/UpdateResourceFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource File Attachment was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource File Attachment" ], "summary": "Delete an existing Resource File Attachment resource.", "description": "", "operationId": "DeleteResourceFileAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteResourceFileAttachmentResourceResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource File Attachment was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/{id}/FileAttachments": { "get": { "tags": [ "Resource File Attachment" ], "summary": "Get a collection of Resource File Attachment resources for the Resource.", "description": "", "operationId": "GetResourceFileAttachmentCollectionForResource", "parameters": [ { "name": "id", "in": "path", "required": true, "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 Resource File Attachment collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceFileAttachmentCollectionForResourceResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/FileAttachments": { "get": { "tags": [ "Resource File Attachment" ], "summary": "Get a collection of Resource File Attachment resources.", "description": "", "operationId": "GetResourceFileAttachmentCollection", "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 Resource File Attachment collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceFileAttachmentCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/FileAttachments/Upload": { "post": { "tags": [ "Resource File Attachment" ], "summary": "Upload and create a new Resource File Attachment resource.", "description": "", "operationId": "CreateResourceFileAttachment", "requestBody": { "x-name": "entityPost", "description": "Request Body content", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateResourceFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/FileAttachments/{id}/Upload": { "put": { "tags": [ "Resource File Attachment" ], "summary": "Upload new content for an existing Resource File Attachment resource.", "description": "", "operationId": "UpdateResourceFileAttachmentContent", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 } ], "requestBody": { "x-name": "entityFilePatch", "description": "Request Body content", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UpdateResourceFileAttachmentContentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource File Attachment was successfully updated" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/FileAttachments/Batch/{ids}": { "get": { "tags": [ "Resource File Attachment" ], "summary": "Get a collection of Resource File Attachment resources for the set of id's.", "description": "", "operationId": "BatchGetResourceFileAttachment", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Resource File Attachment id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource File Attachment collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetResourceFileAttachmentResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/FileAttachments/{id}/ContentHistory": { "get": { "tags": [ "Resource File Attachment" ], "summary": "Get a collection of File Attachment Content History resources for the Resource File Attachment.", "description": "", "operationId": "GetResourceFileAttachmentContentHistory", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource File Attachment collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/GetResourceFileAttachmentContentHistoryResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/FileAttachments/Upload/Batch": { "post": { "tags": [ "Resource File Attachment" ], "summary": "Upload and create a new collection of Resource File Attachment resources.", "description": "", "operationId": "BatchCreateResourceFileAttachment", "parameters": [ { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "entityPostCollection", "description": "Request Body content", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BatchCreateResourceFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Resource File Attachment batch was successfully created" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/FileAttachments/Batch": { "patch": { "tags": [ "Resource File Attachment" ], "summary": "Update a collection of existing Resource File Attachment resources.", "description": "", "operationId": "BatchUpdateResourceFileAttachment", "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/BatchUpdateResourceFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource File Attachment batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource File Attachment" ], "summary": "Delete a collection of existing Resource File Attachment resources.", "description": "", "operationId": "BatchDeleteResourceFileAttachment", "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/BatchDeleteResourceFileAttachmentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource File Attachment batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/PhoneNumbers/{id}": { "get": { "tags": [ "Resource Phone Number" ], "summary": "Get a Resource Phone Number resource.", "description": "", "operationId": "GetResourcePhoneNumber", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Phone Number Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Phone Number", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetResourcePhoneNumberResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Phone Number" ], "summary": "Update an existing Resource Phone Number resource.", "description": "", "operationId": "UpdateResourcePhoneNumber", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Phone Number 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/UpdateResourcePhoneNumberResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Phone Number was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Phone Number" ], "summary": "Delete an existing Resource Phone Number resource.", "description": "", "operationId": "DeleteResourcePhoneNumber", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Phone Number Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteResourcePhoneNumberResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Phone Number was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/PhoneNumbers": { "get": { "tags": [ "Resource Phone Number" ], "summary": "Get a collection of Resource Phone Number resources.", "description": "", "operationId": "GetResourcePhoneNumberCollection", "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 Resource Phone Number collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourcePhoneNumberCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Resource Phone Number" ], "summary": "Create a new Resource Phone Number resource.", "description": "", "operationId": "CreateResourcePhoneNumber", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateResourcePhoneNumberResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/{resourceId}/PhoneNumbers": { "get": { "tags": [ "Resource Phone Number" ], "summary": "Get a collection of Resource PhoneNumber resources for the Resource.", "description": "", "operationId": "GetResourcePhoneNumberForResourceCollection", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "description": "Resource 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 Resource Phone Number collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourcePhoneNumberForResourceCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/PhoneNumbers/Lookups/LookupResourcePhoneNumberInsertPermissionTree": { "get": { "tags": [ "Resource Phone Number" ], "summary": "Lookup the permission set for creating the Resource Phone Number.", "description": "", "operationId": "LookupResourcePhoneNumberInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourcePhoneNumberInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/PhoneNumbers/Lookups/LookupResourcePhoneNumberResource": { "get": { "tags": [ "Resource Phone Number" ], "summary": "Lookup the Resource for the Resource Phone Number.", "description": "", "operationId": "LookupResourcePhoneNumberResource", "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 Resource collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourcePhoneNumberResourceLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/PhoneNumbers/Lookups/LookupResourcePhoneNumberChangePermissionTree": { "get": { "tags": [ "Resource Phone Number" ], "summary": "Lookup the permission set for changing the Resource Phone Number.", "description": "", "operationId": "LookupResourcePhoneNumberChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourcePhoneNumberChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/PhoneNumbers/Lookups/LookupResourcePhoneNumberPhoneNumberType": { "get": { "tags": [ "Resource Phone Number" ], "summary": "Lookup the Phone Number Type for the Resource Phone Number.", "description": "", "operationId": "LookupResourcePhoneNumberPhoneNumberType", "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 Phone Number Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourcePhoneNumberPhoneNumberTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/PhoneNumbers/Batch/{ids}": { "get": { "tags": [ "Resource Phone Number" ], "summary": "Get a collection of Resource Phone Number resources for the set of id's.", "description": "", "operationId": "BatchGetResourcePhoneNumber", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Resource Phone Number id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Phone Number collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetResourcePhoneNumberResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/PhoneNumbers/Batch": { "post": { "tags": [ "Resource Phone Number" ], "summary": "Create a new collection of Resource Phone Number resources.", "description": "", "operationId": "BatchCreateResourcePhoneNumber", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateResourcePhoneNumberResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Resource Phone Number batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Phone Number" ], "summary": "Update a collection of existing Resource Phone Number resources.", "description": "", "operationId": "BatchUpdateResourcePhoneNumber", "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/BatchUpdateResourcePhoneNumberResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Phone Number batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Phone Number" ], "summary": "Delete a collection of existing Resource Phone Number resources.", "description": "", "operationId": "BatchDeleteResourcePhoneNumber", "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/BatchDeleteResourcePhoneNumberResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Phone Number batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/PhoneNumbers/{id}/Active": { "patch": { "tags": [ "Resource Phone Number" ], "summary": "Change the IsActive status for an existing Resource Phone Number resource.", "description": "", "operationId": "ChangeResourcePhoneNumberIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Phone Number 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/ChangeResourcePhoneNumberIsActiveResourceActionRequest" } } }, "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/RES/Resources/PhoneNumbers/{id}/PermissionTree": { "patch": { "tags": [ "Resource Phone Number" ], "summary": "Change the PermissionTree for an existing Resource Phone Number resource.", "description": "", "operationId": "ChangeResourcePhoneNumberPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Phone Number 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/ChangeResourcePhoneNumberPermissionTreeResourceActionRequest" } } }, "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/RES/Resources/PhoneNumbers/Batch/Active": { "patch": { "tags": [ "Resource Phone Number" ], "summary": "Change the IsActive status for a collection of existing Resource Phone Number resources.", "description": "", "operationId": "BatchChangeResourcePhoneNumberIsActive", "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/BatchChangeResourcePhoneNumberIsActiveResourceActionRequest" } } }, "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/RES/Resources/PhoneNumbers/Batch/PermissionTree": { "patch": { "tags": [ "Resource Phone Number" ], "summary": "Change the PermissionTree status for a collection of existing Resource Phone Number resources.", "description": "", "operationId": "BatchChangeResourcePhoneNumberPermissionTree", "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/BatchChangeResourcePhoneNumberPermissionTreeResourceActionRequest" } } }, "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/RES/Resources/Trades/{id}": { "get": { "tags": [ "Resource Trade" ], "summary": "Get a Resource Trade resource.", "description": "", "operationId": "GetResourceTrade", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Trade", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetResourceTradeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Trade" ], "summary": "Update an existing Resource Trade resource.", "description": "", "operationId": "UpdateResourceTrade", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade 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/UpdateResourceTradeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Trade was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Trade" ], "summary": "Delete an existing Resource Trade resource.", "description": "", "operationId": "DeleteResourceTrade", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteResourceTradeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Trade was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades": { "get": { "tags": [ "Resource Trade" ], "summary": "Get a collection of Resource Trade resources.", "description": "", "operationId": "GetResourceTradeCollection", "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 Resource Trade collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceTradeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Resource Trade" ], "summary": "Create a new Resource Trade resource.", "description": "", "operationId": "CreateResourceTrade", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateResourceTradeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/{resourceId}/Trades": { "get": { "tags": [ "Resource Trade" ], "summary": "Get a collection of Resource Trade resources for the Resource Trade.", "description": "", "operationId": "GetResourceTradeForResourceCollection", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "description": "Resource 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 Resource Trade collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceTradeForResourceCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/Lookups/LookupResourceTradeChangePermissionTree": { "get": { "tags": [ "Resource Trade" ], "summary": "Lookup the permission set for changing the Resource Trade.", "description": "", "operationId": "LookupResourceTradeChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceTradeChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/Lookups/LookupResourceTradeDefaultResourceTradeFinancialRate": { "get": { "tags": [ "Resource Trade" ], "summary": "Lookup the Resource Trade Financial Rate for the Resource Trade.", "description": "", "operationId": "LookupResourceTradeDefaultResourceTradeFinancialRate", "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 Resource Trade Financial Rate collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceTradeDefaultResourceTradeFinancialRateLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/Lookups/LookupResourceTradeInsertPermissionTree": { "get": { "tags": [ "Resource Trade" ], "summary": "Lookup the permission set for creating the Resource Trade.", "description": "", "operationId": "LookupResourceTradeInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceTradeInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/Lookups/LookupResourceTradeResource": { "get": { "tags": [ "Resource Trade" ], "summary": "Lookup the Resource for the Resource Trade.", "description": "", "operationId": "LookupResourceTradeResource", "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 Resource collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceTradeResourceLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/Lookups/LookupResourceTradeTrade": { "get": { "tags": [ "Resource Trade" ], "summary": "Lookup the Trade for the Resource Trade.", "description": "", "operationId": "LookupResourceTradeTrade", "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 Trade collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceTradeTradeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/Batch/{ids}": { "get": { "tags": [ "Resource Trade" ], "summary": "Get a collection of Resource Trade resources for the set of id's.", "description": "", "operationId": "BatchGetResourceTrade", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Resource Trade id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Trade collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetResourceTradeResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/Batch": { "post": { "tags": [ "Resource Trade" ], "summary": "Create a new collection of Resource Trade resources.", "description": "", "operationId": "BatchCreateResourceTrade", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateResourceTradeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Resource Trade batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Trade" ], "summary": "Update a collection of existing Resource Trade resources.", "description": "", "operationId": "BatchUpdateResourceTrade", "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/BatchUpdateResourceTradeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Trade batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Trade" ], "summary": "Delete a collection of existing Resource Trade resources.", "description": "", "operationId": "BatchDeleteResourceTrade", "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/BatchDeleteResourceTradeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Trade batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/{id}/Active": { "patch": { "tags": [ "Resource Trade" ], "summary": "Change the IsActive status for an existing Resource Trade resource.", "description": "", "operationId": "ChangeResourceTradeIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade 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/ChangeResourceTradeIsActiveResourceActionRequest" } } }, "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/RES/Resources/Trades/{id}/PermissionTree": { "patch": { "tags": [ "Resource Trade" ], "summary": "Change the PermissionTree for an existing Resource Trade resource.", "description": "", "operationId": "ChangeResourceTradePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade 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/ChangeResourceTradePermissionTreeResourceActionRequest" } } }, "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/RES/Resources/Trades/{id}/Customise": { "patch": { "tags": [ "Resource Trade" ], "summary": "Customise the Resource Trade.", "description": "", "operationId": "CustomiseResourceTrade", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade 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/CustomiseResourceTradeResourceActionRequest" } } }, "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/RES/Resources/Trades/{id}/Reset": { "patch": { "tags": [ "Resource Trade" ], "summary": "Reset the Resource Trade.", "description": "", "operationId": "ResetResourceTrade", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade 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/ResetResourceTradeResourceActionRequest" } } }, "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/RES/Resources/Trades/Batch/Active": { "patch": { "tags": [ "Resource Trade" ], "summary": "Change the IsActive status for a collection of existing Resource Trade resources.", "description": "", "operationId": "BatchChangeResourceTradeIsActive", "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/BatchChangeResourceTradeIsActiveResourceActionRequest" } } }, "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/RES/Resources/Trades/Batch/PermissionTree": { "patch": { "tags": [ "Resource Trade" ], "summary": "Change the PermissionTree status for a collection of existing Resource Trade resources.", "description": "", "operationId": "BatchChangeResourceTradePermissionTree", "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/BatchChangeResourceTradePermissionTreeResourceActionRequest" } } }, "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/RES/Resources/Trades/Competencies/{id}": { "get": { "tags": [ "Resource Trade Competency" ], "summary": "Get a Resource Trade Competency resource.", "description": "", "operationId": "GetResourceTradeCompetency", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade Competency Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Trade Competency", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetResourceTradeCompetencyResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Trade Competency" ], "summary": "Update an existing Resource Trade Competency resource.", "description": "", "operationId": "UpdateResourceTradeCompetency", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade Competency 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/UpdateResourceTradeCompetencyResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Trade Competency was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Trade Competency" ], "summary": "Delete an existing Resource Trade Competency resource.", "description": "", "operationId": "DeleteResourceTradeCompetency", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade Competency Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteResourceTradeCompetencyResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Trade Competency was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/Competencies": { "get": { "tags": [ "Resource Trade Competency" ], "summary": "Get a collection of Resource Trade Competency resources.", "description": "", "operationId": "GetResourceTradeCompetencyCollection", "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 Resource Trade Competency collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceTradeCompetencyCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Resource Trade Competency" ], "summary": "Create a new Resource Trade Competency resource.", "description": "", "operationId": "CreateResourceTradeCompetency", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateResourceTradeCompetencyResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/{resourceId}/Trades/Competencies": { "get": { "tags": [ "Resource Trade Competency" ], "summary": "Get a collection of Resource Trade Competency resources for the Resource.", "description": "", "operationId": "GetResourceTradeCompetencyForResourceCollection", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "description": "Resource 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 Resource Trade Competency collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceTradeCompetencyForResourceCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/Competencies/Lookups/LookupResourceTradeCompetencyChangePermissionTree": { "get": { "tags": [ "Resource Trade Competency" ], "summary": "Lookup the permission set for changing the Resource Trade Competency.", "description": "", "operationId": "LookupResourceTradeCompetencyChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceTradeCompetencyChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/Competencies/Lookups/LookupResourceTradeCompetencyInsertPermissionTree": { "get": { "tags": [ "Resource Trade Competency" ], "summary": "Lookup the permission set for creating the Resource Trade Competency.", "description": "", "operationId": "LookupResourceTradeCompetencyInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceTradeCompetencyInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/Competencies/Lookups/LookupResourceTradeCompetencyResource": { "get": { "tags": [ "Resource Trade Competency" ], "summary": "Lookup the Resource for the Resource Trade Competency.", "description": "", "operationId": "LookupResourceTradeCompetencyResource", "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 Resource collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceTradeCompetencyResourceLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/Competencies/Lookups/LookupResourceTradeCompetencyTradeCompetency": { "get": { "tags": [ "Resource Trade Competency" ], "summary": "Lookup the Trade Competency for the Resource Trade Competency.", "description": "", "operationId": "LookupResourceTradeCompetencyTradeCompetency", "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 Trade Competency collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceTradeCompetencyTradeCompetencyLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/Competencies/Batch/{ids}": { "get": { "tags": [ "Resource Trade Competency" ], "summary": "Get a collection of Resource Trade Competency resources for the set of id's.", "description": "", "operationId": "BatchGetResourceTradeCompetency", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Resource Trade Competency id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Trade Competency collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetResourceTradeCompetencyResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/Competencies/Batch": { "post": { "tags": [ "Resource Trade Competency" ], "summary": "Create a new collection of Resource Trade Competency resources.", "description": "", "operationId": "BatchCreateResourceTradeCompetency", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateResourceTradeCompetencyResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Resource Trade Competency batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Trade Competency" ], "summary": "Update a collection of existing Resource Trade Competency resources.", "description": "", "operationId": "BatchUpdateResourceTradeCompetency", "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/BatchUpdateResourceTradeCompetencyResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Trade Competency batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Trade Competency" ], "summary": "Delete a collection of existing Resource Trade Competency resources.", "description": "", "operationId": "BatchDeleteResourceTradeCompetency", "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/BatchDeleteResourceTradeCompetencyResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Trade Competency batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/Competencies/{id}/Active": { "patch": { "tags": [ "Resource Trade Competency" ], "summary": "Change the IsActive status for an existing Resource Trade Competency resource.", "description": "", "operationId": "ChangeResourceTradeCompetencyIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade Competency 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/ChangeResourceTradeCompetencyIsActiveResourceActionRequest" } } }, "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/RES/Resources/Trades/Competencies/{id}/PermissionTree": { "patch": { "tags": [ "Resource Trade Competency" ], "summary": "Change the PermissionTree for an existing Resource Trade Competency resource.", "description": "", "operationId": "ChangeResourceTradeCompetencyPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade Competency 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/ChangeResourceTradeCompetencyPermissionTreeResourceActionRequest" } } }, "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/RES/Resources/Trades/Competencies/Batch/Active": { "patch": { "tags": [ "Resource Trade Competency" ], "summary": "Change the IsActive status for a collection of existing Resource Trade Competency resources.", "description": "", "operationId": "BatchChangeResourceTradeCompetencyIsActive", "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/BatchChangeResourceTradeCompetencyIsActiveResourceActionRequest" } } }, "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/RES/Resources/Trades/Competencies/Batch/PermissionTree": { "patch": { "tags": [ "Resource Trade Competency" ], "summary": "Change the PermissionTree status for a collection of existing Resource Trade Competency resources.", "description": "", "operationId": "BatchChangeResourceTradeCompetencyPermissionTree", "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/BatchChangeResourceTradeCompetencyPermissionTreeResourceActionRequest" } } }, "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/RES/Resources/Trades/FinancialRates/{id}": { "get": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Get a Resource Trade Financial Rate resource.", "description": "", "operationId": "GetResourceTradeFinancialRate", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade Financial Rate Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Trade Financial Rate", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetResourceTradeFinancialRateResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Update an existing Resource Trade Financial Rate resource.", "description": "", "operationId": "UpdateResourceTradeFinancialRate", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade Financial Rate 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/UpdateResourceTradeFinancialRateResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Trade Financial Rate was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Delete an existing Resource Trade Financial Rate resource.", "description": "", "operationId": "DeleteResourceTradeFinancialRate", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade Financial Rate Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteResourceTradeFinancialRateResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Resource Trade Financial Rate was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/FinancialRates": { "get": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Get a collection of Resource Trade Financial Rate resources.", "description": "", "operationId": "GetResourceTradeFinancialRateCollection", "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 Resource Trade Financial Rate collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceTradeFinancialRateCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Create a new Resource Trade Financial Rate resource.", "description": "", "operationId": "CreateResourceTradeFinancialRate", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateResourceTradeFinancialRateResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/{id}/Trades/FinancialRates": { "get": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Get a collection of Resource Trade Financial Rate resources for the Resource.", "description": "", "operationId": "GetResourceTradeFinancialRateForResourceCollection", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource 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 Resource Trade Financial Rate collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceTradeFinancialRateForResourceCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/{resourceTradeId}/FinancialRates": { "get": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Get a collection of Resource Trade Financial Rate resources for the Resource Trade.", "description": "", "operationId": "GetResourceTradeFinancialRateForResourceTradeCollection", "parameters": [ { "name": "resourceTradeId", "in": "path", "required": true, "description": "Resource Trade 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 Resource Trade Financial Rate collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetResourceTradeFinancialRateForResourceTradeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/FinancialRates/Lookups/LookupResourceTradeFinancialRateChangePermissionTree": { "get": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Lookup the permission set for changing the Resource Trade Financial Rate.", "description": "", "operationId": "LookupResourceTradeFinancialRateChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceTradeFinancialRateChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/FinancialRates/Lookups/LookupResourceTradeFinancialRateCostElement": { "get": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Lookup the Cost Element for the Resource Trade Financial Rate.", "description": "", "operationId": "LookupResourceTradeFinancialRateCostElement", "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 Cost Element collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceTradeFinancialRateCostElementLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/FinancialRates/Lookups/LookupResourceTradeFinancialRateCurrency": { "get": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Lookup the Currency for the Resource Trade Financial Rate.", "description": "", "operationId": "LookupResourceTradeFinancialRateCurrency", "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 Currency collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceTradeFinancialRateCurrencyLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/FinancialRates/Lookups/LookupResourceTradeFinancialRateInsertPermissionTree": { "get": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Lookup the permission set for creating the Resource Trade Financial Rate.", "description": "", "operationId": "LookupResourceTradeFinancialRateInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceTradeFinancialRateInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/FinancialRates/Lookups/LookupResourceTradeFinancialRateResource": { "get": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Lookup the Resource Trade for the Resource Trade Financial Rate.", "description": "", "operationId": "LookupResourceTradeFinancialRateResource", "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 Resource collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceTradeFinancialRateResourceLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/FinancialRates/Lookups/LookupResourceTradeFinancialRateResourceTrade": { "get": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Lookup the Resource Trade for the Resource Trade Financial Rate.", "description": "", "operationId": "LookupResourceTradeFinancialRateResourceTrade", "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 Resource Trade collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceTradeFinancialRateResourceTradeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/FinancialRates/Lookups/LookupResourceTradeFinancialRateUnitOfMeasurement": { "get": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Lookup the Unit Of Measurement for the Resource Trade Financial Rate.", "description": "", "operationId": "LookupResourceTradeFinancialRateUnitOfMeasurement", "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 Unit Of Measurement collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/ResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/FinancialRates/Batch/{ids}": { "get": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Get a collection of Resource Trade Financial Rate resources for the set of id's.", "description": "", "operationId": "BatchGetResourceTradeFinancialRate", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Resource Trade Financial Rate id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Resource Trade Financial Rate collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetResourceTradeFinancialRateResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/FinancialRates/Batch": { "post": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Create a new collection of Resource Trade Financial Rate resources.", "description": "", "operationId": "BatchCreateResourceTradeFinancialRate", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateResourceTradeFinancialRateResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Resource Trade Financial Rate batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Update a collection of existing Resource Trade Financial Rate resources.", "description": "", "operationId": "BatchUpdateResourceTradeFinancialRate", "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/BatchUpdateResourceTradeFinancialRateResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Trade Financial Rate batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Delete a collection of existing Resource Trade Financial Rate resources.", "description": "", "operationId": "BatchDeleteResourceTradeFinancialRate", "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/BatchDeleteResourceTradeFinancialRateResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Resource Trade Financial Rate batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Resources/Trades/FinancialRates/{id}/Active": { "patch": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Change the IsActive status for an existing Resource Trade Financial Rate resource.", "description": "", "operationId": "ChangeResourceTradeFinancialRateIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade Financial Rate 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/ChangeResourceTradeFinancialRateIsActiveResourceActionRequest" } } }, "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/RES/Resources/Trades/FinancialRates/{id}/PermissionTree": { "patch": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Change the PermissionTree for an existing Resource Trade Financial Rate resource.", "description": "", "operationId": "ChangeResourceTradeFinancialRatePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade Financial Rate 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/ChangeResourceTradeFinancialRatePermissionTreeResourceActionRequest" } } }, "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/RES/Resources/Trades/FinancialRates/{id}/Customise": { "patch": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Customise the Resource Trade Financial Rate.", "description": "", "operationId": "Customise", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade Financial Rate 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/CustomiseResourceTradeFinancialRateResourceActionRequest" } } }, "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/RES/Resources/Trades/FinancialRates/{id}/Reset": { "patch": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Reset the Resource Trade Financial Rate.", "description": "", "operationId": "Reset", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Resource Trade Financial Rate 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/ResetResourceTradeFinancialRateResourceActionRequest" } } }, "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/RES/Resources/Trades/FinancialRates/Batch/Active": { "patch": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Change the IsActive status for a collection of existing Resource Trade Financial Rate resources.", "description": "", "operationId": "BatchChangeResourceTradeFinancialRateIsActive", "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/BatchChangeResourceTradeFinancialRateIsActiveResourceActionRequest" } } }, "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/RES/Resources/Trades/FinancialRates/Batch/PermissionTree": { "patch": { "tags": [ "Resource Trade Financial Rate" ], "summary": "Change the PermissionTree status for a collection of existing Resource Trade Financial Rate resources.", "description": "", "operationId": "BatchChangeResourceTradeFinancialRatePermissionTree", "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/BatchChangeResourceTradeFinancialRatePermissionTreeResourceActionRequest" } } }, "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/RES/Sections/{id}": { "get": { "tags": [ "Section" ], "summary": "Get a Section resource.", "description": "", "operationId": "GetSection", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Section", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetSectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Section" ], "summary": "Update an existing Section resource.", "description": "", "operationId": "UpdateSection", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section 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/UpdateSectionResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Section was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Section" ], "summary": "Delete an existing Section resource.", "description": "", "operationId": "DeleteSection", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteSectionResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Section was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections": { "get": { "tags": [ "Section" ], "summary": "Get a collection of Section resources.", "description": "", "operationId": "GetSectionCollection", "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 Section collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetSectionCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Section" ], "summary": "Create a new Section resource.", "description": "", "operationId": "CreateSection", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateSectionResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Lookups/LookupSectionChangePermissionTree": { "get": { "tags": [ "Section" ], "summary": "Lookup the permission set for changing the Section.", "description": "", "operationId": "LookupSectionChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/SectionChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Lookups/LookupSectionInsertPermissionTree": { "get": { "tags": [ "Section" ], "summary": "Lookup the permission set for creating the Section.", "description": "", "operationId": "LookupSectionInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/SectionInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Lookups/LookupSectionSite": { "get": { "tags": [ "Section" ], "summary": "Lookup the Site for the Section.", "description": "", "operationId": "LookupSectionSite", "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 Site collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/SectionSiteLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Lookups/LookupSectionSupplier": { "get": { "tags": [ "Section" ], "summary": "Lookup the Supplier for the Section.", "description": "", "operationId": "LookupSectionSupplier", "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 Supplier collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/SectionSupplierLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Batch/{ids}": { "get": { "tags": [ "Section" ], "summary": "Get a collection of Section resources for the set of id's.", "description": "", "operationId": "BatchGetSection", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Section id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Section collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetSectionResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Batch": { "post": { "tags": [ "Section" ], "summary": "Create a new collection of Section resources.", "description": "", "operationId": "BatchCreateSection", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateSectionResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Section batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Section" ], "summary": "Update a collection of existing Section resources.", "description": "", "operationId": "BatchUpdateSection", "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/BatchUpdateSectionResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Section batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Section" ], "summary": "Delete a collection of existing Section resources.", "description": "", "operationId": "BatchDeleteSection", "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/BatchDeleteSectionResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Section batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/{id}/Active": { "patch": { "tags": [ "Section" ], "summary": "Change the IsActive status for an existing Section resource.", "description": "", "operationId": "ChangeSectionIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section 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/ChangeSectionIsActiveResourceActionRequest" } } }, "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/RES/Sections/{id}/PermissionTree": { "patch": { "tags": [ "Section" ], "summary": "Change the PermissionTree for an existing Section resource.", "description": "", "operationId": "ChangeSectionPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section 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/ChangeSectionPermissionTreeResourceActionRequest" } } }, "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/RES/Sections/Batch/Active": { "patch": { "tags": [ "Section" ], "summary": "Change the IsActive status for a collection of existing Section resources.", "description": "", "operationId": "BatchChangeSectionIsActive", "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/BatchChangeSectionIsActiveResourceActionRequest" } } }, "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/RES/Sections/Batch/PermissionTree": { "patch": { "tags": [ "Section" ], "summary": "Change the PermissionTree status for a collection of existing Section resources.", "description": "", "operationId": "BatchChangeSectionPermissionTree", "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/BatchChangeSectionPermissionTreeResourceActionRequest" } } }, "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/RES/Sections/Attributes/{id}": { "get": { "tags": [ "Section Attribute" ], "summary": "Get a Section Attribute resource.", "description": "", "operationId": "GetSectionAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Section Attribute", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetSectionAttributeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Section Attribute" ], "summary": "Update an existing Section Attribute resource.", "description": "", "operationId": "UpdateSectionAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section Attribute 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/UpdateSectionAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Section Attribute was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Section Attribute" ], "summary": "Delete an existing Section Attribute resource.", "description": "", "operationId": "DeleteSectionAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteSectionAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Section Attribute was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/{sectionId}/Attributes": { "get": { "tags": [ "Section Attribute" ], "summary": "Get a collection of Section Attribute resources for the Section.", "description": "", "operationId": "GetSectionAttributeCollectionForSection", "parameters": [ { "name": "sectionId", "in": "path", "required": true, "description": "Section 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 Section Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetSectionAttributeCollectionForSectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Attributes": { "get": { "tags": [ "Section Attribute" ], "summary": "Get a collection of Section Attribute resources.", "description": "", "operationId": "GetSectionAttributeCollection", "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 Section Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetSectionAttributeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Section Attribute" ], "summary": "Create a new Section Attribute resource.", "description": "", "operationId": "CreateSectionAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateSectionAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Attributes/Lookups/LookupSectionAttributeAllowedValue": { "get": { "tags": [ "Section Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Section Attribute.", "description": "", "operationId": "LookupSectionAttributeAllowedValue", "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 Attribute Allowed Value collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/SectionAttributeAttributeAllowedValueLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Attributes/Lookups/LookupSectionAttribute": { "get": { "tags": [ "Section Attribute" ], "summary": "Section Attribute", "description": "", "operationId": "LookupSectionAttribute", "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 Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/SectionAttributeAttributeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Attributes/Lookups/LookupSectionAttributeChangePermissionTree": { "get": { "tags": [ "Section Attribute" ], "summary": "Lookup the permission set for changing the Section Attribute.", "description": "", "operationId": "LookupSectionAttributeChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/SectionAttributeChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Attributes/Lookups/LookupSectionAttributeInsertPermissionTree": { "get": { "tags": [ "Section Attribute" ], "summary": "Lookup the permission set for creating the Section Attribute.", "description": "", "operationId": "LookupSectionAttributeInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/SectionAttributeInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Attributes/Lookups/LookupSectionAttributeSection": { "get": { "tags": [ "Section Attribute" ], "summary": "Lookup the Section Attribute for the Section Attribute.", "description": "", "operationId": "LookupSectionAttributeSection", "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 Section collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/SectionAttributeSectionLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Attributes/Batch/{ids}": { "get": { "tags": [ "Section Attribute" ], "summary": "Get a collection of Section Attribute resources for the set of id's.", "description": "", "operationId": "BatchGetSectionAttribute", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Section Attribute id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Section Attribute collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetSectionAttributeResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Attributes/Batch": { "post": { "tags": [ "Section Attribute" ], "summary": "Create a new collection of Section Attribute resources.", "description": "", "operationId": "BatchCreateSectionAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateSectionAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Section Attribute batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Section Attribute" ], "summary": "Update a collection of existing Section Attribute resources.", "description": "", "operationId": "BatchUpdateSectionAttribute", "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/BatchUpdateSectionAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Section Attribute batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Section Attribute" ], "summary": "Delete a collection of existing Section Attribute resources.", "description": "", "operationId": "BatchDeleteSectionAttribute", "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/BatchDeleteSectionAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Section Attribute batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Attributes/{id}/Active": { "patch": { "tags": [ "Section Attribute" ], "summary": "Change the IsActive status for an existing Section Attribute resource.", "description": "", "operationId": "ChangeSectionAttributeIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section Attribute 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/ChangeSectionAttributeIsActiveResourceActionRequest" } } }, "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/RES/Sections/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Section Attribute" ], "summary": "Change the PermissionTree for an existing Section Attribute resource.", "description": "", "operationId": "ChangeSectionAttributePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section Attribute 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/ChangeSectionAttributePermissionTreeResourceActionRequest" } } }, "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/RES/Sections/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Section Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Section Attribute resources.", "description": "", "operationId": "BatchChangeSectionAttributePermissionTree", "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/BatchChangeSectionAttributePermissionTreeResourceActionRequest" } } }, "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/RES/Sections/Attributes/Batch/Active": { "patch": { "tags": [ "Section Attribute" ], "summary": "Change the IsActive status for a collection of existing Section Attribute resources.", "description": "", "operationId": "BatchChangeSectionAttributeIsActive", "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/BatchChangeSectionAttributeIsActiveResourceActionRequest" } } }, "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/RES/Sections/Documents/{id}": { "get": { "tags": [ "Section Document" ], "summary": "Get a Section Document resource.", "description": "", "operationId": "GetSectionDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Section Document", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetSectionDocumentResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Section Document" ], "summary": "Update an existing Section Document resource.", "description": "", "operationId": "UpdateSectionDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section Document 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/UpdateSectionDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Section Document was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Section Document" ], "summary": "Delete an existing Section Document resource.", "description": "", "operationId": "DeleteSectionDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteSectionDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Section Document was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/{id}/Documents": { "get": { "tags": [ "Section Document" ], "summary": "Get a collection of Section Document resources for the Section.", "description": "", "operationId": "GetSectionDocumentCollectionForSection", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section 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 Section Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetSectionDocumentCollectionForSectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Documents": { "get": { "tags": [ "Section Document" ], "summary": "Get a collection of Section Document resources.", "description": "", "operationId": "GetSectionDocumentCollection", "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 Section Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetSectionDocumentCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Section Document" ], "summary": "Create a new Section Document resource.", "description": "", "operationId": "CreateSectionDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateSectionDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Documents/Lookups/LookupSectionDocumentChangePermissionTree": { "get": { "tags": [ "Section Document" ], "summary": "Lookup the permission set for changing the Section Document.", "description": "", "operationId": "LookupSectionDocumentChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/SectionDocumentChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Documents/Lookups/LookupSectionDocument": { "get": { "tags": [ "Section Document" ], "summary": "Section Document", "description": "", "operationId": "LookupSectionDocument", "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 Document Record collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/SectionDocumentDocumentLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Documents/Lookups/LookupSectionDocumentInsertPermissionTree": { "get": { "tags": [ "Section Document" ], "summary": "Lookup the permission set for creating the Section Document.", "description": "", "operationId": "LookupSectionDocumentInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/SectionDocumentInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Documents/Lookups/LookupSectionDocumentSection": { "get": { "tags": [ "Section Document" ], "summary": "Lookup the Section Document for the Section Document.", "description": "", "operationId": "LookupSectionDocumentSection", "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 Section collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/SectionDocumentSectionLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Documents/Batch/{ids}": { "get": { "tags": [ "Section Document" ], "summary": "Get a collection of Section Document resources for the set of id's.", "description": "", "operationId": "BatchGetSectionDocument", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Section Document id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Section Document collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetSectionDocumentResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Documents/Batch": { "post": { "tags": [ "Section Document" ], "summary": "Create a new collection of Section Document resources.", "description": "", "operationId": "BatchCreateSectionDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateSectionDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Section Document batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Section Document" ], "summary": "Update a collection of existing Section Document resources.", "description": "", "operationId": "BatchUpdateSectionDocument", "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/BatchUpdateSectionDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Section Document batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Section Document" ], "summary": "Delete a collection of existing Section Document resources.", "description": "", "operationId": "BatchDeleteSectionDocument", "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/BatchDeleteSectionDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Section Document batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Documents/{id}/Active": { "patch": { "tags": [ "Section Document" ], "summary": "Change the IsActive status for an existing Section Document resource.", "description": "", "operationId": "ChangeSectionDocumentIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section Document 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/ChangeSectionDocumentIsActiveResourceActionRequest" } } }, "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/RES/Sections/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Section Document" ], "summary": "Change the PermissionTree for an existing Section Document resource.", "description": "", "operationId": "ChangeSectionDocumentPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section Document 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/ChangeSectionDocumentPermissionTreeResourceActionRequest" } } }, "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/RES/Sections/Documents/Batch/Active": { "patch": { "tags": [ "Section Document" ], "summary": "Change the IsActive status for a collection of existing Section Document resources.", "description": "", "operationId": "BatchChangeSectionDocumentIsActive", "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/BatchChangeSectionDocumentIsActiveResourceActionRequest" } } }, "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/RES/Sections/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Section Document" ], "summary": "Change the PermissionTree status for a collection of existing Section Document resources.", "description": "", "operationId": "BatchChangeSectionDocumentPermissionTree", "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/BatchChangeSectionDocumentPermissionTreeResourceActionRequest" } } }, "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/RES/Sections/Trades/{id}": { "get": { "tags": [ "Section Trade" ], "summary": "Get a Section Trade resource.", "description": "", "operationId": "GetSectionTrade", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section Trade Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Section Trade", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetSectionTradeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Section Trade" ], "summary": "Update an existing Section Trade resource.", "description": "", "operationId": "UpdateSectionTrade", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section Trade 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/UpdateSectionTradeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Section Trade was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Section Trade" ], "summary": "Delete an existing Section Trade resource.", "description": "", "operationId": "DeleteSectionTrade", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section Trade Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteSectionTradeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Section Trade was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Trades": { "get": { "tags": [ "Section Trade" ], "summary": "Get a collection of Section Trade resources.", "description": "", "operationId": "GetSectionTradeCollection", "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 Section Trade collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetSectionTradeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Section Trade" ], "summary": "Create a new Section Trade resource.", "description": "", "operationId": "CreateSectionTrade", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateSectionTradeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/{sectionId}/Trades": { "get": { "tags": [ "Section Trade" ], "summary": "Get a collection of Section Trade resources for the Section.", "description": "", "operationId": "GetSectionTradeForSectionCollection", "parameters": [ { "name": "sectionId", "in": "path", "required": true, "description": "Section 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 Section Trade collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetSectionTradeForSectionCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Trades/Lookups/LookupSectionTradeChangePermissionTree": { "get": { "tags": [ "Section Trade" ], "summary": "Lookup the permission set for changing the Section Trade.", "description": "", "operationId": "LookupSectionTradeChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/SectionTradeChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Trades/Lookups/LookupSectionTradeInsertPermissionTree": { "get": { "tags": [ "Section Trade" ], "summary": "Lookup the permission set for creating the Section Trade.", "description": "", "operationId": "LookupSectionTradeInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/SectionTradeInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Trades/Lookups/LookupSectionTradeSection": { "get": { "tags": [ "Section Trade" ], "summary": "Lookup the Section for the Section Trade.", "description": "", "operationId": "LookupSectionTradeSection", "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 Section collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/SectionTradeSectionLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Trades/Lookups/LookupSectionTradeTrade": { "get": { "tags": [ "Section Trade" ], "summary": "Lookup the Trade for the Section Trade.", "description": "", "operationId": "LookupSectionTradeTrade", "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 Trade collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/SectionTradeTradeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Trades/Batch/{ids}": { "get": { "tags": [ "Section Trade" ], "summary": "Get a collection of Section Trade resources for the set of id's.", "description": "", "operationId": "BatchGetSectionTrade", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Section Trade id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Section Trade collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetSectionTradeResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Trades/Batch": { "post": { "tags": [ "Section Trade" ], "summary": "Create a new collection of Section Trade resources.", "description": "", "operationId": "BatchCreateSectionTrade", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateSectionTradeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Section Trade batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Section Trade" ], "summary": "Update a collection of existing Section Trade resources.", "description": "", "operationId": "BatchUpdateSectionTrade", "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/BatchUpdateSectionTradeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Section Trade batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Section Trade" ], "summary": "Delete a collection of existing Section Trade resources.", "description": "", "operationId": "BatchDeleteSectionTrade", "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/BatchDeleteSectionTradeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Section Trade batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Sections/Trades/{id}/Active": { "patch": { "tags": [ "Section Trade" ], "summary": "Change the IsActive status for an existing Section Trade resource.", "description": "", "operationId": "ChangeSectionTradeIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section Trade 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/ChangeSectionTradeIsActiveResourceActionRequest" } } }, "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/RES/Sections/Trades/{id}/PermissionTree": { "patch": { "tags": [ "Section Trade" ], "summary": "Change the PermissionTree for an existing Section Trade resource.", "description": "", "operationId": "ChangeSectionTradePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Section Trade 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/ChangeSectionTradePermissionTreeResourceActionRequest" } } }, "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/RES/Sections/Trades/Batch/Active": { "patch": { "tags": [ "Section Trade" ], "summary": "Change the IsActive status for a collection of existing Section Trade resources.", "description": "", "operationId": "BatchChangeSectionTradeIsActive", "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/BatchChangeSectionTradeIsActiveResourceActionRequest" } } }, "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/RES/Sections/Trades/Batch/PermissionTree": { "patch": { "tags": [ "Section Trade" ], "summary": "Change the PermissionTree status for a collection of existing Section Trade resources.", "description": "", "operationId": "BatchChangeSectionTradePermissionTree", "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/BatchChangeSectionTradePermissionTreeResourceActionRequest" } } }, "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/RES/Trades/{id}": { "get": { "tags": [ "Trade" ], "summary": "Get a Trade resource.", "description": "", "operationId": "GetTrade", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Trade", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetTradeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Trade" ], "summary": "Update an existing Trade resource.", "description": "", "operationId": "UpdateTrade", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade 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/UpdateTradeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Trade was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Trade" ], "summary": "Delete an existing Trade resource.", "description": "", "operationId": "DeleteTrade", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteTradeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Trade was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades": { "get": { "tags": [ "Trade" ], "summary": "Get a collection of Trade resources.", "description": "", "operationId": "GetTradeCollection", "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 Trade collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetTradeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Trade" ], "summary": "Create a new Trade resource.", "description": "", "operationId": "CreateTrade", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateTradeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Lookups/LookupTradeChangePermissionTree": { "get": { "tags": [ "Trade" ], "summary": "Lookup the permission set for changing the Trade.", "description": "", "operationId": "LookupTradeChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Lookups/LookupTradeDefaultTradeFinancialRate": { "get": { "tags": [ "Trade" ], "summary": "Lookup the Trade Financial Rate for the Trade.", "description": "", "operationId": "LookupTradeDefaultTradeFinancialRate", "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 Trade Financial Rate collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeDefaultTradeFinancialRateLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Lookups/LookupTradeInsertPermissionTree": { "get": { "tags": [ "Trade" ], "summary": "Lookup the permission set for creating the Trade.", "description": "", "operationId": "LookupTradeInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Batch/{ids}": { "get": { "tags": [ "Trade" ], "summary": "Get a collection of Trade resources for the set of id's.", "description": "", "operationId": "BatchGetTrade", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Trade id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Trade collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetTradeResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Batch": { "post": { "tags": [ "Trade" ], "summary": "Create a new collection of Trade resources.", "description": "", "operationId": "BatchCreateTrade", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateTradeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Trade batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Trade" ], "summary": "Update a collection of existing Trade resources.", "description": "", "operationId": "BatchUpdateTrade", "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/BatchUpdateTradeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Trade batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Trade" ], "summary": "Delete a collection of existing Trade resources.", "description": "", "operationId": "BatchDeleteTrade", "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/BatchDeleteTradeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Trade batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/{id}/Active": { "patch": { "tags": [ "Trade" ], "summary": "Change the IsActive status for an existing Trade resource.", "description": "", "operationId": "ChangeTradeIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade 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/ChangeTradeIsActiveResourceActionRequest" } } }, "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/RES/Trades/{id}/PermissionTree": { "patch": { "tags": [ "Trade" ], "summary": "Change the PermissionTree for an existing Trade resource.", "description": "", "operationId": "ChangeTradePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade 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/ChangeTradePermissionTreeResourceActionRequest" } } }, "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/RES/Trades/Batch/Active": { "patch": { "tags": [ "Trade" ], "summary": "Change the IsActive status for a collection of existing Trade resources.", "description": "", "operationId": "BatchChangeTradeIsActive", "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/BatchChangeTradeIsActiveResourceActionRequest" } } }, "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/RES/Trades/Batch/PermissionTree": { "patch": { "tags": [ "Trade" ], "summary": "Change the PermissionTree status for a collection of existing Trade resources.", "description": "", "operationId": "BatchChangeTradePermissionTree", "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/BatchChangeTradePermissionTreeResourceActionRequest" } } }, "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/RES/Trades/Attributes/{id}": { "get": { "tags": [ "Trade Attribute" ], "summary": "Get a Trade Attribute resource.", "description": "", "operationId": "GetTradeAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Trade Attribute", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetTradeAttributeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Trade Attribute" ], "summary": "Update an existing Trade Attribute resource.", "description": "", "operationId": "UpdateTradeAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Attribute 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/UpdateTradeAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Trade Attribute was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Trade Attribute" ], "summary": "Delete an existing Trade Attribute resource.", "description": "", "operationId": "DeleteTradeAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteTradeAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Trade Attribute was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/{tradeId}/Attributes": { "get": { "tags": [ "Trade Attribute" ], "summary": "Get a collection of Trade Attribute resources for the Trade.", "description": "", "operationId": "GetTradeAttributeCollectionForTrade", "parameters": [ { "name": "tradeId", "in": "path", "required": true, "description": "Trade 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 Trade Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetTradeAttributeCollectionForTradeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Attributes": { "get": { "tags": [ "Trade Attribute" ], "summary": "Get a collection of Trade Attribute resources.", "description": "", "operationId": "GetTradeAttributeCollection", "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 Trade Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetTradeAttributeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Trade Attribute" ], "summary": "Create a new Trade Attribute resource.", "description": "", "operationId": "CreateTradeAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateTradeAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Attributes/Lookups/LookupTradeAttributeAllowedValue": { "get": { "tags": [ "Trade Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Trade Attribute.", "description": "", "operationId": "LookupTradeAttributeAllowedValue", "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 Attribute Allowed Value collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeAttributeAttributeAllowedValueLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Attributes/Lookups/LookupTradeAttribute": { "get": { "tags": [ "Trade Attribute" ], "summary": "Trade Attribute", "description": "", "operationId": "LookupTradeAttribute", "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 Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeAttributeAttributeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Attributes/Lookups/LookupTradeAttributeChangePermissionTree": { "get": { "tags": [ "Trade Attribute" ], "summary": "Lookup the permission set for changing the Trade Attribute.", "description": "", "operationId": "LookupTradeAttributeChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeAttributeChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Attributes/Lookups/LookupTradeAttributeInsertPermissionTree": { "get": { "tags": [ "Trade Attribute" ], "summary": "Lookup the permission set for creating the Trade Attribute.", "description": "", "operationId": "LookupTradeAttributeInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeAttributeInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Attributes/Lookups/LookupTradeAttributeTrade": { "get": { "tags": [ "Trade Attribute" ], "summary": "Lookup the Trade Attribute for the Trade Attribute.", "description": "", "operationId": "LookupTradeAttributeTrade", "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 Trade collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeAttributeTradeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Attributes/Batch/{ids}": { "get": { "tags": [ "Trade Attribute" ], "summary": "Get a collection of Trade Attribute resources for the set of id's.", "description": "", "operationId": "BatchGetTradeAttribute", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Trade Attribute id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Trade Attribute collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetTradeAttributeResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Attributes/Batch": { "post": { "tags": [ "Trade Attribute" ], "summary": "Create a new collection of Trade Attribute resources.", "description": "", "operationId": "BatchCreateTradeAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateTradeAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Trade Attribute batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Trade Attribute" ], "summary": "Update a collection of existing Trade Attribute resources.", "description": "", "operationId": "BatchUpdateTradeAttribute", "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/BatchUpdateTradeAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Trade Attribute batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Trade Attribute" ], "summary": "Delete a collection of existing Trade Attribute resources.", "description": "", "operationId": "BatchDeleteTradeAttribute", "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/BatchDeleteTradeAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Trade Attribute batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Attributes/{id}/Active": { "patch": { "tags": [ "Trade Attribute" ], "summary": "Change the IsActive status for an existing Trade Attribute resource.", "description": "", "operationId": "ChangeTradeAttributeIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Attribute 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/ChangeTradeAttributeIsActiveResourceActionRequest" } } }, "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/RES/Trades/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Trade Attribute" ], "summary": "Change the PermissionTree for an existing Trade Attribute resource.", "description": "", "operationId": "ChangeTradeAttributePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Attribute 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/ChangeTradeAttributePermissionTreeResourceActionRequest" } } }, "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/RES/Trades/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Trade Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Trade Attribute resources.", "description": "", "operationId": "BatchChangeTradeAttributePermissionTree", "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/BatchChangeTradeAttributePermissionTreeResourceActionRequest" } } }, "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/RES/Trades/Attributes/Batch/Active": { "patch": { "tags": [ "Trade Attribute" ], "summary": "Change the IsActive status for a collection of existing Trade Attribute resources.", "description": "", "operationId": "BatchChangeTradeAttributeIsActive", "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/BatchChangeTradeAttributeIsActiveResourceActionRequest" } } }, "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/RES/Trades/Competencies/{id}": { "get": { "tags": [ "Trade Competency" ], "summary": "Get a Trade Competency resource.", "description": "", "operationId": "GetTradeCompetency", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Competency Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Trade Competency", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetTradeCompetencyResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Trade Competency" ], "summary": "Update an existing Trade Competency resource.", "description": "", "operationId": "UpdateTradeCompetency", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Competency 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/UpdateTradeCompetencyResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Trade Competency was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Trade Competency" ], "summary": "Delete an existing Trade Competency resource.", "description": "", "operationId": "DeleteTradeCompetency", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Competency Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteTradeCompetencyResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Trade Competency was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Competencies": { "get": { "tags": [ "Trade Competency" ], "summary": "Get a collection of Trade Competency resources.", "description": "", "operationId": "GetTradeCompetencyCollection", "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 Trade Competency collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetTradeCompetencyCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Trade Competency" ], "summary": "Create a new Trade Competency resource.", "description": "", "operationId": "CreateTradeCompetency", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateTradeCompetencyResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/{tradeId}/Competencies": { "get": { "tags": [ "Trade Competency" ], "summary": "Get a collection of Trade Competency resources for the Trade.", "description": "", "operationId": "GetTradeCompetencyForTradeCollection", "parameters": [ { "name": "tradeId", "in": "path", "required": true, "description": "Trade 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 Trade Competency collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetTradeCompetencyForTradeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Competencies/Lookups/LookupTradeCompetencyChangePermissionTree": { "get": { "tags": [ "Trade Competency" ], "summary": "Lookup the permission set for changing the Trade Competency.", "description": "", "operationId": "LookupTradeCompetencyChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeCompetencyChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Competencies/Lookups/LookupTradeCompetencyCompetency": { "get": { "tags": [ "Trade Competency" ], "summary": "Lookup the Competency for the Trade Competency.", "description": "", "operationId": "LookupTradeCompetencyCompetency", "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 Competency collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeCompetencyCompetencyLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Competencies/Lookups/LookupTradeCompetencyInsertPermissionTree": { "get": { "tags": [ "Trade Competency" ], "summary": "Lookup the permission set for creating the Trade Competency.", "description": "", "operationId": "LookupTradeCompetencyInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeCompetencyInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Competencies/Lookups/LookupTradeCompetencyTrade": { "get": { "tags": [ "Trade Competency" ], "summary": "Lookup the Trade for the Trade Competency.", "description": "", "operationId": "LookupTradeCompetencyTrade", "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 Trade collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeCompetencyTradeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Competencies/Batch/{ids}": { "get": { "tags": [ "Trade Competency" ], "summary": "Get a collection of Trade Competency resources for the set of id's.", "description": "", "operationId": "BatchGetTradeCompetency", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Trade Competency id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Trade Competency collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetTradeCompetencyResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Competencies/Batch": { "post": { "tags": [ "Trade Competency" ], "summary": "Create a new collection of Trade Competency resources.", "description": "", "operationId": "BatchCreateTradeCompetency", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateTradeCompetencyResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Trade Competency batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Trade Competency" ], "summary": "Update a collection of existing Trade Competency resources.", "description": "", "operationId": "BatchUpdateTradeCompetency", "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/BatchUpdateTradeCompetencyResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Trade Competency batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Trade Competency" ], "summary": "Delete a collection of existing Trade Competency resources.", "description": "", "operationId": "BatchDeleteTradeCompetency", "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/BatchDeleteTradeCompetencyResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Trade Competency batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Competencies/{id}/Active": { "patch": { "tags": [ "Trade Competency" ], "summary": "Change the IsActive status for an existing Trade Competency resource.", "description": "", "operationId": "ChangeTradeCompetencyIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Competency 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/ChangeTradeCompetencyIsActiveResourceActionRequest" } } }, "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/RES/Trades/Competencies/{id}/PermissionTree": { "patch": { "tags": [ "Trade Competency" ], "summary": "Change the PermissionTree for an existing Trade Competency resource.", "description": "", "operationId": "ChangeTradeCompetencyPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Competency 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/ChangeTradeCompetencyPermissionTreeResourceActionRequest" } } }, "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/RES/Trades/Competencies/Batch/Active": { "patch": { "tags": [ "Trade Competency" ], "summary": "Change the IsActive status for a collection of existing Trade Competency resources.", "description": "", "operationId": "BatchChangeTradeCompetencyIsActive", "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/BatchChangeTradeCompetencyIsActiveResourceActionRequest" } } }, "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/RES/Trades/Competencies/Batch/PermissionTree": { "patch": { "tags": [ "Trade Competency" ], "summary": "Change the PermissionTree status for a collection of existing Trade Competency resources.", "description": "", "operationId": "BatchChangeTradeCompetencyPermissionTree", "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/BatchChangeTradeCompetencyPermissionTreeResourceActionRequest" } } }, "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/RES/Trades/Documents/{id}": { "get": { "tags": [ "Trade Document" ], "summary": "Get a Trade Document resource.", "description": "", "operationId": "GetTradeDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Trade Document", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetTradeDocumentResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Trade Document" ], "summary": "Update an existing Trade Document resource.", "description": "", "operationId": "UpdateTradeDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Document 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/UpdateTradeDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Trade Document was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Trade Document" ], "summary": "Delete an existing Trade Document resource.", "description": "", "operationId": "DeleteTradeDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteTradeDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Trade Document was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/{id}/Documents": { "get": { "tags": [ "Trade Document" ], "summary": "Get a collection of Trade Document resources for the Trade.", "description": "", "operationId": "GetTradeDocumentCollectionForTrade", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade 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 Trade Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetTradeDocumentCollectionForTradeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Documents": { "get": { "tags": [ "Trade Document" ], "summary": "Get a collection of Trade Document resources.", "description": "", "operationId": "GetTradeDocumentCollection", "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 Trade Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetTradeDocumentCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Trade Document" ], "summary": "Create a new Trade Document resource.", "description": "", "operationId": "CreateTradeDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateTradeDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Documents/Lookups/LookupTradeDocumentChangePermissionTree": { "get": { "tags": [ "Trade Document" ], "summary": "Lookup the permission set for changing the Trade Document.", "description": "", "operationId": "LookupTradeDocumentChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeDocumentChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Documents/Lookups/LookupTradeDocument": { "get": { "tags": [ "Trade Document" ], "summary": "Trade Document", "description": "", "operationId": "LookupTradeDocument", "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 Document Record collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeDocumentDocumentLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Documents/Lookups/LookupTradeDocumentInsertPermissionTree": { "get": { "tags": [ "Trade Document" ], "summary": "Lookup the permission set for creating the Trade Document.", "description": "", "operationId": "LookupTradeDocumentInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeDocumentInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Documents/Lookups/LookupTradeDocumentTrade": { "get": { "tags": [ "Trade Document" ], "summary": "Lookup the Trade Document for the Trade Document.", "description": "", "operationId": "LookupTradeDocumentTrade", "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 Trade collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeDocumentTradeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Documents/Batch/{ids}": { "get": { "tags": [ "Trade Document" ], "summary": "Get a collection of Trade Document resources for the set of id's.", "description": "", "operationId": "BatchGetTradeDocument", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Trade Document id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Trade Document collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetTradeDocumentResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Documents/Batch": { "post": { "tags": [ "Trade Document" ], "summary": "Create a new collection of Trade Document resources.", "description": "", "operationId": "BatchCreateTradeDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateTradeDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Trade Document batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Trade Document" ], "summary": "Update a collection of existing Trade Document resources.", "description": "", "operationId": "BatchUpdateTradeDocument", "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/BatchUpdateTradeDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Trade Document batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Trade Document" ], "summary": "Delete a collection of existing Trade Document resources.", "description": "", "operationId": "BatchDeleteTradeDocument", "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/BatchDeleteTradeDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Trade Document batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/Documents/{id}/Active": { "patch": { "tags": [ "Trade Document" ], "summary": "Change the IsActive status for an existing Trade Document resource.", "description": "", "operationId": "ChangeTradeDocumentIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Document 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/ChangeTradeDocumentIsActiveResourceActionRequest" } } }, "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/RES/Trades/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Trade Document" ], "summary": "Change the PermissionTree for an existing Trade Document resource.", "description": "", "operationId": "ChangeTradeDocumentPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Document 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/ChangeTradeDocumentPermissionTreeResourceActionRequest" } } }, "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/RES/Trades/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Trade Document" ], "summary": "Change the PermissionTree status for a collection of existing Trade Document resources.", "description": "", "operationId": "BatchChangeTradeDocumentPermissionTree", "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/BatchChangeTradeDocumentPermissionTreeResourceActionRequest" } } }, "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/RES/Trades/Documents/Batch/Active": { "patch": { "tags": [ "Trade Document" ], "summary": "Change the IsActive status for a collection of existing Trade Document resources.", "description": "", "operationId": "BatchChangeTradeDocumentIsActive", "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/BatchChangeTradeDocumentIsActiveResourceActionRequest" } } }, "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/RES/Trades/FinancialRates/{id}": { "get": { "tags": [ "Trade Financial Rate" ], "summary": "Get a Trade Financial Rate resource.", "description": "", "operationId": "GetTradeFinancialRate", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Financial Rate Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Trade Financial Rate", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetTradeFinancialRateResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Trade Financial Rate" ], "summary": "Update an existing Trade Financial Rate resource.", "description": "", "operationId": "UpdateTradeFinancialRate", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Financial Rate 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/UpdateTradeFinancialRateResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Trade Financial Rate was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Trade Financial Rate" ], "summary": "Delete an existing Trade Financial Rate resource.", "description": "", "operationId": "DeleteTradeFinancialRate", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Financial Rate Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteTradeFinancialRateResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Trade Financial Rate was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/FinancialRates": { "get": { "tags": [ "Trade Financial Rate" ], "summary": "Get a collection of Trade Financial Rate resources.", "description": "", "operationId": "GetTradeFinancialRateCollection", "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 Trade Financial Rate collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetTradeFinancialRateCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Trade Financial Rate" ], "summary": "Create a new Trade Financial Rate resource.", "description": "", "operationId": "CreateTradeFinancialRate", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateTradeFinancialRateResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/{tradeId}/FinancialRates": { "get": { "tags": [ "Trade Financial Rate" ], "summary": "Get a collection of Trade Financial Rate resources for the Trade.", "description": "", "operationId": "GetTradeFinancialRateForTradeCollection", "parameters": [ { "name": "tradeId", "in": "path", "required": true, "description": "Trade 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 Trade Financial Rate collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetTradeFinancialRateForTradeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/FinancialRates/Lookups/LookupTradeFinancialRateChangePermissionTree": { "get": { "tags": [ "Trade Financial Rate" ], "summary": "Lookup the permission set for changing the Trade Financial Rate.", "description": "", "operationId": "LookupTradeFinancialRateChangePermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeFinancialRateChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/FinancialRates/Lookups/LookupTradeFinancialRateCurrency": { "get": { "tags": [ "Trade Financial Rate" ], "summary": "Lookup the Currency for the Trade Financial Rate.", "description": "", "operationId": "LookupTradeFinancialRateCurrency", "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 Currency collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeFinancialRateCurrencyLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/FinancialRates/Lookups/LookupTradeFinancialRateInsertPermissionTree": { "get": { "tags": [ "Trade Financial Rate" ], "summary": "Lookup the permission set for creating the Trade Financial Rate.", "description": "", "operationId": "LookupTradeFinancialRateInsertPermissionTree", "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 collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeFinancialRateInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/FinancialRates/Lookups/LookupTradeFinancialRateTrade": { "get": { "tags": [ "Trade Financial Rate" ], "summary": "Lookup the Trade for the Trade Financial Rate.", "description": "", "operationId": "LookupTradeFinancialRateTrade", "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 Trade collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeFinancialRateTradeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/FinancialRates/Lookups/LookupTradeFinancialRateUnitOfMeasurement": { "get": { "tags": [ "Trade Financial Rate" ], "summary": "Lookup the Unit Of Measurement for the Trade Financial Rate.", "description": "", "operationId": "LookupTradeFinancialRateUnitOfMeasurement", "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 Unit Of Measurement collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TradeFinancialRateUnitOfMeasurementLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/FinancialRates/Batch/{ids}": { "get": { "tags": [ "Trade Financial Rate" ], "summary": "Get a collection of Trade Financial Rate resources for the set of id's.", "description": "", "operationId": "BatchGetTradeFinancialRate", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Trade Financial Rate id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Trade Financial Rate collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetTradeFinancialRateResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/FinancialRates/Batch": { "post": { "tags": [ "Trade Financial Rate" ], "summary": "Create a new collection of Trade Financial Rate resources.", "description": "", "operationId": "BatchCreateTradeFinancialRate", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateTradeFinancialRateResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Trade Financial Rate batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Trade Financial Rate" ], "summary": "Update a collection of existing Trade Financial Rate resources.", "description": "", "operationId": "BatchUpdateTradeFinancialRate", "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/BatchUpdateTradeFinancialRateResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Trade Financial Rate batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Trade Financial Rate" ], "summary": "Delete a collection of existing Trade Financial Rate resources.", "description": "", "operationId": "BatchDeleteTradeFinancialRate", "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/BatchDeleteTradeFinancialRateResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Trade Financial Rate batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/RES/Trades/FinancialRates/{id}/Active": { "patch": { "tags": [ "Trade Financial Rate" ], "summary": "Change the IsActive status for an existing Trade Financial Rate resource.", "description": "", "operationId": "ChangeTradeFinancialRateIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Financial Rate 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/ChangeTradeFinancialRateIsActiveResourceActionRequest" } } }, "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/RES/Trades/FinancialRates/{id}/PermissionTree": { "patch": { "tags": [ "Trade Financial Rate" ], "summary": "Change the PermissionTree for an existing Trade Financial Rate resource.", "description": "", "operationId": "ChangeTradeFinancialRatePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Trade Financial Rate 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/ChangeTradeFinancialRatePermissionTreeResourceActionRequest" } } }, "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/RES/Trades/FinancialRates/Batch/Active": { "patch": { "tags": [ "Trade Financial Rate" ], "summary": "Change the IsActive status for a collection of existing Trade Financial Rate resources.", "description": "", "operationId": "BatchChangeTradeFinancialRateIsActive", "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/BatchChangeTradeFinancialRateIsActiveResourceActionRequest" } } }, "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/RES/Trades/FinancialRates/Batch/PermissionTree": { "patch": { "tags": [ "Trade Financial Rate" ], "summary": "Change the PermissionTree status for a collection of existing Trade Financial Rate resources.", "description": "", "operationId": "BatchChangeTradeFinancialRatePermissionTree", "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/BatchChangeTradeFinancialRatePermissionTreeResourceActionRequest" } } }, "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/RES/Trades/FinancialRates/MatchBatch": { "patch": { "tags": [ "Trade Financial Rate" ], "summary": "Update a collection of existing Trade Financial Rate resources to have the same value(s).", "description": "", "operationId": "MatchUpdateTradeFinancialRate", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "matchUpdate", "description": "Request Body content", "content": { "application/vnd.onkey.entitymatchupdatecollection+json": { "schema": { "$ref": "#/components/schemas/MatchUpdateTradeFinancialRateResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Trade Financial Rate batch was successfully updated" }, "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" } } } }, "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" ] }, "GetCompetencyResourceActionResponse": { "title": "GetCompetencyResourceActionResponse", "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": "GetCompetencyResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Competency->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Competency->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Competency->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Competency->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Competency->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "Competency->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Competency->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Competency->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Competency->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Competency->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Competency->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "Competency->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "Competency->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Competency->Description" }, "isStrict": { "title": "isStrict", "type": "boolean", "nullable": false, "x-propertyPath": "Competency->IsStrict" }, "isTradeSpecific": { "title": "isTradeSpecific", "type": "boolean", "nullable": false, "x-propertyPath": "Competency->IsTradeSpecific" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Competency->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Competency->SequenceNumber" }, "validityType": { "title": "validityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Competency->ValidityType", "x-formatSpecifier": "CompetencyValidityType" } } }, "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" } } }, "GetCompetencyCollectionResourceActionResponse": { "title": "GetCompetencyCollectionResourceActionResponse", "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": "GetCompetencyCollectionResourceActionResponseItem", "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": "GetCompetencyCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Competency->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Competency->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Competency->SequenceNumber" }, "validityType": { "title": "validityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Competency->ValidityType", "x-formatSpecifier": "CompetencyValidityType" }, "isStrict": { "title": "isStrict", "type": "boolean", "nullable": false, "x-propertyPath": "Competency->IsStrict" }, "isTradeSpecific": { "title": "isTradeSpecific", "type": "boolean", "nullable": false, "x-propertyPath": "Competency->IsTradeSpecific" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Competency->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Competency->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Competency->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" } } } }, "CompetencyChangePermissionTreeLookupResourceActionResponse": { "title": "CompetencyChangePermissionTreeLookupResourceActionResponse", "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": "CompetencyChangePermissionTreeLookupResourceActionResponseItem", "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": "CompetencyChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "CompetencyInsertPermissionTreeLookupResourceActionResponse": { "title": "CompetencyInsertPermissionTreeLookupResourceActionResponse", "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": "CompetencyInsertPermissionTreeLookupResourceActionResponseItem", "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": "CompetencyInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "CreateCompetencyResourceActionRequest": { "title": "CreateCompetencyResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateCompetencyResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "permissionTreeId", "code", "description", "isTradeSpecific", "isStrict", "validityType" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Competency->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "Competency->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "Competency->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Competency->SequenceNumber" }, "isTradeSpecific": { "title": "isTradeSpecific", "type": "boolean", "nullable": false, "x-propertyPath": "Competency->IsTradeSpecific" }, "isStrict": { "title": "isStrict", "type": "boolean", "nullable": false, "x-propertyPath": "Competency->IsStrict" }, "validityType": { "title": "validityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Competency->ValidityType", "x-formatSpecifier": "CompetencyValidityType" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Competency->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "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 } } }, "UpdateCompetencyResourceActionRequest": { "title": "UpdateCompetencyResourceActionRequest", "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": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "Competency->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "Competency->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Competency->SequenceNumber" }, { "title": "isTradeSpecific", "type": "boolean", "nullable": false, "x-propertyPath": "Competency->IsTradeSpecific" }, { "title": "isStrict", "type": "boolean", "nullable": false, "x-propertyPath": "Competency->IsStrict" }, { "title": "validityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Competency->ValidityType", "x-formatSpecifier": "CompetencyValidityType" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Competency->Notes" } ] } } }, "DeleteCompetencyResourceActionRequest": { "title": "DeleteCompetencyResourceActionRequest", "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 } } }, "BatchGetCompetencyResourceAction": { "title": "BatchGetCompetencyResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Competency entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Competency entities", "items": { "$ref": "#/components/schemas/GetCompetencyResourceActionResponse" } }, "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" } } }, "BatchCreateCompetencyResourceActionRequest": { "title": "BatchCreateCompetencyResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateCompetencyResourceActionRequest" } }, "BatchUpdateCompetencyResourceActionRequest": { "title": "BatchUpdateCompetencyResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateCompetencyResourceActionRequest" } }, "BatchDeleteCompetencyResourceActionRequest": { "title": "BatchDeleteCompetencyResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteCompetencyResourceActionRequest" } }, "ChangeCompetencyIsActiveResourceActionRequest": { "title": "ChangeCompetencyIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "Competency->IsActive" } ] } } }, "ChangeCompetencyPermissionTreeResourceActionRequest": { "title": "ChangeCompetencyPermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Competency->PermissionTree_Id" } ] } } }, "BatchChangeCompetencyIsActiveResourceActionRequest": { "title": "BatchChangeCompetencyIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeCompetencyIsActiveResourceActionRequest" } }, "BatchChangeCompetencyPermissionTreeResourceActionRequest": { "title": "BatchChangeCompetencyPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeCompetencyPermissionTreeResourceActionRequest" } }, "GeoJsonObject": { "type": "object", "discriminator": { "propertyName": "type" }, "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "title": "type", "type": "string", "format": "enum", "nullable": false, "x-formatSpecifier": "GeoJsonObjectType", "x-enumNames": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection", "Feature", "FeatureCollection" ] }, "bbox": { "title": "bbox", "type": "array", "additionalProperties": false, "items": { "type": "number" } } }, "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3" } }, "Feature": { "allOf": [ { "$ref": "#/components/schemas/GeoJsonObject" }, { "type": "object", "additionalProperties": false, "required": [ "geometry", "properties" ], "properties": { "geometry": { "additionalProperties": false, "allOf": [ { "nullable": true, "additionalProperties": false }, { "$ref": "#/components/schemas/Geometry" } ] }, "properties": { "type": "object", "nullable": true, "additionalProperties": false }, "id": { "additionalProperties": false, "oneOf": [ { "type": "number" }, { "type": "string" } ] } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.2" } }, "FeatureCollection": { "allOf": [ { "$ref": "#/components/schemas/GeoJsonObject" }, { "type": "object", "additionalProperties": false, "required": [ "features" ], "properties": { "features": { "type": "array", "items": { "$ref": "#/components/schemas/Feature" } } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.3" } }, "LinearRing": { "type": "array", "minItems": 4, "additionalProperties": false, "items": { "$ref": "#/components/schemas/Position" }, "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.6" } }, "LineStringCoordinates": { "type": "array", "minItems": 2, "additionalProperties": false, "items": { "$ref": "#/components/schemas/Position" }, "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.4" } }, "Position": { "type": "array", "maxItems": 3, "minItems": 2, "additionalProperties": false, "items": { "type": "number" }, "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.1" } }, "GeometryElement": { "allOf": [ { "$ref": "#/components/schemas/Geometry" }, { "type": "object", "discriminator": { "propertyName": "type" }, "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "title": "type", "type": "string", "format": "enum", "nullable": false, "x-formatSpecifier": "GeometryElementType", "x-enumNames": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon" ] } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1" } }, "GeometryCollection": { "allOf": [ { "$ref": "#/components/schemas/Geometry" }, { "type": "object", "additionalProperties": false, "required": [ "geometries" ], "properties": { "geometries": { "type": "array", "additionalProperties": false, "items": { "$ref": "#/components/schemas/GeometryElement" } } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.8" } }, "Geometry": { "allOf": [ { "$ref": "#/components/schemas/GeoJsonObject" }, { "type": "object", "discriminator": { "propertyName": "type" }, "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "title": "type", "type": "string", "format": "enum", "nullable": false, "x-formatSpecifier": "GeometryType", "x-enumNames": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection" ] } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1" } }, "Point": { "allOf": [ { "$ref": "#/components/schemas/GeometryElement" }, { "type": "object", "additionalProperties": false, "required": [ "coordinates" ], "properties": { "coordinates": { "$ref": "#/components/schemas/Position" } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.2" } }, "MultiPoint": { "allOf": [ { "$ref": "#/components/schemas/GeometryElement" }, { "type": "object", "additionalProperties": false, "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "additionalProperties": false, "items": { "$ref": "#/components/schemas/Position" } } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.3" } }, "LineString": { "allOf": [ { "$ref": "#/components/schemas/GeometryElement" }, { "type": "object", "additionalProperties": false, "required": [ "coordinates" ], "properties": { "coordinates": { "$ref": "#/components/schemas/LineStringCoordinates" } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.4" } }, "MultiLineString": { "allOf": [ { "$ref": "#/components/schemas/GeometryElement" }, { "type": "object", "additionalProperties": false, "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "items": { "$ref": "#/components/schemas/LineStringCoordinates" } } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.5" } }, "Polygon": { "allOf": [ { "$ref": "#/components/schemas/GeometryElement" }, { "type": "object", "additionalProperties": false, "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "additionalProperties": false, "items": { "$ref": "#/components/schemas/LinearRing" } } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.6" } }, "MultiPolygon": { "allOf": [ { "$ref": "#/components/schemas/GeometryElement" }, { "type": "object", "additionalProperties": false, "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "additionalProperties": false, "items": { "type": "array", "items": { "$ref": "#/components/schemas/LinearRing" } } } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.7" } }, "GetResourceResourceActionResponse": { "title": "GetResourceResourceActionResponse", "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": "GetResourceResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Resource->Code" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "Resource->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Resource->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Resource->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Resource->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Resource->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Resource->ModifiedOn" }, "geographicId": { "title": "geographicId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->GeographicId" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Resource->GeographicEndPosition" }, "geographicEntityType": { "title": "geographicEntityType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "Resource->GeographicEntityType", "x-formatSpecifier": "EntityType" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Resource->GeographicLength" }, "geographicLocation": { "title": "geographicLocation", "nullable": true, "$ref": "#/components/schemas/Geometry", "x-propertyPath": "Resource->GeographicLocation" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "nullable": true, "x-propertyPath": "Resource->GeographicNotes" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Resource->GeographicReferenceEntityId" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Resource->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Resource->GeographicStartPosition" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->GeographicUnitOfMeasurement_Id" }, "geographicUnitOfMeasurementDescription": { "title": "geographicUnitOfMeasurementDescription", "type": "string", "nullable": true, "x-propertyPath": "Resource->GeographicUnitOfMeasurement_Description" }, "geographicUnitOfMeasurementCode": { "title": "geographicUnitOfMeasurementCode", "type": "string", "nullable": true, "x-propertyPath": "Resource->GeographicUnitOfMeasurement_Code" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Resource->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "Resource->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "Resource->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Resource->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "nullable": true, "x-propertyPath": "Resource->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "nullable": true, "x-propertyPath": "Resource->Site_Description" }, "contactDetailId": { "title": "contactDetailId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->ContactDetailId" }, "contactDetailBarcode": { "title": "contactDetailBarcode", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailBarcode" }, "contactDetailFullName": { "title": "contactDetailFullName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailFullName" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailInitials": { "title": "contactDetailInitials", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailInitials" }, "contactDetailIpAddress": { "title": "contactDetailIpAddress", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailIpAddress" }, "contactDetailJobTitle": { "title": "contactDetailJobTitle", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailJobTitle" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" }, "contactDetailPersonnelNumber": { "title": "contactDetailPersonnelNumber", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailPersonnelNumber" }, "contactDetailRegistrationNumber": { "title": "contactDetailRegistrationNumber", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailRegistrationNumber" }, "contactDetailSerialNumber": { "title": "contactDetailSerialNumber", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailSerialNumber" }, "contactDetailTitle": { "title": "contactDetailTitle", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailTitle" }, "contactDetailDepartment": { "title": "contactDetailDepartment", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailDepartment" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Resource->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "nullable": true, "x-propertyPath": "Resource->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "nullable": true, "x-propertyPath": "Resource->CostElement_Description" }, "defaultResourceTradeId": { "title": "defaultResourceTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->DefaultResourceTrade_Id" }, "defaultResourceTradeTradeId": { "title": "defaultResourceTradeTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->DefaultResourceTrade_Trade_Id" }, "defaultResourceTradeTradeCode": { "title": "defaultResourceTradeTradeCode", "type": "string", "nullable": true, "x-propertyPath": "Resource->DefaultResourceTrade_Trade_Code" }, "defaultResourceTradeTradeDescription": { "title": "defaultResourceTradeTradeDescription", "type": "string", "nullable": true, "x-propertyPath": "Resource->DefaultResourceTrade_Trade_Description" }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "Resource->Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Resource->Notes" }, "resourceClassificationId": { "title": "resourceClassificationId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->ResourceClassification_Id" }, "resourceClassificationCode": { "title": "resourceClassificationCode", "type": "string", "nullable": true, "x-propertyPath": "Resource->ResourceClassification_Code" }, "resourceClassificationDescription": { "title": "resourceClassificationDescription", "type": "string", "nullable": true, "x-propertyPath": "Resource->ResourceClassification_Description" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Resource->ResourceType", "x-formatSpecifier": "ResourceType" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "nullable": true, "x-propertyPath": "Resource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "nullable": true, "x-propertyPath": "Resource->Section_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Resource->SequenceNumber" } } }, "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" } } }, "GetResourceCollectionResourceActionResponse": { "title": "GetResourceCollectionResourceActionResponse", "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": "GetResourceCollectionResourceActionResponseItem", "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": "GetResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Resource->Code" }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "Resource->Description" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" }, "contactDetailFullName": { "title": "contactDetailFullName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailFullName" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Resource->ResourceType", "x-formatSpecifier": "ResourceType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Resource->SequenceNumber" }, "resourceClassificationId": { "title": "resourceClassificationId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->ResourceClassification_Id" }, "resourceClassificationCode": { "title": "resourceClassificationCode", "type": "string", "nullable": false, "x-propertyPath": "Resource->ResourceClassification_Code" }, "resourceClassificationDescription": { "title": "resourceClassificationDescription", "type": "string", "nullable": false, "x-propertyPath": "Resource->ResourceClassification_Description" }, "defaultResourceTradeId": { "title": "defaultResourceTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->DefaultResourceTrade_Id" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "nullable": false, "x-propertyPath": "Resource->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "nullable": false, "x-propertyPath": "Resource->Site_Description" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "nullable": false, "x-propertyPath": "Resource->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "nullable": false, "x-propertyPath": "Resource->Section_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Resource->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Resource->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Resource->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" } } } }, "ResourceChangePermissionTreeLookupResourceActionResponse": { "title": "ResourceChangePermissionTreeLookupResourceActionResponse", "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": "ResourceChangePermissionTreeLookupResourceActionResponseItem", "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": "ResourceChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceClassificationLookupResourceActionResponse": { "title": "ResourceClassificationLookupResourceActionResponse", "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": "ResourceClassificationLookupResourceActionResponseItem", "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": "ResourceClassificationLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "ResourceClassification->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "ResourceClassification->Description" } } }, "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" } } } }, "ResourceCostElementLookupResourceActionResponse": { "title": "ResourceCostElementLookupResourceActionResponse", "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": "ResourceCostElementLookupResourceActionResponseItem", "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": "ResourceCostElementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "CostElement->Description" } } }, "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" } } } }, "ResourceDefaultResourceTradeLookupResourceActionResponse": { "title": "ResourceDefaultResourceTradeLookupResourceActionResponse", "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": "ResourceDefaultResourceTradeLookupResourceActionResponseItem", "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": "ResourceDefaultResourceTradeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTrade->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTrade->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceTrade->Trade_Description" } } }, "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" } } } }, "ResourceInsertPermissionTreeLookupResourceActionResponse": { "title": "ResourceInsertPermissionTreeLookupResourceActionResponse", "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": "ResourceInsertPermissionTreeLookupResourceActionResponseItem", "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": "ResourceInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceSectionLookupResourceActionResponse": { "title": "ResourceSectionLookupResourceActionResponse", "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": "ResourceSectionLookupResourceActionResponseItem", "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": "ResourceSectionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Section->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Section->Description" } } }, "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" } } } }, "ResourceSiteLookupResourceActionResponse": { "title": "ResourceSiteLookupResourceActionResponse", "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": "ResourceSiteLookupResourceActionResponseItem", "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": "ResourceSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Site->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Site->Description" } } }, "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" } } } }, "CreateResourceResourceActionRequest": { "title": "CreateResourceResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateResourceResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "code", "resourceType", "siteId", "costElementId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Resource->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Resource->SequenceNumber" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "Resource->Code" }, "resourceClassificationId": { "title": "resourceClassificationId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->ResourceClassification_Id" }, "resourceType": { "title": "resourceType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Resource->ResourceType", "x-formatSpecifier": "ResourceType" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Resource->Site_Id" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Resource->CostElement_Id" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->Section_Id" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Resource->Notes" }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "Resource->Description" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" }, "contactDetailInitials": { "title": "contactDetailInitials", "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailInitials" }, "contactDetailTitle": { "title": "contactDetailTitle", "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailTitle" }, "contactDetailJobTitle": { "title": "contactDetailJobTitle", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailJobTitle" }, "contactDetailDepartment": { "title": "contactDetailDepartment", "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailDepartment" }, "contactDetailPersonnelNumber": { "title": "contactDetailPersonnelNumber", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailPersonnelNumber" }, "contactDetailRegistrationNumber": { "title": "contactDetailRegistrationNumber", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailRegistrationNumber" }, "contactDetailSerialNumber": { "title": "contactDetailSerialNumber", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailSerialNumber" }, "contactDetailBarcode": { "title": "contactDetailBarcode", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailBarcode" }, "contactDetailIpAddress": { "title": "contactDetailIpAddress", "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailIpAddress" }, "geographicLocation": { "title": "geographicLocation", "nullable": true, "$ref": "#/components/schemas/Geometry", "x-propertyPath": "Resource->GeographicLocation" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Resource->GeographicStartPosition" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Resource->GeographicEndPosition" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Resource->GeographicLength" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->GeographicUnitOfMeasurement_Id" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "nullable": true, "x-propertyPath": "Resource->GeographicNotes" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Resource->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Resource->GeographicReferenceEntityId" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateResourceResourceActionRequest": { "title": "UpdateResourceResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Resource->SequenceNumber" }, { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "Resource->Code" }, { "title": "resourceClassificationId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->ResourceClassification_Id" }, { "title": "costElementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Resource->CostElement_Id" }, { "title": "defaultResourceTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->DefaultResourceTrade_Id" }, { "title": "resourceType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Resource->ResourceType", "x-formatSpecifier": "ResourceType" }, { "title": "siteId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Resource->Site_Id" }, { "title": "sectionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->Section_Id" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Resource->Notes" }, { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "Resource->Description" }, { "title": "contactDetailFirstName", "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, { "title": "contactDetailLastName", "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" }, { "title": "contactDetailInitials", "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailInitials" }, { "title": "contactDetailTitle", "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailTitle" }, { "title": "contactDetailJobTitle", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailJobTitle" }, { "title": "contactDetailDepartment", "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailDepartment" }, { "title": "contactDetailPersonnelNumber", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailPersonnelNumber" }, { "title": "contactDetailRegistrationNumber", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailRegistrationNumber" }, { "title": "contactDetailSerialNumber", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailSerialNumber" }, { "title": "contactDetailBarcode", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailBarcode" }, { "title": "contactDetailIpAddress", "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "x-propertyPath": "Resource->ContactDetailIpAddress" }, { "title": "geographicLocation", "nullable": true, "x-propertyPath": "Resource->GeographicLocation" }, { "title": "geographicStartPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Resource->GeographicStartPosition" }, { "title": "geographicEndPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Resource->GeographicEndPosition" }, { "title": "geographicLength", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Resource->GeographicLength" }, { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->GeographicUnitOfMeasurement_Id" }, { "title": "geographicNotes", "type": "string", "nullable": true, "x-propertyPath": "Resource->GeographicNotes" }, { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Resource->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Resource->GeographicReferenceEntityId" } ] } } }, "DeleteResourceResourceActionRequest": { "title": "DeleteResourceResourceActionRequest", "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 } } }, "BatchGetResourceResourceAction": { "title": "BatchGetResourceResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Resource entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Resource entities", "items": { "$ref": "#/components/schemas/GetResourceResourceActionResponse" } }, "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" } } }, "BatchCreateResourceResourceActionRequest": { "title": "BatchCreateResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateResourceResourceActionRequest" } }, "BatchUpdateResourceResourceActionRequest": { "title": "BatchUpdateResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateResourceResourceActionRequest" } }, "BatchDeleteResourceResourceActionRequest": { "title": "BatchDeleteResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteResourceResourceActionRequest" } }, "ChangeResourceIsActiveResourceActionRequest": { "title": "ChangeResourceIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "Resource->IsActive" } ] } } }, "ChangeResourcePermissionTreeResourceActionRequest": { "title": "ChangeResourcePermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Resource->PermissionTree_Id" } ] } } }, "ChangeResourceSiteResourceActionRequest": { "title": "ChangeResourceSiteResourceActionRequest", "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": "siteId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Resource->Site_Id" } ] } } }, "BatchChangeResourceIsActiveResourceActionRequest": { "title": "BatchChangeResourceIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceIsActiveResourceActionRequest" } }, "BatchChangeResourcePermissionTreeResourceActionRequest": { "title": "BatchChangeResourcePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourcePermissionTreeResourceActionRequest" } }, "BatchChangeResourceSiteResourceActionRequest": { "title": "BatchChangeResourceSiteResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceSiteResourceActionRequest" } }, "EntityMatchRecordSchema": { "type": "object", "additionalProperties": false, "required": [ "id", "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch.", "format": "int64", "example": 14324399978 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 } } }, "MatchUpdateResourceResourceActionRequest": { "title": "MatchUpdateResourceResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entities", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" } }, "records": { "title": "records", "type": "array", "description": "Collection of entities to apply the patch operations to", "items": { "$ref": "#/components/schemas/EntityMatchRecordSchema" }, "x-matchupdateproperties": [ { "title": "resourceClassificationId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->ResourceClassification_Id" }, { "title": "sectionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Resource->Section_Id" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Resource->Notes" } ] } } }, "GetResourceAddressResourceActionResponse": { "title": "GetResourceAddressResourceActionResponse", "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": "GetResourceAddressResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceAddress->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceAddress->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceAddress->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceAddress->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceAddress->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceAddress->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->PermissionTree_Description" }, "addressTypeId": { "title": "addressTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceAddress->AddressType_Id" }, "addressTypeCode": { "title": "addressTypeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->AddressType_Code" }, "addressTypeDescription": { "title": "addressTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->AddressType_Description" }, "body": { "title": "body", "type": "string", "nullable": false, "x-propertyPath": "ResourceAddress->Body" }, "country": { "title": "country", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->Country" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->Notes" }, "postalCode": { "title": "postalCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->PostalCode" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceAddress->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->Resource_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceAddress->SequenceNumber" } } }, "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" } } }, "GetResourceAddressCollectionResourceActionResponse": { "title": "GetResourceAddressCollectionResourceActionResponse", "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": "GetResourceAddressCollectionResourceActionResponseItem", "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": "GetResourceAddressCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "body": { "title": "body", "type": "string", "nullable": false, "x-propertyPath": "ResourceAddress->Body" }, "postalCode": { "title": "postalCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->PostalCode" }, "country": { "title": "country", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->Country" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceAddress->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceAddress->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceAddress->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" } } } }, "GetResourceAddressForResourceCollectionResourceActionResponse": { "title": "GetResourceAddressForResourceCollectionResourceActionResponse", "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": "GetResourceAddressForResourceCollectionResourceActionResponseItem", "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": "GetResourceAddressForResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "body": { "title": "body", "type": "string", "nullable": false, "x-propertyPath": "ResourceAddress->Body" }, "postalCode": { "title": "postalCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->PostalCode" }, "country": { "title": "country", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->Country" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceAddress->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->Notes" }, "addressTypeCode": { "title": "addressTypeCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceAddress->AddressType_Code" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceAddress->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceAddress->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" } } } }, "ResourceAddressAddressTypeLookupResourceActionResponse": { "title": "ResourceAddressAddressTypeLookupResourceActionResponse", "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": "ResourceAddressAddressTypeLookupResourceActionResponseItem", "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": "ResourceAddressAddressTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "AddressType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "AddressType->Description" } } }, "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" } } } }, "ResourceAddressChangePermissionTreeLookupResourceActionResponse": { "title": "ResourceAddressChangePermissionTreeLookupResourceActionResponse", "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": "ResourceAddressChangePermissionTreeLookupResourceActionResponseItem", "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": "ResourceAddressChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceAddressInsertPermissionTreeLookupResourceActionResponse": { "title": "ResourceAddressInsertPermissionTreeLookupResourceActionResponse", "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": "ResourceAddressInsertPermissionTreeLookupResourceActionResponseItem", "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": "ResourceAddressInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceAddressResourceLookupResourceActionResponse": { "title": "ResourceAddressResourceLookupResourceActionResponse", "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": "ResourceAddressResourceLookupResourceActionResponseItem", "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": "ResourceAddressResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Resource->Code" }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "Resource->Description" } } }, "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" } } } }, "CreateResourceAddressResourceActionRequest": { "title": "CreateResourceAddressResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateResourceAddressResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "resourceId", "addressTypeId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceAddress->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceAddress->SequenceNumber" }, "body": { "title": "body", "type": "string", "nullable": false, "x-propertyPath": "ResourceAddress->Body" }, "postalCode": { "title": "postalCode", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "ResourceAddress->PostalCode" }, "country": { "title": "country", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "ResourceAddress->Country" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceAddress->Resource_Id" }, "addressTypeId": { "title": "addressTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceAddress->AddressType_Id" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateResourceAddressResourceActionRequest": { "title": "UpdateResourceAddressResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceAddress->SequenceNumber" }, { "title": "body", "type": "string", "nullable": false, "x-propertyPath": "ResourceAddress->Body" }, { "title": "postalCode", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "ResourceAddress->PostalCode" }, { "title": "country", "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "x-propertyPath": "ResourceAddress->Country" }, { "title": "addressTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceAddress->AddressType_Id" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceAddress->Notes" } ] } } }, "DeleteResourceAddressResourceActionRequest": { "title": "DeleteResourceAddressResourceActionRequest", "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 } } }, "BatchGetResourceAddressResourceAction": { "title": "BatchGetResourceAddressResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Resource Address entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Resource Address entities", "items": { "$ref": "#/components/schemas/GetResourceAddressResourceActionResponse" } }, "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" } } }, "BatchCreateResourceAddressResourceActionRequest": { "title": "BatchCreateResourceAddressResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateResourceAddressResourceActionRequest" } }, "BatchUpdateResourceAddressResourceActionRequest": { "title": "BatchUpdateResourceAddressResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateResourceAddressResourceActionRequest" } }, "BatchDeleteResourceAddressResourceActionRequest": { "title": "BatchDeleteResourceAddressResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteResourceAddressResourceActionRequest" } }, "ChangeResourceAddressIsActiveResourceActionRequest": { "title": "ChangeResourceAddressIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceAddress->IsActive" } ] } } }, "ChangeResourceAddressPermissionTreeResourceActionRequest": { "title": "ChangeResourceAddressPermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceAddress->PermissionTree_Id" } ] } } }, "BatchChangeResourceAddressIsActiveResourceActionRequest": { "title": "BatchChangeResourceAddressIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceAddressIsActiveResourceActionRequest" } }, "BatchChangeResourceAddressPermissionTreeResourceActionRequest": { "title": "BatchChangeResourceAddressPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceAddressPermissionTreeResourceActionRequest" } }, "DynamicValueSchema": { "title": "DynamicValueSchema", "type": "object", "additionalProperties": false, "properties": { "type": { "title": "type", "type": "string", "format": "enum", "nullable": false, "x-formatSpecifier": "DynamicValueType", "x-enumNames": [ "String", "Email", "Integer", "Long", "Float", "Currency", "DateTime", "Date", "Time", "Duration", "Boolean" ] }, "value": { "title": "value", "type": "object", "additionalProperties": false } } }, "GetResourceAttributeResourceActionResponse": { "title": "GetResourceAttributeResourceActionResponse", "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": "GetResourceAttributeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceAttribute->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->Resource_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "ResourceAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "nullable": true, "x-propertyPath": "ResourceAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "ResourceAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "ResourceAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "ResourceAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "ResourceAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "ResourceAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "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" } } }, "GetResourceAttributeCollectionForResourceResourceActionResponse": { "title": "GetResourceAttributeCollectionForResourceResourceActionResponse", "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": "GetResourceAttributeCollectionForResourceResourceActionResponseItem", "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": "GetResourceAttributeCollectionForResourceResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "ResourceAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "ResourceAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "ResourceAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceAttribute->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" } } } }, "GetResourceAttributeCollectionResourceActionResponse": { "title": "GetResourceAttributeCollectionResourceActionResponse", "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": "GetResourceAttributeCollectionResourceActionResponseItem", "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": "GetResourceAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "resourceCode": { "title": "resourceCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceAttribute->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->Resource_Description" }, "resourceResourceType": { "title": "resourceResourceType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "ResourceAttribute->Resource_ResourceType", "x-formatSpecifier": "ResourceType" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->Resource_ContactDetailLastName" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "ResourceAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "ResourceAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "ResourceAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceAttribute->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" } } } }, "ResourceAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "ResourceAttributeAttributeAllowedValueLookupResourceActionResponse", "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": "ResourceAttributeAttributeAllowedValueLookupResourceActionResponseItem", "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": "ResourceAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "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" } } } }, "ResourceAttributeAttributeLookupResourceActionResponse": { "title": "ResourceAttributeAttributeLookupResourceActionResponse", "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": "ResourceAttributeAttributeLookupResourceActionResponseItem", "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": "ResourceAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "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" } } } }, "ResourceAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "ResourceAttributeInsertPermissionTreeLookupResourceActionResponse", "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": "ResourceAttributeInsertPermissionTreeLookupResourceActionResponseItem", "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": "ResourceAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceAttributeResourceLookupResourceActionResponse": { "title": "ResourceAttributeResourceLookupResourceActionResponse", "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": "ResourceAttributeResourceLookupResourceActionResponseItem", "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": "ResourceAttributeResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Resource->Code" }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "Resource->Description" } } }, "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" } } } }, "CreateResourceAttributeResourceActionRequest": { "title": "CreateResourceAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateResourceAttributeResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "resourceId", "attributeId" ], "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceAttribute->Resource_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "ResourceAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateResourceAttributeResourceActionRequest": { "title": "UpdateResourceAttributeResourceActionRequest", "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": "value", "format": "composite", "nullable": true, "x-propertyPath": "ResourceAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceAttribute->Notes" } ] } } }, "DeleteResourceAttributeResourceActionRequest": { "title": "DeleteResourceAttributeResourceActionRequest", "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 } } }, "BatchGetResourceAttributeResourceAction": { "title": "BatchGetResourceAttributeResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Resource Attribute entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Resource Attribute entities", "items": { "$ref": "#/components/schemas/GetResourceAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateResourceAttributeResourceActionRequest": { "title": "BatchCreateResourceAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateResourceAttributeResourceActionRequest" } }, "BatchUpdateResourceAttributeResourceActionRequest": { "title": "BatchUpdateResourceAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateResourceAttributeResourceActionRequest" } }, "BatchDeleteResourceAttributeResourceActionRequest": { "title": "BatchDeleteResourceAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteResourceAttributeResourceActionRequest" } }, "ChangeResourceAttributeIsActiveResourceActionRequest": { "title": "ChangeResourceAttributeIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceAttribute->IsActive" } ] } } }, "BatchChangeResourceAttributeIsActiveResourceActionRequest": { "title": "BatchChangeResourceAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceAttributeIsActiveResourceActionRequest" } }, "GetResourceClassificationResourceActionResponse": { "title": "GetResourceClassificationResourceActionResponse", "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": "GetResourceClassificationResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "ResourceClassification->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceClassification->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceClassification->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceClassification->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceClassification->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceClassification->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceClassification->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceClassification->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceClassification->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceClassification->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceClassification->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceClassification->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceClassification->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "ResourceClassification->Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceClassification->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceClassification->SequenceNumber" } } }, "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" } } }, "GetResourceClassificationCollectionResourceActionResponse": { "title": "GetResourceClassificationCollectionResourceActionResponse", "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": "GetResourceClassificationCollectionResourceActionResponseItem", "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": "GetResourceClassificationCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "ResourceClassification->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "ResourceClassification->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceClassification->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceClassification->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceClassification->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceClassification->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" } } } }, "ResourceClassificationChangePermissionTreeLookupResourceActionResponse": { "title": "ResourceClassificationChangePermissionTreeLookupResourceActionResponse", "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": "ResourceClassificationChangePermissionTreeLookupResourceActionResponseItem", "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": "ResourceClassificationChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceClassificationInsertPermissionTreeLookupResourceActionResponse": { "title": "ResourceClassificationInsertPermissionTreeLookupResourceActionResponse", "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": "ResourceClassificationInsertPermissionTreeLookupResourceActionResponseItem", "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": "ResourceClassificationInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "CreateResourceClassificationResourceActionRequest": { "title": "CreateResourceClassificationResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateResourceClassificationResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceClassification->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "ResourceClassification->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "ResourceClassification->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceClassification->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceClassification->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateResourceClassificationResourceActionRequest": { "title": "UpdateResourceClassificationResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceClassification->SequenceNumber" }, { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "ResourceClassification->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "ResourceClassification->Description" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceClassification->Notes" } ] } } }, "DeleteResourceClassificationResourceActionRequest": { "title": "DeleteResourceClassificationResourceActionRequest", "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 } } }, "BatchGetResourceClassificationResourceAction": { "title": "BatchGetResourceClassificationResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Resource Classification entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Resource Classification entities", "items": { "$ref": "#/components/schemas/GetResourceClassificationResourceActionResponse" } }, "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" } } }, "BatchCreateResourceClassificationResourceActionRequest": { "title": "BatchCreateResourceClassificationResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateResourceClassificationResourceActionRequest" } }, "BatchUpdateResourceClassificationResourceActionRequest": { "title": "BatchUpdateResourceClassificationResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateResourceClassificationResourceActionRequest" } }, "BatchDeleteResourceClassificationResourceActionRequest": { "title": "BatchDeleteResourceClassificationResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteResourceClassificationResourceActionRequest" } }, "ChangeResourceClassificationIsActiveResourceActionRequest": { "title": "ChangeResourceClassificationIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceClassification->IsActive" } ] } } }, "ChangeResourceClassificationPermissionTreeResourceActionRequest": { "title": "ChangeResourceClassificationPermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceClassification->PermissionTree_Id" } ] } } }, "BatchChangeResourceClassificationIsActiveResourceActionRequest": { "title": "BatchChangeResourceClassificationIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceClassificationIsActiveResourceActionRequest" } }, "BatchChangeResourceClassificationPermissionTreeResourceActionRequest": { "title": "BatchChangeResourceClassificationPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceClassificationPermissionTreeResourceActionRequest" } }, "GetResourceCompetencyResourceActionResponse": { "title": "GetResourceCompetencyResourceActionResponse", "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": "GetResourceCompetencyResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceCompetency->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceCompetency->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceCompetency->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceCompetency->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceCompetency->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceCompetency->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceCompetency->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceCompetency->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceCompetency->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceCompetency->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceCompetency->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceCompetency->PermissionTree_Description" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceCompetency->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceCompetency->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceCompetency->Competency_Description" }, "competencyValidityType": { "title": "competencyValidityType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "ResourceCompetency->Competency_ValidityType", "x-formatSpecifier": "CompetencyValidityType" }, "expiryDate": { "title": "expiryDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceCompetency->ExpiryDate" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceCompetency->Notes" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceCompetency->Proficiency" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceCompetency->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceCompetency->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceCompetency->Resource_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceCompetency->SequenceNumber" } } }, "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" } } }, "GetResourceCompetencyCollectionResourceActionResponse": { "title": "GetResourceCompetencyCollectionResourceActionResponse", "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": "GetResourceCompetencyCollectionResourceActionResponseItem", "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": "GetResourceCompetencyCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceCompetency->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceCompetency->Resource_Code" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "nullable": true, "x-propertyPath": "ResourceCompetency->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "nullable": true, "x-propertyPath": "ResourceCompetency->Resource_ContactDetailLastName" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceCompetency->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceCompetency->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceCompetency->Competency_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceCompetency->SequenceNumber" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceCompetency->Proficiency" }, "expiryDate": { "title": "expiryDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceCompetency->ExpiryDate" } } }, "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" } } } }, "GetResourceCompetencyForResourceCollectionResourceActionResponse": { "title": "GetResourceCompetencyForResourceCollectionResourceActionResponse", "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": "GetResourceCompetencyForResourceCollectionResourceActionResponseItem", "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": "GetResourceCompetencyForResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceCompetency->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceCompetency->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceCompetency->Competency_Description" } } }, "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" } } } }, "ResourceCompetencyChangePermissionTreeLookupResourceActionResponse": { "title": "ResourceCompetencyChangePermissionTreeLookupResourceActionResponse", "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": "ResourceCompetencyChangePermissionTreeLookupResourceActionResponseItem", "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": "ResourceCompetencyChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceCompetencyCompetencyLookupResourceActionResponse": { "title": "ResourceCompetencyCompetencyLookupResourceActionResponse", "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": "ResourceCompetencyCompetencyLookupResourceActionResponseItem", "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": "ResourceCompetencyCompetencyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Competency->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Competency->Description" } } }, "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" } } } }, "ResourceCompetencyInsertPermissionTreeLookupResourceActionResponse": { "title": "ResourceCompetencyInsertPermissionTreeLookupResourceActionResponse", "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": "ResourceCompetencyInsertPermissionTreeLookupResourceActionResponseItem", "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": "ResourceCompetencyInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceCompetencyResourceLookupResourceActionResponse": { "title": "ResourceCompetencyResourceLookupResourceActionResponse", "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": "ResourceCompetencyResourceLookupResourceActionResponseItem", "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": "ResourceCompetencyResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Resource->Code" }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "Resource->Description" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" } } }, "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" } } } }, "CreateResourceCompetencyResourceActionRequest": { "title": "CreateResourceCompetencyResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateResourceCompetencyResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "resourceId", "competencyId", "proficiency" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceCompetency->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceCompetency->SequenceNumber" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceCompetency->Resource_Id" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceCompetency->Competency_Id" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "minimum": 1.0, "nullable": false, "x-propertyPath": "ResourceCompetency->Proficiency" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceCompetency->Notes" }, "expiryDate": { "title": "expiryDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceCompetency->ExpiryDate" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateResourceCompetencyResourceActionRequest": { "title": "UpdateResourceCompetencyResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceCompetency->SequenceNumber" }, { "title": "proficiency", "type": "integer", "format": "int32", "minimum": 1.0, "nullable": true, "x-propertyPath": "ResourceCompetency->Proficiency" }, { "title": "expiryDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceCompetency->ExpiryDate" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceCompetency->Notes" } ] } } }, "DeleteResourceCompetencyResourceActionRequest": { "title": "DeleteResourceCompetencyResourceActionRequest", "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 } } }, "BatchGetResourceCompetencyResourceAction": { "title": "BatchGetResourceCompetencyResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Resource Competency entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Resource Competency entities", "items": { "$ref": "#/components/schemas/GetResourceCompetencyResourceActionResponse" } }, "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" } } }, "BatchCreateResourceCompetencyResourceActionRequest": { "title": "BatchCreateResourceCompetencyResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateResourceCompetencyResourceActionRequest" } }, "BatchUpdateResourceCompetencyResourceActionRequest": { "title": "BatchUpdateResourceCompetencyResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateResourceCompetencyResourceActionRequest" } }, "BatchDeleteResourceCompetencyResourceActionRequest": { "title": "BatchDeleteResourceCompetencyResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteResourceCompetencyResourceActionRequest" } }, "ChangeResourceCompetencyIsActiveResourceActionRequest": { "title": "ChangeResourceCompetencyIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceCompetency->IsActive" } ] } } }, "ChangeResourceCompetencyPermissionTreeResourceActionRequest": { "title": "ChangeResourceCompetencyPermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceCompetency->PermissionTree_Id" } ] } } }, "BatchChangeResourceCompetencyIsActiveResourceActionRequest": { "title": "BatchChangeResourceCompetencyIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceCompetencyIsActiveResourceActionRequest" } }, "BatchChangeResourceCompetencyPermissionTreeResourceActionRequest": { "title": "BatchChangeResourceCompetencyPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceCompetencyPermissionTreeResourceActionRequest" } }, "GetResourceContextResourceActionResponse": { "title": "GetResourceContextResourceActionResponse", "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": "GetResourceContextResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "ResourceContext->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceContext->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceContext->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceContext->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceContext->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceContext->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceContext->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceContext->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceContext->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceContext->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceContext->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceContext->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceContext->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "ResourceContext->Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceContext->Notes" } } }, "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" } } }, "GetResourceContextCollectionResourceActionResponse": { "title": "GetResourceContextCollectionResourceActionResponse", "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": "GetResourceContextCollectionResourceActionResponseItem", "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": "GetResourceContextCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "ResourceContext->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "ResourceContext->Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceContext->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceContext->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceContext->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" } } } }, "ResourceContextChangePermissionTreeLookupResourceActionResponse": { "title": "ResourceContextChangePermissionTreeLookupResourceActionResponse", "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": "ResourceContextChangePermissionTreeLookupResourceActionResponseItem", "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": "ResourceContextChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceContextInsertPermissionTreeLookupResourceActionResponse": { "title": "ResourceContextInsertPermissionTreeLookupResourceActionResponse", "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": "ResourceContextInsertPermissionTreeLookupResourceActionResponseItem", "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": "ResourceContextInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "CreateResourceContextResourceActionRequest": { "title": "CreateResourceContextResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateResourceContextResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceContext->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "ResourceContext->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "ResourceContext->Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceContext->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateResourceContextResourceActionRequest": { "title": "UpdateResourceContextResourceActionRequest", "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": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "ResourceContext->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "ResourceContext->Description" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceContext->Notes" } ] } } }, "DeleteResourceContextResourceActionRequest": { "title": "DeleteResourceContextResourceActionRequest", "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 } } }, "BatchGetResourceContextResourceAction": { "title": "BatchGetResourceContextResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Resource Context entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Resource Context entities", "items": { "$ref": "#/components/schemas/GetResourceContextResourceActionResponse" } }, "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" } } }, "BatchCreateResourceContextResourceActionRequest": { "title": "BatchCreateResourceContextResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateResourceContextResourceActionRequest" } }, "BatchUpdateResourceContextResourceActionRequest": { "title": "BatchUpdateResourceContextResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateResourceContextResourceActionRequest" } }, "BatchDeleteResourceContextResourceActionRequest": { "title": "BatchDeleteResourceContextResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteResourceContextResourceActionRequest" } }, "ChangeResourceContextIsActiveResourceActionRequest": { "title": "ChangeResourceContextIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceContext->IsActive" } ] } } }, "ChangeResourceContextPermissionTreeResourceActionRequest": { "title": "ChangeResourceContextPermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceContext->PermissionTree_Id" } ] } } }, "BatchChangeResourceContextIsActiveResourceActionRequest": { "title": "BatchChangeResourceContextIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceContextIsActiveResourceActionRequest" } }, "BatchChangeResourceContextPermissionTreeResourceActionRequest": { "title": "BatchChangeResourceContextPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceContextPermissionTreeResourceActionRequest" } }, "GetResourceDocumentResourceActionResponse": { "title": "GetResourceDocumentResourceActionResponse", "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": "GetResourceDocumentResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceDocument->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->Resource_Description" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "ResourceDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceDocument->SequenceNumber" } } }, "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" } } }, "GetResourceDocumentCollectionForResourceResourceActionResponse": { "title": "GetResourceDocumentCollectionForResourceResourceActionResponse", "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": "GetResourceDocumentCollectionForResourceResourceActionResponseItem", "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": "GetResourceDocumentCollectionForResourceResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_FileType_Extension" } } }, "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" } } } }, "GetResourceDocumentCollectionResourceActionResponse": { "title": "GetResourceDocumentCollectionResourceActionResponse", "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": "GetResourceDocumentCollectionResourceActionResponseItem", "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": "GetResourceDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceDocument->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceDocument->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->Resource_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->DocumentRecord_FileType_Extension" } } }, "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" } } } }, "ResourceDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "ResourceDocumentChangePermissionTreeLookupResourceActionResponse", "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": "ResourceDocumentChangePermissionTreeLookupResourceActionResponseItem", "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": "ResourceDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceDocumentDocumentLookupResourceActionResponse": { "title": "ResourceDocumentDocumentLookupResourceActionResponse", "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": "ResourceDocumentDocumentLookupResourceActionResponseItem", "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": "ResourceDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "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" } } } }, "ResourceDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "ResourceDocumentInsertPermissionTreeLookupResourceActionResponse", "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": "ResourceDocumentInsertPermissionTreeLookupResourceActionResponseItem", "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": "ResourceDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceDocumentResourceLookupResourceActionResponse": { "title": "ResourceDocumentResourceLookupResourceActionResponse", "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": "ResourceDocumentResourceLookupResourceActionResponseItem", "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": "ResourceDocumentResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Resource->Code" }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "Resource->Description" } } }, "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" } } } }, "CreateResourceDocumentResourceActionRequest": { "title": "CreateResourceDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateResourceDocumentResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "resourceId", "documentRecordId" ], "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceDocument->Resource_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateResourceDocumentResourceActionRequest": { "title": "UpdateResourceDocumentResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceDocument->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceDocument->Notes" } ] } } }, "DeleteResourceDocumentResourceActionRequest": { "title": "DeleteResourceDocumentResourceActionRequest", "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 } } }, "BatchGetResourceDocumentResourceAction": { "title": "BatchGetResourceDocumentResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Resource Document entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Resource Document entities", "items": { "$ref": "#/components/schemas/GetResourceDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateResourceDocumentResourceActionRequest": { "title": "BatchCreateResourceDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateResourceDocumentResourceActionRequest" } }, "BatchUpdateResourceDocumentResourceActionRequest": { "title": "BatchUpdateResourceDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateResourceDocumentResourceActionRequest" } }, "BatchDeleteResourceDocumentResourceActionRequest": { "title": "BatchDeleteResourceDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteResourceDocumentResourceActionRequest" } }, "ChangeResourceDocumentIsActiveResourceActionRequest": { "title": "ChangeResourceDocumentIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceDocument->IsActive" } ] } } }, "ChangeResourceDocumentPermissionTreeResourceActionRequest": { "title": "ChangeResourceDocumentPermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceDocument->PermissionTree_Id" } ] } } }, "BatchChangeResourceDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeResourceDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeResourceDocumentIsActiveResourceActionRequest": { "title": "BatchChangeResourceDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceDocumentIsActiveResourceActionRequest" } }, "GetResourceEmailResourceActionResponse": { "title": "GetResourceEmailResourceActionResponse", "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": "GetResourceEmailResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceEmail->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceEmail->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceEmail->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceEmail->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceEmail->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceEmail->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceEmail->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceEmail->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceEmail->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceEmail->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceEmail->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceEmail->PermissionTree_Description" }, "email": { "title": "email", "type": "string", "format": "email", "nullable": false, "x-propertyPath": "ResourceEmail->Email" }, "emailTypeId": { "title": "emailTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceEmail->EmailType_Id" }, "emailTypeCode": { "title": "emailTypeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceEmail->EmailType_Code" }, "emailTypeDescription": { "title": "emailTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceEmail->EmailType_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceEmail->Notes" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceEmail->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceEmail->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceEmail->Resource_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceEmail->SequenceNumber" } } }, "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" } } }, "GetResourceEmailCollectionResourceActionResponse": { "title": "GetResourceEmailCollectionResourceActionResponse", "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": "GetResourceEmailCollectionResourceActionResponseItem", "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": "GetResourceEmailCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceEmail->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceEmail->Resource_Code" }, "emailTypeId": { "title": "emailTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceEmail->EmailType_Id" }, "emailTypeCode": { "title": "emailTypeCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceEmail->EmailType_Code" }, "emailTypeDescription": { "title": "emailTypeDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceEmail->EmailType_Description" }, "email": { "title": "email", "type": "string", "format": "email", "nullable": false, "x-propertyPath": "ResourceEmail->Email" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceEmail->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceEmail->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceEmail->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceEmail->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" } } } }, "GetResourceEmailForResourceCollectionResourceActionResponse": { "title": "GetResourceEmailForResourceCollectionResourceActionResponse", "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": "GetResourceEmailForResourceCollectionResourceActionResponseItem", "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": "GetResourceEmailForResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "email": { "title": "email", "type": "string", "format": "email", "nullable": false, "x-propertyPath": "ResourceEmail->Email" }, "emailTypeId": { "title": "emailTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceEmail->EmailType_Id" }, "emailTypeCode": { "title": "emailTypeCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceEmail->EmailType_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceEmail->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceEmail->Notes" } } }, "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" } } } }, "ResourceEmailChangePermissionTreeLookupResourceActionResponse": { "title": "ResourceEmailChangePermissionTreeLookupResourceActionResponse", "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": "ResourceEmailChangePermissionTreeLookupResourceActionResponseItem", "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": "ResourceEmailChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceEmailEmailTypeLookupResourceActionResponse": { "title": "ResourceEmailEmailTypeLookupResourceActionResponse", "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": "ResourceEmailEmailTypeLookupResourceActionResponseItem", "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": "ResourceEmailEmailTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "EmailType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "EmailType->Description" } } }, "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" } } } }, "ResourceEmailInsertPermissionTreeLookupResourceActionResponse": { "title": "ResourceEmailInsertPermissionTreeLookupResourceActionResponse", "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": "ResourceEmailInsertPermissionTreeLookupResourceActionResponseItem", "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": "ResourceEmailInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceEmailResourceLookupResourceActionResponse": { "title": "ResourceEmailResourceLookupResourceActionResponse", "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": "ResourceEmailResourceLookupResourceActionResponseItem", "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": "ResourceEmailResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Resource->Code" }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "Resource->Description" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" } } }, "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" } } } }, "CreateResourceEmailResourceActionRequest": { "title": "CreateResourceEmailResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateResourceEmailResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "resourceId", "emailTypeId", "email" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceEmail->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceEmail->SequenceNumber" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceEmail->Resource_Id" }, "emailTypeId": { "title": "emailTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceEmail->EmailType_Id" }, "email": { "title": "email", "type": "string", "format": "email", "maxLength": 255, "nullable": false, "x-propertyPath": "ResourceEmail->Email" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceEmail->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateResourceEmailResourceActionRequest": { "title": "UpdateResourceEmailResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceEmail->SequenceNumber" }, { "title": "emailTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceEmail->EmailType_Id" }, { "title": "email", "type": "string", "format": "email", "maxLength": 255, "nullable": false, "x-propertyPath": "ResourceEmail->Email" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceEmail->Notes" }, { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceEmail->Resource_Id" } ] } } }, "DeleteResourceEmailResourceActionRequest": { "title": "DeleteResourceEmailResourceActionRequest", "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 } } }, "BatchGetResourceEmailResourceAction": { "title": "BatchGetResourceEmailResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Resource Email entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Resource Email entities", "items": { "$ref": "#/components/schemas/GetResourceEmailResourceActionResponse" } }, "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" } } }, "BatchCreateResourceEmailResourceActionRequest": { "title": "BatchCreateResourceEmailResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateResourceEmailResourceActionRequest" } }, "BatchUpdateResourceEmailResourceActionRequest": { "title": "BatchUpdateResourceEmailResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateResourceEmailResourceActionRequest" } }, "BatchDeleteResourceEmailResourceActionRequest": { "title": "BatchDeleteResourceEmailResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteResourceEmailResourceActionRequest" } }, "ChangeResourceEmailIsActiveResourceActionRequest": { "title": "ChangeResourceEmailIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceEmail->IsActive" } ] } } }, "ChangeResourceEmailPermissionTreeResourceActionRequest": { "title": "ChangeResourceEmailPermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceEmail->PermissionTree_Id" } ] } } }, "BatchChangeResourceEmailIsActiveResourceActionRequest": { "title": "BatchChangeResourceEmailIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceEmailIsActiveResourceActionRequest" } }, "BatchChangeResourceEmailPermissionTreeResourceActionRequest": { "title": "BatchChangeResourceEmailPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceEmailPermissionTreeResourceActionRequest" } }, "GetResourceFileAttachmentResourceActionResponse": { "title": "GetResourceFileAttachmentResourceActionResponse", "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": "GetResourceFileAttachmentResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceFileAttachment->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceFileAttachment->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceFileAttachment->Resource_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceFileAttachment->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceFileAttachment->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceFileAttachment->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceFileAttachment->CreatedOn" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceFileAttachment->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceFileAttachment->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceFileAttachment->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "ResourceFileAttachment->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "ResourceFileAttachment->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceFileAttachment->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "ResourceFileAttachment->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "ResourceFileAttachment->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "nullable": false, "x-propertyPath": "ResourceFileAttachment->ContentVersion" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "ResourceFileAttachment->EntityType", "x-formatSpecifier": "EntityType" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceFileAttachment->FileCategory_Description" }, "fileCategoryAutoIsRestricted": { "title": "fileCategoryAutoIsRestricted", "type": "boolean", "nullable": true, "x-propertyPath": "ResourceFileAttachment->FileCategory_AutoIsRestricted" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceFileAttachment->FileFullName" }, "fileName": { "title": "fileName", "type": "string", "nullable": false, "x-propertyPath": "ResourceFileAttachment->FileName" }, "fileTypeId": { "title": "fileTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceFileAttachment->FileType_Id" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "ResourceFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceFileAttachment->IsRestricted" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceFileAttachment->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceFileAttachment->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceFileAttachment->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceFileAttachment->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceFileAttachment->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceFileAttachment->PermissionTree_Description" } } }, "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" } } }, "GetResourceFileAttachmentCollectionForResourceResourceActionResponse": { "title": "GetResourceFileAttachmentCollectionForResourceResourceActionResponse", "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": "GetResourceFileAttachmentCollectionForResourceResourceActionResponseItem", "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": "GetResourceFileAttachmentCollectionForResourceResourceActionResponseItemProperties", "type": "object", "properties": { "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "ResourceFileAttachment->Content_SizeInMb" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceFileAttachment->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" } } } }, "GetResourceFileAttachmentCollectionResourceActionResponse": { "title": "GetResourceFileAttachmentCollectionResourceActionResponse", "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": "GetResourceFileAttachmentCollectionResourceActionResponseItem", "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": "GetResourceFileAttachmentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceFileAttachment->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceFileAttachment->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceFileAttachment->Resource_Description" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "ResourceFileAttachment->Content_SizeInMb" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "ResourceFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceFileAttachment->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" } } } }, "CreateResourceFileAttachmentResourceActionRequest": { "title": "CreateResourceFileAttachmentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "resourceId" ], "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceFileAttachment->Resource_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "nullable": false, "x-propertyPath": "ResourceFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "string", "format": "binary" } } }, "UpdateResourceFileAttachmentContentResourceActionRequest": { "title": "UpdateResourceFileAttachmentContentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "x-propertyPath": "ResourceFileAttachment->Version" }, "file": { "type": "string", "format": "binary" } } }, "UpdateResourceFileAttachmentResourceActionRequest": { "title": "UpdateResourceFileAttachmentResourceActionRequest", "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": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceFileAttachment->FileCategory_Id" }, { "title": "fileName", "type": "string", "nullable": false, "x-propertyPath": "ResourceFileAttachment->FileName" }, { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceFileAttachment->IsRestricted" } ] } } }, "DeleteResourceFileAttachmentResourceResourceActionRequest": { "title": "DeleteResourceFileAttachmentResourceResourceActionRequest", "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 } } }, "BatchGetResourceFileAttachmentResourceAction": { "title": "BatchGetResourceFileAttachmentResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Resource File Attachment entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Resource File Attachment entities", "items": { "$ref": "#/components/schemas/GetResourceFileAttachmentResourceActionResponse" } }, "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" } } }, "GetResourceFileAttachmentContentHistoryResourceActionResponse": { "title": "GetResourceFileAttachmentContentHistoryResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Id" }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Version" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->ContentVersion" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FileAttachmentContentHistory->CreatedOn" }, "fileAttachmentId": { "title": "fileAttachmentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "FileAttachmentContentHistory->FileAttachment_Id" } } }, "GetResourceFileAttachmentContentHistoryResourceAction": { "title": "GetResourceFileAttachmentContentHistoryResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Resource File Attachment entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Resource File Attachment entities", "items": { "$ref": "#/components/schemas/GetResourceFileAttachmentContentHistoryResourceActionResponse" } }, "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" } } }, "BatchCreateResourceFileAttachmentResourceActionRequest": { "title": "BatchCreateResourceFileAttachmentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "resourceId" ], "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceFileAttachment->Resource_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "nullable": false, "x-propertyPath": "ResourceFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "BatchUpdateResourceFileAttachmentResourceActionRequest": { "title": "BatchUpdateResourceFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateResourceFileAttachmentResourceActionRequest" } }, "BatchDeleteResourceFileAttachmentResourceActionRequest": { "title": "BatchDeleteResourceFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteResourceFileAttachmentResourceResourceActionRequest" } }, "GetResourcePhoneNumberResourceActionResponse": { "title": "GetResourcePhoneNumberResourceActionResponse", "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": "GetResourcePhoneNumberResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourcePhoneNumber->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourcePhoneNumber->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourcePhoneNumber->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->PermissionTree_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->Notes" }, "phoneNumber": { "title": "phoneNumber", "type": "string", "format": "phone", "nullable": false, "x-propertyPath": "ResourcePhoneNumber->PhoneNumber" }, "phoneNumberTypeId": { "title": "phoneNumberTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->PhoneNumberType_Id" }, "phoneNumberTypeCode": { "title": "phoneNumberTypeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->PhoneNumberType_Code" }, "phoneNumberTypeDescription": { "title": "phoneNumberTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->PhoneNumberType_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourcePhoneNumber->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->Resource_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->SequenceNumber" } } }, "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" } } }, "GetResourcePhoneNumberCollectionResourceActionResponse": { "title": "GetResourcePhoneNumberCollectionResourceActionResponse", "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": "GetResourcePhoneNumberCollectionResourceActionResponseItem", "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": "GetResourcePhoneNumberCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "phoneNumber": { "title": "phoneNumber", "type": "string", "format": "phone", "nullable": false, "x-propertyPath": "ResourcePhoneNumber->PhoneNumber" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "nullable": false, "x-propertyPath": "ResourcePhoneNumber->Resource_Code" }, "phoneNumberTypeId": { "title": "phoneNumberTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->PhoneNumberType_Id" }, "phoneNumberTypeCode": { "title": "phoneNumberTypeCode", "type": "string", "nullable": false, "x-propertyPath": "ResourcePhoneNumber->PhoneNumberType_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->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" } } } }, "GetResourcePhoneNumberForResourceCollectionResourceActionResponse": { "title": "GetResourcePhoneNumberForResourceCollectionResourceActionResponse", "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": "GetResourcePhoneNumberForResourceCollectionResourceActionResponseItem", "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": "GetResourcePhoneNumberForResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "phoneNumber": { "title": "phoneNumber", "type": "string", "format": "phone", "nullable": false, "x-propertyPath": "ResourcePhoneNumber->PhoneNumber" }, "phoneNumberTypeId": { "title": "phoneNumberTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->PhoneNumberType_Id" }, "phoneNumberTypeCode": { "title": "phoneNumberTypeCode", "type": "string", "nullable": false, "x-propertyPath": "ResourcePhoneNumber->PhoneNumberType_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->Notes" } } }, "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" } } } }, "ResourcePhoneNumberInsertPermissionTreeLookupResourceActionResponse": { "title": "ResourcePhoneNumberInsertPermissionTreeLookupResourceActionResponse", "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": "ResourcePhoneNumberInsertPermissionTreeLookupResourceActionResponseItem", "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": "ResourcePhoneNumberInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourcePhoneNumberResourceLookupResourceActionResponse": { "title": "ResourcePhoneNumberResourceLookupResourceActionResponse", "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": "ResourcePhoneNumberResourceLookupResourceActionResponseItem", "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": "ResourcePhoneNumberResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Resource->Code" }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "Resource->Description" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" } } }, "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" } } } }, "ResourcePhoneNumberChangePermissionTreeLookupResourceActionResponse": { "title": "ResourcePhoneNumberChangePermissionTreeLookupResourceActionResponse", "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": "ResourcePhoneNumberChangePermissionTreeLookupResourceActionResponseItem", "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": "ResourcePhoneNumberChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourcePhoneNumberPhoneNumberTypeLookupResourceActionResponse": { "title": "ResourcePhoneNumberPhoneNumberTypeLookupResourceActionResponse", "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": "ResourcePhoneNumberPhoneNumberTypeLookupResourceActionResponseItem", "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": "ResourcePhoneNumberPhoneNumberTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PhoneNumberType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PhoneNumberType->Description" } } }, "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" } } } }, "CreateResourcePhoneNumberResourceActionRequest": { "title": "CreateResourcePhoneNumberResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateResourcePhoneNumberResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "phoneNumber", "phoneNumberTypeId", "resourceId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourcePhoneNumber->PermissionTree_Id", "x-systemGenerated": true }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->Notes" }, "phoneNumber": { "title": "phoneNumber", "type": "string", "format": "phone", "maxLength": 30, "minLength": 1, "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "nullable": false, "x-propertyPath": "ResourcePhoneNumber->PhoneNumber" }, "phoneNumberTypeId": { "title": "phoneNumberTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourcePhoneNumber->PhoneNumberType_Id" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourcePhoneNumber->Resource_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateResourcePhoneNumberResourceActionRequest": { "title": "UpdateResourcePhoneNumberResourceActionRequest", "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": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->Notes" }, { "title": "phoneNumber", "type": "string", "format": "phone", "maxLength": 30, "minLength": 1, "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "nullable": false, "x-propertyPath": "ResourcePhoneNumber->PhoneNumber" }, { "title": "phoneNumberTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->PhoneNumberType_Id" }, { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourcePhoneNumber->Resource_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourcePhoneNumber->SequenceNumber" } ] } } }, "DeleteResourcePhoneNumberResourceActionRequest": { "title": "DeleteResourcePhoneNumberResourceActionRequest", "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 } } }, "BatchGetResourcePhoneNumberResourceAction": { "title": "BatchGetResourcePhoneNumberResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Resource Phone Number entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Resource Phone Number entities", "items": { "$ref": "#/components/schemas/GetResourcePhoneNumberResourceActionResponse" } }, "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" } } }, "BatchCreateResourcePhoneNumberResourceActionRequest": { "title": "BatchCreateResourcePhoneNumberResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateResourcePhoneNumberResourceActionRequest" } }, "BatchUpdateResourcePhoneNumberResourceActionRequest": { "title": "BatchUpdateResourcePhoneNumberResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateResourcePhoneNumberResourceActionRequest" } }, "BatchDeleteResourcePhoneNumberResourceActionRequest": { "title": "BatchDeleteResourcePhoneNumberResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteResourcePhoneNumberResourceActionRequest" } }, "ChangeResourcePhoneNumberIsActiveResourceActionRequest": { "title": "ChangeResourcePhoneNumberIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourcePhoneNumber->IsActive" } ] } } }, "ChangeResourcePhoneNumberPermissionTreeResourceActionRequest": { "title": "ChangeResourcePhoneNumberPermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourcePhoneNumber->PermissionTree_Id" } ] } } }, "BatchChangeResourcePhoneNumberIsActiveResourceActionRequest": { "title": "BatchChangeResourcePhoneNumberIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourcePhoneNumberIsActiveResourceActionRequest" } }, "BatchChangeResourcePhoneNumberPermissionTreeResourceActionRequest": { "title": "BatchChangeResourcePhoneNumberPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourcePhoneNumberPermissionTreeResourceActionRequest" } }, "GetResourceTradeResourceActionResponse": { "title": "GetResourceTradeResourceActionResponse", "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": "GetResourceTradeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceTrade->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTrade->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTrade->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceTrade->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceTrade->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTrade->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTrade->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceTrade->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceTrade->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTrade->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTrade->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceTrade->PermissionTree_Description" }, "defaultResourceTradeFinancialRateId": { "title": "defaultResourceTradeFinancialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTrade->DefaultResourceTradeFinancialRate_Id" }, "defaultResourceTradeFinancialRateFinancialRateId": { "title": "defaultResourceTradeFinancialRateFinancialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTrade->DefaultResourceTradeFinancialRate_FinancialRateId" }, "defaultResourceTradeFinancialRateFinancialRateDescription": { "title": "defaultResourceTradeFinancialRateFinancialRateDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceTrade->DefaultResourceTradeFinancialRate_FinancialRateDescription" }, "isCustomised": { "title": "isCustomised", "type": "boolean", "nullable": true, "x-propertyPath": "ResourceTrade->IsCustomised" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceTrade->Notes" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTrade->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTrade->Resource_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceTrade->SequenceNumber" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTrade->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTrade->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceTrade->Trade_Description" } } }, "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" } } }, "GetResourceTradeCollectionResourceActionResponse": { "title": "GetResourceTradeCollectionResourceActionResponse", "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": "GetResourceTradeCollectionResourceActionResponseItem", "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": "GetResourceTradeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTrade->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTrade->Resource_Code" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "nullable": true, "x-propertyPath": "ResourceTrade->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "nullable": true, "x-propertyPath": "ResourceTrade->Resource_ContactDetailLastName" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceTrade->SequenceNumber" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTrade->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTrade->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceTrade->Trade_Description" }, "isCustomised": { "title": "isCustomised", "type": "boolean", "nullable": true, "x-propertyPath": "ResourceTrade->IsCustomised" } } }, "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" } } } }, "GetResourceTradeForResourceCollectionResourceActionResponse": { "title": "GetResourceTradeForResourceCollectionResourceActionResponse", "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": "GetResourceTradeForResourceCollectionResourceActionResponseItem", "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": "GetResourceTradeForResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTrade->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTrade->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceTrade->Trade_Description" }, "isCustomised": { "title": "isCustomised", "type": "boolean", "nullable": true, "x-propertyPath": "ResourceTrade->IsCustomised" }, "defaultResourceTradeFinancialRateId": { "title": "defaultResourceTradeFinancialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTrade->DefaultResourceTradeFinancialRate_Id" }, "defaultResourceTradeFinancialRateFinancialRateId": { "title": "defaultResourceTradeFinancialRateFinancialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTrade->DefaultResourceTradeFinancialRate_FinancialRateId" }, "defaultResourceTradeFinancialRateFinancialRateDescription": { "title": "defaultResourceTradeFinancialRateFinancialRateDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceTrade->DefaultResourceTradeFinancialRate_FinancialRateDescription" } } }, "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" } } } }, "ResourceTradeChangePermissionTreeLookupResourceActionResponse": { "title": "ResourceTradeChangePermissionTreeLookupResourceActionResponse", "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": "ResourceTradeChangePermissionTreeLookupResourceActionResponseItem", "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": "ResourceTradeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceTradeDefaultResourceTradeFinancialRateLookupResourceActionResponse": { "title": "ResourceTradeDefaultResourceTradeFinancialRateLookupResourceActionResponse", "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": "ResourceTradeDefaultResourceTradeFinancialRateLookupResourceActionResponseItem", "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": "ResourceTradeDefaultResourceTradeFinancialRateLookupResourceActionResponseItemProperties", "type": "object", "properties": { "resourceTradeId": { "title": "resourceTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Id" }, "financialRateId": { "title": "financialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateId" }, "financialRateDescription": { "title": "financialRateDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateDescription" }, "financialRateAmount": { "title": "financialRateAmount", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateAmount" }, "financialRateCurrencyId": { "title": "financialRateCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateCurrency_Id" }, "financialRateCurrencyCode": { "title": "financialRateCurrencyCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateCurrency_Code" }, "financialRateUnitOfMeasurementId": { "title": "financialRateUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Id" }, "financialRateUnitOfMeasurementCode": { "title": "financialRateUnitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Code" } } }, "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" } } } }, "ResourceTradeInsertPermissionTreeLookupResourceActionResponse": { "title": "ResourceTradeInsertPermissionTreeLookupResourceActionResponse", "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": "ResourceTradeInsertPermissionTreeLookupResourceActionResponseItem", "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": "ResourceTradeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceTradeResourceLookupResourceActionResponse": { "title": "ResourceTradeResourceLookupResourceActionResponse", "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": "ResourceTradeResourceLookupResourceActionResponseItem", "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": "ResourceTradeResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Resource->Code" }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "Resource->Description" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" } } }, "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" } } } }, "ResourceTradeTradeLookupResourceActionResponse": { "title": "ResourceTradeTradeLookupResourceActionResponse", "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": "ResourceTradeTradeLookupResourceActionResponseItem", "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": "ResourceTradeTradeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Trade->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Trade->Description" } } }, "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" } } } }, "CreateResourceTradeResourceActionRequest": { "title": "CreateResourceTradeResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateResourceTradeResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "resourceId", "tradeId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTrade->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceTrade->SequenceNumber" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTrade->Resource_Id" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTrade->Trade_Id" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceTrade->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateResourceTradeResourceActionRequest": { "title": "UpdateResourceTradeResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceTrade->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceTrade->Notes" }, { "title": "defaultResourceTradeFinancialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTrade->DefaultResourceTradeFinancialRate_Id" } ] } } }, "DeleteResourceTradeResourceActionRequest": { "title": "DeleteResourceTradeResourceActionRequest", "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 } } }, "BatchGetResourceTradeResourceAction": { "title": "BatchGetResourceTradeResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Resource Trade entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Resource Trade entities", "items": { "$ref": "#/components/schemas/GetResourceTradeResourceActionResponse" } }, "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" } } }, "BatchCreateResourceTradeResourceActionRequest": { "title": "BatchCreateResourceTradeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateResourceTradeResourceActionRequest" } }, "BatchUpdateResourceTradeResourceActionRequest": { "title": "BatchUpdateResourceTradeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateResourceTradeResourceActionRequest" } }, "BatchDeleteResourceTradeResourceActionRequest": { "title": "BatchDeleteResourceTradeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteResourceTradeResourceActionRequest" } }, "ChangeResourceTradeIsActiveResourceActionRequest": { "title": "ChangeResourceTradeIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceTrade->IsActive" } ] } } }, "ChangeResourceTradePermissionTreeResourceActionRequest": { "title": "ChangeResourceTradePermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTrade->PermissionTree_Id" } ] } } }, "CustomiseResourceTradeResourceActionRequest": { "title": "CustomiseResourceTradeResourceActionRequest", "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" } } } }, "ResetResourceTradeResourceActionRequest": { "title": "ResetResourceTradeResourceActionRequest", "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" } } } }, "BatchChangeResourceTradeIsActiveResourceActionRequest": { "title": "BatchChangeResourceTradeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceTradeIsActiveResourceActionRequest" } }, "BatchChangeResourceTradePermissionTreeResourceActionRequest": { "title": "BatchChangeResourceTradePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceTradePermissionTreeResourceActionRequest" } }, "GetResourceTradeCompetencyResourceActionResponse": { "title": "GetResourceTradeCompetencyResourceActionResponse", "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": "GetResourceTradeCompetencyResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceTradeCompetency->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceTradeCompetency->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->PermissionTree_Description" }, "expiryDate": { "title": "expiryDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceTradeCompetency->ExpiryDate" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->Notes" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->Proficiency" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->Resource_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->SequenceNumber" }, "tradeCompetencyId": { "title": "tradeCompetencyId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Id" }, "tradeCompetencyTradeId": { "title": "tradeCompetencyTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Trade_Id" }, "tradeCompetencyTradeCode": { "title": "tradeCompetencyTradeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Trade_Code" }, "tradeCompetencyTradeDescription": { "title": "tradeCompetencyTradeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Trade_Description" }, "tradeCompetencyCompetencyId": { "title": "tradeCompetencyCompetencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Competency_Id" }, "tradeCompetencyCompetencyCode": { "title": "tradeCompetencyCompetencyCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Competency_Code" }, "tradeCompetencyCompetencyDescription": { "title": "tradeCompetencyCompetencyDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Competency_Description" } } }, "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" } } }, "GetResourceTradeCompetencyCollectionResourceActionResponse": { "title": "GetResourceTradeCompetencyCollectionResourceActionResponse", "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": "GetResourceTradeCompetencyCollectionResourceActionResponseItem", "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": "GetResourceTradeCompetencyCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->Resource_Code" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->Resource_Description" }, "resourceContactDetailFirstName": { "title": "resourceContactDetailFirstName", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->Resource_ContactDetailFirstName" }, "resourceContactDetailLastName": { "title": "resourceContactDetailLastName", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->Resource_ContactDetailLastName" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->SequenceNumber" }, "tradeCompetencyId": { "title": "tradeCompetencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Id" }, "tradeCompetencyTradeId": { "title": "tradeCompetencyTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Trade_Id" }, "tradeCompetencyTradeCode": { "title": "tradeCompetencyTradeCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Trade_Code" }, "tradeCompetencyTradeDescription": { "title": "tradeCompetencyTradeDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Trade_Description" }, "tradeCompetencyCompetencyId": { "title": "tradeCompetencyCompetencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Competency_Id" }, "tradeCompetencyCompetencyCode": { "title": "tradeCompetencyCompetencyCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Competency_Code" }, "tradeCompetencyCompetencyDescription": { "title": "tradeCompetencyCompetencyDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Competency_Description" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->Proficiency" }, "expiryDate": { "title": "expiryDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceTradeCompetency->ExpiryDate" } } }, "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" } } } }, "GetResourceTradeCompetencyForResourceCollectionResourceActionResponse": { "title": "GetResourceTradeCompetencyForResourceCollectionResourceActionResponse", "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": "GetResourceTradeCompetencyForResourceCollectionResourceActionResponseItem", "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": "GetResourceTradeCompetencyForResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "tradeCompetencyId": { "title": "tradeCompetencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Id" }, "tradeCompetencyTradeId": { "title": "tradeCompetencyTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Trade_Id" }, "tradeCompetencyTradeCode": { "title": "tradeCompetencyTradeCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Trade_Code" }, "tradeCompetencyTradeDescription": { "title": "tradeCompetencyTradeDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Trade_Description" }, "tradeCompetencyCompetencyId": { "title": "tradeCompetencyCompetencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Competency_Id" }, "tradeCompetencyCompetencyCode": { "title": "tradeCompetencyCompetencyCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Competency_Code" }, "tradeCompetencyCompetencyDescription": { "title": "tradeCompetencyCompetencyDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Competency_Description" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->Proficiency" }, "expiryDate": { "title": "expiryDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceTradeCompetency->ExpiryDate" } } }, "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" } } } }, "ResourceTradeCompetencyChangePermissionTreeLookupResourceActionResponse": { "title": "ResourceTradeCompetencyChangePermissionTreeLookupResourceActionResponse", "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": "ResourceTradeCompetencyChangePermissionTreeLookupResourceActionResponseItem", "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": "ResourceTradeCompetencyChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceTradeCompetencyInsertPermissionTreeLookupResourceActionResponse": { "title": "ResourceTradeCompetencyInsertPermissionTreeLookupResourceActionResponse", "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": "ResourceTradeCompetencyInsertPermissionTreeLookupResourceActionResponseItem", "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": "ResourceTradeCompetencyInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceTradeCompetencyResourceLookupResourceActionResponse": { "title": "ResourceTradeCompetencyResourceLookupResourceActionResponse", "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": "ResourceTradeCompetencyResourceLookupResourceActionResponseItem", "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": "ResourceTradeCompetencyResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Resource->Code" }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "Resource->Description" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" } } }, "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" } } } }, "ResourceTradeCompetencyTradeCompetencyLookupResourceActionResponse": { "title": "ResourceTradeCompetencyTradeCompetencyLookupResourceActionResponse", "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": "ResourceTradeCompetencyTradeCompetencyLookupResourceActionResponseItem", "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": "ResourceTradeCompetencyTradeCompetencyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeCompetency->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "nullable": false, "x-propertyPath": "TradeCompetency->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "nullable": false, "x-propertyPath": "TradeCompetency->Trade_Description" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeCompetency->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "nullable": false, "x-propertyPath": "TradeCompetency->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "nullable": false, "x-propertyPath": "TradeCompetency->Competency_Description" }, "competencyValidityType": { "title": "competencyValidityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "TradeCompetency->Competency_ValidityType", "x-formatSpecifier": "CompetencyValidityType" } } }, "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" } } } }, "CreateResourceTradeCompetencyResourceActionRequest": { "title": "CreateResourceTradeCompetencyResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateResourceTradeCompetencyResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "resourceId", "tradeCompetencyId", "proficiency" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->SequenceNumber" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->Resource_Id" }, "tradeCompetencyId": { "title": "tradeCompetencyId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->TradeCompetency_Id" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "minimum": 1.0, "nullable": false, "x-propertyPath": "ResourceTradeCompetency->Proficiency" }, "expiryDate": { "title": "expiryDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceTradeCompetency->ExpiryDate" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateResourceTradeCompetencyResourceActionRequest": { "title": "UpdateResourceTradeCompetencyResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->SequenceNumber" }, { "title": "proficiency", "type": "integer", "format": "int32", "minimum": 1.0, "nullable": true, "x-propertyPath": "ResourceTradeCompetency->Proficiency" }, { "title": "expiryDate", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceTradeCompetency->ExpiryDate" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeCompetency->Notes" } ] } } }, "DeleteResourceTradeCompetencyResourceActionRequest": { "title": "DeleteResourceTradeCompetencyResourceActionRequest", "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 } } }, "BatchGetResourceTradeCompetencyResourceAction": { "title": "BatchGetResourceTradeCompetencyResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Resource Trade Competency entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Resource Trade Competency entities", "items": { "$ref": "#/components/schemas/GetResourceTradeCompetencyResourceActionResponse" } }, "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" } } }, "BatchCreateResourceTradeCompetencyResourceActionRequest": { "title": "BatchCreateResourceTradeCompetencyResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateResourceTradeCompetencyResourceActionRequest" } }, "BatchUpdateResourceTradeCompetencyResourceActionRequest": { "title": "BatchUpdateResourceTradeCompetencyResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateResourceTradeCompetencyResourceActionRequest" } }, "BatchDeleteResourceTradeCompetencyResourceActionRequest": { "title": "BatchDeleteResourceTradeCompetencyResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteResourceTradeCompetencyResourceActionRequest" } }, "ChangeResourceTradeCompetencyIsActiveResourceActionRequest": { "title": "ChangeResourceTradeCompetencyIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->IsActive" } ] } } }, "ChangeResourceTradeCompetencyPermissionTreeResourceActionRequest": { "title": "ChangeResourceTradeCompetencyPermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeCompetency->PermissionTree_Id" } ] } } }, "BatchChangeResourceTradeCompetencyIsActiveResourceActionRequest": { "title": "BatchChangeResourceTradeCompetencyIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceTradeCompetencyIsActiveResourceActionRequest" } }, "BatchChangeResourceTradeCompetencyPermissionTreeResourceActionRequest": { "title": "BatchChangeResourceTradeCompetencyPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceTradeCompetencyPermissionTreeResourceActionRequest" } }, "GetResourceTradeFinancialRateResourceActionResponse": { "title": "GetResourceTradeFinancialRateResourceActionResponse", "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": "GetResourceTradeFinancialRateResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceTradeFinancialRate->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceTradeFinancialRate->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->PermissionTree_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->CostElement_Description" }, "financialRateId": { "title": "financialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateId" }, "financialRateAmount": { "title": "financialRateAmount", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateAmount" }, "financialRateCurrencyId": { "title": "financialRateCurrencyId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateCurrency_Id" }, "financialRateCurrencyCode": { "title": "financialRateCurrencyCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateCurrency_Code" }, "financialRateCurrencyDescription": { "title": "financialRateCurrencyDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateCurrency_Description" }, "financialRateDescription": { "title": "financialRateDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateDescription" }, "financialRateUnitOfMeasurementId": { "title": "financialRateUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Id" }, "financialRateUnitOfMeasurementCode": { "title": "financialRateUnitOfMeasurementCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Code" }, "financialRateUnitOfMeasurementDescription": { "title": "financialRateUnitOfMeasurementDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Description" }, "financialRateUnitOfMeasurementMeasurementType": { "title": "financialRateUnitOfMeasurementMeasurementType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_MeasurementType", "x-formatSpecifier": "MeasurementType" }, "financialRateUnitOfMeasurementMeasurementTypeQuantity": { "title": "financialRateUnitOfMeasurementMeasurementTypeQuantity", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_MeasurementTypeQuantity" }, "isCustomised": { "title": "isCustomised", "type": "boolean", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->IsCustomised" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->Notes" }, "resourceTradeId": { "title": "resourceTradeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Id" }, "resourceTradeResourceId": { "title": "resourceTradeResourceId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Resource_Id" }, "resourceTradeResourceCode": { "title": "resourceTradeResourceCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Resource_Code" }, "resourceTradeResourceDescription": { "title": "resourceTradeResourceDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Resource_Description" }, "resourceTradeTradeId": { "title": "resourceTradeTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Trade_Id" }, "resourceTradeTradeCode": { "title": "resourceTradeTradeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Trade_Code" }, "resourceTradeTradeDescription": { "title": "resourceTradeTradeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Trade_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->SequenceNumber" }, "tradeFinancialRateId": { "title": "tradeFinancialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->TradeFinancialRate_Id" }, "tradeFinancialRateFinancialRateId": { "title": "tradeFinancialRateFinancialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->TradeFinancialRate_FinancialRateId" }, "tradeFinancialRateFinancialRateCurrencyId": { "title": "tradeFinancialRateFinancialRateCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->TradeFinancialRate_FinancialRateCurrency_Id" }, "tradeFinancialRateFinancialRateCurrencyCode": { "title": "tradeFinancialRateFinancialRateCurrencyCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->TradeFinancialRate_FinancialRateCurrency_Code" }, "tradeFinancialRateFinancialRateCurrencyDescription": { "title": "tradeFinancialRateFinancialRateCurrencyDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->TradeFinancialRate_FinancialRateCurrency_Description" }, "tradeFinancialRateFinancialRateUnitOfMeasurementId": { "title": "tradeFinancialRateFinancialRateUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->TradeFinancialRate_FinancialRateUnitOfMeasurement_Id" }, "tradeFinancialRateFinancialRateUnitOfMeasurementCode": { "title": "tradeFinancialRateFinancialRateUnitOfMeasurementCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->TradeFinancialRate_FinancialRateUnitOfMeasurement_Code" }, "tradeFinancialRateFinancialRateUnitOfMeasurementDescription": { "title": "tradeFinancialRateFinancialRateUnitOfMeasurementDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->TradeFinancialRate_FinancialRateUnitOfMeasurement_Description" }, "tradeFinancialRateTradeId": { "title": "tradeFinancialRateTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->TradeFinancialRate_Trade_Id" }, "tradeFinancialRateTradeCode": { "title": "tradeFinancialRateTradeCode", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->TradeFinancialRate_Trade_Code" }, "tradeFinancialRateTradeDescription": { "title": "tradeFinancialRateTradeDescription", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->TradeFinancialRate_Trade_Description" } } }, "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" } } }, "GetResourceTradeFinancialRateCollectionResourceActionResponse": { "title": "GetResourceTradeFinancialRateCollectionResourceActionResponse", "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": "GetResourceTradeFinancialRateCollectionResourceActionResponseItem", "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": "GetResourceTradeFinancialRateCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "resourceTradeId": { "title": "resourceTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Id" }, "resourceTradeTradeId": { "title": "resourceTradeTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Trade_Id" }, "resourceTradeTradeCode": { "title": "resourceTradeTradeCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Trade_Code" }, "resourceTradeResourceId": { "title": "resourceTradeResourceId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Resource_Id" }, "resourceTradeResourceCode": { "title": "resourceTradeResourceCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Resource_Code" }, "tradeFinancialRateId": { "title": "tradeFinancialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->TradeFinancialRate_Id" }, "financialRateId": { "title": "financialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateId" }, "financialRateAmount": { "title": "financialRateAmount", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateAmount" }, "financialRateDescription": { "title": "financialRateDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateDescription" }, "financialRateCurrencyId": { "title": "financialRateCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateCurrency_Id" }, "financialRateCurrencyCode": { "title": "financialRateCurrencyCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateCurrency_Code" }, "financialRateUnitOfMeasurementId": { "title": "financialRateUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Id" }, "financialRateUnitOfMeasurementCode": { "title": "financialRateUnitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Code" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->CostElement_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->Notes" }, "isCustomised": { "title": "isCustomised", "type": "boolean", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->IsCustomised" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceTradeFinancialRate->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceTradeFinancialRate->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" } } } }, "GetResourceTradeFinancialRateForResourceCollectionResourceActionResponse": { "title": "GetResourceTradeFinancialRateForResourceCollectionResourceActionResponse", "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": "GetResourceTradeFinancialRateForResourceCollectionResourceActionResponseItem", "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": "GetResourceTradeFinancialRateForResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "resourceTradeId": { "title": "resourceTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Id" }, "resourceTradeTradeId": { "title": "resourceTradeTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Trade_Id" }, "resourceTradeTradeCode": { "title": "resourceTradeTradeCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Trade_Code" }, "resourceTradeResourceId": { "title": "resourceTradeResourceId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Resource_Id" }, "resourceTradeResourceCode": { "title": "resourceTradeResourceCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Resource_Code" }, "tradeFinancialRateId": { "title": "tradeFinancialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->TradeFinancialRate_Id" }, "financialRateId": { "title": "financialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateId" }, "financialRateAmount": { "title": "financialRateAmount", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateAmount" }, "financialRateDescription": { "title": "financialRateDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateDescription" }, "financialRateCurrencyId": { "title": "financialRateCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateCurrency_Id" }, "financialRateCurrencyCode": { "title": "financialRateCurrencyCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateCurrency_Code" }, "financialRateUnitOfMeasurementId": { "title": "financialRateUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Id" }, "financialRateUnitOfMeasurementCode": { "title": "financialRateUnitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Code" }, "financialRateUnitOfMeasurementDescription": { "title": "financialRateUnitOfMeasurementDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Description" }, "financialRateUnitOfMeasurementMeasurementType": { "title": "financialRateUnitOfMeasurementMeasurementType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_MeasurementType", "x-formatSpecifier": "MeasurementType" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->CostElement_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->Notes" }, "isCustomised": { "title": "isCustomised", "type": "boolean", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->IsCustomised" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceTradeFinancialRate->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ResourceTradeFinancialRate->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" } } } }, "GetResourceTradeFinancialRateForResourceTradeCollectionResourceActionResponse": { "title": "GetResourceTradeFinancialRateForResourceTradeCollectionResourceActionResponse", "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": "GetResourceTradeFinancialRateForResourceTradeCollectionResourceActionResponseItem", "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": "GetResourceTradeFinancialRateForResourceTradeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isCustomised": { "title": "isCustomised", "type": "boolean", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->IsCustomised" }, "financialRateId": { "title": "financialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateId" }, "financialRateAmount": { "title": "financialRateAmount", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateAmount" }, "financialRateDescription": { "title": "financialRateDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateDescription" }, "financialRateCurrencyId": { "title": "financialRateCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateCurrency_Id" }, "financialRateCurrencyCode": { "title": "financialRateCurrencyCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateCurrency_Code" }, "financialRateUnitOfMeasurementId": { "title": "financialRateUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Id" }, "financialRateUnitOfMeasurementCode": { "title": "financialRateUnitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Code" } } }, "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" } } } }, "ResourceTradeFinancialRateChangePermissionTreeLookupResourceActionResponse": { "title": "ResourceTradeFinancialRateChangePermissionTreeLookupResourceActionResponse", "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": "ResourceTradeFinancialRateChangePermissionTreeLookupResourceActionResponseItem", "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": "ResourceTradeFinancialRateChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceTradeFinancialRateCostElementLookupResourceActionResponse": { "title": "ResourceTradeFinancialRateCostElementLookupResourceActionResponse", "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": "ResourceTradeFinancialRateCostElementLookupResourceActionResponseItem", "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": "ResourceTradeFinancialRateCostElementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "CostElement->Description" } } }, "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" } } } }, "ResourceTradeFinancialRateCurrencyLookupResourceActionResponse": { "title": "ResourceTradeFinancialRateCurrencyLookupResourceActionResponse", "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": "ResourceTradeFinancialRateCurrencyLookupResourceActionResponseItem", "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": "ResourceTradeFinancialRateCurrencyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Currency->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Currency->Description" } } }, "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" } } } }, "ResourceTradeFinancialRateInsertPermissionTreeLookupResourceActionResponse": { "title": "ResourceTradeFinancialRateInsertPermissionTreeLookupResourceActionResponse", "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": "ResourceTradeFinancialRateInsertPermissionTreeLookupResourceActionResponseItem", "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": "ResourceTradeFinancialRateInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "ResourceTradeFinancialRateResourceLookupResourceActionResponse": { "title": "ResourceTradeFinancialRateResourceLookupResourceActionResponse", "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": "ResourceTradeFinancialRateResourceLookupResourceActionResponseItem", "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": "ResourceTradeFinancialRateResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Resource->Code" }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "Resource->Description" } } }, "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" } } } }, "ResourceTradeFinancialRateResourceTradeLookupResourceActionResponse": { "title": "ResourceTradeFinancialRateResourceTradeLookupResourceActionResponse", "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": "ResourceTradeFinancialRateResourceTradeLookupResourceActionResponseItem", "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": "ResourceTradeFinancialRateResourceTradeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTrade->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTrade->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceTrade->Trade_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "ResourceTrade->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "nullable": false, "x-propertyPath": "ResourceTrade->Resource_Code" } } }, "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" } } } }, "ResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse": { "title": "ResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponse", "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": "ResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItem", "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": "ResourceTradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" } } }, "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" } } } }, "CreateResourceTradeFinancialRateResourceActionRequest": { "title": "CreateResourceTradeFinancialRateResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateResourceTradeFinancialRateResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "resourceTradeId", "costElementId", "financialRateDescription", "financialRateAmount", "financialRateCurrencyId", "financialRateUnitOfMeasurementId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->PermissionTree_Id", "x-systemGenerated": true }, "resourceTradeId": { "title": "resourceTradeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->ResourceTrade_Id" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->CostElement_Id" }, "isCustomised": { "title": "isCustomised", "type": "boolean", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->IsCustomised" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->SequenceNumber" }, "financialRateDescription": { "title": "financialRateDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateDescription" }, "financialRateAmount": { "title": "financialRateAmount", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateAmount" }, "financialRateCurrencyId": { "title": "financialRateCurrencyId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateCurrency_Id" }, "financialRateUnitOfMeasurementId": { "title": "financialRateUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Id" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateResourceTradeFinancialRateResourceActionRequest": { "title": "UpdateResourceTradeFinancialRateResourceActionRequest", "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": "costElementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->CostElement_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->SequenceNumber" }, { "title": "financialRateDescription", "type": "string", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateDescription" }, { "title": "financialRateAmount", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateAmount" }, { "title": "financialRateCurrencyId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateCurrency_Id" }, { "title": "financialRateUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->FinancialRateUnitOfMeasurement_Id" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "ResourceTradeFinancialRate->Notes" } ] } } }, "DeleteResourceTradeFinancialRateResourceActionRequest": { "title": "DeleteResourceTradeFinancialRateResourceActionRequest", "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 } } }, "BatchGetResourceTradeFinancialRateResourceAction": { "title": "BatchGetResourceTradeFinancialRateResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Resource Trade Financial Rate entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Resource Trade Financial Rate entities", "items": { "$ref": "#/components/schemas/GetResourceTradeFinancialRateResourceActionResponse" } }, "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" } } }, "BatchCreateResourceTradeFinancialRateResourceActionRequest": { "title": "BatchCreateResourceTradeFinancialRateResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateResourceTradeFinancialRateResourceActionRequest" } }, "BatchUpdateResourceTradeFinancialRateResourceActionRequest": { "title": "BatchUpdateResourceTradeFinancialRateResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateResourceTradeFinancialRateResourceActionRequest" } }, "BatchDeleteResourceTradeFinancialRateResourceActionRequest": { "title": "BatchDeleteResourceTradeFinancialRateResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteResourceTradeFinancialRateResourceActionRequest" } }, "ChangeResourceTradeFinancialRateIsActiveResourceActionRequest": { "title": "ChangeResourceTradeFinancialRateIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->IsActive" } ] } } }, "ChangeResourceTradeFinancialRatePermissionTreeResourceActionRequest": { "title": "ChangeResourceTradeFinancialRatePermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "ResourceTradeFinancialRate->PermissionTree_Id" } ] } } }, "CustomiseResourceTradeFinancialRateResourceActionRequest": { "title": "CustomiseResourceTradeFinancialRateResourceActionRequest", "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" } } } }, "ResetResourceTradeFinancialRateResourceActionRequest": { "title": "ResetResourceTradeFinancialRateResourceActionRequest", "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" } } } }, "BatchChangeResourceTradeFinancialRateIsActiveResourceActionRequest": { "title": "BatchChangeResourceTradeFinancialRateIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceTradeFinancialRateIsActiveResourceActionRequest" } }, "BatchChangeResourceTradeFinancialRatePermissionTreeResourceActionRequest": { "title": "BatchChangeResourceTradeFinancialRatePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeResourceTradeFinancialRatePermissionTreeResourceActionRequest" } }, "GetSectionResourceActionResponse": { "title": "GetSectionResourceActionResponse", "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": "GetSectionResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Section->Code" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "Section->IsActive" }, "geographicId": { "title": "geographicId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Section->GeographicId" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Section->GeographicEndPosition" }, "geographicEntityType": { "title": "geographicEntityType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "Section->GeographicEntityType", "x-formatSpecifier": "EntityType" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Section->GeographicLength" }, "geographicLocation": { "title": "geographicLocation", "nullable": true, "$ref": "#/components/schemas/Geometry", "x-propertyPath": "Section->GeographicLocation" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "nullable": true, "x-propertyPath": "Section->GeographicNotes" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Section->GeographicReferenceEntityId" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Section->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Section->GeographicStartPosition" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Section->GeographicUnitOfMeasurement_Id" }, "geographicUnitOfMeasurementDescription": { "title": "geographicUnitOfMeasurementDescription", "type": "string", "nullable": true, "x-propertyPath": "Section->GeographicUnitOfMeasurement_Description" }, "geographicUnitOfMeasurementCode": { "title": "geographicUnitOfMeasurementCode", "type": "string", "nullable": true, "x-propertyPath": "Section->GeographicUnitOfMeasurement_Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Section->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Section->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Section->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Section->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Section->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Section->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Section->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Section->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Section->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "Section->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "Section->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Section->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "nullable": true, "x-propertyPath": "Section->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "nullable": true, "x-propertyPath": "Section->Site_Description" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Section->Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Section->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Section->SequenceNumber" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Section->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "nullable": true, "x-propertyPath": "Section->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "nullable": true, "x-propertyPath": "Section->Supplier_Description" } } }, "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" } } }, "GetSectionCollectionResourceActionResponse": { "title": "GetSectionCollectionResourceActionResponse", "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": "GetSectionCollectionResourceActionResponseItem", "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": "GetSectionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Section->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Section->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Section->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Section->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Section->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Section->ModifiedOn" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Section->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "nullable": false, "x-propertyPath": "Section->Site_Code" } } }, "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" } } } }, "SectionChangePermissionTreeLookupResourceActionResponse": { "title": "SectionChangePermissionTreeLookupResourceActionResponse", "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": "SectionChangePermissionTreeLookupResourceActionResponseItem", "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": "SectionChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "SectionInsertPermissionTreeLookupResourceActionResponse": { "title": "SectionInsertPermissionTreeLookupResourceActionResponse", "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": "SectionInsertPermissionTreeLookupResourceActionResponseItem", "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": "SectionInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "SectionSiteLookupResourceActionResponse": { "title": "SectionSiteLookupResourceActionResponse", "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": "SectionSiteLookupResourceActionResponseItem", "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": "SectionSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Site->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Site->Description" } } }, "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" } } } }, "SectionSupplierLookupResourceActionResponse": { "title": "SectionSupplierLookupResourceActionResponse", "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": "SectionSupplierLookupResourceActionResponseItem", "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": "SectionSupplierLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Supplier->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Supplier->Description" } } }, "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" } } } }, "CreateSectionResourceActionRequest": { "title": "CreateSectionResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateSectionResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Section->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Section->SequenceNumber" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "Section->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "Section->Description" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Section->Supplier_Id" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Section->Site_Id" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Section->Notes" }, "geographicLocation": { "title": "geographicLocation", "nullable": true, "$ref": "#/components/schemas/Geometry", "x-propertyPath": "Section->GeographicLocation" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Section->GeographicStartPosition" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Section->GeographicEndPosition" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Section->GeographicLength" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Section->GeographicUnitOfMeasurement_Id" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "nullable": true, "x-propertyPath": "Section->GeographicNotes" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Section->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Section->GeographicReferenceEntityId" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateSectionResourceActionRequest": { "title": "UpdateSectionResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Section->SequenceNumber" }, { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "Section->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "Section->Description" }, { "title": "siteId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Section->Site_Id" }, { "title": "supplierId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Section->Supplier_Id" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Section->Notes" }, { "title": "geographicLocation", "nullable": true, "x-propertyPath": "Section->GeographicLocation" }, { "title": "geographicStartPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Section->GeographicStartPosition" }, { "title": "geographicEndPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Section->GeographicEndPosition" }, { "title": "geographicLength", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "Section->GeographicLength" }, { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Section->GeographicUnitOfMeasurement_Id" }, { "title": "geographicNotes", "type": "string", "nullable": true, "x-propertyPath": "Section->GeographicNotes" }, { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Section->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Section->GeographicReferenceEntityId" } ] } } }, "DeleteSectionResourceActionRequest": { "title": "DeleteSectionResourceActionRequest", "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 } } }, "BatchGetSectionResourceAction": { "title": "BatchGetSectionResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Section entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Section entities", "items": { "$ref": "#/components/schemas/GetSectionResourceActionResponse" } }, "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" } } }, "BatchCreateSectionResourceActionRequest": { "title": "BatchCreateSectionResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateSectionResourceActionRequest" } }, "BatchUpdateSectionResourceActionRequest": { "title": "BatchUpdateSectionResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateSectionResourceActionRequest" } }, "BatchDeleteSectionResourceActionRequest": { "title": "BatchDeleteSectionResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteSectionResourceActionRequest" } }, "ChangeSectionIsActiveResourceActionRequest": { "title": "ChangeSectionIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "Section->IsActive" } ] } } }, "ChangeSectionPermissionTreeResourceActionRequest": { "title": "ChangeSectionPermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Section->PermissionTree_Id" } ] } } }, "BatchChangeSectionIsActiveResourceActionRequest": { "title": "BatchChangeSectionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeSectionIsActiveResourceActionRequest" } }, "BatchChangeSectionPermissionTreeResourceActionRequest": { "title": "BatchChangeSectionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeSectionPermissionTreeResourceActionRequest" } }, "GetSectionAttributeResourceActionResponse": { "title": "GetSectionAttributeResourceActionResponse", "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": "GetSectionAttributeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionAttribute->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->Section_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SectionAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "SectionAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SectionAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "nullable": true, "x-propertyPath": "SectionAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "SectionAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "SectionAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "SectionAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "SectionAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "SectionAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "SectionAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "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" } } }, "GetSectionAttributeCollectionForSectionResourceActionResponse": { "title": "GetSectionAttributeCollectionForSectionResourceActionResponse", "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": "GetSectionAttributeCollectionForSectionResourceActionResponseItem", "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": "GetSectionAttributeCollectionForSectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "SectionAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "SectionAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "SectionAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "SectionAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "SectionAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "SectionAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SectionAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SectionAttribute->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" } } } }, "GetSectionAttributeCollectionResourceActionResponse": { "title": "GetSectionAttributeCollectionResourceActionResponse", "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": "GetSectionAttributeCollectionResourceActionResponseItem", "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": "GetSectionAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionAttribute->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "nullable": false, "x-propertyPath": "SectionAttribute->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "nullable": false, "x-propertyPath": "SectionAttribute->Section_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "SectionAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "SectionAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "SectionAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "SectionAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "SectionAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "SectionAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SectionAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SectionAttribute->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" } } } }, "SectionAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "SectionAttributeAttributeAllowedValueLookupResourceActionResponse", "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": "SectionAttributeAttributeAllowedValueLookupResourceActionResponseItem", "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": "SectionAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "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" } } } }, "SectionAttributeAttributeLookupResourceActionResponse": { "title": "SectionAttributeAttributeLookupResourceActionResponse", "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": "SectionAttributeAttributeLookupResourceActionResponseItem", "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": "SectionAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "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" } } } }, "SectionAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "SectionAttributeChangePermissionTreeLookupResourceActionResponse", "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": "SectionAttributeChangePermissionTreeLookupResourceActionResponseItem", "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": "SectionAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "SectionAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "SectionAttributeInsertPermissionTreeLookupResourceActionResponse", "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": "SectionAttributeInsertPermissionTreeLookupResourceActionResponseItem", "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": "SectionAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "SectionAttributeSectionLookupResourceActionResponse": { "title": "SectionAttributeSectionLookupResourceActionResponse", "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": "SectionAttributeSectionLookupResourceActionResponseItem", "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": "SectionAttributeSectionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Section->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Section->Description" } } }, "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" } } } }, "CreateSectionAttributeResourceActionRequest": { "title": "CreateSectionAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateSectionAttributeResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "sectionId", "attributeId" ], "properties": { "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionAttribute->Section_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "SectionAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "SectionAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateSectionAttributeResourceActionRequest": { "title": "UpdateSectionAttributeResourceActionRequest", "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": "value", "format": "composite", "nullable": true, "x-propertyPath": "SectionAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "SectionAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "SectionAttribute->Notes" } ] } } }, "DeleteSectionAttributeResourceActionRequest": { "title": "DeleteSectionAttributeResourceActionRequest", "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 } } }, "BatchGetSectionAttributeResourceAction": { "title": "BatchGetSectionAttributeResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Section Attribute entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Section Attribute entities", "items": { "$ref": "#/components/schemas/GetSectionAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateSectionAttributeResourceActionRequest": { "title": "BatchCreateSectionAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateSectionAttributeResourceActionRequest" } }, "BatchUpdateSectionAttributeResourceActionRequest": { "title": "BatchUpdateSectionAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateSectionAttributeResourceActionRequest" } }, "BatchDeleteSectionAttributeResourceActionRequest": { "title": "BatchDeleteSectionAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteSectionAttributeResourceActionRequest" } }, "ChangeSectionAttributeIsActiveResourceActionRequest": { "title": "ChangeSectionAttributeIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "SectionAttribute->IsActive" } ] } } }, "ChangeSectionAttributePermissionTreeResourceActionRequest": { "title": "ChangeSectionAttributePermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionAttribute->PermissionTree_Id" } ] } } }, "BatchChangeSectionAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeSectionAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeSectionAttributePermissionTreeResourceActionRequest" } }, "BatchChangeSectionAttributeIsActiveResourceActionRequest": { "title": "BatchChangeSectionAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeSectionAttributeIsActiveResourceActionRequest" } }, "GetSectionDocumentResourceActionResponse": { "title": "GetSectionDocumentResourceActionResponse", "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": "GetSectionDocumentResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionDocument->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->Section_Description" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "SectionDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SectionDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SectionDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "SectionDocument->SequenceNumber" } } }, "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" } } }, "GetSectionDocumentCollectionForSectionResourceActionResponse": { "title": "GetSectionDocumentCollectionForSectionResourceActionResponse", "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": "GetSectionDocumentCollectionForSectionResourceActionResponseItem", "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": "GetSectionDocumentCollectionForSectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "SectionDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "SectionDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "SectionDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_FileType_Extension" } } }, "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" } } } }, "GetSectionDocumentCollectionResourceActionResponse": { "title": "GetSectionDocumentCollectionResourceActionResponse", "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": "GetSectionDocumentCollectionResourceActionResponseItem", "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": "GetSectionDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionDocument->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "nullable": false, "x-propertyPath": "SectionDocument->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "nullable": false, "x-propertyPath": "SectionDocument->Section_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "SectionDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "SectionDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "SectionDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->DocumentRecord_FileType_Extension" } } }, "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" } } } }, "SectionDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "SectionDocumentChangePermissionTreeLookupResourceActionResponse", "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": "SectionDocumentChangePermissionTreeLookupResourceActionResponseItem", "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": "SectionDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "SectionDocumentDocumentLookupResourceActionResponse": { "title": "SectionDocumentDocumentLookupResourceActionResponse", "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": "SectionDocumentDocumentLookupResourceActionResponseItem", "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": "SectionDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "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" } } } }, "SectionDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "SectionDocumentInsertPermissionTreeLookupResourceActionResponse", "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": "SectionDocumentInsertPermissionTreeLookupResourceActionResponseItem", "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": "SectionDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "SectionDocumentSectionLookupResourceActionResponse": { "title": "SectionDocumentSectionLookupResourceActionResponse", "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": "SectionDocumentSectionLookupResourceActionResponseItem", "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": "SectionDocumentSectionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Section->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Section->Description" } } }, "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" } } } }, "CreateSectionDocumentResourceActionRequest": { "title": "CreateSectionDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateSectionDocumentResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "sectionId", "documentRecordId" ], "properties": { "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionDocument->Section_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "SectionDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateSectionDocumentResourceActionRequest": { "title": "UpdateSectionDocumentResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "SectionDocument->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "SectionDocument->Notes" } ] } } }, "DeleteSectionDocumentResourceActionRequest": { "title": "DeleteSectionDocumentResourceActionRequest", "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 } } }, "BatchGetSectionDocumentResourceAction": { "title": "BatchGetSectionDocumentResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Section Document entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Section Document entities", "items": { "$ref": "#/components/schemas/GetSectionDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateSectionDocumentResourceActionRequest": { "title": "BatchCreateSectionDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateSectionDocumentResourceActionRequest" } }, "BatchUpdateSectionDocumentResourceActionRequest": { "title": "BatchUpdateSectionDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateSectionDocumentResourceActionRequest" } }, "BatchDeleteSectionDocumentResourceActionRequest": { "title": "BatchDeleteSectionDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteSectionDocumentResourceActionRequest" } }, "ChangeSectionDocumentIsActiveResourceActionRequest": { "title": "ChangeSectionDocumentIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "SectionDocument->IsActive" } ] } } }, "ChangeSectionDocumentPermissionTreeResourceActionRequest": { "title": "ChangeSectionDocumentPermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionDocument->PermissionTree_Id" } ] } } }, "BatchChangeSectionDocumentIsActiveResourceActionRequest": { "title": "BatchChangeSectionDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeSectionDocumentIsActiveResourceActionRequest" } }, "BatchChangeSectionDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeSectionDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeSectionDocumentPermissionTreeResourceActionRequest" } }, "GetSectionTradeResourceActionResponse": { "title": "GetSectionTradeResourceActionResponse", "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": "GetSectionTradeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionTrade->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "SectionTrade->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "SectionTrade->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SectionTrade->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "SectionTrade->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "SectionTrade->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "SectionTrade->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SectionTrade->ModifiedOn" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "SectionTrade->IsActive" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionTrade->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "SectionTrade->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "SectionTrade->PermissionTree_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "SectionTrade->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "SectionTrade->SequenceNumber" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionTrade->Section_Id" }, "sectionCode": { "title": "sectionCode", "type": "string", "nullable": true, "x-propertyPath": "SectionTrade->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "nullable": true, "x-propertyPath": "SectionTrade->Section_Description" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionTrade->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "nullable": true, "x-propertyPath": "SectionTrade->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "nullable": true, "x-propertyPath": "SectionTrade->Trade_Description" } } }, "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" } } }, "GetSectionTradeCollectionResourceActionResponse": { "title": "GetSectionTradeCollectionResourceActionResponse", "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": "GetSectionTradeCollectionResourceActionResponseItem", "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": "GetSectionTradeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sectionCode": { "title": "sectionCode", "type": "string", "nullable": false, "x-propertyPath": "SectionTrade->Section_Code" }, "sectionDescription": { "title": "sectionDescription", "type": "string", "nullable": false, "x-propertyPath": "SectionTrade->Section_Description" }, "tradeCode": { "title": "tradeCode", "type": "string", "nullable": false, "x-propertyPath": "SectionTrade->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "nullable": false, "x-propertyPath": "SectionTrade->Trade_Description" } } }, "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" } } } }, "GetSectionTradeForSectionCollectionResourceActionResponse": { "title": "GetSectionTradeForSectionCollectionResourceActionResponse", "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": "GetSectionTradeForSectionCollectionResourceActionResponseItem", "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": "GetSectionTradeForSectionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "tradeCode": { "title": "tradeCode", "type": "string", "nullable": false, "x-propertyPath": "SectionTrade->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "nullable": false, "x-propertyPath": "SectionTrade->Trade_Description" } } }, "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" } } } }, "SectionTradeChangePermissionTreeLookupResourceActionResponse": { "title": "SectionTradeChangePermissionTreeLookupResourceActionResponse", "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": "SectionTradeChangePermissionTreeLookupResourceActionResponseItem", "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": "SectionTradeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "SectionTradeInsertPermissionTreeLookupResourceActionResponse": { "title": "SectionTradeInsertPermissionTreeLookupResourceActionResponse", "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": "SectionTradeInsertPermissionTreeLookupResourceActionResponseItem", "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": "SectionTradeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "SectionTradeSectionLookupResourceActionResponse": { "title": "SectionTradeSectionLookupResourceActionResponse", "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": "SectionTradeSectionLookupResourceActionResponseItem", "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": "SectionTradeSectionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Section->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Section->Description" } } }, "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" } } } }, "SectionTradeTradeLookupResourceActionResponse": { "title": "SectionTradeTradeLookupResourceActionResponse", "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": "SectionTradeTradeLookupResourceActionResponseItem", "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": "SectionTradeTradeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Trade->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Trade->Description" } } }, "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" } } } }, "CreateSectionTradeResourceActionRequest": { "title": "CreateSectionTradeResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateSectionTradeResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "tradeId", "sectionId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionTrade->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "SectionTrade->SequenceNumber" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionTrade->Trade_Id" }, "sectionId": { "title": "sectionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionTrade->Section_Id" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "SectionTrade->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateSectionTradeResourceActionRequest": { "title": "UpdateSectionTradeResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "SectionTrade->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "SectionTrade->Notes" } ] } } }, "DeleteSectionTradeResourceActionRequest": { "title": "DeleteSectionTradeResourceActionRequest", "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 } } }, "BatchGetSectionTradeResourceAction": { "title": "BatchGetSectionTradeResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Section Trade entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Section Trade entities", "items": { "$ref": "#/components/schemas/GetSectionTradeResourceActionResponse" } }, "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" } } }, "BatchCreateSectionTradeResourceActionRequest": { "title": "BatchCreateSectionTradeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateSectionTradeResourceActionRequest" } }, "BatchUpdateSectionTradeResourceActionRequest": { "title": "BatchUpdateSectionTradeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateSectionTradeResourceActionRequest" } }, "BatchDeleteSectionTradeResourceActionRequest": { "title": "BatchDeleteSectionTradeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteSectionTradeResourceActionRequest" } }, "ChangeSectionTradeIsActiveResourceActionRequest": { "title": "ChangeSectionTradeIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "SectionTrade->IsActive" } ] } } }, "ChangeSectionTradePermissionTreeResourceActionRequest": { "title": "ChangeSectionTradePermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "SectionTrade->PermissionTree_Id" } ] } } }, "BatchChangeSectionTradeIsActiveResourceActionRequest": { "title": "BatchChangeSectionTradeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeSectionTradeIsActiveResourceActionRequest" } }, "BatchChangeSectionTradePermissionTreeResourceActionRequest": { "title": "BatchChangeSectionTradePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeSectionTradePermissionTreeResourceActionRequest" } }, "GetTradeResourceActionResponse": { "title": "GetTradeResourceActionResponse", "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": "GetTradeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Trade->Code" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "Trade->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Trade->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Trade->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Trade->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Trade->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Trade->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Trade->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Trade->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Trade->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Trade->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "Trade->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "Trade->PermissionTree_Description" }, "defaultTradeFinancialRateId": { "title": "defaultTradeFinancialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Trade->DefaultTradeFinancialRate_Id" }, "defaultTradeFinancialRateFinancialRateId": { "title": "defaultTradeFinancialRateFinancialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Trade->DefaultTradeFinancialRate_FinancialRateId" }, "defaultTradeFinancialRateFinancialRateDescription": { "title": "defaultTradeFinancialRateFinancialRateDescription", "type": "string", "nullable": true, "x-propertyPath": "Trade->DefaultTradeFinancialRate_FinancialRateDescription" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Trade->Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Trade->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Trade->SequenceNumber" } } }, "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" } } }, "GetTradeCollectionResourceActionResponse": { "title": "GetTradeCollectionResourceActionResponse", "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": "GetTradeCollectionResourceActionResponseItem", "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": "GetTradeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Trade->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Trade->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Trade->SequenceNumber" }, "defaultTradeFinancialRateId": { "title": "defaultTradeFinancialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Trade->DefaultTradeFinancialRate_Id" }, "defaultTradeFinancialRateFinancialRateDescription": { "title": "defaultTradeFinancialRateFinancialRateDescription", "type": "string", "nullable": false, "x-propertyPath": "Trade->DefaultTradeFinancialRate_FinancialRateDescription" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Trade->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Trade->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Trade->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" } } } }, "TradeChangePermissionTreeLookupResourceActionResponse": { "title": "TradeChangePermissionTreeLookupResourceActionResponse", "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": "TradeChangePermissionTreeLookupResourceActionResponseItem", "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": "TradeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "TradeDefaultTradeFinancialRateLookupResourceActionResponse": { "title": "TradeDefaultTradeFinancialRateLookupResourceActionResponse", "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": "TradeDefaultTradeFinancialRateLookupResourceActionResponseItem", "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": "TradeDefaultTradeFinancialRateLookupResourceActionResponseItemProperties", "type": "object", "properties": { "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeFinancialRate->Trade_Id" }, "financialRateId": { "title": "financialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeFinancialRate->FinancialRateId" }, "financialRateDescription": { "title": "financialRateDescription", "type": "string", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateDescription" }, "financialRateAmount": { "title": "financialRateAmount", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateAmount" }, "financialRateCurrencyId": { "title": "financialRateCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeFinancialRate->FinancialRateCurrency_Id" }, "financialRateCurrencyCode": { "title": "financialRateCurrencyCode", "type": "string", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateCurrency_Code" }, "financialRateUnitOfMeasurementId": { "title": "financialRateUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeFinancialRate->FinancialRateUnitOfMeasurement_Id" }, "financialRateUnitOfMeasurementCode": { "title": "financialRateUnitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateUnitOfMeasurement_Code" } } }, "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" } } } }, "TradeInsertPermissionTreeLookupResourceActionResponse": { "title": "TradeInsertPermissionTreeLookupResourceActionResponse", "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": "TradeInsertPermissionTreeLookupResourceActionResponseItem", "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": "TradeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "CreateTradeResourceActionRequest": { "title": "CreateTradeResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateTradeResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Trade->PermissionTree_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Trade->SequenceNumber" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "Trade->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "Trade->Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Trade->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateTradeResourceActionRequest": { "title": "UpdateTradeResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Trade->SequenceNumber" }, { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "Trade->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "Trade->Description" }, { "title": "defaultTradeFinancialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Trade->DefaultTradeFinancialRate_Id" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Trade->Notes" } ] } } }, "DeleteTradeResourceActionRequest": { "title": "DeleteTradeResourceActionRequest", "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 } } }, "BatchGetTradeResourceAction": { "title": "BatchGetTradeResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Trade entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Trade entities", "items": { "$ref": "#/components/schemas/GetTradeResourceActionResponse" } }, "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" } } }, "BatchCreateTradeResourceActionRequest": { "title": "BatchCreateTradeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateTradeResourceActionRequest" } }, "BatchUpdateTradeResourceActionRequest": { "title": "BatchUpdateTradeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateTradeResourceActionRequest" } }, "BatchDeleteTradeResourceActionRequest": { "title": "BatchDeleteTradeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteTradeResourceActionRequest" } }, "ChangeTradeIsActiveResourceActionRequest": { "title": "ChangeTradeIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "Trade->IsActive" } ] } } }, "ChangeTradePermissionTreeResourceActionRequest": { "title": "ChangeTradePermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Trade->PermissionTree_Id" } ] } } }, "BatchChangeTradeIsActiveResourceActionRequest": { "title": "BatchChangeTradeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeTradeIsActiveResourceActionRequest" } }, "BatchChangeTradePermissionTreeResourceActionRequest": { "title": "BatchChangeTradePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeTradePermissionTreeResourceActionRequest" } }, "GetTradeAttributeResourceActionResponse": { "title": "GetTradeAttributeResourceActionResponse", "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": "GetTradeAttributeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeAttribute->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->Trade_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TradeAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "TradeAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TradeAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "nullable": true, "x-propertyPath": "TradeAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "TradeAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "TradeAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "TradeAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "TradeAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "TradeAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "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" } } }, "GetTradeAttributeCollectionForTradeResourceActionResponse": { "title": "GetTradeAttributeCollectionForTradeResourceActionResponse", "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": "GetTradeAttributeCollectionForTradeResourceActionResponseItem", "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": "GetTradeAttributeCollectionForTradeResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "TradeAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "TradeAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "TradeAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "TradeAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "TradeAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TradeAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TradeAttribute->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" } } } }, "GetTradeAttributeCollectionResourceActionResponse": { "title": "GetTradeAttributeCollectionResourceActionResponse", "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": "GetTradeAttributeCollectionResourceActionResponseItem", "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": "GetTradeAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeAttribute->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "nullable": false, "x-propertyPath": "TradeAttribute->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "nullable": false, "x-propertyPath": "TradeAttribute->Trade_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "TradeAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "TradeAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "TradeAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "TradeAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "TradeAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TradeAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TradeAttribute->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" } } } }, "TradeAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "TradeAttributeAttributeAllowedValueLookupResourceActionResponse", "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": "TradeAttributeAttributeAllowedValueLookupResourceActionResponseItem", "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": "TradeAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "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" } } } }, "TradeAttributeAttributeLookupResourceActionResponse": { "title": "TradeAttributeAttributeLookupResourceActionResponse", "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": "TradeAttributeAttributeLookupResourceActionResponseItem", "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": "TradeAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "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" } } } }, "TradeAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "TradeAttributeChangePermissionTreeLookupResourceActionResponse", "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": "TradeAttributeChangePermissionTreeLookupResourceActionResponseItem", "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": "TradeAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "TradeAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "TradeAttributeInsertPermissionTreeLookupResourceActionResponse", "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": "TradeAttributeInsertPermissionTreeLookupResourceActionResponseItem", "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": "TradeAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "TradeAttributeTradeLookupResourceActionResponse": { "title": "TradeAttributeTradeLookupResourceActionResponse", "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": "TradeAttributeTradeLookupResourceActionResponseItem", "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": "TradeAttributeTradeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Trade->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Trade->Description" } } }, "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" } } } }, "CreateTradeAttributeResourceActionRequest": { "title": "CreateTradeAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateTradeAttributeResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "tradeId", "attributeId" ], "properties": { "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeAttribute->Trade_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "TradeAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateTradeAttributeResourceActionRequest": { "title": "UpdateTradeAttributeResourceActionRequest", "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": "value", "format": "composite", "nullable": true, "x-propertyPath": "TradeAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "TradeAttribute->Notes" } ] } } }, "DeleteTradeAttributeResourceActionRequest": { "title": "DeleteTradeAttributeResourceActionRequest", "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 } } }, "BatchGetTradeAttributeResourceAction": { "title": "BatchGetTradeAttributeResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Trade Attribute entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Trade Attribute entities", "items": { "$ref": "#/components/schemas/GetTradeAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateTradeAttributeResourceActionRequest": { "title": "BatchCreateTradeAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateTradeAttributeResourceActionRequest" } }, "BatchUpdateTradeAttributeResourceActionRequest": { "title": "BatchUpdateTradeAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateTradeAttributeResourceActionRequest" } }, "BatchDeleteTradeAttributeResourceActionRequest": { "title": "BatchDeleteTradeAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteTradeAttributeResourceActionRequest" } }, "ChangeTradeAttributeIsActiveResourceActionRequest": { "title": "ChangeTradeAttributeIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "TradeAttribute->IsActive" } ] } } }, "ChangeTradeAttributePermissionTreeResourceActionRequest": { "title": "ChangeTradeAttributePermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeAttribute->PermissionTree_Id" } ] } } }, "BatchChangeTradeAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeTradeAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeTradeAttributePermissionTreeResourceActionRequest" } }, "BatchChangeTradeAttributeIsActiveResourceActionRequest": { "title": "BatchChangeTradeAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeTradeAttributeIsActiveResourceActionRequest" } }, "GetTradeCompetencyResourceActionResponse": { "title": "GetTradeCompetencyResourceActionResponse", "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": "GetTradeCompetencyResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "TradeCompetency->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeCompetency->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "TradeCompetency->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "TradeCompetency->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TradeCompetency->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeCompetency->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "TradeCompetency->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "TradeCompetency->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TradeCompetency->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeCompetency->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "TradeCompetency->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "TradeCompetency->PermissionTree_Description" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeCompetency->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "nullable": true, "x-propertyPath": "TradeCompetency->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "nullable": true, "x-propertyPath": "TradeCompetency->Competency_Description" }, "competencyValidityType": { "title": "competencyValidityType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "TradeCompetency->Competency_ValidityType", "x-formatSpecifier": "CompetencyValidityType" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "TradeCompetency->Notes" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "nullable": false, "x-propertyPath": "TradeCompetency->Proficiency" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeCompetency->SequenceNumber" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeCompetency->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "nullable": true, "x-propertyPath": "TradeCompetency->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "nullable": true, "x-propertyPath": "TradeCompetency->Trade_Description" } } }, "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" } } }, "GetTradeCompetencyCollectionResourceActionResponse": { "title": "GetTradeCompetencyCollectionResourceActionResponse", "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": "GetTradeCompetencyCollectionResourceActionResponseItem", "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": "GetTradeCompetencyCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeCompetency->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "nullable": false, "x-propertyPath": "TradeCompetency->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "nullable": false, "x-propertyPath": "TradeCompetency->Trade_Description" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeCompetency->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "nullable": false, "x-propertyPath": "TradeCompetency->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "nullable": false, "x-propertyPath": "TradeCompetency->Competency_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeCompetency->SequenceNumber" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "nullable": false, "x-propertyPath": "TradeCompetency->Proficiency" } } }, "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" } } } }, "GetTradeCompetencyForTradeCollectionResourceActionResponse": { "title": "GetTradeCompetencyForTradeCollectionResourceActionResponse", "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": "GetTradeCompetencyForTradeCollectionResourceActionResponseItem", "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": "GetTradeCompetencyForTradeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeCompetency->Competency_Id" }, "competencyCode": { "title": "competencyCode", "type": "string", "nullable": false, "x-propertyPath": "TradeCompetency->Competency_Code" }, "competencyDescription": { "title": "competencyDescription", "type": "string", "nullable": false, "x-propertyPath": "TradeCompetency->Competency_Description" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "nullable": false, "x-propertyPath": "TradeCompetency->Proficiency" } } }, "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" } } } }, "TradeCompetencyChangePermissionTreeLookupResourceActionResponse": { "title": "TradeCompetencyChangePermissionTreeLookupResourceActionResponse", "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": "TradeCompetencyChangePermissionTreeLookupResourceActionResponseItem", "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": "TradeCompetencyChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "TradeCompetencyCompetencyLookupResourceActionResponse": { "title": "TradeCompetencyCompetencyLookupResourceActionResponse", "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": "TradeCompetencyCompetencyLookupResourceActionResponseItem", "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": "TradeCompetencyCompetencyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Competency->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Competency->Description" } } }, "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" } } } }, "TradeCompetencyInsertPermissionTreeLookupResourceActionResponse": { "title": "TradeCompetencyInsertPermissionTreeLookupResourceActionResponse", "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": "TradeCompetencyInsertPermissionTreeLookupResourceActionResponseItem", "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": "TradeCompetencyInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "TradeCompetencyTradeLookupResourceActionResponse": { "title": "TradeCompetencyTradeLookupResourceActionResponse", "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": "TradeCompetencyTradeLookupResourceActionResponseItem", "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": "TradeCompetencyTradeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Trade->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Trade->Description" } } }, "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" } } } }, "CreateTradeCompetencyResourceActionRequest": { "title": "CreateTradeCompetencyResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateTradeCompetencyResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "tradeId", "competencyId", "proficiency" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeCompetency->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeCompetency->SequenceNumber" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeCompetency->Trade_Id" }, "competencyId": { "title": "competencyId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeCompetency->Competency_Id" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "TradeCompetency->Notes" }, "proficiency": { "title": "proficiency", "type": "integer", "format": "int32", "maximum": 9.0, "minimum": 1.0, "nullable": false, "x-propertyPath": "TradeCompetency->Proficiency" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateTradeCompetencyResourceActionRequest": { "title": "UpdateTradeCompetencyResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeCompetency->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "TradeCompetency->Notes" }, { "title": "proficiency", "type": "integer", "format": "int32", "maximum": 9.0, "minimum": 1.0, "nullable": false, "x-propertyPath": "TradeCompetency->Proficiency" } ] } } }, "DeleteTradeCompetencyResourceActionRequest": { "title": "DeleteTradeCompetencyResourceActionRequest", "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 } } }, "BatchGetTradeCompetencyResourceAction": { "title": "BatchGetTradeCompetencyResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Trade Competency entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Trade Competency entities", "items": { "$ref": "#/components/schemas/GetTradeCompetencyResourceActionResponse" } }, "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" } } }, "BatchCreateTradeCompetencyResourceActionRequest": { "title": "BatchCreateTradeCompetencyResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateTradeCompetencyResourceActionRequest" } }, "BatchUpdateTradeCompetencyResourceActionRequest": { "title": "BatchUpdateTradeCompetencyResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateTradeCompetencyResourceActionRequest" } }, "BatchDeleteTradeCompetencyResourceActionRequest": { "title": "BatchDeleteTradeCompetencyResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteTradeCompetencyResourceActionRequest" } }, "ChangeTradeCompetencyIsActiveResourceActionRequest": { "title": "ChangeTradeCompetencyIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "TradeCompetency->IsActive" } ] } } }, "ChangeTradeCompetencyPermissionTreeResourceActionRequest": { "title": "ChangeTradeCompetencyPermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeCompetency->PermissionTree_Id" } ] } } }, "BatchChangeTradeCompetencyIsActiveResourceActionRequest": { "title": "BatchChangeTradeCompetencyIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeTradeCompetencyIsActiveResourceActionRequest" } }, "BatchChangeTradeCompetencyPermissionTreeResourceActionRequest": { "title": "BatchChangeTradeCompetencyPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeTradeCompetencyPermissionTreeResourceActionRequest" } }, "GetTradeDocumentResourceActionResponse": { "title": "GetTradeDocumentResourceActionResponse", "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": "GetTradeDocumentResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeDocument->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->Trade_Description" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "TradeDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TradeDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TradeDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeDocument->SequenceNumber" } } }, "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" } } }, "GetTradeDocumentCollectionForTradeResourceActionResponse": { "title": "GetTradeDocumentCollectionForTradeResourceActionResponse", "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": "GetTradeDocumentCollectionForTradeResourceActionResponseItem", "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": "GetTradeDocumentCollectionForTradeResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "TradeDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "TradeDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_FileType_Extension" } } }, "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" } } } }, "GetTradeDocumentCollectionResourceActionResponse": { "title": "GetTradeDocumentCollectionResourceActionResponse", "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": "GetTradeDocumentCollectionResourceActionResponseItem", "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": "GetTradeDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeDocument->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "nullable": false, "x-propertyPath": "TradeDocument->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "nullable": false, "x-propertyPath": "TradeDocument->Trade_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "TradeDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "TradeDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->DocumentRecord_FileType_Extension" } } }, "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" } } } }, "TradeDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "TradeDocumentChangePermissionTreeLookupResourceActionResponse", "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": "TradeDocumentChangePermissionTreeLookupResourceActionResponseItem", "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": "TradeDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "TradeDocumentDocumentLookupResourceActionResponse": { "title": "TradeDocumentDocumentLookupResourceActionResponse", "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": "TradeDocumentDocumentLookupResourceActionResponseItem", "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": "TradeDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "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" } } } }, "TradeDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "TradeDocumentInsertPermissionTreeLookupResourceActionResponse", "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": "TradeDocumentInsertPermissionTreeLookupResourceActionResponseItem", "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": "TradeDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "TradeDocumentTradeLookupResourceActionResponse": { "title": "TradeDocumentTradeLookupResourceActionResponse", "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": "TradeDocumentTradeLookupResourceActionResponseItem", "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": "TradeDocumentTradeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Trade->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Trade->Description" } } }, "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" } } } }, "CreateTradeDocumentResourceActionRequest": { "title": "CreateTradeDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateTradeDocumentResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "tradeId", "documentRecordId" ], "properties": { "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeDocument->Trade_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateTradeDocumentResourceActionRequest": { "title": "UpdateTradeDocumentResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeDocument->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "TradeDocument->Notes" } ] } } }, "DeleteTradeDocumentResourceActionRequest": { "title": "DeleteTradeDocumentResourceActionRequest", "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 } } }, "BatchGetTradeDocumentResourceAction": { "title": "BatchGetTradeDocumentResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Trade Document entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Trade Document entities", "items": { "$ref": "#/components/schemas/GetTradeDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateTradeDocumentResourceActionRequest": { "title": "BatchCreateTradeDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateTradeDocumentResourceActionRequest" } }, "BatchUpdateTradeDocumentResourceActionRequest": { "title": "BatchUpdateTradeDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateTradeDocumentResourceActionRequest" } }, "BatchDeleteTradeDocumentResourceActionRequest": { "title": "BatchDeleteTradeDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteTradeDocumentResourceActionRequest" } }, "ChangeTradeDocumentIsActiveResourceActionRequest": { "title": "ChangeTradeDocumentIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "TradeDocument->IsActive" } ] } } }, "ChangeTradeDocumentPermissionTreeResourceActionRequest": { "title": "ChangeTradeDocumentPermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeDocument->PermissionTree_Id" } ] } } }, "BatchChangeTradeDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeTradeDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeTradeDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeTradeDocumentIsActiveResourceActionRequest": { "title": "BatchChangeTradeDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeTradeDocumentIsActiveResourceActionRequest" } }, "GetTradeFinancialRateResourceActionResponse": { "title": "GetTradeFinancialRateResourceActionResponse", "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": "GetTradeFinancialRateResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "TradeFinancialRate->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeFinancialRate->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "TradeFinancialRate->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "TradeFinancialRate->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TradeFinancialRate->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeFinancialRate->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "TradeFinancialRate->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "TradeFinancialRate->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TradeFinancialRate->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeFinancialRate->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "TradeFinancialRate->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "TradeFinancialRate->PermissionTree_Description" }, "financialRateId": { "title": "financialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeFinancialRate->FinancialRateId" }, "financialRateAmount": { "title": "financialRateAmount", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateAmount" }, "financialRateCurrencyId": { "title": "financialRateCurrencyId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateCurrency_Id" }, "financialRateCurrencyCode": { "title": "financialRateCurrencyCode", "type": "string", "nullable": true, "x-propertyPath": "TradeFinancialRate->FinancialRateCurrency_Code" }, "financialRateCurrencyDescription": { "title": "financialRateCurrencyDescription", "type": "string", "nullable": true, "x-propertyPath": "TradeFinancialRate->FinancialRateCurrency_Description" }, "financialRateDescription": { "title": "financialRateDescription", "type": "string", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateDescription" }, "financialRateUnitOfMeasurementId": { "title": "financialRateUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateUnitOfMeasurement_Id" }, "financialRateUnitOfMeasurementCode": { "title": "financialRateUnitOfMeasurementCode", "type": "string", "nullable": true, "x-propertyPath": "TradeFinancialRate->FinancialRateUnitOfMeasurement_Code" }, "financialRateUnitOfMeasurementDescription": { "title": "financialRateUnitOfMeasurementDescription", "type": "string", "nullable": true, "x-propertyPath": "TradeFinancialRate->FinancialRateUnitOfMeasurement_Description" }, "financialRateUnitOfMeasurementMeasurementType": { "title": "financialRateUnitOfMeasurementMeasurementType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "TradeFinancialRate->FinancialRateUnitOfMeasurement_MeasurementType", "x-formatSpecifier": "MeasurementType" }, "financialRateUnitOfMeasurementMeasurementTypeQuantity": { "title": "financialRateUnitOfMeasurementMeasurementTypeQuantity", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeFinancialRate->FinancialRateUnitOfMeasurement_MeasurementTypeQuantity" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "TradeFinancialRate->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeFinancialRate->SequenceNumber" }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeFinancialRate->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "nullable": true, "x-propertyPath": "TradeFinancialRate->Trade_Code" }, "tradeDescription": { "title": "tradeDescription", "type": "string", "nullable": true, "x-propertyPath": "TradeFinancialRate->Trade_Description" } } }, "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" } } }, "GetTradeFinancialRateCollectionResourceActionResponse": { "title": "GetTradeFinancialRateCollectionResourceActionResponse", "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": "GetTradeFinancialRateCollectionResourceActionResponseItem", "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": "GetTradeFinancialRateCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeFinancialRate->Trade_Id" }, "tradeCode": { "title": "tradeCode", "type": "string", "nullable": false, "x-propertyPath": "TradeFinancialRate->Trade_Code" }, "financialRateId": { "title": "financialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeFinancialRate->FinancialRateId" }, "financialRateAmount": { "title": "financialRateAmount", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateAmount" }, "financialRateDescription": { "title": "financialRateDescription", "type": "string", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateDescription" }, "financialRateCurrencyId": { "title": "financialRateCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeFinancialRate->FinancialRateCurrency_Id" }, "financialRateCurrencyCode": { "title": "financialRateCurrencyCode", "type": "string", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateCurrency_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeFinancialRate->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "TradeFinancialRate->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TradeFinancialRate->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TradeFinancialRate->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" } } } }, "GetTradeFinancialRateForTradeCollectionResourceActionResponse": { "title": "GetTradeFinancialRateForTradeCollectionResourceActionResponse", "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": "GetTradeFinancialRateForTradeCollectionResourceActionResponseItem", "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": "GetTradeFinancialRateForTradeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "financialRateId": { "title": "financialRateId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeFinancialRate->FinancialRateId" }, "financialRateAmount": { "title": "financialRateAmount", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateAmount" }, "financialRateDescription": { "title": "financialRateDescription", "type": "string", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateDescription" }, "financialRateCurrencyId": { "title": "financialRateCurrencyId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeFinancialRate->FinancialRateCurrency_Id" }, "financialRateCurrencyCode": { "title": "financialRateCurrencyCode", "type": "string", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateCurrency_Code" }, "financialRateUnitOfMeasurementId": { "title": "financialRateUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "TradeFinancialRate->FinancialRateUnitOfMeasurement_Id" }, "financialRateUnitOfMeasurementCode": { "title": "financialRateUnitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateUnitOfMeasurement_Code" } } }, "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" } } } }, "TradeFinancialRateChangePermissionTreeLookupResourceActionResponse": { "title": "TradeFinancialRateChangePermissionTreeLookupResourceActionResponse", "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": "TradeFinancialRateChangePermissionTreeLookupResourceActionResponseItem", "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": "TradeFinancialRateChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "TradeFinancialRateCurrencyLookupResourceActionResponse": { "title": "TradeFinancialRateCurrencyLookupResourceActionResponse", "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": "TradeFinancialRateCurrencyLookupResourceActionResponseItem", "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": "TradeFinancialRateCurrencyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Currency->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Currency->Description" } } }, "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" } } } }, "TradeFinancialRateInsertPermissionTreeLookupResourceActionResponse": { "title": "TradeFinancialRateInsertPermissionTreeLookupResourceActionResponse", "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": "TradeFinancialRateInsertPermissionTreeLookupResourceActionResponseItem", "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": "TradeFinancialRateInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "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" } } } }, "TradeFinancialRateTradeLookupResourceActionResponse": { "title": "TradeFinancialRateTradeLookupResourceActionResponse", "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": "TradeFinancialRateTradeLookupResourceActionResponseItem", "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": "TradeFinancialRateTradeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Trade->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Trade->Description" } } }, "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" } } } }, "TradeFinancialRateUnitOfMeasurementLookupResourceActionResponse": { "title": "TradeFinancialRateUnitOfMeasurementLookupResourceActionResponse", "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": "TradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItem", "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": "TradeFinancialRateUnitOfMeasurementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" } } }, "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" } } } }, "CreateTradeFinancialRateResourceActionRequest": { "title": "CreateTradeFinancialRateResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateTradeFinancialRateResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "tradeId", "financialRateDescription", "financialRateAmount", "financialRateCurrencyId", "financialRateUnitOfMeasurementId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeFinancialRate->PermissionTree_Id", "x-systemGenerated": true }, "tradeId": { "title": "tradeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeFinancialRate->Trade_Id" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "TradeFinancialRate->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeFinancialRate->SequenceNumber" }, "financialRateDescription": { "title": "financialRateDescription", "type": "string", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateDescription" }, "financialRateAmount": { "title": "financialRateAmount", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateAmount" }, "financialRateCurrencyId": { "title": "financialRateCurrencyId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateCurrency_Id" }, "financialRateUnitOfMeasurementId": { "title": "financialRateUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateUnitOfMeasurement_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateTradeFinancialRateResourceActionRequest": { "title": "UpdateTradeFinancialRateResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeFinancialRate->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "TradeFinancialRate->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "TradeFinancialRate->SequenceNumber" }, { "title": "financialRateDescription", "type": "string", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateDescription" }, { "title": "financialRateAmount", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateAmount" }, { "title": "financialRateCurrencyId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateCurrency_Id" }, { "title": "financialRateUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateUnitOfMeasurement_Id" } ] } } }, "DeleteTradeFinancialRateResourceActionRequest": { "title": "DeleteTradeFinancialRateResourceActionRequest", "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 } } }, "BatchGetTradeFinancialRateResourceAction": { "title": "BatchGetTradeFinancialRateResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Trade Financial Rate entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Trade Financial Rate entities", "items": { "$ref": "#/components/schemas/GetTradeFinancialRateResourceActionResponse" } }, "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" } } }, "BatchCreateTradeFinancialRateResourceActionRequest": { "title": "BatchCreateTradeFinancialRateResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateTradeFinancialRateResourceActionRequest" } }, "BatchUpdateTradeFinancialRateResourceActionRequest": { "title": "BatchUpdateTradeFinancialRateResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateTradeFinancialRateResourceActionRequest" } }, "BatchDeleteTradeFinancialRateResourceActionRequest": { "title": "BatchDeleteTradeFinancialRateResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteTradeFinancialRateResourceActionRequest" } }, "ChangeTradeFinancialRateIsActiveResourceActionRequest": { "title": "ChangeTradeFinancialRateIsActiveResourceActionRequest", "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": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "TradeFinancialRate->IsActive" } ] } } }, "ChangeTradeFinancialRatePermissionTreeResourceActionRequest": { "title": "ChangeTradeFinancialRatePermissionTreeResourceActionRequest", "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": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeFinancialRate->PermissionTree_Id" } ] } } }, "BatchChangeTradeFinancialRateIsActiveResourceActionRequest": { "title": "BatchChangeTradeFinancialRateIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeTradeFinancialRateIsActiveResourceActionRequest" } }, "BatchChangeTradeFinancialRatePermissionTreeResourceActionRequest": { "title": "BatchChangeTradeFinancialRatePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeTradeFinancialRatePermissionTreeResourceActionRequest" } }, "MatchUpdateTradeFinancialRateResourceActionRequest": { "title": "MatchUpdateTradeFinancialRateResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entities", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" } }, "records": { "title": "records", "type": "array", "description": "Collection of entities to apply the patch operations to", "items": { "$ref": "#/components/schemas/EntityMatchRecordSchema" }, "x-matchupdateproperties": [ { "title": "financialRateAmount", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateAmount" }, { "title": "financialRateCurrencyId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "TradeFinancialRate->FinancialRateCurrency_Id" } ] } } } }, "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": "Competency" }, { "name": "Resource" }, { "name": "Resource Address" }, { "name": "Resource Attribute" }, { "name": "Resource Classification" }, { "name": "Resource Competency" }, { "name": "Resource Context" }, { "name": "Resource Document" }, { "name": "Resource Email" }, { "name": "Resource File Attachment" }, { "name": "Resource Phone Number" }, { "name": "Resource Trade" }, { "name": "Resource Trade Competency" }, { "name": "Resource Trade Financial Rate" }, { "name": "Section" }, { "name": "Section Attribute" }, { "name": "Section Document" }, { "name": "Section Trade" }, { "name": "Trade" }, { "name": "Trade Attribute" }, { "name": "Trade Competency" }, { "name": "Trade Document" }, { "name": "Trade Financial Rate" } ], "x-tagGroups": [ { "name": "RES", "tags": [ "Competency", "Resource", "Resource Address", "Resource Attribute", "Resource Classification", "Resource Competency", "Resource Context", "Resource Document", "Resource Email", "Resource File Attachment", "Resource Phone Number", "Resource Trade", "Resource Trade Competency", "Resource Trade Financial Rate", "Section", "Section Attribute", "Section Document", "Section Trade", "Trade", "Trade Attribute", "Trade Competency", "Trade Document", "Trade Financial Rate" ] } ] }