{ "x-generator": "On Key REST API Docs Generator", "swagger": "2.0", "info": { "title": "On Key RISK 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" }, "host": ":443", "basePath": "/api/tenants/{client}/{connection}", "schemes": [ "https" ], "consumes": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.entitypatch+json", "application/vnd.onkey.entitydelete+json", "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.entitypatchcollection+json", "application/vnd.onkey.entitydeletecollection+json", "application/vnd.onkey.entitymatchupdatecollection+json" ], "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json", "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.entitycollection+json" ], "paths": { "/Modules/RISK/AssetImportances/{id}": { "get": { "tags": [ "Asset Importance" ], "summary": "Get a Asset Importance resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | AssetImportance->Code | string | |\r\n| createdByUserId | AssetImportance->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetImportance->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetImportance->CreatedByUser_FullName | string | |\r\n| createdOn | AssetImportance->CreatedOn | string | date-time |\r\n| isActive | AssetImportance->IsActive | boolean | |\r\n| modifiedByUserId | AssetImportance->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetImportance->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetImportance->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetImportance->ModifiedOn | string | date-time |\r\n| permissionTreeId | AssetImportance->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetImportance->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetImportance->PermissionTree_Description | string | |\r\n| version | AssetImportance->Version | integer | int32 |\r\n| id | AssetImportance->Id | integer | int64 |\r\n| description | AssetImportance->Description | string | |\r\n| notes | AssetImportance->Notes | string | |\r\n| weight | AssetImportance->Weight | integer | int32 |\r\n| sequenceNumber | AssetImportance->SequenceNumber | integer | int32 |\r\n", "operationId": "GetAssetImportance", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Importance Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Importance", "schema": { "$ref": "#/definitions/GetAssetImportanceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Asset Importance" ], "summary": "Update an existing Asset Importance resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AssetImportance->Version | integer | int32 |\r\n| code | AssetImportance->Code | string | |\r\n| description | AssetImportance->Description | string | |\r\n| sequenceNumber | AssetImportance->SequenceNumber | integer | int32 |\r\n| notes | AssetImportance->Notes | string | |\r\n| weight | AssetImportance->Weight | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| weight | Nullable | False | |\r\n| weight | Min Value | >= 0| |\r\n\r\n", "operationId": "UpdateAssetImportance", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Importance Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAssetImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset Importance was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Asset Importance" ], "summary": "Delete an existing Asset Importance resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AssetImportance->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteAssetImportance", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Importance Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteAssetImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset Importance was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/AssetImportances": { "get": { "tags": [ "Asset Importance" ], "summary": "Get a collection of Asset Importance resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AssetImportance->Version | integer | int32 |\r\n| id | AssetImportance->Id | integer | int64 |\r\n| code | AssetImportance->Code | string | |\r\n| description | AssetImportance->Description | string | |\r\n| sequenceNumber | AssetImportance->SequenceNumber | integer | int32 |\r\n| weight | AssetImportance->Weight | integer | int32 |\r\n", "operationId": "GetAssetImportanceCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset Importance collection", "schema": { "$ref": "#/definitions/GetAssetImportanceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Asset Importance" ], "summary": "Create a new Asset Importance resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | AssetImportance->PermissionTree_Id | integer | int64 |\r\n| code | AssetImportance->Code | string | |\r\n| description | AssetImportance->Description | string | |\r\n| sequenceNumber | AssetImportance->SequenceNumber | integer | int32 |\r\n| weight | AssetImportance->Weight | integer | int32 |\r\n| notes | AssetImportance->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| weight | Required | True | |\r\n| weight | Nullable | False | |\r\n| weight | Min Value | >= 0| |\r\n\r\n", "operationId": "CreateAssetImportance", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateAssetImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/AssetImportances/Lookups/LookupAssetImportanceChangePermissionTree": { "get": { "tags": [ "Asset Importance" ], "summary": "Lookup the permission set for changing the Asset Importance.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupAssetImportanceChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/AssetImportanceChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/AssetImportances/Lookups/LookupAssetImportanceInsertPermissionTree": { "get": { "tags": [ "Asset Importance" ], "summary": "Lookup the permission set for creating the Asset Importance.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupAssetImportanceInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/AssetImportanceInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/AssetImportances/Batch/{ids}": { "get": { "tags": [ "Asset Importance" ], "summary": "Get a collection of Asset Importance resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | AssetImportance->Code | string | |\r\n| createdByUserId | AssetImportance->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AssetImportance->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AssetImportance->CreatedByUser_FullName | string | |\r\n| createdOn | AssetImportance->CreatedOn | string | date-time |\r\n| isActive | AssetImportance->IsActive | boolean | |\r\n| modifiedByUserId | AssetImportance->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AssetImportance->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AssetImportance->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AssetImportance->ModifiedOn | string | date-time |\r\n| permissionTreeId | AssetImportance->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AssetImportance->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AssetImportance->PermissionTree_Description | string | |\r\n| version | AssetImportance->Version | integer | int32 |\r\n| id | AssetImportance->Id | integer | int64 |\r\n| description | AssetImportance->Description | string | |\r\n| notes | AssetImportance->Notes | string | |\r\n| weight | AssetImportance->Weight | integer | int32 |\r\n| sequenceNumber | AssetImportance->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetAssetImportance", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Asset Importance id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Asset Importance collection", "schema": { "$ref": "#/definitions/BatchGetAssetImportanceResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/AssetImportances/Batch": { "post": { "tags": [ "Asset Importance" ], "summary": "Create a new collection of Asset Importance resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | AssetImportance->PermissionTree_Id | integer | int64 |\r\n| code | AssetImportance->Code | string | |\r\n| description | AssetImportance->Description | string | |\r\n| sequenceNumber | AssetImportance->SequenceNumber | integer | int32 |\r\n| weight | AssetImportance->Weight | integer | int32 |\r\n| notes | AssetImportance->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| weight | Required | True | |\r\n| weight | Nullable | False | |\r\n| weight | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchCreateAssetImportance", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateAssetImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Asset Importance batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Asset Importance" ], "summary": "Update a collection of existing Asset Importance resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetImportance->Id | integer | int64 |\r\n| version | AssetImportance->Version | integer | int32 |\r\n| code | AssetImportance->Code | string | |\r\n| description | AssetImportance->Description | string | |\r\n| sequenceNumber | AssetImportance->SequenceNumber | integer | int32 |\r\n| notes | AssetImportance->Notes | string | |\r\n| weight | AssetImportance->Weight | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| weight | Nullable | False | |\r\n| weight | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchUpdateAssetImportance", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateAssetImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset Importance batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Asset Importance" ], "summary": "Delete a collection of existing Asset Importance resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetImportance->Id | integer | int64 |\r\n| version | AssetImportance->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteAssetImportance", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteAssetImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset Importance batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/AssetImportances/{id}/Active": { "patch": { "tags": [ "Asset Importance" ], "summary": "Change the IsActive status for an existing Asset Importance resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AssetImportance->Version | integer | int32 |\r\n| isActive | AssetImportance->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeAssetImportanceIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Importance Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetImportanceIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/AssetImportances/{id}/PermissionTree": { "patch": { "tags": [ "Asset Importance" ], "summary": "Change the PermissionTree for an existing Asset Importance resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AssetImportance->Version | integer | int32 |\r\n| permissionTreeId | AssetImportance->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeAssetImportancePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Asset Importance Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAssetImportancePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/AssetImportances/Batch/Active": { "patch": { "tags": [ "Asset Importance" ], "summary": "Change the IsActive status for a collection of existing Asset Importance resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetImportance->Id | integer | int64 |\r\n| version | AssetImportance->Version | integer | int32 |\r\n| isActive | AssetImportance->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeAssetImportanceIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeAssetImportanceIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/AssetImportances/Batch/PermissionTree": { "patch": { "tags": [ "Asset Importance" ], "summary": "Change the PermissionTree status for a collection of existing Asset Importance resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetImportance->Id | integer | int64 |\r\n| version | AssetImportance->Version | integer | int32 |\r\n| permissionTreeId | AssetImportance->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeAssetImportancePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeAssetImportancePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/AssetImportances/MatchBatch": { "patch": { "tags": [ "Asset Importance" ], "summary": "Update a collection of existing Asset Importance resources to have the same value(s).", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetImportance->Id | integer | int64 |\r\n| version | AssetImportance->Version | integer | int32 |\r\n| description | AssetImportance->Description | string | |\r\n| notes | AssetImportance->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "MatchUpdateAssetImportance", "consumes": [ "application/vnd.onkey.entitymatchupdatecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "matchUpdate", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/MatchUpdateAssetImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Asset Importance batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequences/{id}": { "get": { "tags": [ "Risk Consequence" ], "summary": "Get a Risk Consequence resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RiskConsequence->Code | string | |\r\n| isActive | RiskConsequence->IsActive | boolean | |\r\n| createdByUserId | RiskConsequence->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RiskConsequence->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RiskConsequence->CreatedByUser_FullName | string | |\r\n| createdOn | RiskConsequence->CreatedOn | string | date-time |\r\n| modifiedByUserId | RiskConsequence->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RiskConsequence->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RiskConsequence->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RiskConsequence->ModifiedOn | string | date-time |\r\n| version | RiskConsequence->Version | integer | int32 |\r\n| permissionTreeId | RiskConsequence->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RiskConsequence->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RiskConsequence->PermissionTree_Description | string | |\r\n| id | RiskConsequence->Id | integer | int64 |\r\n| description | RiskConsequence->Description | string | |\r\n| notes | RiskConsequence->Notes | string | |\r\n| riskConsequenceCategoryId | RiskConsequence->RiskConsequenceCategory_Id | integer | int64 |\r\n| riskConsequenceCategoryCode | RiskConsequence->RiskConsequenceCategory_Code | string | |\r\n| riskConsequenceCategoryDescription | RiskConsequence->RiskConsequenceCategory_Description | string | |\r\n| sequenceNumber | RiskConsequence->SequenceNumber | integer | int32 |\r\n| value | RiskConsequence->Value | number | decimal |\r\n", "operationId": "GetRiskConsequence", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Consequence Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Risk Consequence", "schema": { "$ref": "#/definitions/GetRiskConsequenceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Risk Consequence" ], "summary": "Update an existing Risk Consequence resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskConsequence->Version | integer | int32 |\r\n| code | RiskConsequence->Code | string | |\r\n| description | RiskConsequence->Description | string | |\r\n| notes | RiskConsequence->Notes | string | |\r\n| riskConsequenceCategoryId | RiskConsequence->RiskConsequenceCategory_Id | integer | int64 |\r\n| sequenceNumber | RiskConsequence->SequenceNumber | integer | int32 |\r\n| value | RiskConsequence->Value | number | decimal |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| riskConsequenceCategoryId | Nullable | False | |\r\n| value | Nullable | False | |\r\n| value | Min Value | >= 0| |\r\n\r\n", "operationId": "UpdateRiskConsequence", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Consequence Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRiskConsequenceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Consequence was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Risk Consequence" ], "summary": "Delete an existing Risk Consequence resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskConsequence->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteRiskConsequence", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Consequence Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRiskConsequenceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Consequence was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequences": { "get": { "tags": [ "Risk Consequence" ], "summary": "Get a collection of Risk Consequence resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskConsequence->Id | integer | int64 |\r\n| version | RiskConsequence->Version | integer | int32 |\r\n| code | RiskConsequence->Code | string | |\r\n| description | RiskConsequence->Description | string | |\r\n| riskConsequenceCategoryId | RiskConsequence->RiskConsequenceCategory_Id | integer | int64 |\r\n| riskConsequenceCategoryCode | RiskConsequence->RiskConsequenceCategory_Code | string | |\r\n| riskConsequenceCategoryDescription | RiskConsequence->RiskConsequenceCategory_Description | string | |\r\n| sequenceNumber | RiskConsequence->SequenceNumber | integer | int32 |\r\n| isActive | RiskConsequence->IsActive | boolean | |\r\n| value | RiskConsequence->Value | number | decimal |\r\n", "operationId": "GetRiskConsequenceCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Risk Consequence collection", "schema": { "$ref": "#/definitions/GetRiskConsequenceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Risk Consequence" ], "summary": "Create a new Risk Consequence resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RiskConsequence->Code | string | |\r\n| description | RiskConsequence->Description | string | |\r\n| notes | RiskConsequence->Notes | string | |\r\n| permissionTreeId | RiskConsequence->PermissionTree_Id | integer | int64 |\r\n| riskConsequenceCategoryId | RiskConsequence->RiskConsequenceCategory_Id | integer | int64 |\r\n| sequenceNumber | RiskConsequence->SequenceNumber | integer | int32 |\r\n| value | RiskConsequence->Value | number | decimal |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| riskConsequenceCategoryId | Required | True | |\r\n| riskConsequenceCategoryId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | Nullable | False | |\r\n| value | Min Value | >= 0| |\r\n\r\n", "operationId": "CreateRiskConsequence", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateRiskConsequenceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequences/Lookups/LookupRiskConsequenceChangePermissionTree": { "get": { "tags": [ "Risk Consequence" ], "summary": "Lookup the permission set for changing the Risk Consequence.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRiskConsequenceChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/RiskConsequenceChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequences/Lookups/LookupRiskConsequenceInsertPermissionTree": { "get": { "tags": [ "Risk Consequence" ], "summary": "Lookup the permission set for creating the Risk Consequence.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRiskConsequenceInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/RiskConsequenceInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequences/Lookups/LookupRiskConsequenceRiskConsequenceCategory": { "get": { "tags": [ "Risk Consequence" ], "summary": "Lookup the Risk Consequence Category for the Risk Consequence.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskConsequenceCategory->Id | integer | int64 |\r\n| code | RiskConsequenceCategory->Code | string | |\r\n| description | RiskConsequenceCategory->Description | string | |\r\n", "operationId": "LookupRiskConsequenceRiskConsequenceCategory", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Risk Consequence Category collection", "schema": { "$ref": "#/definitions/RiskConsequenceRiskConsequenceCategoryLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequences/Batch/{ids}": { "get": { "tags": [ "Risk Consequence" ], "summary": "Get a collection of Risk Consequence resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RiskConsequence->Code | string | |\r\n| isActive | RiskConsequence->IsActive | boolean | |\r\n| createdByUserId | RiskConsequence->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RiskConsequence->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RiskConsequence->CreatedByUser_FullName | string | |\r\n| createdOn | RiskConsequence->CreatedOn | string | date-time |\r\n| modifiedByUserId | RiskConsequence->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RiskConsequence->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RiskConsequence->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RiskConsequence->ModifiedOn | string | date-time |\r\n| version | RiskConsequence->Version | integer | int32 |\r\n| permissionTreeId | RiskConsequence->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RiskConsequence->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RiskConsequence->PermissionTree_Description | string | |\r\n| id | RiskConsequence->Id | integer | int64 |\r\n| description | RiskConsequence->Description | string | |\r\n| notes | RiskConsequence->Notes | string | |\r\n| riskConsequenceCategoryId | RiskConsequence->RiskConsequenceCategory_Id | integer | int64 |\r\n| riskConsequenceCategoryCode | RiskConsequence->RiskConsequenceCategory_Code | string | |\r\n| riskConsequenceCategoryDescription | RiskConsequence->RiskConsequenceCategory_Description | string | |\r\n| sequenceNumber | RiskConsequence->SequenceNumber | integer | int32 |\r\n| value | RiskConsequence->Value | number | decimal |\r\n", "operationId": "BatchGetRiskConsequence", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Risk Consequence id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Risk Consequence collection", "schema": { "$ref": "#/definitions/BatchGetRiskConsequenceResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequences/Batch": { "post": { "tags": [ "Risk Consequence" ], "summary": "Create a new collection of Risk Consequence resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RiskConsequence->Code | string | |\r\n| description | RiskConsequence->Description | string | |\r\n| notes | RiskConsequence->Notes | string | |\r\n| permissionTreeId | RiskConsequence->PermissionTree_Id | integer | int64 |\r\n| riskConsequenceCategoryId | RiskConsequence->RiskConsequenceCategory_Id | integer | int64 |\r\n| sequenceNumber | RiskConsequence->SequenceNumber | integer | int32 |\r\n| value | RiskConsequence->Value | number | decimal |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| riskConsequenceCategoryId | Required | True | |\r\n| riskConsequenceCategoryId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | Nullable | False | |\r\n| value | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchCreateRiskConsequence", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateRiskConsequenceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Risk Consequence batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Risk Consequence" ], "summary": "Update a collection of existing Risk Consequence resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskConsequence->Id | integer | int64 |\r\n| version | RiskConsequence->Version | integer | int32 |\r\n| code | RiskConsequence->Code | string | |\r\n| description | RiskConsequence->Description | string | |\r\n| notes | RiskConsequence->Notes | string | |\r\n| riskConsequenceCategoryId | RiskConsequence->RiskConsequenceCategory_Id | integer | int64 |\r\n| sequenceNumber | RiskConsequence->SequenceNumber | integer | int32 |\r\n| value | RiskConsequence->Value | number | decimal |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| riskConsequenceCategoryId | Nullable | False | |\r\n| value | Nullable | False | |\r\n| value | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchUpdateRiskConsequence", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRiskConsequenceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Consequence batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Risk Consequence" ], "summary": "Delete a collection of existing Risk Consequence resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskConsequence->Id | integer | int64 |\r\n| version | RiskConsequence->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRiskConsequence", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteRiskConsequenceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Consequence batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequences/{id}/Active": { "patch": { "tags": [ "Risk Consequence" ], "summary": "Change the IsActive status for an existing Risk Consequence resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskConsequence->Version | integer | int32 |\r\n| isActive | RiskConsequence->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeRiskConsequenceIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Consequence Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRiskConsequenceIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequences/{id}/PermissionTree": { "patch": { "tags": [ "Risk Consequence" ], "summary": "Change the PermissionTree for an existing Risk Consequence resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskConsequence->Version | integer | int32 |\r\n| permissionTreeId | RiskConsequence->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeRiskConsequencePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Consequence Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRiskConsequencePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequences/Batch/Active": { "patch": { "tags": [ "Risk Consequence" ], "summary": "Change the IsActive status for a collection of existing Risk Consequence resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskConsequence->Id | integer | int64 |\r\n| version | RiskConsequence->Version | integer | int32 |\r\n| isActive | RiskConsequence->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeRiskConsequenceIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRiskConsequenceIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequences/Batch/PermissionTree": { "patch": { "tags": [ "Risk Consequence" ], "summary": "Change the PermissionTree status for a collection of existing Risk Consequence resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskConsequence->Id | integer | int64 |\r\n| version | RiskConsequence->Version | integer | int32 |\r\n| permissionTreeId | RiskConsequence->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeRiskConsequencePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRiskConsequencePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequenceCategories/{id}": { "get": { "tags": [ "Risk Consequence Category" ], "summary": "Get a Risk Consequence Category resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RiskConsequenceCategory->Code | string | |\r\n| createdByUserId | RiskConsequenceCategory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RiskConsequenceCategory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RiskConsequenceCategory->CreatedByUser_FullName | string | |\r\n| createdOn | RiskConsequenceCategory->CreatedOn | string | date-time |\r\n| isActive | RiskConsequenceCategory->IsActive | boolean | |\r\n| modifiedByUserId | RiskConsequenceCategory->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RiskConsequenceCategory->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RiskConsequenceCategory->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RiskConsequenceCategory->ModifiedOn | string | date-time |\r\n| permissionTreeId | RiskConsequenceCategory->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RiskConsequenceCategory->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RiskConsequenceCategory->PermissionTree_Description | string | |\r\n| version | RiskConsequenceCategory->Version | integer | int32 |\r\n| id | RiskConsequenceCategory->Id | integer | int64 |\r\n| description | RiskConsequenceCategory->Description | string | |\r\n| notes | RiskConsequenceCategory->Notes | string | |\r\n| sequenceNumber | RiskConsequenceCategory->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRiskConsequenceCategory", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Consequence Category Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Risk Consequence Category", "schema": { "$ref": "#/definitions/GetRiskConsequenceCategoryResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Risk Consequence Category" ], "summary": "Update an existing Risk Consequence Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskConsequenceCategory->Version | integer | int32 |\r\n| code | RiskConsequenceCategory->Code | string | |\r\n| description | RiskConsequenceCategory->Description | string | |\r\n| notes | RiskConsequenceCategory->Notes | string | |\r\n| sequenceNumber | RiskConsequenceCategory->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateRiskConsequenceCategory", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Consequence Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRiskConsequenceCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Consequence Category was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Risk Consequence Category" ], "summary": "Delete an existing Risk Consequence Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskConsequenceCategory->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteRiskConsequenceCategory", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Consequence Category Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRiskConsequenceCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Consequence Category was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequenceCategories": { "get": { "tags": [ "Risk Consequence Category" ], "summary": "Get a collection of Risk Consequence Category resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskConsequenceCategory->Id | integer | int64 |\r\n| version | RiskConsequenceCategory->Version | integer | int32 |\r\n| code | RiskConsequenceCategory->Code | string | |\r\n| description | RiskConsequenceCategory->Description | string | |\r\n| sequenceNumber | RiskConsequenceCategory->SequenceNumber | integer | int32 |\r\n| isActive | RiskConsequenceCategory->IsActive | boolean | |\r\n", "operationId": "GetRiskConsequenceCategoryCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Risk Consequence Category collection", "schema": { "$ref": "#/definitions/GetRiskConsequenceCategoryCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Risk Consequence Category" ], "summary": "Create a new Risk Consequence Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RiskConsequenceCategory->Code | string | |\r\n| description | RiskConsequenceCategory->Description | string | |\r\n| notes | RiskConsequenceCategory->Notes | string | |\r\n| permissionTreeId | RiskConsequenceCategory->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RiskConsequenceCategory->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateRiskConsequenceCategory", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateRiskConsequenceCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequenceCategories/Lookups/LookupRiskConsequenceCategoryChangePermissionTree": { "get": { "tags": [ "Risk Consequence Category" ], "summary": "Lookup the permission set for changing the Risk Consequence Category.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRiskConsequenceCategoryChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/RiskConsequenceCategoryChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequenceCategories/Lookups/LookupRiskConsequenceCategoryInsertPermissionTree": { "get": { "tags": [ "Risk Consequence Category" ], "summary": "Lookup the permission set for creating the Risk Consequence Category.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRiskConsequenceCategoryInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/RiskConsequenceCategoryInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequenceCategories/Batch/{ids}": { "get": { "tags": [ "Risk Consequence Category" ], "summary": "Get a collection of Risk Consequence Category resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RiskConsequenceCategory->Code | string | |\r\n| createdByUserId | RiskConsequenceCategory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RiskConsequenceCategory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RiskConsequenceCategory->CreatedByUser_FullName | string | |\r\n| createdOn | RiskConsequenceCategory->CreatedOn | string | date-time |\r\n| isActive | RiskConsequenceCategory->IsActive | boolean | |\r\n| modifiedByUserId | RiskConsequenceCategory->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RiskConsequenceCategory->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RiskConsequenceCategory->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RiskConsequenceCategory->ModifiedOn | string | date-time |\r\n| permissionTreeId | RiskConsequenceCategory->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RiskConsequenceCategory->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RiskConsequenceCategory->PermissionTree_Description | string | |\r\n| version | RiskConsequenceCategory->Version | integer | int32 |\r\n| id | RiskConsequenceCategory->Id | integer | int64 |\r\n| description | RiskConsequenceCategory->Description | string | |\r\n| notes | RiskConsequenceCategory->Notes | string | |\r\n| sequenceNumber | RiskConsequenceCategory->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRiskConsequenceCategory", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Risk Consequence Category id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Risk Consequence Category collection", "schema": { "$ref": "#/definitions/BatchGetRiskConsequenceCategoryResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequenceCategories/Batch": { "post": { "tags": [ "Risk Consequence Category" ], "summary": "Create a new collection of Risk Consequence Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RiskConsequenceCategory->Code | string | |\r\n| description | RiskConsequenceCategory->Description | string | |\r\n| notes | RiskConsequenceCategory->Notes | string | |\r\n| permissionTreeId | RiskConsequenceCategory->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RiskConsequenceCategory->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRiskConsequenceCategory", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateRiskConsequenceCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Risk Consequence Category batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Risk Consequence Category" ], "summary": "Update a collection of existing Risk Consequence Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskConsequenceCategory->Id | integer | int64 |\r\n| version | RiskConsequenceCategory->Version | integer | int32 |\r\n| code | RiskConsequenceCategory->Code | string | |\r\n| description | RiskConsequenceCategory->Description | string | |\r\n| notes | RiskConsequenceCategory->Notes | string | |\r\n| sequenceNumber | RiskConsequenceCategory->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateRiskConsequenceCategory", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRiskConsequenceCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Consequence Category batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Risk Consequence Category" ], "summary": "Delete a collection of existing Risk Consequence Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskConsequenceCategory->Id | integer | int64 |\r\n| version | RiskConsequenceCategory->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRiskConsequenceCategory", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteRiskConsequenceCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Consequence Category batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequenceCategories/{id}/Active": { "patch": { "tags": [ "Risk Consequence Category" ], "summary": "Change the IsActive status for an existing Risk Consequence Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskConsequenceCategory->Version | integer | int32 |\r\n| isActive | RiskConsequenceCategory->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeRiskConsequenceCategoryIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Consequence Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRiskConsequenceCategoryIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequenceCategories/{id}/PermissionTree": { "patch": { "tags": [ "Risk Consequence Category" ], "summary": "Change the PermissionTree for an existing Risk Consequence Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskConsequenceCategory->Version | integer | int32 |\r\n| permissionTreeId | RiskConsequenceCategory->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeRiskConsequenceCategoryPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Consequence Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRiskConsequenceCategoryPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequenceCategories/Batch/Active": { "patch": { "tags": [ "Risk Consequence Category" ], "summary": "Change the IsActive status for a collection of existing Risk Consequence Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskConsequenceCategory->Id | integer | int64 |\r\n| version | RiskConsequenceCategory->Version | integer | int32 |\r\n| isActive | RiskConsequenceCategory->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeRiskConsequenceCategoryIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRiskConsequenceCategoryIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskConsequenceCategories/Batch/PermissionTree": { "patch": { "tags": [ "Risk Consequence Category" ], "summary": "Change the PermissionTree status for a collection of existing Risk Consequence Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskConsequenceCategory->Id | integer | int64 |\r\n| version | RiskConsequenceCategory->Version | integer | int32 |\r\n| permissionTreeId | RiskConsequenceCategory->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeRiskConsequenceCategoryPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRiskConsequenceCategoryPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/{id}": { "get": { "tags": [ "Risk Model" ], "summary": "Get a Risk Model resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RiskModel->Code | string | |\r\n| isActive | RiskModel->IsActive | boolean | |\r\n| version | RiskModel->Version | integer | int32 |\r\n| permissionTreeId | RiskModel->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RiskModel->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RiskModel->PermissionTree_Description | string | |\r\n| createdByUserId | RiskModel->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RiskModel->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RiskModel->CreatedByUser_FullName | string | |\r\n| createdOn | RiskModel->CreatedOn | string | date-time |\r\n| modifiedByUserId | RiskModel->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RiskModel->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RiskModel->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RiskModel->ModifiedOn | string | date-time |\r\n| id | RiskModel->Id | integer | int64 |\r\n| riskCalculationType | RiskModel->RiskCalculationType | string (Allowed values: [NormalisedWeightedSum, WeightedSum, WeightedProduct]) | enum |\r\n| description | RiskModel->Description | string | |\r\n| importancesConfigured | RiskModel->ImportancesConfigured | boolean | |\r\n| importancesRangesVerified | RiskModel->ImportancesRangesVerified | boolean | |\r\n| notes | RiskModel->Notes | string | |\r\n| reason | RiskModel->Reason | string | |\r\n| sequenceNumber | RiskModel->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRiskModel", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Model Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Risk Model", "schema": { "$ref": "#/definitions/GetRiskModelResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Risk Model" ], "summary": "Update an existing Risk Model resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskModel->Version | integer | int32 |\r\n| code | RiskModel->Code | string | |\r\n| riskCalculationType | RiskModel->RiskCalculationType | string (Allowed values: [NormalisedWeightedSum, WeightedSum, WeightedProduct]) | enum |\r\n| description | RiskModel->Description | string | |\r\n| notes | RiskModel->Notes | string | |\r\n| sequenceNumber | RiskModel->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| riskCalculationType | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateRiskModel", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Model Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRiskModelResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Model was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Risk Model" ], "summary": "Delete an existing Risk Model resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskModel->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteRiskModel", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Model Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRiskModelResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Model was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels": { "get": { "tags": [ "Risk Model" ], "summary": "Get a collection of Risk Model resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModel->Id | integer | int64 |\r\n| version | RiskModel->Version | integer | int32 |\r\n| code | RiskModel->Code | string | |\r\n| description | RiskModel->Description | string | |\r\n| sequenceNumber | RiskModel->SequenceNumber | integer | int32 |\r\n| isActive | RiskModel->IsActive | boolean | |\r\n| riskCalculationType | RiskModel->RiskCalculationType | string (Allowed values: [NormalisedWeightedSum, WeightedSum, WeightedProduct]) | enum |\r\n| importancesConfigured | RiskModel->ImportancesConfigured | boolean | |\r\n| importancesRangesVerified | RiskModel->ImportancesRangesVerified | boolean | |\r\n| reason | RiskModel->Reason | string | |\r\n", "operationId": "GetRiskModelCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Risk Model collection", "schema": { "$ref": "#/definitions/GetRiskModelCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Risk Model" ], "summary": "Create a new Risk Model resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RiskModel->Code | string | |\r\n| riskCalculationType | RiskModel->RiskCalculationType | string (Allowed values: [NormalisedWeightedSum, WeightedSum, WeightedProduct]) | enum |\r\n| description | RiskModel->Description | string | |\r\n| notes | RiskModel->Notes | string | |\r\n| permissionTreeId | RiskModel->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RiskModel->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| riskCalculationType | Required | True | |\r\n| riskCalculationType | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateRiskModel", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateRiskModelResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Lookups/LookupRiskModelChangePermissionTree": { "get": { "tags": [ "Risk Model" ], "summary": "Lookup the permission set for changing the Risk Model.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRiskModelChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/RiskModelChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Lookups/LookupRiskModelInsertPermissionTree": { "get": { "tags": [ "Risk Model" ], "summary": "Lookup the permission set for creating the Risk Model.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRiskModelInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/RiskModelInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Batch/{ids}": { "get": { "tags": [ "Risk Model" ], "summary": "Get a collection of Risk Model resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RiskModel->Code | string | |\r\n| isActive | RiskModel->IsActive | boolean | |\r\n| version | RiskModel->Version | integer | int32 |\r\n| permissionTreeId | RiskModel->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RiskModel->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RiskModel->PermissionTree_Description | string | |\r\n| createdByUserId | RiskModel->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RiskModel->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RiskModel->CreatedByUser_FullName | string | |\r\n| createdOn | RiskModel->CreatedOn | string | date-time |\r\n| modifiedByUserId | RiskModel->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RiskModel->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RiskModel->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RiskModel->ModifiedOn | string | date-time |\r\n| id | RiskModel->Id | integer | int64 |\r\n| riskCalculationType | RiskModel->RiskCalculationType | string (Allowed values: [NormalisedWeightedSum, WeightedSum, WeightedProduct]) | enum |\r\n| description | RiskModel->Description | string | |\r\n| importancesConfigured | RiskModel->ImportancesConfigured | boolean | |\r\n| importancesRangesVerified | RiskModel->ImportancesRangesVerified | boolean | |\r\n| notes | RiskModel->Notes | string | |\r\n| reason | RiskModel->Reason | string | |\r\n| sequenceNumber | RiskModel->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRiskModel", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Risk Model id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Risk Model collection", "schema": { "$ref": "#/definitions/BatchGetRiskModelResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Batch": { "post": { "tags": [ "Risk Model" ], "summary": "Create a new collection of Risk Model resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RiskModel->Code | string | |\r\n| riskCalculationType | RiskModel->RiskCalculationType | string (Allowed values: [NormalisedWeightedSum, WeightedSum, WeightedProduct]) | enum |\r\n| description | RiskModel->Description | string | |\r\n| notes | RiskModel->Notes | string | |\r\n| permissionTreeId | RiskModel->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RiskModel->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| riskCalculationType | Required | True | |\r\n| riskCalculationType | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRiskModel", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateRiskModelResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Risk Model batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Risk Model" ], "summary": "Update a collection of existing Risk Model resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModel->Id | integer | int64 |\r\n| version | RiskModel->Version | integer | int32 |\r\n| code | RiskModel->Code | string | |\r\n| riskCalculationType | RiskModel->RiskCalculationType | string (Allowed values: [NormalisedWeightedSum, WeightedSum, WeightedProduct]) | enum |\r\n| description | RiskModel->Description | string | |\r\n| notes | RiskModel->Notes | string | |\r\n| sequenceNumber | RiskModel->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| riskCalculationType | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateRiskModel", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRiskModelResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Model batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Risk Model" ], "summary": "Delete a collection of existing Risk Model resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModel->Id | integer | int64 |\r\n| version | RiskModel->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRiskModel", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteRiskModelResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Model batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/{id}/Active": { "patch": { "tags": [ "Risk Model" ], "summary": "Change the IsActive status for an existing Risk Model resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskModel->Version | integer | int32 |\r\n| isActive | RiskModel->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeRiskModelIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Model Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRiskModelIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/{id}/PermissionTree": { "patch": { "tags": [ "Risk Model" ], "summary": "Change the PermissionTree for an existing Risk Model resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskModel->Version | integer | int32 |\r\n| permissionTreeId | RiskModel->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeRiskModelPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Model Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRiskModelPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Batch/Active": { "patch": { "tags": [ "Risk Model" ], "summary": "Change the IsActive status for a collection of existing Risk Model resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModel->Id | integer | int64 |\r\n| version | RiskModel->Version | integer | int32 |\r\n| isActive | RiskModel->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeRiskModelIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRiskModelIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Batch/PermissionTree": { "patch": { "tags": [ "Risk Model" ], "summary": "Change the PermissionTree status for a collection of existing Risk Model resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModel->Id | integer | int64 |\r\n| version | RiskModel->Version | integer | int32 |\r\n| permissionTreeId | RiskModel->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeRiskModelPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRiskModelPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/ConsequenceCategories/{id}": { "get": { "tags": [ "Risk Model Consequence Category" ], "summary": "Get a Risk Model Consequence Category resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | RiskModelConsequenceCategory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RiskModelConsequenceCategory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RiskModelConsequenceCategory->CreatedByUser_FullName | string | |\r\n| createdOn | RiskModelConsequenceCategory->CreatedOn | string | date-time |\r\n| modifiedByUserId | RiskModelConsequenceCategory->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RiskModelConsequenceCategory->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RiskModelConsequenceCategory->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RiskModelConsequenceCategory->ModifiedOn | string | date-time |\r\n| version | RiskModelConsequenceCategory->Version | integer | int32 |\r\n| permissionTreeId | RiskModelConsequenceCategory->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RiskModelConsequenceCategory->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RiskModelConsequenceCategory->PermissionTree_Description | string | |\r\n| id | RiskModelConsequenceCategory->Id | integer | int64 |\r\n| notes | RiskModelConsequenceCategory->Notes | string | |\r\n| riskConsequenceCategoryId | RiskModelConsequenceCategory->RiskConsequenceCategory_Id | integer | int64 |\r\n| riskConsequenceCategoryCode | RiskModelConsequenceCategory->RiskConsequenceCategory_Code | string | |\r\n| riskConsequenceCategoryDescription | RiskModelConsequenceCategory->RiskConsequenceCategory_Description | string | |\r\n| riskModelId | RiskModelConsequenceCategory->RiskModel_Id | integer | int64 |\r\n| riskModelCode | RiskModelConsequenceCategory->RiskModel_Code | string | |\r\n| riskModelDescription | RiskModelConsequenceCategory->RiskModel_Description | string | |\r\n| sequenceNumber | RiskModelConsequenceCategory->SequenceNumber | integer | int32 |\r\n| weightValue | RiskModelConsequenceCategory->WeightValue | number | decimal |\r\n", "operationId": "GetRiskModelConsequenceCategory", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Model Consequence Category Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Risk Model Consequence Category", "schema": { "$ref": "#/definitions/GetRiskModelConsequenceCategoryResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Risk Model Consequence Category" ], "summary": "Update an existing Risk Model Consequence Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskModelConsequenceCategory->Version | integer | int32 |\r\n| riskConsequenceCategoryId | RiskModelConsequenceCategory->RiskConsequenceCategory_Id | integer | int64 |\r\n| sequenceNumber | RiskModelConsequenceCategory->SequenceNumber | integer | int32 |\r\n| weightValue | RiskModelConsequenceCategory->WeightValue | number | decimal |\r\n| notes | RiskModelConsequenceCategory->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| riskConsequenceCategoryId | Nullable | False | |\r\n| weightValue | Min Value | > 0| |\r\n\r\n", "operationId": "UpdateRiskModelConsequenceCategory", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Model Consequence Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRiskModelConsequenceCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Model Consequence Category was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Risk Model Consequence Category" ], "summary": "Delete an existing Risk Model Consequence Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskModelConsequenceCategory->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteRiskModelConsequenceCategory", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Model Consequence Category Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRiskModelConsequenceCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Model Consequence Category was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/ConsequenceCategories": { "get": { "tags": [ "Risk Model Consequence Category" ], "summary": "Get a collection of Risk Model Consequence Category resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModelConsequenceCategory->Id | integer | int64 |\r\n| version | RiskModelConsequenceCategory->Version | integer | int32 |\r\n| sequenceNumber | RiskModelConsequenceCategory->SequenceNumber | integer | int32 |\r\n| riskModelId | RiskModelConsequenceCategory->RiskModel_Id | integer | int64 |\r\n| riskModelCode | RiskModelConsequenceCategory->RiskModel_Code | string | |\r\n| riskModelDescription | RiskModelConsequenceCategory->RiskModel_Description | string | |\r\n| riskConsequenceCategoryId | RiskModelConsequenceCategory->RiskConsequenceCategory_Id | integer | int64 |\r\n| riskConsequenceCategoryCode | RiskModelConsequenceCategory->RiskConsequenceCategory_Code | string | |\r\n| riskConsequenceCategoryDescription | RiskModelConsequenceCategory->RiskConsequenceCategory_Description | string | |\r\n| permissionTreeId | RiskModelConsequenceCategory->PermissionTree_Id | integer | int64 |\r\n| permissionTreeDescription | RiskModelConsequenceCategory->PermissionTree_Description | string | |\r\n| permissionTreeCode | RiskModelConsequenceCategory->PermissionTree_Code | string | |\r\n| notes | RiskModelConsequenceCategory->Notes | string | |\r\n| weightValue | RiskModelConsequenceCategory->WeightValue | number | decimal |\r\n| createdOn | RiskModelConsequenceCategory->CreatedOn | string | date-time |\r\n| modifiedOn | RiskModelConsequenceCategory->ModifiedOn | string | date-time |\r\n", "operationId": "GetRiskModelConsequenceCategoryCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Risk Model Consequence Category collection", "schema": { "$ref": "#/definitions/GetRiskModelConsequenceCategoryCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Risk Model Consequence Category" ], "summary": "Create a new Risk Model Consequence Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RiskModelConsequenceCategory->PermissionTree_Id | integer | int64 |\r\n| weightValue | RiskModelConsequenceCategory->WeightValue | number | decimal |\r\n| sequenceNumber | RiskModelConsequenceCategory->SequenceNumber | integer | int32 |\r\n| riskModelId | RiskModelConsequenceCategory->RiskModel_Id | integer | int64 |\r\n| riskConsequenceCategoryId | RiskModelConsequenceCategory->RiskConsequenceCategory_Id | integer | int64 |\r\n| notes | RiskModelConsequenceCategory->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| weightValue | Min Value | > 0| |\r\n| riskModelId | Required | True | |\r\n| riskModelId | Nullable | False | |\r\n| riskConsequenceCategoryId | Required | True | |\r\n| riskConsequenceCategoryId | Nullable | False | |\r\n\r\n", "operationId": "CreateRiskModelConsequenceCategory", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateRiskModelConsequenceCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/{riskModelId}/ConsequenceCategories": { "get": { "tags": [ "Risk Model Consequence Category" ], "summary": "Get a collection of Risk Model Consequence Category resources for the Risk Model.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModelConsequenceCategory->Id | integer | int64 |\r\n| version | RiskModelConsequenceCategory->Version | integer | int32 |\r\n| riskModelId | RiskModelConsequenceCategory->RiskModel_Id | integer | int64 |\r\n| riskModelCode | RiskModelConsequenceCategory->RiskModel_Code | string | |\r\n| riskModelDescription | RiskModelConsequenceCategory->RiskModel_Description | string | |\r\n| sequenceNumber | RiskModelConsequenceCategory->SequenceNumber | integer | int32 |\r\n| riskConsequenceCategoryId | RiskModelConsequenceCategory->RiskConsequenceCategory_Id | integer | int64 |\r\n| riskConsequenceCategoryCode | RiskModelConsequenceCategory->RiskConsequenceCategory_Code | string | |\r\n| riskConsequenceCategoryDescription | RiskModelConsequenceCategory->RiskConsequenceCategory_Description | string | |\r\n| weightValue | RiskModelConsequenceCategory->WeightValue | number | decimal |\r\n| notes | RiskModelConsequenceCategory->Notes | string | |\r\n", "operationId": "GetRiskModelConsequenceCategoryForRiskModelCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "riskModelId", "in": "path", "required": true, "description": "Risk Model Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Risk Model Consequence Category collection", "schema": { "$ref": "#/definitions/GetRiskModelConsequenceCategoryForRiskModelCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/ConsequenceCategories/Lookups/LookupRiskModelConsequenceCategoryChangePermissionTree": { "get": { "tags": [ "Risk Model Consequence Category" ], "summary": "Lookup the permission set for changing the Risk Model Consequence Category.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRiskModelConsequenceCategoryChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/RiskModelConsequenceCategoryChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/ConsequenceCategories/Lookups/LookupRiskModelConsequenceCategoryInsertPermissionTree": { "get": { "tags": [ "Risk Model Consequence Category" ], "summary": "Lookup the permission set for creating the Risk Model Consequence Category.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRiskModelConsequenceCategoryInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/RiskModelConsequenceCategoryInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/ConsequenceCategories/Lookups/LookupRiskModelConsequenceCategoryRiskConsequenceCategory": { "get": { "tags": [ "Risk Model Consequence Category" ], "summary": "Lookup the Risk Consequence Category for the Risk Model Consequence Category.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskConsequenceCategory->Id | integer | int64 |\r\n| code | RiskConsequenceCategory->Code | string | |\r\n| description | RiskConsequenceCategory->Description | string | |\r\n", "operationId": "LookupRiskModelConsequenceCategoryRiskConsequenceCategory", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Risk Consequence Category collection", "schema": { "$ref": "#/definitions/RiskModelConsequenceCategoryRiskConsequenceCategoryLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/ConsequenceCategories/Lookups/LookupRiskModelConsequenceCategoryRiskModel": { "get": { "tags": [ "Risk Model Consequence Category" ], "summary": "Lookup the Risk Model for the Risk Model Consequence Category.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModel->Id | integer | int64 |\r\n| code | RiskModel->Code | string | |\r\n| description | RiskModel->Description | string | |\r\n", "operationId": "LookupRiskModelConsequenceCategoryRiskModel", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Risk Model collection", "schema": { "$ref": "#/definitions/RiskModelConsequenceCategoryRiskModelLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/ConsequenceCategories/Batch/{ids}": { "get": { "tags": [ "Risk Model Consequence Category" ], "summary": "Get a collection of Risk Model Consequence Category resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | RiskModelConsequenceCategory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RiskModelConsequenceCategory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RiskModelConsequenceCategory->CreatedByUser_FullName | string | |\r\n| createdOn | RiskModelConsequenceCategory->CreatedOn | string | date-time |\r\n| modifiedByUserId | RiskModelConsequenceCategory->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RiskModelConsequenceCategory->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RiskModelConsequenceCategory->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RiskModelConsequenceCategory->ModifiedOn | string | date-time |\r\n| version | RiskModelConsequenceCategory->Version | integer | int32 |\r\n| permissionTreeId | RiskModelConsequenceCategory->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RiskModelConsequenceCategory->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RiskModelConsequenceCategory->PermissionTree_Description | string | |\r\n| id | RiskModelConsequenceCategory->Id | integer | int64 |\r\n| notes | RiskModelConsequenceCategory->Notes | string | |\r\n| riskConsequenceCategoryId | RiskModelConsequenceCategory->RiskConsequenceCategory_Id | integer | int64 |\r\n| riskConsequenceCategoryCode | RiskModelConsequenceCategory->RiskConsequenceCategory_Code | string | |\r\n| riskConsequenceCategoryDescription | RiskModelConsequenceCategory->RiskConsequenceCategory_Description | string | |\r\n| riskModelId | RiskModelConsequenceCategory->RiskModel_Id | integer | int64 |\r\n| riskModelCode | RiskModelConsequenceCategory->RiskModel_Code | string | |\r\n| riskModelDescription | RiskModelConsequenceCategory->RiskModel_Description | string | |\r\n| sequenceNumber | RiskModelConsequenceCategory->SequenceNumber | integer | int32 |\r\n| weightValue | RiskModelConsequenceCategory->WeightValue | number | decimal |\r\n", "operationId": "BatchGetRiskModelConsequenceCategory", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Risk Model Consequence Category id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Risk Model Consequence Category collection", "schema": { "$ref": "#/definitions/BatchGetRiskModelConsequenceCategoryResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/ConsequenceCategories/Batch": { "post": { "tags": [ "Risk Model Consequence Category" ], "summary": "Create a new collection of Risk Model Consequence Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RiskModelConsequenceCategory->PermissionTree_Id | integer | int64 |\r\n| weightValue | RiskModelConsequenceCategory->WeightValue | number | decimal |\r\n| sequenceNumber | RiskModelConsequenceCategory->SequenceNumber | integer | int32 |\r\n| riskModelId | RiskModelConsequenceCategory->RiskModel_Id | integer | int64 |\r\n| riskConsequenceCategoryId | RiskModelConsequenceCategory->RiskConsequenceCategory_Id | integer | int64 |\r\n| notes | RiskModelConsequenceCategory->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| weightValue | Min Value | > 0| |\r\n| riskModelId | Required | True | |\r\n| riskModelId | Nullable | False | |\r\n| riskConsequenceCategoryId | Required | True | |\r\n| riskConsequenceCategoryId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRiskModelConsequenceCategory", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateRiskModelConsequenceCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Risk Model Consequence Category batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Risk Model Consequence Category" ], "summary": "Update a collection of existing Risk Model Consequence Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModelConsequenceCategory->Id | integer | int64 |\r\n| version | RiskModelConsequenceCategory->Version | integer | int32 |\r\n| riskConsequenceCategoryId | RiskModelConsequenceCategory->RiskConsequenceCategory_Id | integer | int64 |\r\n| sequenceNumber | RiskModelConsequenceCategory->SequenceNumber | integer | int32 |\r\n| weightValue | RiskModelConsequenceCategory->WeightValue | number | decimal |\r\n| notes | RiskModelConsequenceCategory->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| riskConsequenceCategoryId | Nullable | False | |\r\n| weightValue | Min Value | > 0| |\r\n\r\n", "operationId": "BatchUpdateRiskModelConsequenceCategory", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRiskModelConsequenceCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Model Consequence Category batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Risk Model Consequence Category" ], "summary": "Delete a collection of existing Risk Model Consequence Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModelConsequenceCategory->Id | integer | int64 |\r\n| version | RiskModelConsequenceCategory->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRiskModelConsequenceCategory", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteRiskModelConsequenceCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Model Consequence Category batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/ConsequenceCategories/{id}/PermissionTree": { "patch": { "tags": [ "Risk Model Consequence Category" ], "summary": "Change the PermissionTree for an existing Risk Model Consequence Category resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskModelConsequenceCategory->Version | integer | int32 |\r\n| permissionTreeId | RiskModelConsequenceCategory->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeRiskModelConsequenceCategoryPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Model Consequence Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRiskModelConsequenceCategoryPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/ConsequenceCategories/Batch/PermissionTree": { "patch": { "tags": [ "Risk Model Consequence Category" ], "summary": "Change the PermissionTree status for a collection of existing Risk Model Consequence Category resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModelConsequenceCategory->Id | integer | int64 |\r\n| version | RiskModelConsequenceCategory->Version | integer | int32 |\r\n| permissionTreeId | RiskModelConsequenceCategory->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeRiskModelConsequenceCategoryPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRiskModelConsequenceCategoryPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Importances/{id}": { "get": { "tags": [ "Risk Model Importance" ], "summary": "Get a Risk Model Importance resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | RiskModelImportance->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RiskModelImportance->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RiskModelImportance->CreatedByUser_FullName | string | |\r\n| createdOn | RiskModelImportance->CreatedOn | string | date-time |\r\n| modifiedByUserId | RiskModelImportance->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RiskModelImportance->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RiskModelImportance->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RiskModelImportance->ModifiedOn | string | date-time |\r\n| version | RiskModelImportance->Version | integer | int32 |\r\n| permissionTreeId | RiskModelImportance->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RiskModelImportance->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RiskModelImportance->PermissionTree_Description | string | |\r\n| id | RiskModelImportance->Id | integer | int64 |\r\n| assetImportanceId | RiskModelImportance->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | RiskModelImportance->AssetImportance_Code | string | |\r\n| assetImportanceDescription | RiskModelImportance->AssetImportance_Description | string | |\r\n| bottomRange | RiskModelImportance->BottomRange | number | decimal |\r\n| notes | RiskModelImportance->Notes | string | |\r\n| riskModelId | RiskModelImportance->RiskModel_Id | integer | int64 |\r\n| riskModelCode | RiskModelImportance->RiskModel_Code | string | |\r\n| riskModelDescription | RiskModelImportance->RiskModel_Description | string | |\r\n| sequenceNumber | RiskModelImportance->SequenceNumber | integer | int32 |\r\n| topRange | RiskModelImportance->TopRange | number | decimal |\r\n", "operationId": "GetRiskModelImportance", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Model Importance Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Risk Model Importance", "schema": { "$ref": "#/definitions/GetRiskModelImportanceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Risk Model Importance" ], "summary": "Update an existing Risk Model Importance resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskModelImportance->Version | integer | int32 |\r\n| assetImportanceId | RiskModelImportance->AssetImportance_Id | integer | int64 |\r\n| bottomRange | RiskModelImportance->BottomRange | number | decimal |\r\n| topRange | RiskModelImportance->TopRange | number | decimal |\r\n| sequenceNumber | RiskModelImportance->SequenceNumber | integer | int32 |\r\n| notes | RiskModelImportance->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| assetImportanceId | Nullable | False | |\r\n| bottomRange | Nullable | False | |\r\n| bottomRange | Min Value | >= 0| |\r\n\r\n", "operationId": "UpdateRiskModelImportance", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Model Importance Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRiskModelImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Model Importance was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Risk Model Importance" ], "summary": "Delete an existing Risk Model Importance resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskModelImportance->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteRiskModelImportance", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Model Importance Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRiskModelImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Model Importance was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Importances": { "get": { "tags": [ "Risk Model Importance" ], "summary": "Get a collection of Risk Model Importance resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModelImportance->Id | integer | int64 |\r\n| version | RiskModelImportance->Version | integer | int32 |\r\n| riskModelId | RiskModelImportance->RiskModel_Id | integer | int64 |\r\n| riskModelCode | RiskModelImportance->RiskModel_Code | string | |\r\n| riskModelDescription | RiskModelImportance->RiskModel_Description | string | |\r\n| assetImportanceId | RiskModelImportance->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | RiskModelImportance->AssetImportance_Code | string | |\r\n| assetImportanceDescription | RiskModelImportance->AssetImportance_Description | string | |\r\n| bottomRange | RiskModelImportance->BottomRange | number | decimal |\r\n| topRange | RiskModelImportance->TopRange | number | decimal |\r\n", "operationId": "GetRiskModelImportanceCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Risk Model Importance collection", "schema": { "$ref": "#/definitions/GetRiskModelImportanceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Risk Model Importance" ], "summary": "Create a new Risk Model Importance resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RiskModelImportance->PermissionTree_Id | integer | int64 |\r\n| assetImportanceId | RiskModelImportance->AssetImportance_Id | integer | int64 |\r\n| riskModelId | RiskModelImportance->RiskModel_Id | integer | int64 |\r\n| bottomRange | RiskModelImportance->BottomRange | number | decimal |\r\n| topRange | RiskModelImportance->TopRange | number | decimal |\r\n| sequenceNumber | RiskModelImportance->SequenceNumber | integer | int32 |\r\n| notes | RiskModelImportance->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| assetImportanceId | Required | True | |\r\n| assetImportanceId | Nullable | False | |\r\n| riskModelId | Required | True | |\r\n| riskModelId | Nullable | False | |\r\n| bottomRange | Nullable | False | |\r\n| bottomRange | Min Value | >= 0| |\r\n\r\n", "operationId": "CreateRiskModelImportance", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateRiskModelImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/{riskModelId}/Importances": { "get": { "tags": [ "Risk Model Importance" ], "summary": "Get a collection of Risk Model Importance resources for the Risk Model.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModelImportance->Id | integer | int64 |\r\n| version | RiskModelImportance->Version | integer | int32 |\r\n| assetImportanceId | RiskModelImportance->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | RiskModelImportance->AssetImportance_Code | string | |\r\n| assetImportanceDescription | RiskModelImportance->AssetImportance_Description | string | |\r\n| bottomRange | RiskModelImportance->BottomRange | number | decimal |\r\n| topRange | RiskModelImportance->TopRange | number | decimal |\r\n", "operationId": "GetRiskModelImportanceForRiskModelCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "riskModelId", "in": "path", "required": true, "description": "Risk Model Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Risk Model Importance collection", "schema": { "$ref": "#/definitions/GetRiskModelImportanceForRiskModelCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Importances/Lookups/LookupRiskModelImportanceAssetImportance": { "get": { "tags": [ "Risk Model Importance" ], "summary": "Lookup the Asset Importance for the Risk Model Importance.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AssetImportance->Id | integer | int64 |\r\n| code | AssetImportance->Code | string | |\r\n| description | AssetImportance->Description | string | |\r\n", "operationId": "LookupRiskModelImportanceAssetImportance", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Asset Importance collection", "schema": { "$ref": "#/definitions/RiskModelImportanceAssetImportanceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Importances/Lookups/LookupRiskModelImportanceChangePermissionTree": { "get": { "tags": [ "Risk Model Importance" ], "summary": "Lookup the permission set for changing the Risk Model Importance.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRiskModelImportanceChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/RiskModelImportanceChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Importances/Lookups/LookupRiskModelImportanceInsertPermissionTree": { "get": { "tags": [ "Risk Model Importance" ], "summary": "Lookup the permission set for creating the Risk Model Importance.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRiskModelImportanceInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/RiskModelImportanceInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Importances/Lookups/LookupRiskModelImportanceRiskModel": { "get": { "tags": [ "Risk Model Importance" ], "summary": "Lookup the Risk Model for the Risk Model Importance.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModel->Id | integer | int64 |\r\n| code | RiskModel->Code | string | |\r\n| description | RiskModel->Description | string | |\r\n", "operationId": "LookupRiskModelImportanceRiskModel", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Risk Model collection", "schema": { "$ref": "#/definitions/RiskModelImportanceRiskModelLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Importances/Batch/{ids}": { "get": { "tags": [ "Risk Model Importance" ], "summary": "Get a collection of Risk Model Importance resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | RiskModelImportance->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RiskModelImportance->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RiskModelImportance->CreatedByUser_FullName | string | |\r\n| createdOn | RiskModelImportance->CreatedOn | string | date-time |\r\n| modifiedByUserId | RiskModelImportance->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RiskModelImportance->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RiskModelImportance->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RiskModelImportance->ModifiedOn | string | date-time |\r\n| version | RiskModelImportance->Version | integer | int32 |\r\n| permissionTreeId | RiskModelImportance->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RiskModelImportance->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RiskModelImportance->PermissionTree_Description | string | |\r\n| id | RiskModelImportance->Id | integer | int64 |\r\n| assetImportanceId | RiskModelImportance->AssetImportance_Id | integer | int64 |\r\n| assetImportanceCode | RiskModelImportance->AssetImportance_Code | string | |\r\n| assetImportanceDescription | RiskModelImportance->AssetImportance_Description | string | |\r\n| bottomRange | RiskModelImportance->BottomRange | number | decimal |\r\n| notes | RiskModelImportance->Notes | string | |\r\n| riskModelId | RiskModelImportance->RiskModel_Id | integer | int64 |\r\n| riskModelCode | RiskModelImportance->RiskModel_Code | string | |\r\n| riskModelDescription | RiskModelImportance->RiskModel_Description | string | |\r\n| sequenceNumber | RiskModelImportance->SequenceNumber | integer | int32 |\r\n| topRange | RiskModelImportance->TopRange | number | decimal |\r\n", "operationId": "BatchGetRiskModelImportance", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Risk Model Importance id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Risk Model Importance collection", "schema": { "$ref": "#/definitions/BatchGetRiskModelImportanceResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Importances/Batch": { "post": { "tags": [ "Risk Model Importance" ], "summary": "Create a new collection of Risk Model Importance resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RiskModelImportance->PermissionTree_Id | integer | int64 |\r\n| assetImportanceId | RiskModelImportance->AssetImportance_Id | integer | int64 |\r\n| riskModelId | RiskModelImportance->RiskModel_Id | integer | int64 |\r\n| bottomRange | RiskModelImportance->BottomRange | number | decimal |\r\n| topRange | RiskModelImportance->TopRange | number | decimal |\r\n| sequenceNumber | RiskModelImportance->SequenceNumber | integer | int32 |\r\n| notes | RiskModelImportance->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| assetImportanceId | Required | True | |\r\n| assetImportanceId | Nullable | False | |\r\n| riskModelId | Required | True | |\r\n| riskModelId | Nullable | False | |\r\n| bottomRange | Nullable | False | |\r\n| bottomRange | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchCreateRiskModelImportance", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateRiskModelImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Risk Model Importance batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Risk Model Importance" ], "summary": "Update a collection of existing Risk Model Importance resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModelImportance->Id | integer | int64 |\r\n| version | RiskModelImportance->Version | integer | int32 |\r\n| assetImportanceId | RiskModelImportance->AssetImportance_Id | integer | int64 |\r\n| bottomRange | RiskModelImportance->BottomRange | number | decimal |\r\n| topRange | RiskModelImportance->TopRange | number | decimal |\r\n| sequenceNumber | RiskModelImportance->SequenceNumber | integer | int32 |\r\n| notes | RiskModelImportance->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| assetImportanceId | Nullable | False | |\r\n| bottomRange | Nullable | False | |\r\n| bottomRange | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchUpdateRiskModelImportance", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRiskModelImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Model Importance batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Risk Model Importance" ], "summary": "Delete a collection of existing Risk Model Importance resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModelImportance->Id | integer | int64 |\r\n| version | RiskModelImportance->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRiskModelImportance", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteRiskModelImportanceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Model Importance batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Importances/{id}/PermissionTree": { "patch": { "tags": [ "Risk Model Importance" ], "summary": "Change the PermissionTree for an existing Risk Model Importance resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskModelImportance->Version | integer | int32 |\r\n| permissionTreeId | RiskModelImportance->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeRiskModelImportancePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Model Importance Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRiskModelImportancePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Importances/Batch/PermissionTree": { "patch": { "tags": [ "Risk Model Importance" ], "summary": "Change the PermissionTree status for a collection of existing Risk Model Importance resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModelImportance->Id | integer | int64 |\r\n| version | RiskModelImportance->Version | integer | int32 |\r\n| permissionTreeId | RiskModelImportance->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeRiskModelImportancePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRiskModelImportancePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Probabilities/{id}": { "get": { "tags": [ "Risk Model Probability" ], "summary": "Get a Risk Model Probability resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | RiskModelProbability->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RiskModelProbability->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RiskModelProbability->CreatedByUser_FullName | string | |\r\n| createdOn | RiskModelProbability->CreatedOn | string | date-time |\r\n| modifiedByUserId | RiskModelProbability->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RiskModelProbability->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RiskModelProbability->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RiskModelProbability->ModifiedOn | string | date-time |\r\n| version | RiskModelProbability->Version | integer | int32 |\r\n| permissionTreeId | RiskModelProbability->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RiskModelProbability->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RiskModelProbability->PermissionTree_Description | string | |\r\n| id | RiskModelProbability->Id | integer | int64 |\r\n| notes | RiskModelProbability->Notes | string | |\r\n| riskModelId | RiskModelProbability->RiskModel_Id | integer | int64 |\r\n| riskModelCode | RiskModelProbability->RiskModel_Code | string | |\r\n| riskModelDescription | RiskModelProbability->RiskModel_Description | string | |\r\n| riskProbabilityId | RiskModelProbability->RiskProbability_Id | integer | int64 |\r\n| riskProbabilityCode | RiskModelProbability->RiskProbability_Code | string | |\r\n| riskProbabilityDescription | RiskModelProbability->RiskProbability_Description | string | |\r\n| riskProbabilityValue | RiskModelProbability->RiskProbability_Value | number | decimal |\r\n| sequenceNumber | RiskModelProbability->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRiskModelProbability", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Model Probability Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Risk Model Probability", "schema": { "$ref": "#/definitions/GetRiskModelProbabilityResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Risk Model Probability" ], "summary": "Update an existing Risk Model Probability resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskModelProbability->Version | integer | int32 |\r\n| riskProbabilityId | RiskModelProbability->RiskProbability_Id | integer | int64 |\r\n| sequenceNumber | RiskModelProbability->SequenceNumber | integer | int32 |\r\n| notes | RiskModelProbability->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| riskProbabilityId | Nullable | False | |\r\n\r\n", "operationId": "UpdateRiskModelProbability", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Model Probability Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRiskModelProbabilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Model Probability was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Risk Model Probability" ], "summary": "Delete an existing Risk Model Probability resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskModelProbability->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteRiskModelProbability", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Model Probability Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRiskModelProbabilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Model Probability was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Probabilities": { "get": { "tags": [ "Risk Model Probability" ], "summary": "Get a collection of Risk Model Probability resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModelProbability->Id | integer | int64 |\r\n| version | RiskModelProbability->Version | integer | int32 |\r\n| sequenceNumber | RiskModelProbability->SequenceNumber | integer | int32 |\r\n| riskModelId | RiskModelProbability->RiskModel_Id | integer | int64 |\r\n| riskModelCode | RiskModelProbability->RiskModel_Code | string | |\r\n| riskModelDescription | RiskModelProbability->RiskModel_Description | string | |\r\n| riskProbabilityId | RiskModelProbability->RiskProbability_Id | integer | int64 |\r\n| riskProbabilityCode | RiskModelProbability->RiskProbability_Code | string | |\r\n| riskProbabilityDescription | RiskModelProbability->RiskProbability_Description | string | |\r\n| riskProbabilityValue | RiskModelProbability->RiskProbability_Value | number | decimal |\r\n| permissionTreeId | RiskModelProbability->PermissionTree_Id | integer | int64 |\r\n| permissionTreeDescription | RiskModelProbability->PermissionTree_Description | string | |\r\n| permissionTreeCode | RiskModelProbability->PermissionTree_Code | string | |\r\n| notes | RiskModelProbability->Notes | string | |\r\n| createdOn | RiskModelProbability->CreatedOn | string | date-time |\r\n| modifiedOn | RiskModelProbability->ModifiedOn | string | date-time |\r\n", "operationId": "GetRiskModelProbabilityCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Risk Model Probability collection", "schema": { "$ref": "#/definitions/GetRiskModelProbabilityCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Risk Model Probability" ], "summary": "Create a new Risk Model Probability resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RiskModelProbability->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RiskModelProbability->SequenceNumber | integer | int32 |\r\n| riskModelId | RiskModelProbability->RiskModel_Id | integer | int64 |\r\n| riskProbabilityId | RiskModelProbability->RiskProbability_Id | integer | int64 |\r\n| notes | RiskModelProbability->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| riskModelId | Required | True | |\r\n| riskModelId | Nullable | False | |\r\n| riskProbabilityId | Required | True | |\r\n| riskProbabilityId | Nullable | False | |\r\n\r\n", "operationId": "CreateRiskModelProbability", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateRiskModelProbabilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/{riskModelId}/Probabilities": { "get": { "tags": [ "Risk Model Probability" ], "summary": "Get a collection of Risk Model Probability resources for the Risk Model.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModelProbability->Id | integer | int64 |\r\n| version | RiskModelProbability->Version | integer | int32 |\r\n| riskModelId | RiskModelProbability->RiskModel_Id | integer | int64 |\r\n| riskModelCode | RiskModelProbability->RiskModel_Code | string | |\r\n| riskModelDescription | RiskModelProbability->RiskModel_Description | string | |\r\n| sequenceNumber | RiskModelProbability->SequenceNumber | integer | int32 |\r\n| riskProbabilityId | RiskModelProbability->RiskProbability_Id | integer | int64 |\r\n| riskProbabilityCode | RiskModelProbability->RiskProbability_Code | string | |\r\n| riskProbabilityDescription | RiskModelProbability->RiskProbability_Description | string | |\r\n| riskProbabilityValue | RiskModelProbability->RiskProbability_Value | number | decimal |\r\n| notes | RiskModelProbability->Notes | string | |\r\n", "operationId": "GetRiskModelProbabilityForRiskModelCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "riskModelId", "in": "path", "required": true, "description": "Risk Model Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Risk Model Probability collection", "schema": { "$ref": "#/definitions/GetRiskModelProbabilityForRiskModelCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Probabilities/Lookups/LookupRiskModelProbabilityChangePermissionTree": { "get": { "tags": [ "Risk Model Probability" ], "summary": "Lookup the permission set for changing the Risk Model Probability.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRiskModelProbabilityChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/RiskModelProbabilityChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Probabilities/Lookups/LookupRiskModelProbabilityInsertPermissionTree": { "get": { "tags": [ "Risk Model Probability" ], "summary": "Lookup the permission set for creating the Risk Model Probability.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRiskModelProbabilityInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/RiskModelProbabilityInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Probabilities/Lookups/LookupRiskModelProbabilityRiskModel": { "get": { "tags": [ "Risk Model Probability" ], "summary": "Lookup the Risk Model for the Risk Model Probability.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModel->Id | integer | int64 |\r\n| code | RiskModel->Code | string | |\r\n| description | RiskModel->Description | string | |\r\n", "operationId": "LookupRiskModelProbabilityRiskModel", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Risk Model collection", "schema": { "$ref": "#/definitions/RiskModelProbabilityRiskModelLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Probabilities/Lookups/LookupRiskModelProbabilityRiskProbability": { "get": { "tags": [ "Risk Model Probability" ], "summary": "Lookup the Risk Probability for the Risk Model Probability.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskProbability->Id | integer | int64 |\r\n| code | RiskProbability->Code | string | |\r\n| description | RiskProbability->Description | string | |\r\n| value | RiskProbability->Value | number | decimal |\r\n", "operationId": "LookupRiskModelProbabilityRiskProbability", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Risk Probability collection", "schema": { "$ref": "#/definitions/RiskModelProbabilityRiskProbabilityLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Probabilities/Batch/{ids}": { "get": { "tags": [ "Risk Model Probability" ], "summary": "Get a collection of Risk Model Probability resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | RiskModelProbability->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RiskModelProbability->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RiskModelProbability->CreatedByUser_FullName | string | |\r\n| createdOn | RiskModelProbability->CreatedOn | string | date-time |\r\n| modifiedByUserId | RiskModelProbability->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RiskModelProbability->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RiskModelProbability->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RiskModelProbability->ModifiedOn | string | date-time |\r\n| version | RiskModelProbability->Version | integer | int32 |\r\n| permissionTreeId | RiskModelProbability->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RiskModelProbability->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RiskModelProbability->PermissionTree_Description | string | |\r\n| id | RiskModelProbability->Id | integer | int64 |\r\n| notes | RiskModelProbability->Notes | string | |\r\n| riskModelId | RiskModelProbability->RiskModel_Id | integer | int64 |\r\n| riskModelCode | RiskModelProbability->RiskModel_Code | string | |\r\n| riskModelDescription | RiskModelProbability->RiskModel_Description | string | |\r\n| riskProbabilityId | RiskModelProbability->RiskProbability_Id | integer | int64 |\r\n| riskProbabilityCode | RiskModelProbability->RiskProbability_Code | string | |\r\n| riskProbabilityDescription | RiskModelProbability->RiskProbability_Description | string | |\r\n| riskProbabilityValue | RiskModelProbability->RiskProbability_Value | number | decimal |\r\n| sequenceNumber | RiskModelProbability->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRiskModelProbability", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Risk Model Probability id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Risk Model Probability collection", "schema": { "$ref": "#/definitions/BatchGetRiskModelProbabilityResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Probabilities/Batch": { "post": { "tags": [ "Risk Model Probability" ], "summary": "Create a new collection of Risk Model Probability resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | RiskModelProbability->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RiskModelProbability->SequenceNumber | integer | int32 |\r\n| riskModelId | RiskModelProbability->RiskModel_Id | integer | int64 |\r\n| riskProbabilityId | RiskModelProbability->RiskProbability_Id | integer | int64 |\r\n| notes | RiskModelProbability->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| riskModelId | Required | True | |\r\n| riskModelId | Nullable | False | |\r\n| riskProbabilityId | Required | True | |\r\n| riskProbabilityId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateRiskModelProbability", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateRiskModelProbabilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Risk Model Probability batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Risk Model Probability" ], "summary": "Update a collection of existing Risk Model Probability resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModelProbability->Id | integer | int64 |\r\n| version | RiskModelProbability->Version | integer | int32 |\r\n| riskProbabilityId | RiskModelProbability->RiskProbability_Id | integer | int64 |\r\n| sequenceNumber | RiskModelProbability->SequenceNumber | integer | int32 |\r\n| notes | RiskModelProbability->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| riskProbabilityId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateRiskModelProbability", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRiskModelProbabilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Model Probability batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Risk Model Probability" ], "summary": "Delete a collection of existing Risk Model Probability resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModelProbability->Id | integer | int64 |\r\n| version | RiskModelProbability->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRiskModelProbability", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteRiskModelProbabilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Model Probability batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Probabilities/{id}/PermissionTree": { "patch": { "tags": [ "Risk Model Probability" ], "summary": "Change the PermissionTree for an existing Risk Model Probability resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskModelProbability->Version | integer | int32 |\r\n| permissionTreeId | RiskModelProbability->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeRiskModelProbabilityPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Model Probability Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRiskModelProbabilityPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskModels/Probabilities/Batch/PermissionTree": { "patch": { "tags": [ "Risk Model Probability" ], "summary": "Change the PermissionTree status for a collection of existing Risk Model Probability resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskModelProbability->Id | integer | int64 |\r\n| version | RiskModelProbability->Version | integer | int32 |\r\n| permissionTreeId | RiskModelProbability->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeRiskModelProbabilityPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRiskModelProbabilityPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskProbabilities/{id}": { "get": { "tags": [ "Risk Probability" ], "summary": "Get a Risk Probability resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RiskProbability->Code | string | |\r\n| createdByUserId | RiskProbability->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RiskProbability->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RiskProbability->CreatedByUser_FullName | string | |\r\n| createdOn | RiskProbability->CreatedOn | string | date-time |\r\n| isActive | RiskProbability->IsActive | boolean | |\r\n| modifiedByUserId | RiskProbability->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RiskProbability->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RiskProbability->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RiskProbability->ModifiedOn | string | date-time |\r\n| permissionTreeId | RiskProbability->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RiskProbability->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RiskProbability->PermissionTree_Description | string | |\r\n| version | RiskProbability->Version | integer | int32 |\r\n| id | RiskProbability->Id | integer | int64 |\r\n| description | RiskProbability->Description | string | |\r\n| notes | RiskProbability->Notes | string | |\r\n| sequenceNumber | RiskProbability->SequenceNumber | integer | int32 |\r\n| value | RiskProbability->Value | number | decimal |\r\n", "operationId": "GetRiskProbability", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Probability Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Risk Probability", "schema": { "$ref": "#/definitions/GetRiskProbabilityResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Risk Probability" ], "summary": "Update an existing Risk Probability resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskProbability->Version | integer | int32 |\r\n| code | RiskProbability->Code | string | |\r\n| description | RiskProbability->Description | string | |\r\n| notes | RiskProbability->Notes | string | |\r\n| sequenceNumber | RiskProbability->SequenceNumber | integer | int32 |\r\n| value | RiskProbability->Value | number | decimal |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| value | Nullable | False | |\r\n| value | Min Value | > 0| |\r\n\r\n", "operationId": "UpdateRiskProbability", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Probability Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRiskProbabilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Probability was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Risk Probability" ], "summary": "Delete an existing Risk Probability resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskProbability->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteRiskProbability", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Probability Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRiskProbabilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Probability was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskProbabilities": { "get": { "tags": [ "Risk Probability" ], "summary": "Get a collection of Risk Probability resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskProbability->Id | integer | int64 |\r\n| version | RiskProbability->Version | integer | int32 |\r\n| code | RiskProbability->Code | string | |\r\n| description | RiskProbability->Description | string | |\r\n| sequenceNumber | RiskProbability->SequenceNumber | integer | int32 |\r\n| isActive | RiskProbability->IsActive | boolean | |\r\n| value | RiskProbability->Value | number | decimal |\r\n", "operationId": "GetRiskProbabilityCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Risk Probability collection", "schema": { "$ref": "#/definitions/GetRiskProbabilityCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Risk Probability" ], "summary": "Create a new Risk Probability resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RiskProbability->Code | string | |\r\n| description | RiskProbability->Description | string | |\r\n| notes | RiskProbability->Notes | string | |\r\n| permissionTreeId | RiskProbability->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RiskProbability->SequenceNumber | integer | int32 |\r\n| value | RiskProbability->Value | number | decimal |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | Nullable | False | |\r\n| value | Min Value | > 0| |\r\n\r\n", "operationId": "CreateRiskProbability", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateRiskProbabilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskProbabilities/Lookups/LookupRiskProbabilityChangePermissionTree": { "get": { "tags": [ "Risk Probability" ], "summary": "Lookup the permission set for changing the Risk Probability.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRiskProbabilityChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/RiskProbabilityChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskProbabilities/Lookups/LookupRiskProbabilityInsertPermissionTree": { "get": { "tags": [ "Risk Probability" ], "summary": "Lookup the permission set for creating the Risk Probability.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupRiskProbabilityInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/RiskProbabilityInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskProbabilities/Batch/{ids}": { "get": { "tags": [ "Risk Probability" ], "summary": "Get a collection of Risk Probability resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RiskProbability->Code | string | |\r\n| createdByUserId | RiskProbability->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RiskProbability->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RiskProbability->CreatedByUser_FullName | string | |\r\n| createdOn | RiskProbability->CreatedOn | string | date-time |\r\n| isActive | RiskProbability->IsActive | boolean | |\r\n| modifiedByUserId | RiskProbability->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RiskProbability->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RiskProbability->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RiskProbability->ModifiedOn | string | date-time |\r\n| permissionTreeId | RiskProbability->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RiskProbability->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RiskProbability->PermissionTree_Description | string | |\r\n| version | RiskProbability->Version | integer | int32 |\r\n| id | RiskProbability->Id | integer | int64 |\r\n| description | RiskProbability->Description | string | |\r\n| notes | RiskProbability->Notes | string | |\r\n| sequenceNumber | RiskProbability->SequenceNumber | integer | int32 |\r\n| value | RiskProbability->Value | number | decimal |\r\n", "operationId": "BatchGetRiskProbability", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Risk Probability id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Risk Probability collection", "schema": { "$ref": "#/definitions/BatchGetRiskProbabilityResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskProbabilities/Batch": { "post": { "tags": [ "Risk Probability" ], "summary": "Create a new collection of Risk Probability resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | RiskProbability->Code | string | |\r\n| description | RiskProbability->Description | string | |\r\n| notes | RiskProbability->Notes | string | |\r\n| permissionTreeId | RiskProbability->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | RiskProbability->SequenceNumber | integer | int32 |\r\n| value | RiskProbability->Value | number | decimal |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | Nullable | False | |\r\n| value | Min Value | > 0| |\r\n\r\n", "operationId": "BatchCreateRiskProbability", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateRiskProbabilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Risk Probability batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Risk Probability" ], "summary": "Update a collection of existing Risk Probability resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskProbability->Id | integer | int64 |\r\n| version | RiskProbability->Version | integer | int32 |\r\n| code | RiskProbability->Code | string | |\r\n| description | RiskProbability->Description | string | |\r\n| notes | RiskProbability->Notes | string | |\r\n| sequenceNumber | RiskProbability->SequenceNumber | integer | int32 |\r\n| value | RiskProbability->Value | number | decimal |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| value | Nullable | False | |\r\n| value | Min Value | > 0| |\r\n\r\n", "operationId": "BatchUpdateRiskProbability", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateRiskProbabilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Probability batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Risk Probability" ], "summary": "Delete a collection of existing Risk Probability resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskProbability->Id | integer | int64 |\r\n| version | RiskProbability->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteRiskProbability", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteRiskProbabilityResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Risk Probability batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskProbabilities/{id}/Active": { "patch": { "tags": [ "Risk Probability" ], "summary": "Change the IsActive status for an existing Risk Probability resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskProbability->Version | integer | int32 |\r\n| isActive | RiskProbability->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeRiskProbabilityIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Probability Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRiskProbabilityIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskProbabilities/{id}/PermissionTree": { "patch": { "tags": [ "Risk Probability" ], "summary": "Change the PermissionTree for an existing Risk Probability resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | RiskProbability->Version | integer | int32 |\r\n| permissionTreeId | RiskProbability->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeRiskProbabilityPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Risk Probability Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRiskProbabilityPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskProbabilities/Batch/Active": { "patch": { "tags": [ "Risk Probability" ], "summary": "Change the IsActive status for a collection of existing Risk Probability resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskProbability->Id | integer | int64 |\r\n| version | RiskProbability->Version | integer | int32 |\r\n| isActive | RiskProbability->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeRiskProbabilityIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRiskProbabilityIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/RISK/RiskProbabilities/Batch/PermissionTree": { "patch": { "tags": [ "Risk Probability" ], "summary": "Change the PermissionTree status for a collection of existing Risk Probability resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RiskProbability->Id | integer | int64 |\r\n| version | RiskProbability->Version | integer | int32 |\r\n| permissionTreeId | RiskProbability->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeRiskProbabilityPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeRiskProbabilityPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } } }, "definitions": { "OperationExecutionMode": { "type": "string", "description": "", "x-enumNames": [ "AllOrNone", "PerRecord" ], "enum": [ "AllOrNone", "PerRecord" ] }, "SeverityType": { "type": "string", "description": "", "x-nullable": false, "x-enumNames": [ "Error", "Warning", "Information" ], "enum": [ "error", "warning", "information" ] }, "NotificationItemSchema": { "title": "NotificationItemSchema", "type": "object", "properties": { "code": { "title": "code", "type": "string", "description": "Unique code for message", "x-nullable": false }, "message": { "title": "message", "type": "string", "x-nullable": false }, "objectId": { "title": "objectId", "type": "string", "description": "Optional id of record to which the message applies", "x-nullable": true }, "objectType": { "title": "objectType", "type": "string", "format": "enum", "x-nullable": true, "x-formatSpecifier": "EntityType" }, "properties": { "title": "properties", "type": "array", "description": "Collection of properties referenced by the message using property path syntax", "x-nullable": true, "example": [ "Asset->Code" ], "items": { "type": "string" } }, "severity": { "$ref": "#/definitions/SeverityType" }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Optional provided unique external record identifier to echo back with message", "x-nullable": true } } }, "NotificationSchema": { "title": "NotificationSchema", "type": "object", "properties": { "messages": { "title": "messages", "type": "array", "description": "Collection of messages", "x-nullable": false, "items": { "$ref": "#/definitions/NotificationItemSchema" } } } }, "EntityPermissionViolationSchema": { "type": "object", "required": [ "permissionId", "permissionTreeId", "propertyPaths" ], "properties": { "permissionId": { "type": "integer", "format": "int64" }, "permissionTreeId": { "type": "integer", "format": "int64" }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "EntityPhraseTranslationSchema": { "type": "object", "required": [ "phrase", "translation", "propertyPaths" ], "properties": { "phrase": { "type": "string" }, "translation": { "type": "string" }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "Link": { "type": "object", "required": [ "href", "method" ], "properties": { "doc": { "type": "string", "description": "Documentation endpoint that describes the link" }, "href": { "type": "string", "description": "Endpoint to invoke link", "minLength": 1 }, "mapping": { "type": "array", "items": { "$ref": "#/definitions/LinkMapping" } }, "method": { "type": "string", "description": "HTTP method used for link", "minLength": 1 }, "module": { "type": "string", "description": "Module used by link" }, "rel": { "type": "string" }, "resource": { "type": "string", "description": "Resource used by link" }, "resourceAction": { "type": "string", "description": "Resource Action used by link" }, "title": { "type": "string", "description": "Title" }, "type": { "description": "Type of link", "$ref": "#/definitions/ResourceLinkType" } } }, "LinkMapping": { "type": "object", "required": [ "source" ], "properties": { "source": { "type": "string" }, "target": { "type": "string" } } }, "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" ] }, "GetAssetImportanceResourceActionResponse": { "title": "GetAssetImportanceResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetAssetImportanceResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetImportance->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetImportance->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetImportance->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetImportance->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetImportance->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetImportance->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AssetImportance->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetImportance->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AssetImportance->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AssetImportance->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetImportance->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AssetImportance->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AssetImportance->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetImportance->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetImportance->Notes" }, "weight": { "title": "weight", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "AssetImportance->Weight" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetImportance->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetAssetImportanceCollectionResourceActionResponse": { "title": "GetAssetImportanceCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAssetImportanceCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetAssetImportanceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetImportance->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetImportance->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetImportance->SequenceNumber" }, "weight": { "title": "weight", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "AssetImportance->Weight" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetImportanceChangePermissionTreeLookupResourceActionResponse": { "title": "AssetImportanceChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetImportanceChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetImportanceChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "AssetImportanceInsertPermissionTreeLookupResourceActionResponse": { "title": "AssetImportanceInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AssetImportanceInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "AssetImportanceInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateAssetImportanceResourceActionRequest": { "title": "CreateAssetImportanceResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateAssetImportanceResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "weight" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetImportance->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetImportance->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetImportance->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetImportance->SequenceNumber" }, "weight": { "title": "weight", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "AssetImportance->Weight" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetImportance->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "PatchOperationType": { "type": "string", "description": "", "x-nullable": true, "x-enumNames": [ "Replace", "Add", "Remove" ], "enum": [ "replace", "add", "remove" ] }, "EntityPatchOperationSchema": { "type": "object", "required": [ "path", "value" ], "properties": { "op": { "title": "op", "description": "Type of operation to apply", "example": "replace", "$ref": "#/definitions/PatchOperationType" }, "path": { "title": "path", "type": "string", "description": "Property path for the property being updated", "x-nullable": false, "example": "Asset->Code" }, "value": { "title": "value", "type": "object", "description": "Value for the property being updated", "x-nullable": true, "example": "BOILER" } } }, "UpdateAssetImportanceResourceActionRequest": { "title": "UpdateAssetImportanceResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetImportance->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetImportance->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AssetImportance->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetImportance->Notes" }, { "title": "weight", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "AssetImportance->Weight" } ] } } }, "DeleteAssetImportanceResourceActionRequest": { "title": "DeleteAssetImportanceResourceActionRequest", "type": "object", "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", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetAssetImportanceResourceAction": { "title": "BatchGetAssetImportanceResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Asset Importance entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Asset Importance entities", "items": { "$ref": "#/definitions/GetAssetImportanceResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateAssetImportanceResourceActionRequest": { "title": "BatchCreateAssetImportanceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAssetImportanceResourceActionRequest" } }, "BatchUpdateAssetImportanceResourceActionRequest": { "title": "BatchUpdateAssetImportanceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateAssetImportanceResourceActionRequest" } }, "BatchDeleteAssetImportanceResourceActionRequest": { "title": "BatchDeleteAssetImportanceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteAssetImportanceResourceActionRequest" } }, "ChangeAssetImportanceIsActiveResourceActionRequest": { "title": "ChangeAssetImportanceIsActiveResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AssetImportance->IsActive" } ] } } }, "ChangeAssetImportancePermissionTreeResourceActionRequest": { "title": "ChangeAssetImportancePermissionTreeResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AssetImportance->PermissionTree_Id" } ] } } }, "BatchChangeAssetImportanceIsActiveResourceActionRequest": { "title": "BatchChangeAssetImportanceIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetImportanceIsActiveResourceActionRequest" } }, "BatchChangeAssetImportancePermissionTreeResourceActionRequest": { "title": "BatchChangeAssetImportancePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAssetImportancePermissionTreeResourceActionRequest" } }, "EntityMatchRecordSchema": { "type": "object", "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 } } }, "MatchUpdateAssetImportanceResourceActionRequest": { "title": "MatchUpdateAssetImportanceResourceActionRequest", "type": "object", "properties": { "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entities", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } }, "records": { "title": "records", "type": "array", "description": "Collection of entities to apply the patch operations to", "items": { "$ref": "#/definitions/EntityMatchRecordSchema" }, "x-matchupdateproperties": [ { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "AssetImportance->Description" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AssetImportance->Notes" } ] } } }, "GetRiskConsequenceResourceActionResponse": { "title": "GetRiskConsequenceResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetRiskConsequenceResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RiskConsequence->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RiskConsequence->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskConsequence->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequence->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequence->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskConsequence->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskConsequence->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequence->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequence->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskConsequence->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskConsequence->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequence->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequence->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RiskConsequence->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequence->Notes" }, "riskConsequenceCategoryId": { "title": "riskConsequenceCategoryId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskConsequence->RiskConsequenceCategory_Id" }, "riskConsequenceCategoryCode": { "title": "riskConsequenceCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequence->RiskConsequenceCategory_Code" }, "riskConsequenceCategoryDescription": { "title": "riskConsequenceCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequence->RiskConsequenceCategory_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskConsequence->SequenceNumber" }, "value": { "title": "value", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RiskConsequence->Value" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetRiskConsequenceCollectionResourceActionResponse": { "title": "GetRiskConsequenceCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRiskConsequenceCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRiskConsequenceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RiskConsequence->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RiskConsequence->Description" }, "riskConsequenceCategoryId": { "title": "riskConsequenceCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskConsequence->RiskConsequenceCategory_Id" }, "riskConsequenceCategoryCode": { "title": "riskConsequenceCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RiskConsequence->RiskConsequenceCategory_Code" }, "riskConsequenceCategoryDescription": { "title": "riskConsequenceCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RiskConsequence->RiskConsequenceCategory_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskConsequence->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RiskConsequence->IsActive" }, "value": { "title": "value", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RiskConsequence->Value" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskConsequenceChangePermissionTreeLookupResourceActionResponse": { "title": "RiskConsequenceChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskConsequenceChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskConsequenceChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskConsequenceInsertPermissionTreeLookupResourceActionResponse": { "title": "RiskConsequenceInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskConsequenceInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskConsequenceInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskConsequenceRiskConsequenceCategoryLookupResourceActionResponse": { "title": "RiskConsequenceRiskConsequenceCategoryLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskConsequenceRiskConsequenceCategoryLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskConsequenceRiskConsequenceCategoryLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRiskConsequenceResourceActionRequest": { "title": "CreateRiskConsequenceResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRiskConsequenceResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "permissionTreeId", "riskConsequenceCategoryId", "value" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RiskConsequence->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RiskConsequence->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequence->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskConsequence->PermissionTree_Id" }, "riskConsequenceCategoryId": { "title": "riskConsequenceCategoryId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskConsequence->RiskConsequenceCategory_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskConsequence->SequenceNumber" }, "value": { "title": "value", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "RiskConsequence->Value" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRiskConsequenceResourceActionRequest": { "title": "UpdateRiskConsequenceResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RiskConsequence->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RiskConsequence->Description" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequence->Notes" }, { "title": "riskConsequenceCategoryId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskConsequence->RiskConsequenceCategory_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskConsequence->SequenceNumber" }, { "title": "value", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "RiskConsequence->Value" } ] } } }, "DeleteRiskConsequenceResourceActionRequest": { "title": "DeleteRiskConsequenceResourceActionRequest", "type": "object", "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", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetRiskConsequenceResourceAction": { "title": "BatchGetRiskConsequenceResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Risk Consequence entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Risk Consequence entities", "items": { "$ref": "#/definitions/GetRiskConsequenceResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateRiskConsequenceResourceActionRequest": { "title": "BatchCreateRiskConsequenceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRiskConsequenceResourceActionRequest" } }, "BatchUpdateRiskConsequenceResourceActionRequest": { "title": "BatchUpdateRiskConsequenceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRiskConsequenceResourceActionRequest" } }, "BatchDeleteRiskConsequenceResourceActionRequest": { "title": "BatchDeleteRiskConsequenceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRiskConsequenceResourceActionRequest" } }, "ChangeRiskConsequenceIsActiveResourceActionRequest": { "title": "ChangeRiskConsequenceIsActiveResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RiskConsequence->IsActive" } ] } } }, "ChangeRiskConsequencePermissionTreeResourceActionRequest": { "title": "ChangeRiskConsequencePermissionTreeResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskConsequence->PermissionTree_Id" } ] } } }, "BatchChangeRiskConsequenceIsActiveResourceActionRequest": { "title": "BatchChangeRiskConsequenceIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRiskConsequenceIsActiveResourceActionRequest" } }, "BatchChangeRiskConsequencePermissionTreeResourceActionRequest": { "title": "BatchChangeRiskConsequencePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRiskConsequencePermissionTreeResourceActionRequest" } }, "GetRiskConsequenceCategoryResourceActionResponse": { "title": "GetRiskConsequenceCategoryResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetRiskConsequenceCategoryResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskConsequenceCategory->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequenceCategory->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequenceCategory->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskConsequenceCategory->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskConsequenceCategory->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequenceCategory->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequenceCategory->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskConsequenceCategory->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequenceCategory->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequenceCategory->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequenceCategory->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskConsequenceCategory->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetRiskConsequenceCategoryCollectionResourceActionResponse": { "title": "GetRiskConsequenceCategoryCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRiskConsequenceCategoryCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRiskConsequenceCategoryCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskConsequenceCategory->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->IsActive" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskConsequenceCategoryChangePermissionTreeLookupResourceActionResponse": { "title": "RiskConsequenceCategoryChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskConsequenceCategoryChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskConsequenceCategoryChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskConsequenceCategoryInsertPermissionTreeLookupResourceActionResponse": { "title": "RiskConsequenceCategoryInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskConsequenceCategoryInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskConsequenceCategoryInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRiskConsequenceCategoryResourceActionRequest": { "title": "CreateRiskConsequenceCategoryResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRiskConsequenceCategoryResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "permissionTreeId" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequenceCategory->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->PermissionTree_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskConsequenceCategory->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRiskConsequenceCategoryResourceActionRequest": { "title": "UpdateRiskConsequenceCategoryResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->Description" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskConsequenceCategory->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskConsequenceCategory->SequenceNumber" } ] } } }, "DeleteRiskConsequenceCategoryResourceActionRequest": { "title": "DeleteRiskConsequenceCategoryResourceActionRequest", "type": "object", "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", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetRiskConsequenceCategoryResourceAction": { "title": "BatchGetRiskConsequenceCategoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Risk Consequence Category entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Risk Consequence Category entities", "items": { "$ref": "#/definitions/GetRiskConsequenceCategoryResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateRiskConsequenceCategoryResourceActionRequest": { "title": "BatchCreateRiskConsequenceCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRiskConsequenceCategoryResourceActionRequest" } }, "BatchUpdateRiskConsequenceCategoryResourceActionRequest": { "title": "BatchUpdateRiskConsequenceCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRiskConsequenceCategoryResourceActionRequest" } }, "BatchDeleteRiskConsequenceCategoryResourceActionRequest": { "title": "BatchDeleteRiskConsequenceCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRiskConsequenceCategoryResourceActionRequest" } }, "ChangeRiskConsequenceCategoryIsActiveResourceActionRequest": { "title": "ChangeRiskConsequenceCategoryIsActiveResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->IsActive" } ] } } }, "ChangeRiskConsequenceCategoryPermissionTreeResourceActionRequest": { "title": "ChangeRiskConsequenceCategoryPermissionTreeResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->PermissionTree_Id" } ] } } }, "BatchChangeRiskConsequenceCategoryIsActiveResourceActionRequest": { "title": "BatchChangeRiskConsequenceCategoryIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRiskConsequenceCategoryIsActiveResourceActionRequest" } }, "BatchChangeRiskConsequenceCategoryPermissionTreeResourceActionRequest": { "title": "BatchChangeRiskConsequenceCategoryPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRiskConsequenceCategoryPermissionTreeResourceActionRequest" } }, "GetRiskModelResourceActionResponse": { "title": "GetRiskModelResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetRiskModelResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModel->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RiskModel->IsActive" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModel->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModel->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModel->PermissionTree_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModel->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModel->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModel->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskModel->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModel->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModel->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModel->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskModel->ModifiedOn" }, "riskCalculationType": { "title": "riskCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RiskModel->RiskCalculationType", "x-formatSpecifier": "RiskCalculationType" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModel->Description" }, "importancesConfigured": { "title": "importancesConfigured", "type": "boolean", "x-nullable": false, "x-propertyPath": "RiskModel->ImportancesConfigured" }, "importancesRangesVerified": { "title": "importancesRangesVerified", "type": "boolean", "x-nullable": false, "x-propertyPath": "RiskModel->ImportancesRangesVerified" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModel->Notes" }, "reason": { "title": "reason", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModel->Reason" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskModel->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetRiskModelCollectionResourceActionResponse": { "title": "GetRiskModelCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRiskModelCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRiskModelCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModel->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModel->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskModel->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RiskModel->IsActive" }, "riskCalculationType": { "title": "riskCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RiskModel->RiskCalculationType", "x-formatSpecifier": "RiskCalculationType" }, "importancesConfigured": { "title": "importancesConfigured", "type": "boolean", "x-nullable": false, "x-propertyPath": "RiskModel->ImportancesConfigured" }, "importancesRangesVerified": { "title": "importancesRangesVerified", "type": "boolean", "x-nullable": false, "x-propertyPath": "RiskModel->ImportancesRangesVerified" }, "reason": { "title": "reason", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModel->Reason" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskModelChangePermissionTreeLookupResourceActionResponse": { "title": "RiskModelChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskModelChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskModelChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskModelInsertPermissionTreeLookupResourceActionResponse": { "title": "RiskModelInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskModelInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskModelInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRiskModelResourceActionRequest": { "title": "CreateRiskModelResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRiskModelResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "riskCalculationType", "description", "permissionTreeId" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RiskModel->Code" }, "riskCalculationType": { "title": "riskCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RiskModel->RiskCalculationType", "x-formatSpecifier": "RiskCalculationType" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RiskModel->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModel->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModel->PermissionTree_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskModel->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRiskModelResourceActionRequest": { "title": "UpdateRiskModelResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RiskModel->Code" }, { "title": "riskCalculationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "RiskModel->RiskCalculationType", "x-formatSpecifier": "RiskCalculationType" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RiskModel->Description" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModel->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskModel->SequenceNumber" } ] } } }, "DeleteRiskModelResourceActionRequest": { "title": "DeleteRiskModelResourceActionRequest", "type": "object", "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", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetRiskModelResourceAction": { "title": "BatchGetRiskModelResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Risk Model entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Risk Model entities", "items": { "$ref": "#/definitions/GetRiskModelResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateRiskModelResourceActionRequest": { "title": "BatchCreateRiskModelResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRiskModelResourceActionRequest" } }, "BatchUpdateRiskModelResourceActionRequest": { "title": "BatchUpdateRiskModelResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRiskModelResourceActionRequest" } }, "BatchDeleteRiskModelResourceActionRequest": { "title": "BatchDeleteRiskModelResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRiskModelResourceActionRequest" } }, "ChangeRiskModelIsActiveResourceActionRequest": { "title": "ChangeRiskModelIsActiveResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RiskModel->IsActive" } ] } } }, "ChangeRiskModelPermissionTreeResourceActionRequest": { "title": "ChangeRiskModelPermissionTreeResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModel->PermissionTree_Id" } ] } } }, "BatchChangeRiskModelIsActiveResourceActionRequest": { "title": "BatchChangeRiskModelIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRiskModelIsActiveResourceActionRequest" } }, "BatchChangeRiskModelPermissionTreeResourceActionRequest": { "title": "BatchChangeRiskModelPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRiskModelPermissionTreeResourceActionRequest" } }, "GetRiskModelConsequenceCategoryResourceActionResponse": { "title": "GetRiskModelConsequenceCategoryResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetRiskModelConsequenceCategoryResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskModelConsequenceCategory->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskModelConsequenceCategory->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->PermissionTree_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->Notes" }, "riskConsequenceCategoryId": { "title": "riskConsequenceCategoryId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->RiskConsequenceCategory_Id" }, "riskConsequenceCategoryCode": { "title": "riskConsequenceCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->RiskConsequenceCategory_Code" }, "riskConsequenceCategoryDescription": { "title": "riskConsequenceCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->RiskConsequenceCategory_Description" }, "riskModelId": { "title": "riskModelId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->RiskModel_Id" }, "riskModelCode": { "title": "riskModelCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->RiskModel_Code" }, "riskModelDescription": { "title": "riskModelDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->RiskModel_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->SequenceNumber" }, "weightValue": { "title": "weightValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->WeightValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetRiskModelConsequenceCategoryCollectionResourceActionResponse": { "title": "GetRiskModelConsequenceCategoryCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRiskModelConsequenceCategoryCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRiskModelConsequenceCategoryCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->SequenceNumber" }, "riskModelId": { "title": "riskModelId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->RiskModel_Id" }, "riskModelCode": { "title": "riskModelCode", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->RiskModel_Code" }, "riskModelDescription": { "title": "riskModelDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->RiskModel_Description" }, "riskConsequenceCategoryId": { "title": "riskConsequenceCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->RiskConsequenceCategory_Id" }, "riskConsequenceCategoryCode": { "title": "riskConsequenceCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->RiskConsequenceCategory_Code" }, "riskConsequenceCategoryDescription": { "title": "riskConsequenceCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->RiskConsequenceCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->PermissionTree_Id" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->PermissionTree_Description" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->PermissionTree_Code" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->Notes" }, "weightValue": { "title": "weightValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->WeightValue" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskModelConsequenceCategory->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskModelConsequenceCategory->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRiskModelConsequenceCategoryForRiskModelCollectionResourceActionResponse": { "title": "GetRiskModelConsequenceCategoryForRiskModelCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRiskModelConsequenceCategoryForRiskModelCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRiskModelConsequenceCategoryForRiskModelCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "riskModelId": { "title": "riskModelId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->RiskModel_Id" }, "riskModelCode": { "title": "riskModelCode", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->RiskModel_Code" }, "riskModelDescription": { "title": "riskModelDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->RiskModel_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->SequenceNumber" }, "riskConsequenceCategoryId": { "title": "riskConsequenceCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->RiskConsequenceCategory_Id" }, "riskConsequenceCategoryCode": { "title": "riskConsequenceCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->RiskConsequenceCategory_Code" }, "riskConsequenceCategoryDescription": { "title": "riskConsequenceCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->RiskConsequenceCategory_Description" }, "weightValue": { "title": "weightValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->WeightValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->Notes" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskModelConsequenceCategoryChangePermissionTreeLookupResourceActionResponse": { "title": "RiskModelConsequenceCategoryChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskModelConsequenceCategoryChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskModelConsequenceCategoryChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskModelConsequenceCategoryInsertPermissionTreeLookupResourceActionResponse": { "title": "RiskModelConsequenceCategoryInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskModelConsequenceCategoryInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskModelConsequenceCategoryInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskModelConsequenceCategoryRiskConsequenceCategoryLookupResourceActionResponse": { "title": "RiskModelConsequenceCategoryRiskConsequenceCategoryLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskModelConsequenceCategoryRiskConsequenceCategoryLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskModelConsequenceCategoryRiskConsequenceCategoryLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RiskConsequenceCategory->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskModelConsequenceCategoryRiskModelLookupResourceActionResponse": { "title": "RiskModelConsequenceCategoryRiskModelLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskModelConsequenceCategoryRiskModelLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskModelConsequenceCategoryRiskModelLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModel->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModel->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRiskModelConsequenceCategoryResourceActionRequest": { "title": "CreateRiskModelConsequenceCategoryResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRiskModelConsequenceCategoryResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "riskModelId", "riskConsequenceCategoryId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->PermissionTree_Id", "x-systemGenerated": true }, "weightValue": { "title": "weightValue", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RiskModelConsequenceCategory->WeightValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->SequenceNumber" }, "riskModelId": { "title": "riskModelId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->RiskModel_Id" }, "riskConsequenceCategoryId": { "title": "riskConsequenceCategoryId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->RiskConsequenceCategory_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRiskModelConsequenceCategoryResourceActionRequest": { "title": "UpdateRiskModelConsequenceCategoryResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "riskConsequenceCategoryId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->RiskConsequenceCategory_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->SequenceNumber" }, { "title": "weightValue", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "RiskModelConsequenceCategory->WeightValue" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelConsequenceCategory->Notes" } ] } } }, "DeleteRiskModelConsequenceCategoryResourceActionRequest": { "title": "DeleteRiskModelConsequenceCategoryResourceActionRequest", "type": "object", "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", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetRiskModelConsequenceCategoryResourceAction": { "title": "BatchGetRiskModelConsequenceCategoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Risk Model Consequence Category entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Risk Model Consequence Category entities", "items": { "$ref": "#/definitions/GetRiskModelConsequenceCategoryResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateRiskModelConsequenceCategoryResourceActionRequest": { "title": "BatchCreateRiskModelConsequenceCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRiskModelConsequenceCategoryResourceActionRequest" } }, "BatchUpdateRiskModelConsequenceCategoryResourceActionRequest": { "title": "BatchUpdateRiskModelConsequenceCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRiskModelConsequenceCategoryResourceActionRequest" } }, "BatchDeleteRiskModelConsequenceCategoryResourceActionRequest": { "title": "BatchDeleteRiskModelConsequenceCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRiskModelConsequenceCategoryResourceActionRequest" } }, "ChangeRiskModelConsequenceCategoryPermissionTreeResourceActionRequest": { "title": "ChangeRiskModelConsequenceCategoryPermissionTreeResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelConsequenceCategory->PermissionTree_Id" } ] } } }, "BatchChangeRiskModelConsequenceCategoryPermissionTreeResourceActionRequest": { "title": "BatchChangeRiskModelConsequenceCategoryPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRiskModelConsequenceCategoryPermissionTreeResourceActionRequest" } }, "GetRiskModelImportanceResourceActionResponse": { "title": "GetRiskModelImportanceResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetRiskModelImportanceResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelImportance->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelImportance->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelImportance->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskModelImportance->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelImportance->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelImportance->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelImportance->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskModelImportance->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelImportance->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelImportance->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelImportance->PermissionTree_Description" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelImportance->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelImportance->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelImportance->AssetImportance_Description" }, "bottomRange": { "title": "bottomRange", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RiskModelImportance->BottomRange" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelImportance->Notes" }, "riskModelId": { "title": "riskModelId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelImportance->RiskModel_Id" }, "riskModelCode": { "title": "riskModelCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelImportance->RiskModel_Code" }, "riskModelDescription": { "title": "riskModelDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelImportance->RiskModel_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskModelImportance->SequenceNumber" }, "topRange": { "title": "topRange", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RiskModelImportance->TopRange" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetRiskModelImportanceCollectionResourceActionResponse": { "title": "GetRiskModelImportanceCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRiskModelImportanceCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRiskModelImportanceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "riskModelId": { "title": "riskModelId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelImportance->RiskModel_Id" }, "riskModelCode": { "title": "riskModelCode", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelImportance->RiskModel_Code" }, "riskModelDescription": { "title": "riskModelDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelImportance->RiskModel_Description" }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelImportance->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelImportance->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelImportance->AssetImportance_Description" }, "bottomRange": { "title": "bottomRange", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RiskModelImportance->BottomRange" }, "topRange": { "title": "topRange", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RiskModelImportance->TopRange" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRiskModelImportanceForRiskModelCollectionResourceActionResponse": { "title": "GetRiskModelImportanceForRiskModelCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRiskModelImportanceForRiskModelCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRiskModelImportanceForRiskModelCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelImportance->AssetImportance_Id" }, "assetImportanceCode": { "title": "assetImportanceCode", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelImportance->AssetImportance_Code" }, "assetImportanceDescription": { "title": "assetImportanceDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelImportance->AssetImportance_Description" }, "bottomRange": { "title": "bottomRange", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RiskModelImportance->BottomRange" }, "topRange": { "title": "topRange", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RiskModelImportance->TopRange" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskModelImportanceAssetImportanceLookupResourceActionResponse": { "title": "RiskModelImportanceAssetImportanceLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskModelImportanceAssetImportanceLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskModelImportanceAssetImportanceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AssetImportance->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AssetImportance->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskModelImportanceChangePermissionTreeLookupResourceActionResponse": { "title": "RiskModelImportanceChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskModelImportanceChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskModelImportanceChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskModelImportanceInsertPermissionTreeLookupResourceActionResponse": { "title": "RiskModelImportanceInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskModelImportanceInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskModelImportanceInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskModelImportanceRiskModelLookupResourceActionResponse": { "title": "RiskModelImportanceRiskModelLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskModelImportanceRiskModelLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskModelImportanceRiskModelLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModel->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModel->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRiskModelImportanceResourceActionRequest": { "title": "CreateRiskModelImportanceResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRiskModelImportanceResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "assetImportanceId", "riskModelId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelImportance->PermissionTree_Id", "x-systemGenerated": true }, "assetImportanceId": { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelImportance->AssetImportance_Id" }, "riskModelId": { "title": "riskModelId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelImportance->RiskModel_Id" }, "bottomRange": { "title": "bottomRange", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "RiskModelImportance->BottomRange" }, "topRange": { "title": "topRange", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RiskModelImportance->TopRange" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskModelImportance->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelImportance->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRiskModelImportanceResourceActionRequest": { "title": "UpdateRiskModelImportanceResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "assetImportanceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelImportance->AssetImportance_Id" }, { "title": "bottomRange", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "RiskModelImportance->BottomRange" }, { "title": "topRange", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RiskModelImportance->TopRange" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskModelImportance->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelImportance->Notes" } ] } } }, "DeleteRiskModelImportanceResourceActionRequest": { "title": "DeleteRiskModelImportanceResourceActionRequest", "type": "object", "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", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetRiskModelImportanceResourceAction": { "title": "BatchGetRiskModelImportanceResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Risk Model Importance entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Risk Model Importance entities", "items": { "$ref": "#/definitions/GetRiskModelImportanceResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateRiskModelImportanceResourceActionRequest": { "title": "BatchCreateRiskModelImportanceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRiskModelImportanceResourceActionRequest" } }, "BatchUpdateRiskModelImportanceResourceActionRequest": { "title": "BatchUpdateRiskModelImportanceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRiskModelImportanceResourceActionRequest" } }, "BatchDeleteRiskModelImportanceResourceActionRequest": { "title": "BatchDeleteRiskModelImportanceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRiskModelImportanceResourceActionRequest" } }, "ChangeRiskModelImportancePermissionTreeResourceActionRequest": { "title": "ChangeRiskModelImportancePermissionTreeResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelImportance->PermissionTree_Id" } ] } } }, "BatchChangeRiskModelImportancePermissionTreeResourceActionRequest": { "title": "BatchChangeRiskModelImportancePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRiskModelImportancePermissionTreeResourceActionRequest" } }, "GetRiskModelProbabilityResourceActionResponse": { "title": "GetRiskModelProbabilityResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetRiskModelProbabilityResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelProbability->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelProbability->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelProbability->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskModelProbability->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelProbability->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelProbability->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelProbability->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskModelProbability->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelProbability->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelProbability->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelProbability->PermissionTree_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelProbability->Notes" }, "riskModelId": { "title": "riskModelId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelProbability->RiskModel_Id" }, "riskModelCode": { "title": "riskModelCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelProbability->RiskModel_Code" }, "riskModelDescription": { "title": "riskModelDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelProbability->RiskModel_Description" }, "riskProbabilityId": { "title": "riskProbabilityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelProbability->RiskProbability_Id" }, "riskProbabilityCode": { "title": "riskProbabilityCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelProbability->RiskProbability_Code" }, "riskProbabilityDescription": { "title": "riskProbabilityDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelProbability->RiskProbability_Description" }, "riskProbabilityValue": { "title": "riskProbabilityValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "RiskModelProbability->RiskProbability_Value" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskModelProbability->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetRiskModelProbabilityCollectionResourceActionResponse": { "title": "GetRiskModelProbabilityCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRiskModelProbabilityCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRiskModelProbabilityCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskModelProbability->SequenceNumber" }, "riskModelId": { "title": "riskModelId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelProbability->RiskModel_Id" }, "riskModelCode": { "title": "riskModelCode", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelProbability->RiskModel_Code" }, "riskModelDescription": { "title": "riskModelDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelProbability->RiskModel_Description" }, "riskProbabilityId": { "title": "riskProbabilityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelProbability->RiskProbability_Id" }, "riskProbabilityCode": { "title": "riskProbabilityCode", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelProbability->RiskProbability_Code" }, "riskProbabilityDescription": { "title": "riskProbabilityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelProbability->RiskProbability_Description" }, "riskProbabilityValue": { "title": "riskProbabilityValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RiskModelProbability->RiskProbability_Value" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelProbability->PermissionTree_Id" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelProbability->PermissionTree_Description" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelProbability->PermissionTree_Code" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelProbability->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskModelProbability->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskModelProbability->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRiskModelProbabilityForRiskModelCollectionResourceActionResponse": { "title": "GetRiskModelProbabilityForRiskModelCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRiskModelProbabilityForRiskModelCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRiskModelProbabilityForRiskModelCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "riskModelId": { "title": "riskModelId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelProbability->RiskModel_Id" }, "riskModelCode": { "title": "riskModelCode", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelProbability->RiskModel_Code" }, "riskModelDescription": { "title": "riskModelDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelProbability->RiskModel_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskModelProbability->SequenceNumber" }, "riskProbabilityId": { "title": "riskProbabilityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskModelProbability->RiskProbability_Id" }, "riskProbabilityCode": { "title": "riskProbabilityCode", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelProbability->RiskProbability_Code" }, "riskProbabilityDescription": { "title": "riskProbabilityDescription", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModelProbability->RiskProbability_Description" }, "riskProbabilityValue": { "title": "riskProbabilityValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RiskModelProbability->RiskProbability_Value" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelProbability->Notes" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskModelProbabilityChangePermissionTreeLookupResourceActionResponse": { "title": "RiskModelProbabilityChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskModelProbabilityChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskModelProbabilityChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskModelProbabilityInsertPermissionTreeLookupResourceActionResponse": { "title": "RiskModelProbabilityInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskModelProbabilityInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskModelProbabilityInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskModelProbabilityRiskModelLookupResourceActionResponse": { "title": "RiskModelProbabilityRiskModelLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskModelProbabilityRiskModelLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskModelProbabilityRiskModelLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModel->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RiskModel->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskModelProbabilityRiskProbabilityLookupResourceActionResponse": { "title": "RiskModelProbabilityRiskProbabilityLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskModelProbabilityRiskProbabilityLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskModelProbabilityRiskProbabilityLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RiskProbability->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RiskProbability->Description" }, "value": { "title": "value", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RiskProbability->Value" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRiskModelProbabilityResourceActionRequest": { "title": "CreateRiskModelProbabilityResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRiskModelProbabilityResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "riskModelId", "riskProbabilityId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelProbability->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskModelProbability->SequenceNumber" }, "riskModelId": { "title": "riskModelId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelProbability->RiskModel_Id" }, "riskProbabilityId": { "title": "riskProbabilityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelProbability->RiskProbability_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelProbability->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRiskModelProbabilityResourceActionRequest": { "title": "UpdateRiskModelProbabilityResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "riskProbabilityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelProbability->RiskProbability_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskModelProbability->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskModelProbability->Notes" } ] } } }, "DeleteRiskModelProbabilityResourceActionRequest": { "title": "DeleteRiskModelProbabilityResourceActionRequest", "type": "object", "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", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetRiskModelProbabilityResourceAction": { "title": "BatchGetRiskModelProbabilityResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Risk Model Probability entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Risk Model Probability entities", "items": { "$ref": "#/definitions/GetRiskModelProbabilityResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateRiskModelProbabilityResourceActionRequest": { "title": "BatchCreateRiskModelProbabilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRiskModelProbabilityResourceActionRequest" } }, "BatchUpdateRiskModelProbabilityResourceActionRequest": { "title": "BatchUpdateRiskModelProbabilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRiskModelProbabilityResourceActionRequest" } }, "BatchDeleteRiskModelProbabilityResourceActionRequest": { "title": "BatchDeleteRiskModelProbabilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRiskModelProbabilityResourceActionRequest" } }, "ChangeRiskModelProbabilityPermissionTreeResourceActionRequest": { "title": "ChangeRiskModelProbabilityPermissionTreeResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskModelProbability->PermissionTree_Id" } ] } } }, "BatchChangeRiskModelProbabilityPermissionTreeResourceActionRequest": { "title": "BatchChangeRiskModelProbabilityPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRiskModelProbabilityPermissionTreeResourceActionRequest" } }, "GetRiskProbabilityResourceActionResponse": { "title": "GetRiskProbabilityResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetRiskProbabilityResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RiskProbability->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskProbability->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskProbability->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RiskProbability->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskProbability->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RiskProbability->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RiskProbability->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskProbability->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RiskProbability->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RiskProbability->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskProbability->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RiskProbability->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RiskProbability->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RiskProbability->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskProbability->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskProbability->SequenceNumber" }, "value": { "title": "value", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RiskProbability->Value" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetRiskProbabilityCollectionResourceActionResponse": { "title": "GetRiskProbabilityCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetRiskProbabilityCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetRiskProbabilityCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RiskProbability->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RiskProbability->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskProbability->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RiskProbability->IsActive" }, "value": { "title": "value", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "RiskProbability->Value" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskProbabilityChangePermissionTreeLookupResourceActionResponse": { "title": "RiskProbabilityChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskProbabilityChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskProbabilityChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "RiskProbabilityInsertPermissionTreeLookupResourceActionResponse": { "title": "RiskProbabilityInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "RiskProbabilityInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "RiskProbabilityInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateRiskProbabilityResourceActionRequest": { "title": "CreateRiskProbabilityResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRiskProbabilityResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "permissionTreeId", "value" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RiskProbability->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RiskProbability->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskProbability->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskProbability->PermissionTree_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskProbability->SequenceNumber" }, "value": { "title": "value", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RiskProbability->Value" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRiskProbabilityResourceActionRequest": { "title": "UpdateRiskProbabilityResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RiskProbability->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RiskProbability->Description" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RiskProbability->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RiskProbability->SequenceNumber" }, { "title": "value", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "exclusiveMinimum": true, "x-propertyPath": "RiskProbability->Value" } ] } } }, "DeleteRiskProbabilityResourceActionRequest": { "title": "DeleteRiskProbabilityResourceActionRequest", "type": "object", "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", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetRiskProbabilityResourceAction": { "title": "BatchGetRiskProbabilityResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Risk Probability entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Risk Probability entities", "items": { "$ref": "#/definitions/GetRiskProbabilityResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateRiskProbabilityResourceActionRequest": { "title": "BatchCreateRiskProbabilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRiskProbabilityResourceActionRequest" } }, "BatchUpdateRiskProbabilityResourceActionRequest": { "title": "BatchUpdateRiskProbabilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRiskProbabilityResourceActionRequest" } }, "BatchDeleteRiskProbabilityResourceActionRequest": { "title": "BatchDeleteRiskProbabilityResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRiskProbabilityResourceActionRequest" } }, "ChangeRiskProbabilityIsActiveResourceActionRequest": { "title": "ChangeRiskProbabilityIsActiveResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RiskProbability->IsActive" } ] } } }, "ChangeRiskProbabilityPermissionTreeResourceActionRequest": { "title": "ChangeRiskProbabilityPermissionTreeResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RiskProbability->PermissionTree_Id" } ] } } }, "BatchChangeRiskProbabilityIsActiveResourceActionRequest": { "title": "BatchChangeRiskProbabilityIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRiskProbabilityIsActiveResourceActionRequest" } }, "BatchChangeRiskProbabilityPermissionTreeResourceActionRequest": { "title": "BatchChangeRiskProbabilityPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRiskProbabilityPermissionTreeResourceActionRequest" } } }, "parameters": { "ExecutionMode": { "type": "string", "name": "mode", "in": "query", "description": "Execution mode to use for executing the batch operation", "enum": [ "AllOrNone", "PerRecord" ] }, "Async": { "type": "boolean", "name": "async", "in": "query", "description": "Enqueue the operation asynchronously using a Background Task." }, "AsyncDescription": { "type": "string", "name": "description", "in": "query", "description": "Optional description for the asynchronous execution of the Background Task." }, "Schedule": { "type": "string", "name": "schedule", "in": "query", "description": "Optional cron expression to schedule the asynchronous execution of the Background Task." }, "ScheduleFrom": { "type": "string", "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." }, "Filter": { "type": "string", "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'" }, "OrderBy": { "type": "string", "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" }, "Param": { "type": "string", "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'" }, "Select": { "type": "string", "name": "$select", "in": "query", "description": "Comma separated list of the data properties on the resource to return, e.g. $select=id,code,description" }, "Skip": { "type": "string", "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" }, "Top": { "type": "string", "name": "$top", "in": "query", "description": "Number of items to return in the response data, e.g. $top=20" } }, "responses": { "default": { "x-nullable": true, "description": "Error response - operation failed" }, "created": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "accepted": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "scheduled": { "description": "Request was successfully scheduled for asynchronous execution using a Scheduled Background Task", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the Scheduled Background Task resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the Scheduled Background Task resource" }, "OnKey-Job-Id": { "type": "string", "description": "Job id of the job schedule created", "format": "Uuid" }, "OnKey-Job-Schedule-Location": { "type": "string", "description": "URI to fetch the job schedule for the asynchronous execution of the request" } } } }, "securityDefinitions": { "Bearer": { "type": "basic", "description": "Use the JWT access token received by authenticating with your configured On Key Identity Provider" } }, "security": [ { "Bearer": [] } ], "tags": [ { "name": "Asset Importance" }, { "name": "Risk Consequence" }, { "name": "Risk Consequence Category" }, { "name": "Risk Model" }, { "name": "Risk Model Consequence Category" }, { "name": "Risk Model Importance" }, { "name": "Risk Model Probability" }, { "name": "Risk Probability" } ], "x-tagGroups": [ { "name": "RISK", "tags": [ "Asset Importance", "Risk Consequence", "Risk Consequence Category", "Risk Model", "Risk Model Consequence Category", "Risk Model Importance", "Risk Model Probability", "Risk Probability" ] } ] }