{ "x-generator": "On Key REST API Docs Generator", "swagger": "2.0", "info": { "title": "On Key UAM 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", "application/vnd.onkey.assetregistertreenode+json", "application/vnd.onkey.assetregistertreenodecollectionpage+json" ], "paths": { "/Modules/UAM/OperationalRoles/{id}": { "get": { "tags": [ "Operational Role" ], "summary": "Get a Operational Role 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 | OperationalRole->Code | string | |\r\n| isActive | OperationalRole->IsActive | boolean | |\r\n| version | OperationalRole->Version | integer | int32 |\r\n| permissionTreeId | OperationalRole->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | OperationalRole->PermissionTree_Code | string | |\r\n| permissionTreeDescription | OperationalRole->PermissionTree_Description | string | |\r\n| createdByUserId | OperationalRole->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | OperationalRole->CreatedByUser_Code | string | |\r\n| createdByUserFullName | OperationalRole->CreatedByUser_FullName | string | |\r\n| createdOn | OperationalRole->CreatedOn | string | date-time |\r\n| modifiedByUserId | OperationalRole->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | OperationalRole->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | OperationalRole->ModifiedByUser_FullName | string | |\r\n| modifiedOn | OperationalRole->ModifiedOn | string | date-time |\r\n| id | OperationalRole->Id | integer | int64 |\r\n| description | OperationalRole->Description | string | |\r\n| notes | OperationalRole->Notes | string | |\r\n| sequenceNumber | OperationalRole->SequenceNumber | integer | int32 |\r\n", "operationId": "GetOperationalRole", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Operational Role Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Operational Role", "schema": { "$ref": "#/definitions/GetOperationalRoleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Operational Role" ], "summary": "Update an existing Operational Role 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 | OperationalRole->Version | integer | int32 |\r\n| code | OperationalRole->Code | string | |\r\n| description | OperationalRole->Description | string | |\r\n| sequenceNumber | OperationalRole->SequenceNumber | integer | int32 |\r\n| notes | OperationalRole->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| 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": "UpdateOperationalRole", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Operational Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateOperationalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Operational Role 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": [ "Operational Role" ], "summary": "Delete an existing Operational Role 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 | OperationalRole->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": "DeleteOperationalRole", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Operational Role Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteOperationalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Operational Role 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/UAM/OperationalRoles": { "get": { "tags": [ "Operational Role" ], "summary": "Get a collection of Operational Role 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 | OperationalRole->Version | integer | int32 |\r\n| id | OperationalRole->Id | integer | int64 |\r\n| code | OperationalRole->Code | string | |\r\n| description | OperationalRole->Description | string | |\r\n| sequenceNumber | OperationalRole->SequenceNumber | integer | int32 |\r\n| isActive | OperationalRole->IsActive | boolean | |\r\n", "operationId": "GetOperationalRoleCollection", "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 Operational Role collection", "schema": { "$ref": "#/definitions/GetOperationalRoleCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Operational Role" ], "summary": "Create a new Operational Role 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 | OperationalRole->PermissionTree_Id | integer | int64 |\r\n| code | OperationalRole->Code | string | |\r\n| description | OperationalRole->Description | string | |\r\n| sequenceNumber | OperationalRole->SequenceNumber | integer | int32 |\r\n| notes | OperationalRole->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\r\n", "operationId": "CreateOperationalRole", "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/CreateOperationalRoleResourceActionRequest" } }, { "$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/UAM/OperationalRoles/Lookups/LookupOperationalRoleChangePermissionTree": { "get": { "tags": [ "Operational Role" ], "summary": "Lookup the permission set for changing the Operational Role.", "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": "LookupOperationalRoleChangePermissionTree", "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/OperationalRoleChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/OperationalRoles/Lookups/LookupOperationalRoleInsertPermissionTree": { "get": { "tags": [ "Operational Role" ], "summary": "Lookup the permission set for creating the Operational Role.", "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": "LookupOperationalRoleInsertPermissionTree", "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/OperationalRoleInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/OperationalRoles/Batch/{ids}": { "get": { "tags": [ "Operational Role" ], "summary": "Get a collection of Operational Role 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 | OperationalRole->Code | string | |\r\n| isActive | OperationalRole->IsActive | boolean | |\r\n| version | OperationalRole->Version | integer | int32 |\r\n| permissionTreeId | OperationalRole->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | OperationalRole->PermissionTree_Code | string | |\r\n| permissionTreeDescription | OperationalRole->PermissionTree_Description | string | |\r\n| createdByUserId | OperationalRole->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | OperationalRole->CreatedByUser_Code | string | |\r\n| createdByUserFullName | OperationalRole->CreatedByUser_FullName | string | |\r\n| createdOn | OperationalRole->CreatedOn | string | date-time |\r\n| modifiedByUserId | OperationalRole->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | OperationalRole->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | OperationalRole->ModifiedByUser_FullName | string | |\r\n| modifiedOn | OperationalRole->ModifiedOn | string | date-time |\r\n| id | OperationalRole->Id | integer | int64 |\r\n| description | OperationalRole->Description | string | |\r\n| notes | OperationalRole->Notes | string | |\r\n| sequenceNumber | OperationalRole->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetOperationalRole", "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 Operational Role 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 Operational Role collection", "schema": { "$ref": "#/definitions/BatchGetOperationalRoleResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/OperationalRoles/Batch": { "post": { "tags": [ "Operational Role" ], "summary": "Create a new collection of Operational Role 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 | OperationalRole->PermissionTree_Id | integer | int64 |\r\n| code | OperationalRole->Code | string | |\r\n| description | OperationalRole->Description | string | |\r\n| sequenceNumber | OperationalRole->SequenceNumber | integer | int32 |\r\n| notes | OperationalRole->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\r\n", "operationId": "BatchCreateOperationalRole", "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/BatchCreateOperationalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Operational Role 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": [ "Operational Role" ], "summary": "Update a collection of existing Operational Role 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 | OperationalRole->Id | integer | int64 |\r\n| version | OperationalRole->Version | integer | int32 |\r\n| code | OperationalRole->Code | string | |\r\n| description | OperationalRole->Description | string | |\r\n| sequenceNumber | OperationalRole->SequenceNumber | integer | int32 |\r\n| notes | OperationalRole->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| 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": "BatchUpdateOperationalRole", "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/BatchUpdateOperationalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Operational Role 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": [ "Operational Role" ], "summary": "Delete a collection of existing Operational Role 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 | OperationalRole->Id | integer | int64 |\r\n| version | OperationalRole->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": "BatchDeleteOperationalRole", "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/BatchDeleteOperationalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Operational Role 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/UAM/OperationalRoles/{id}/Active": { "patch": { "tags": [ "Operational Role" ], "summary": "Change the IsActive status for an existing Operational Role 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 | OperationalRole->Version | integer | int32 |\r\n| isActive | OperationalRole->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": "ChangeOperationalRoleIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Operational Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeOperationalRoleIsActiveResourceActionRequest" } }, { "$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/UAM/OperationalRoles/{id}/PermissionTree": { "patch": { "tags": [ "Operational Role" ], "summary": "Change the PermissionTree for an existing Operational Role 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 | OperationalRole->Version | integer | int32 |\r\n| permissionTreeId | OperationalRole->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": "ChangeOperationalRolePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Operational Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeOperationalRolePermissionTreeResourceActionRequest" } }, { "$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/UAM/OperationalRoles/Batch/Active": { "patch": { "tags": [ "Operational Role" ], "summary": "Change the IsActive status for a collection of existing Operational Role 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 | OperationalRole->Id | integer | int64 |\r\n| version | OperationalRole->Version | integer | int32 |\r\n| isActive | OperationalRole->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": "BatchChangeOperationalRoleIsActive", "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/BatchChangeOperationalRoleIsActiveResourceActionRequest" } }, { "$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/UAM/OperationalRoles/Batch/PermissionTree": { "patch": { "tags": [ "Operational Role" ], "summary": "Change the PermissionTree status for a collection of existing Operational Role 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 | OperationalRole->Id | integer | int64 |\r\n| version | OperationalRole->Version | integer | int32 |\r\n| permissionTreeId | OperationalRole->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": "BatchChangeOperationalRolePermissionTree", "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/BatchChangeOperationalRolePermissionTreeResourceActionRequest" } }, { "$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/UAM/OperationalRoles/Resources/{id}": { "get": { "tags": [ "Operational Role Resource" ], "summary": "Get a Operational Role Resource 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 | OperationalRoleResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | OperationalRoleResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | OperationalRoleResource->CreatedByUser_FullName | string | |\r\n| createdOn | OperationalRoleResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | OperationalRoleResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | OperationalRoleResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | OperationalRoleResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | OperationalRoleResource->ModifiedOn | string | date-time |\r\n| version | OperationalRoleResource->Version | integer | int32 |\r\n| id | OperationalRoleResource->Id | integer | int64 |\r\n| inheritedFromId | OperationalRoleResource->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromType | OperationalRoleResource->InheritedFrom_Type | string | |\r\n| inheritedFromModule | OperationalRoleResource->InheritedFrom_Module | string | |\r\n| inheritedFromIsDefault | OperationalRoleResource->InheritedFrom_IsDefault | boolean | |\r\n| inheritedFromTemplate | OperationalRoleResource->InheritedFrom_Template | string | |\r\n| isDefault | OperationalRoleResource->IsDefault | boolean | |\r\n| isInherited | OperationalRoleResource->IsInherited | boolean | |\r\n| module | OperationalRoleResource->Module | string | |\r\n| notes | OperationalRoleResource->Notes | string | |\r\n| operationalRoleId | OperationalRoleResource->OperationalRole_Id | integer | int64 |\r\n| operationalRoleCode | OperationalRoleResource->OperationalRole_Code | string | |\r\n| operationalRoleDescription | OperationalRoleResource->OperationalRole_Description | string | |\r\n| resource | OperationalRoleResource->Resource | string | |\r\n| resourceAction | OperationalRoleResource->ResourceAction | string | |\r\n| resourceActionCustomisationId | OperationalRoleResource->ResourceActionCustomisation_Id | integer | int64 |\r\n| resourceActionCustomisationName | OperationalRoleResource->ResourceActionCustomisation_Name | string | |\r\n| resourceActionCustomisationDescription | OperationalRoleResource->ResourceActionCustomisation_Description | string | |\r\n| resourceActionCustomisationRestrictionLevel | OperationalRoleResource->ResourceActionCustomisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| sequenceNumber | OperationalRoleResource->SequenceNumber | integer | int32 |\r\n", "operationId": "GetOperationalRoleResource", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Operational Role Resource Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Operational Role Resource", "schema": { "$ref": "#/definitions/GetOperationalRoleResourceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Operational Role Resource" ], "summary": "Update an existing Operational Role Resource 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 | OperationalRoleResource->Version | integer | int32 |\r\n| isDefault | OperationalRoleResource->IsDefault | boolean | |\r\n| sequenceNumber | OperationalRoleResource->SequenceNumber | integer | int32 |\r\n| notes | OperationalRoleResource->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| isDefault | Nullable | False | |\r\n\r\n", "operationId": "UpdateOperationalRoleResource", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Operational Role Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateOperationalRoleResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Operational Role Resource 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": [ "Operational Role Resource" ], "summary": "Delete an existing Operational Role Resource 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 | OperationalRoleResource->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": "DeleteOperationalRoleResource", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Operational Role Resource Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteOperationalRoleResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Operational Role Resource 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/UAM/OperationalRoles/Resources": { "get": { "tags": [ "Operational Role Resource" ], "summary": "Get a collection of Operational Role Resource 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 | OperationalRoleResource->Version | integer | int32 |\r\n| id | OperationalRoleResource->Id | integer | int64 |\r\n| operationalRoleId | OperationalRoleResource->OperationalRole_Id | integer | int64 |\r\n| operationalRoleCode | OperationalRoleResource->OperationalRole_Code | string | |\r\n| operationalRoleDescription | OperationalRoleResource->OperationalRole_Description | string | |\r\n| resourceActionCustomisationId | OperationalRoleResource->ResourceActionCustomisation_Id | integer | int64 |\r\n| resourceActionCustomisationName | OperationalRoleResource->ResourceActionCustomisation_Name | string | |\r\n| resourceActionCustomisationRestrictionLevel | OperationalRoleResource->ResourceActionCustomisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| module | OperationalRoleResource->Module | string | |\r\n| resource | OperationalRoleResource->Resource | string | |\r\n| resourceAction | OperationalRoleResource->ResourceAction | string | |\r\n| sequenceNumber | OperationalRoleResource->SequenceNumber | integer | int32 |\r\n| isDefault | OperationalRoleResource->IsDefault | boolean | |\r\n", "operationId": "GetOperationalRoleResourceCollection", "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 Operational Role Resource collection", "schema": { "$ref": "#/definitions/GetOperationalRoleResourceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Operational Role Resource" ], "summary": "Create a new Operational Role Resource 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| operationalRoleId | OperationalRoleResource->OperationalRole_Id | integer | int64 |\r\n| module | OperationalRoleResource->Module | string | |\r\n| resource | OperationalRoleResource->Resource | string | |\r\n| resourceAction | OperationalRoleResource->ResourceAction | string | |\r\n| resourceActionCustomisationId | OperationalRoleResource->ResourceActionCustomisation_Id | integer | int64 |\r\n| isDefault | OperationalRoleResource->IsDefault | boolean | |\r\n| sequenceNumber | OperationalRoleResource->SequenceNumber | integer | int32 |\r\n| notes | OperationalRoleResource->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| operationalRoleId | Required | True | |\r\n| operationalRoleId | Nullable | False | |\r\n| module | Nullable | False | |\r\n| module | Nullable | False | |\r\n| resource | Nullable | False | |\r\n| resource | Nullable | False | |\r\n| resourceAction | Nullable | False | |\r\n| resourceAction | Nullable | False | |\r\n| isDefault | Required | True | |\r\n| isDefault | Nullable | False | |\r\n\r\n", "operationId": "CreateOperationalRoleResource", "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/CreateOperationalRoleResourceResourceActionRequest" } }, { "$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/UAM/OperationalRoles/{operationalRoleId}/Resources": { "get": { "tags": [ "Operational Role Resource" ], "summary": "Get a collection of Operational Role Resource resources for the Operational Role.", "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 | OperationalRoleResource->Id | integer | int64 |\r\n| version | OperationalRoleResource->Version | integer | int32 |\r\n| resourceActionCustomisationId | OperationalRoleResource->ResourceActionCustomisation_Id | integer | int64 |\r\n| resourceActionCustomisationName | OperationalRoleResource->ResourceActionCustomisation_Name | string | |\r\n| resourceActionCustomisationDescription | OperationalRoleResource->ResourceActionCustomisation_Description | string | |\r\n| resourceActionCustomisationRestrictionLevel | OperationalRoleResource->ResourceActionCustomisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| module | OperationalRoleResource->Module | string | |\r\n| resource | OperationalRoleResource->Resource | string | |\r\n| resourceAction | OperationalRoleResource->ResourceAction | string | |\r\n| sequenceNumber | OperationalRoleResource->SequenceNumber | integer | int32 |\r\n| isDefault | OperationalRoleResource->IsDefault | boolean | |\r\n| isInherited | OperationalRoleResource->IsInherited | boolean | |\r\n| inheritedFromTemplate | OperationalRoleResource->InheritedFrom_Template | string | |\r\n| inheritedFromTemplateCustomisationName | OperationalRoleResource->InheritedFrom_TemplateCustomisation_Name | string | |\r\n", "operationId": "GetOperationalRoleResourceForOperationalRoleCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "operationalRoleId", "in": "path", "required": true, "description": "Operational Role 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 Operational Role Resource collection", "schema": { "$ref": "#/definitions/GetOperationalRoleResourceForOperationalRoleCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/OperationalRoles/Resources/Lookups/LookupOperationalRoleResourceOperationalRole": { "get": { "tags": [ "Operational Role Resource" ], "summary": "Lookup the Operational Role for the Operational Role 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| id | OperationalRole->Id | integer | int64 |\r\n| code | OperationalRole->Code | string | |\r\n| description | OperationalRole->Description | string | |\r\n", "operationId": "LookupOperationalRoleResourceOperationalRole", "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 Operational Role collection", "schema": { "$ref": "#/definitions/OperationalRoleResourceOperationalRoleLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/OperationalRoles/Resources/Lookups/LookupOperationalRoleResourceResourceActionCustomisation": { "get": { "tags": [ "Operational Role Resource" ], "summary": "Lookup the API Resource Action Customisation for the Operational Role 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| id | ResourceActionCustomisation->Id | integer | int64 |\r\n| name | ResourceActionCustomisation->Name | string | |\r\n| description | ResourceActionCustomisation->Description | string | |\r\n| restrictionLevel | ResourceActionCustomisation->RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| module | ResourceActionCustomisation->Module | string | |\r\n| resource | ResourceActionCustomisation->Resource | string | |\r\n| resourceAction | ResourceActionCustomisation->ResourceAction | string | |\r\n", "operationId": "LookupOperationalRoleResourceResourceActionCustomisation", "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 API Resource Action Customisation collection", "schema": { "$ref": "#/definitions/OperationalRoleResourceResourceActionCustomisationLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/OperationalRoles/Resources/Lookups/LookupOperationalRoleResourceResourceAction": { "get": { "tags": [ "Operational Role Resource" ], "summary": "Operational Role 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| resourceActionName | ResourceActionSummary->ResourceActionName | string | |\r\n| moduleName | ResourceActionSummary->ModuleName | string | |\r\n| resourceName | ResourceActionSummary->ResourceName | string | |\r\n| resourceActionType | ResourceActionSummary->ResourceActionType | string | |\r\n", "operationId": "LookupOperationalRoleResourceResourceAction", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable API Resource collection", "schema": { "$ref": "#/definitions/OperationalRoleResourceResourceActionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/OperationalRoles/Resources/Lookups/LookupOperationalRoleResourceResource": { "get": { "tags": [ "Operational Role Resource" ], "summary": "Operational Role 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| resourceName | ResourceSummary->ResourceName | string | |\r\n| moduleName | ResourceSummary->ModuleName | string | |\r\n| resourceDescription | ResourceSummary->ResourceDescription | string | |\r\n", "operationId": "LookupOperationalRoleResourceResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable API Resource collection", "schema": { "$ref": "#/definitions/OperationalRoleResourceResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/OperationalRoles/Resources/Batch/{ids}": { "get": { "tags": [ "Operational Role Resource" ], "summary": "Get a collection of Operational Role Resource 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 | OperationalRoleResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | OperationalRoleResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | OperationalRoleResource->CreatedByUser_FullName | string | |\r\n| createdOn | OperationalRoleResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | OperationalRoleResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | OperationalRoleResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | OperationalRoleResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | OperationalRoleResource->ModifiedOn | string | date-time |\r\n| version | OperationalRoleResource->Version | integer | int32 |\r\n| id | OperationalRoleResource->Id | integer | int64 |\r\n| inheritedFromId | OperationalRoleResource->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromType | OperationalRoleResource->InheritedFrom_Type | string | |\r\n| inheritedFromModule | OperationalRoleResource->InheritedFrom_Module | string | |\r\n| inheritedFromIsDefault | OperationalRoleResource->InheritedFrom_IsDefault | boolean | |\r\n| inheritedFromTemplate | OperationalRoleResource->InheritedFrom_Template | string | |\r\n| isDefault | OperationalRoleResource->IsDefault | boolean | |\r\n| isInherited | OperationalRoleResource->IsInherited | boolean | |\r\n| module | OperationalRoleResource->Module | string | |\r\n| notes | OperationalRoleResource->Notes | string | |\r\n| operationalRoleId | OperationalRoleResource->OperationalRole_Id | integer | int64 |\r\n| operationalRoleCode | OperationalRoleResource->OperationalRole_Code | string | |\r\n| operationalRoleDescription | OperationalRoleResource->OperationalRole_Description | string | |\r\n| resource | OperationalRoleResource->Resource | string | |\r\n| resourceAction | OperationalRoleResource->ResourceAction | string | |\r\n| resourceActionCustomisationId | OperationalRoleResource->ResourceActionCustomisation_Id | integer | int64 |\r\n| resourceActionCustomisationName | OperationalRoleResource->ResourceActionCustomisation_Name | string | |\r\n| resourceActionCustomisationDescription | OperationalRoleResource->ResourceActionCustomisation_Description | string | |\r\n| resourceActionCustomisationRestrictionLevel | OperationalRoleResource->ResourceActionCustomisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| sequenceNumber | OperationalRoleResource->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetOperationalRoleResource", "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 Operational Role Resource 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 Operational Role Resource collection", "schema": { "$ref": "#/definitions/BatchGetOperationalRoleResourceResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/OperationalRoles/Resources/Batch": { "post": { "tags": [ "Operational Role Resource" ], "summary": "Create a new collection of Operational Role Resource 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| operationalRoleId | OperationalRoleResource->OperationalRole_Id | integer | int64 |\r\n| module | OperationalRoleResource->Module | string | |\r\n| resource | OperationalRoleResource->Resource | string | |\r\n| resourceAction | OperationalRoleResource->ResourceAction | string | |\r\n| resourceActionCustomisationId | OperationalRoleResource->ResourceActionCustomisation_Id | integer | int64 |\r\n| isDefault | OperationalRoleResource->IsDefault | boolean | |\r\n| sequenceNumber | OperationalRoleResource->SequenceNumber | integer | int32 |\r\n| notes | OperationalRoleResource->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| operationalRoleId | Required | True | |\r\n| operationalRoleId | Nullable | False | |\r\n| module | Nullable | False | |\r\n| module | Nullable | False | |\r\n| resource | Nullable | False | |\r\n| resource | Nullable | False | |\r\n| resourceAction | Nullable | False | |\r\n| resourceAction | Nullable | False | |\r\n| isDefault | Required | True | |\r\n| isDefault | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateOperationalRoleResource", "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/BatchCreateOperationalRoleResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Operational Role Resource 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": [ "Operational Role Resource" ], "summary": "Update a collection of existing Operational Role Resource 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 | OperationalRoleResource->Id | integer | int64 |\r\n| version | OperationalRoleResource->Version | integer | int32 |\r\n| isDefault | OperationalRoleResource->IsDefault | boolean | |\r\n| sequenceNumber | OperationalRoleResource->SequenceNumber | integer | int32 |\r\n| notes | OperationalRoleResource->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| isDefault | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateOperationalRoleResource", "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/BatchUpdateOperationalRoleResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Operational Role Resource 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": [ "Operational Role Resource" ], "summary": "Delete a collection of existing Operational Role Resource 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 | OperationalRoleResource->Id | integer | int64 |\r\n| version | OperationalRoleResource->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": "BatchDeleteOperationalRoleResource", "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/BatchDeleteOperationalRoleResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Operational Role Resource 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/UAM/OperationalRoles/Templates/{id}": { "get": { "tags": [ "Operational Role Template" ], "summary": "Get a Operational Role Template 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 | OperationalRoleTemplate->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | OperationalRoleTemplate->CreatedByUser_Code | string | |\r\n| createdByUserFullName | OperationalRoleTemplate->CreatedByUser_FullName | string | |\r\n| createdOn | OperationalRoleTemplate->CreatedOn | string | date-time |\r\n| modifiedByUserId | OperationalRoleTemplate->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | OperationalRoleTemplate->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | OperationalRoleTemplate->ModifiedByUser_FullName | string | |\r\n| modifiedOn | OperationalRoleTemplate->ModifiedOn | string | date-time |\r\n| version | OperationalRoleTemplate->Version | integer | int32 |\r\n| id | OperationalRoleTemplate->Id | integer | int64 |\r\n| isDefault | OperationalRoleTemplate->IsDefault | boolean | |\r\n| module | OperationalRoleTemplate->Module | string | |\r\n| notes | OperationalRoleTemplate->Notes | string | |\r\n| operationalRoleId | OperationalRoleTemplate->OperationalRole_Id | integer | int64 |\r\n| operationalRoleCode | OperationalRoleTemplate->OperationalRole_Code | string | |\r\n| operationalRoleDescription | OperationalRoleTemplate->OperationalRole_Description | string | |\r\n| sequenceNumber | OperationalRoleTemplate->SequenceNumber | integer | int32 |\r\n| template | OperationalRoleTemplate->Template | string | |\r\n| templateCustomisationId | OperationalRoleTemplate->TemplateCustomisation_Id | integer | int64 |\r\n| templateCustomisationName | OperationalRoleTemplate->TemplateCustomisation_Name | string | |\r\n| templateCustomisationDescription | OperationalRoleTemplate->TemplateCustomisation_Description | string | |\r\n| templateCustomisationRestrictionLevel | OperationalRoleTemplate->TemplateCustomisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| type | OperationalRoleTemplate->Type | string | |\r\n", "operationId": "GetOperationalRoleTemplate", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Operational Role Template Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Operational Role Template", "schema": { "$ref": "#/definitions/GetOperationalRoleTemplateResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Operational Role Template" ], "summary": "Update an existing Operational Role Template 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 | OperationalRoleTemplate->Version | integer | int32 |\r\n| isDefault | OperationalRoleTemplate->IsDefault | boolean | |\r\n| sequenceNumber | OperationalRoleTemplate->SequenceNumber | integer | int32 |\r\n| notes | OperationalRoleTemplate->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| isDefault | Nullable | False | |\r\n\r\n", "operationId": "UpdateOperationalRoleTemplate", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Operational Role Template Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateOperationalRoleTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Operational Role Template 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": [ "Operational Role Template" ], "summary": "Delete an existing Operational Role Template 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 | OperationalRoleTemplate->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": "DeleteOperationalRoleTemplate", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Operational Role Template Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteOperationalRoleTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Operational Role Template 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/UAM/OperationalRoles/Templates": { "get": { "tags": [ "Operational Role Template" ], "summary": "Get a collection of Operational Role Template 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 | OperationalRoleTemplate->Version | integer | int32 |\r\n| id | OperationalRoleTemplate->Id | integer | int64 |\r\n| operationalRoleId | OperationalRoleTemplate->OperationalRole_Id | integer | int64 |\r\n| operationalRoleCode | OperationalRoleTemplate->OperationalRole_Code | string | |\r\n| operationalRoleDescription | OperationalRoleTemplate->OperationalRole_Description | string | |\r\n| templateCustomisationId | OperationalRoleTemplate->TemplateCustomisation_Id | integer | int64 |\r\n| templateCustomisationName | OperationalRoleTemplate->TemplateCustomisation_Name | string | |\r\n| templateCustomisationDescription | OperationalRoleTemplate->TemplateCustomisation_Description | string | |\r\n| templateCustomisationRestrictionLevel | OperationalRoleTemplate->TemplateCustomisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| module | OperationalRoleTemplate->Module | string | |\r\n| template | OperationalRoleTemplate->Template | string | |\r\n| type | OperationalRoleTemplate->Type | string | |\r\n| sequenceNumber | OperationalRoleTemplate->SequenceNumber | integer | int32 |\r\n| isDefault | OperationalRoleTemplate->IsDefault | boolean | |\r\n", "operationId": "GetOperationalRoleTemplateCollection", "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 Operational Role Template collection", "schema": { "$ref": "#/definitions/GetOperationalRoleTemplateCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Operational Role Template" ], "summary": "Create a new Operational Role Template 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| operationalRoleId | OperationalRoleTemplate->OperationalRole_Id | integer | int64 |\r\n| module | OperationalRoleTemplate->Module | string | |\r\n| template | OperationalRoleTemplate->Template | string | |\r\n| type | OperationalRoleTemplate->Type | string | |\r\n| templateCustomisationId | OperationalRoleTemplate->TemplateCustomisation_Id | integer | int64 |\r\n| isDefault | OperationalRoleTemplate->IsDefault | boolean | |\r\n| sequenceNumber | OperationalRoleTemplate->SequenceNumber | integer | int32 |\r\n| notes | OperationalRoleTemplate->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| operationalRoleId | Required | True | |\r\n| operationalRoleId | Nullable | False | |\r\n| module | Nullable | False | |\r\n| template | Nullable | False | |\r\n| type | Nullable | False | |\r\n| isDefault | Required | True | |\r\n| isDefault | Nullable | False | |\r\n\r\n", "operationId": "CreateOperationalRoleTemplate", "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/CreateOperationalRoleTemplateResourceActionRequest" } }, { "$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/UAM/OperationalRoles/{operationalRoleId}/Templates": { "get": { "tags": [ "Operational Role Template" ], "summary": "Get a collection of Operational Role Template resources for the Operational Role.", "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 | OperationalRoleTemplate->Id | integer | int64 |\r\n| version | OperationalRoleTemplate->Version | integer | int32 |\r\n| template | OperationalRoleTemplate->Template | string | |\r\n| type | OperationalRoleTemplate->Type | string | |\r\n| module | OperationalRoleTemplate->Module | string | |\r\n| templateCustomisationId | OperationalRoleTemplate->TemplateCustomisation_Id | integer | int64 |\r\n| templateCustomisationName | OperationalRoleTemplate->TemplateCustomisation_Name | string | |\r\n| templateCustomisationDescription | OperationalRoleTemplate->TemplateCustomisation_Description | string | |\r\n| templateCustomisationRestrictionLevel | OperationalRoleTemplate->TemplateCustomisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| isDefault | OperationalRoleTemplate->IsDefault | boolean | |\r\n", "operationId": "GetOperationalRoleTemplateForOperationalRoleCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "operationalRoleId", "in": "path", "required": true, "description": "Operational Role 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 Operational Role Template collection", "schema": { "$ref": "#/definitions/GetOperationalRoleTemplateForOperationalRoleCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/OperationalRoles/Templates/Lookups/LookupOperationalRoleTemplateOperationalRole": { "get": { "tags": [ "Operational Role Template" ], "summary": "Lookup the Operational Role for the Operational Role Template.", "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 | OperationalRole->Id | integer | int64 |\r\n| code | OperationalRole->Code | string | |\r\n| description | OperationalRole->Description | string | |\r\n", "operationId": "LookupOperationalRoleTemplateOperationalRole", "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 Operational Role collection", "schema": { "$ref": "#/definitions/OperationalRoleTemplateOperationalRoleLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/OperationalRoles/Templates/Lookups/LookupOperationalRoleTemplateTemplateCustomisation": { "get": { "tags": [ "Operational Role Template" ], "summary": "Lookup the Template Customisation for the Operational Role Template.", "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 | TemplateCustomisation->Id | integer | int64 |\r\n| name | TemplateCustomisation->Name | string | |\r\n| description | TemplateCustomisation->Description | string | |\r\n| module | TemplateCustomisation->Module | string | |\r\n| template | TemplateCustomisation->Template | string | |\r\n| type | TemplateCustomisation->Type | string | |\r\n| restrictionLevel | TemplateCustomisation->RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n", "operationId": "LookupOperationalRoleTemplateTemplateCustomisation", "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 Template Customisation collection", "schema": { "$ref": "#/definitions/OperationalRoleTemplateTemplateCustomisationLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/OperationalRoles/Templates/Lookups/LookupOperationalRoleTemplateTemplate": { "get": { "tags": [ "Operational Role Template" ], "summary": "Operational Role Template", "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| templateName | TemplateSummary->TemplateName | string | |\r\n| moduleName | TemplateSummary->ModuleName | string | |\r\n| templateType | TemplateSummary->TemplateType | string | |\r\n", "operationId": "LookupOperationalRoleTemplateTemplate", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Template collection", "schema": { "$ref": "#/definitions/OperationalRoleTemplateTemplateLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/OperationalRoles/Templates/Batch/{ids}": { "get": { "tags": [ "Operational Role Template" ], "summary": "Get a collection of Operational Role Template 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 | OperationalRoleTemplate->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | OperationalRoleTemplate->CreatedByUser_Code | string | |\r\n| createdByUserFullName | OperationalRoleTemplate->CreatedByUser_FullName | string | |\r\n| createdOn | OperationalRoleTemplate->CreatedOn | string | date-time |\r\n| modifiedByUserId | OperationalRoleTemplate->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | OperationalRoleTemplate->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | OperationalRoleTemplate->ModifiedByUser_FullName | string | |\r\n| modifiedOn | OperationalRoleTemplate->ModifiedOn | string | date-time |\r\n| version | OperationalRoleTemplate->Version | integer | int32 |\r\n| id | OperationalRoleTemplate->Id | integer | int64 |\r\n| isDefault | OperationalRoleTemplate->IsDefault | boolean | |\r\n| module | OperationalRoleTemplate->Module | string | |\r\n| notes | OperationalRoleTemplate->Notes | string | |\r\n| operationalRoleId | OperationalRoleTemplate->OperationalRole_Id | integer | int64 |\r\n| operationalRoleCode | OperationalRoleTemplate->OperationalRole_Code | string | |\r\n| operationalRoleDescription | OperationalRoleTemplate->OperationalRole_Description | string | |\r\n| sequenceNumber | OperationalRoleTemplate->SequenceNumber | integer | int32 |\r\n| template | OperationalRoleTemplate->Template | string | |\r\n| templateCustomisationId | OperationalRoleTemplate->TemplateCustomisation_Id | integer | int64 |\r\n| templateCustomisationName | OperationalRoleTemplate->TemplateCustomisation_Name | string | |\r\n| templateCustomisationDescription | OperationalRoleTemplate->TemplateCustomisation_Description | string | |\r\n| templateCustomisationRestrictionLevel | OperationalRoleTemplate->TemplateCustomisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| type | OperationalRoleTemplate->Type | string | |\r\n", "operationId": "BatchGetOperationalRoleTemplate", "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 Operational Role Template 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 Operational Role Template collection", "schema": { "$ref": "#/definitions/BatchGetOperationalRoleTemplateResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/OperationalRoles/Templates/Batch": { "post": { "tags": [ "Operational Role Template" ], "summary": "Create a new collection of Operational Role Template 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| operationalRoleId | OperationalRoleTemplate->OperationalRole_Id | integer | int64 |\r\n| module | OperationalRoleTemplate->Module | string | |\r\n| template | OperationalRoleTemplate->Template | string | |\r\n| type | OperationalRoleTemplate->Type | string | |\r\n| templateCustomisationId | OperationalRoleTemplate->TemplateCustomisation_Id | integer | int64 |\r\n| isDefault | OperationalRoleTemplate->IsDefault | boolean | |\r\n| sequenceNumber | OperationalRoleTemplate->SequenceNumber | integer | int32 |\r\n| notes | OperationalRoleTemplate->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| operationalRoleId | Required | True | |\r\n| operationalRoleId | Nullable | False | |\r\n| module | Nullable | False | |\r\n| template | Nullable | False | |\r\n| type | Nullable | False | |\r\n| isDefault | Required | True | |\r\n| isDefault | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateOperationalRoleTemplate", "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/BatchCreateOperationalRoleTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Operational Role Template 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": [ "Operational Role Template" ], "summary": "Update a collection of existing Operational Role Template 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 | OperationalRoleTemplate->Id | integer | int64 |\r\n| version | OperationalRoleTemplate->Version | integer | int32 |\r\n| isDefault | OperationalRoleTemplate->IsDefault | boolean | |\r\n| sequenceNumber | OperationalRoleTemplate->SequenceNumber | integer | int32 |\r\n| notes | OperationalRoleTemplate->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| isDefault | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateOperationalRoleTemplate", "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/BatchUpdateOperationalRoleTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Operational Role Template 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": [ "Operational Role Template" ], "summary": "Delete a collection of existing Operational Role Template 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 | OperationalRoleTemplate->Id | integer | int64 |\r\n| version | OperationalRoleTemplate->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": "BatchDeleteOperationalRoleTemplate", "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/BatchDeleteOperationalRoleTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Operational Role Template 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/UAM/Permissions/ReleaseLog": { "get": { "tags": [ "Permission" ], "summary": "Get the Permission Release Log entries per release.", "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| category | PermissionReleaseLog->Category | string | |\r\n| subcategory | PermissionReleaseLog->Subcategory | string | |\r\n| name | PermissionReleaseLog->Name | string | |\r\n| entityName | PermissionReleaseLog->EntityName | string | |\r\n| isStandardPermission | PermissionReleaseLog->IsStandardPermission | boolean | |\r\n| isDomainEntityPermission | PermissionReleaseLog->IsDomainEntityPermission | boolean | |\r\n| isTreePermission | PermissionReleaseLog->IsTreePermission | boolean | |\r\n| permissionId | PermissionReleaseLog->PermissionId | integer | int64 |\r\n| id | PermissionReleaseLog->Id | integer | int64 |\r\n| onKeyVersionNumber | PermissionReleaseLog->OnKeyVersionNumber | string | |\r\n| onKeyBuildNumber | PermissionReleaseLog->OnKeyBuildNumber | integer | int32 |\r\n", "operationId": "GetPermissionReleaseLog", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Permission collection", "schema": { "$ref": "#/definitions/GetPermissionReleaseLogListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Lookups/PermissionsLookup": { "get": { "tags": [ "Permission" ], "summary": "Permission", "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| permissionId | PermissionView->PermissionId | integer | int32 |\r\n| entityName | PermissionView->EntityName | string | |\r\n| category | PermissionView->Category | string | |\r\n| name | PermissionView->Name | string | |\r\n| standardRight | PermissionView->StandardRight | boolean | |\r\n| subcategory | PermissionView->Subcategory | string | |\r\n| treePermission | PermissionView->TreePermission | boolean | |\r\n", "operationId": "PermissionsLookup", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/LookupPermissionsResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/PermissionTrees/{id}": { "get": { "tags": [ "Permission Tree" ], "summary": "Get a Permission Tree 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 | PermissionTree->Code | string | |\r\n| createdByUserId | PermissionTree->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PermissionTree->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PermissionTree->CreatedByUser_FullName | string | |\r\n| createdOn | PermissionTree->CreatedOn | string | date-time |\r\n| isActive | PermissionTree->IsActive | boolean | |\r\n| modifiedByUserId | PermissionTree->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PermissionTree->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PermissionTree->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PermissionTree->ModifiedOn | string | date-time |\r\n| version | PermissionTree->Version | integer | int32 |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| description | PermissionTree->Description | string | |\r\n| inheritedFromId | PermissionTree->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromCode | PermissionTree->InheritedFrom_Code | string | |\r\n| inheritedFromDescription | PermissionTree->InheritedFrom_Description | string | |\r\n| isInherited | PermissionTree->IsInherited | boolean | |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n| parentPermissionTreeCode | PermissionTree->ParentPermissionTree_Code | string | |\r\n| parentPermissionTreeDescription | PermissionTree->ParentPermissionTree_Description | string | |\r\n", "operationId": "GetPermissionTree", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Permission Tree Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Permission Tree", "schema": { "$ref": "#/definitions/GetPermissionTreeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Permission Tree" ], "summary": "Update an existing Permission Tree 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 | PermissionTree->Version | integer | int32 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | 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| 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": "UpdatePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Permission Tree Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Permission Tree 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": [ "Permission Tree" ], "summary": "Delete an existing Permission Tree 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 | PermissionTree->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": "DeletePermissionTree", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Permission Tree Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Permission Tree 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/UAM/PermissionTrees": { "get": { "tags": [ "Permission Tree" ], "summary": "Get a collection of Permission Tree 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 | PermissionTree->Id | integer | int64 |\r\n| version | PermissionTree->Version | integer | int32 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| parentPermissionTreeCode | PermissionTree->ParentPermissionTree_Code | string | |\r\n| parentPermissionTreeDescription | PermissionTree->ParentPermissionTree_Description | string | |\r\n| isInherited | PermissionTree->IsInherited | boolean | |\r\n| inheritedFromCode | PermissionTree->InheritedFrom_Code | string | |\r\n| inheritedFromDescription | PermissionTree->InheritedFrom_Description | string | |\r\n| createdOn | PermissionTree->CreatedOn | string | date-time |\r\n| modifiedOn | PermissionTree->ModifiedOn | string | date-time |\r\n| isActive | PermissionTree->IsActive | boolean | |\r\n", "operationId": "GetPermissionTreeCollection", "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 Permission Tree collection", "schema": { "$ref": "#/definitions/GetPermissionTreeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Permission Tree" ], "summary": "Create a new Permission Tree 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| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | 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| parentPermissionTreeId | Required | True | |\r\n| parentPermissionTreeId | 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 | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "CreatePermissionTree", "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/CreatePermissionTreeResourceActionRequest" } }, { "$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/UAM/PermissionTrees/Lookups/LookupPermissionTreeInsertParentPermissionTree": { "get": { "tags": [ "Permission Tree" ], "summary": "Lookup the Permission Tree for the Permission Tree.", "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| isInherited | PermissionTree->IsInherited | boolean | |\r\n| inheritedFromCode | PermissionTree->InheritedFrom_Code | string | |\r\n| inheritedFromDescription | PermissionTree->InheritedFrom_Description | string | |\r\n", "operationId": "LookupPermissionTreeInsertParentPermissionTree", "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 Permission Tree collection", "schema": { "$ref": "#/definitions/LookupPermissionTreeInsertParentPermissionTreeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/PermissionTrees/Batch/{ids}": { "get": { "tags": [ "Permission Tree" ], "summary": "Get a collection of Permission Tree 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 | PermissionTree->Code | string | |\r\n| createdByUserId | PermissionTree->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PermissionTree->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PermissionTree->CreatedByUser_FullName | string | |\r\n| createdOn | PermissionTree->CreatedOn | string | date-time |\r\n| isActive | PermissionTree->IsActive | boolean | |\r\n| modifiedByUserId | PermissionTree->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PermissionTree->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PermissionTree->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PermissionTree->ModifiedOn | string | date-time |\r\n| version | PermissionTree->Version | integer | int32 |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| description | PermissionTree->Description | string | |\r\n| inheritedFromId | PermissionTree->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromCode | PermissionTree->InheritedFrom_Code | string | |\r\n| inheritedFromDescription | PermissionTree->InheritedFrom_Description | string | |\r\n| isInherited | PermissionTree->IsInherited | boolean | |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n| parentPermissionTreeCode | PermissionTree->ParentPermissionTree_Code | string | |\r\n| parentPermissionTreeDescription | PermissionTree->ParentPermissionTree_Description | string | |\r\n", "operationId": "BatchGetPermissionTree", "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 Permission Tree 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 Permission Tree collection", "schema": { "$ref": "#/definitions/BatchGetPermissionTreeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/PermissionTrees/Batch": { "post": { "tags": [ "Permission Tree" ], "summary": "Create a new collection of Permission Tree 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| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | 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| parentPermissionTreeId | Required | True | |\r\n| parentPermissionTreeId | 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 | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchCreatePermissionTree", "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/BatchCreatePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Permission Tree 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": [ "Permission Tree" ], "summary": "Update a collection of existing Permission Tree 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 | PermissionTree->Id | integer | int64 |\r\n| version | PermissionTree->Version | integer | int32 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | 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| 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": "BatchUpdatePermissionTree", "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/BatchUpdatePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Permission Tree 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": [ "Permission Tree" ], "summary": "Delete a collection of existing Permission Tree 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 | PermissionTree->Id | integer | int64 |\r\n| version | PermissionTree->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": "BatchDeletePermissionTree", "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/BatchDeletePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Permission Tree 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/UAM/PermissionTrees/{id}/Active": { "patch": { "tags": [ "Permission Tree" ], "summary": "Change the IsActive status for an existing Permission Tree 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 | PermissionTree->Version | integer | int32 |\r\n| isActive | PermissionTree->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": "ChangePermissionTreeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Permission Tree Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePermissionTreeIsActiveResourceActionRequest" } }, { "$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/UAM/PermissionTrees/Batch/Active": { "patch": { "tags": [ "Permission Tree" ], "summary": "Change the IsActive status for a collection of existing Permission Tree 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 | PermissionTree->Id | integer | int64 |\r\n| version | PermissionTree->Version | integer | int32 |\r\n| isActive | PermissionTree->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": "BatchChangePermissionTreeIsActive", "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/BatchChangePermissionTreeIsActiveResourceActionRequest" } }, { "$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/UAM/PermissionTrees/Tree/PermissionTree/{id}/PathMap": { "get": { "tags": [ "Permission Tree Tree" ], "summary": "Get a collection of tree nodes that contains the path map to navigate to the resource within the tree.", "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 | TreePathMapNode->Id | integer | int64 |\r\n| code | TreePathMapNode->Code | string | |\r\n| recordType | TreePathMapNode->RecordType | string | |\r\n| treeLevel | TreePathMapNode->TreeLevel | integer | int32 |\r\n| type | TreePathMapNode->Type | string | enum |\r\n", "operationId": "GetPermissionTreeTreePathMap", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Node Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Permission Tree Tree collection", "schema": { "$ref": "#/definitions/GetPermissionTreeTreePathMapResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/PermissionTrees/Tree": { "get": { "tags": [ "Permission Tree Tree" ], "summary": "Get a collection of PermissionTree resources for the Root node.", "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", "operationId": "GetPermissionTreeTreeRoot", "produces": [ "application/vnd.onkey.assetregistertreenode+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "boolean", "name": "showInActive", "in": "query", "description": "Include records that are inactive (default=False)", "x-nullable": true }, { "$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 Permission Tree Tree", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/PermissionTrees/Tree/{parentNodeType}/{parentId}/PermissionTrees": { "get": { "tags": [ "Permission Tree Tree" ], "summary": "Get a collection of Permission Tree resources beneath the parent tree node.", "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| version | PermissionTree->Version | integer | int32 |\r\n| isActive | PermissionTree->IsActive | boolean | |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n", "operationId": "GetTreePermissionTreeCollection", "produces": [ "application/vnd.onkey.assetregistertreenodecollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "string", "name": "parentNodeType", "in": "path", "required": true, "description": "Parent Node Type", "format": "enum", "x-nullable": false, "x-formatSpecifier": "TreeNodeType" }, { "type": "integer", "name": "parentId", "in": "path", "required": true, "description": "Parent Id", "format": "int64", "x-nullable": false }, { "type": "boolean", "name": "showInActive", "in": "query", "description": "Include records that are inactive (default=False)", "x-nullable": true }, { "$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 Permission Tree Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/SecurityRoles/{id}": { "get": { "tags": [ "Security Role" ], "summary": "Get a Security Role 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 | SecurityRole->Code | string | |\r\n| createdByUserId | SecurityRole->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SecurityRole->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SecurityRole->CreatedByUser_FullName | string | |\r\n| createdOn | SecurityRole->CreatedOn | string | date-time |\r\n| isActive | SecurityRole->IsActive | boolean | |\r\n| modifiedByUserId | SecurityRole->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SecurityRole->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SecurityRole->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SecurityRole->ModifiedOn | string | date-time |\r\n| permissionTreeId | SecurityRole->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SecurityRole->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SecurityRole->PermissionTree_Description | string | |\r\n| version | SecurityRole->Version | integer | int32 |\r\n| id | SecurityRole->Id | integer | int64 |\r\n| description | SecurityRole->Description | string | |\r\n| isPermissionTreeRole | SecurityRole->IsPermissionTreeRole | boolean | |\r\n| isSystem | SecurityRole->IsSystem | boolean | |\r\n| notes | SecurityRole->Notes | string | |\r\n", "operationId": "GetSecurityRole", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Security Role Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Security Role", "schema": { "$ref": "#/definitions/GetRoleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Security Role" ], "summary": "Update an existing Security Role 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 | SecurityRole->Version | integer | int32 |\r\n| code | SecurityRole->Code | string | |\r\n| description | SecurityRole->Description | string | |\r\n| notes | SecurityRole->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| 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": "UpdateSecurityRole", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Security Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Security Role 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": [ "Security Role" ], "summary": "Delete an existing Security Role 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 | SecurityRole->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": "DeleteSecurityRole", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Security Role Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Security Role 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/UAM/SecurityRoles": { "get": { "tags": [ "Security Role" ], "summary": "Get a collection of Security Role 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 | SecurityRole->Version | integer | int32 |\r\n| id | SecurityRole->Id | integer | int64 |\r\n| code | SecurityRole->Code | string | |\r\n| description | SecurityRole->Description | string | |\r\n| isPermissionTreeRole | SecurityRole->IsPermissionTreeRole | boolean | |\r\n| isActive | SecurityRole->IsActive | boolean | |\r\n", "operationId": "GetSecurityRoleCollection", "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 Security Role collection", "schema": { "$ref": "#/definitions/GetRoleCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Security Role" ], "summary": "Create a new Security Role 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 | SecurityRole->PermissionTree_Id | integer | int64 |\r\n| code | SecurityRole->Code | string | |\r\n| description | SecurityRole->Description | string | |\r\n| isPermissionTreeRole | SecurityRole->IsPermissionTreeRole | boolean | |\r\n| notes | SecurityRole->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| isPermissionTreeRole | Nullable | False | |\r\n\r\n", "operationId": "CreateSecurityRole", "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/CreateRoleResourceActionRequest" } }, { "$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/UAM/SecurityRoles/Lookups/LookupSecurityRoleChangePermissionTree": { "get": { "tags": [ "Security Role" ], "summary": "Lookup the permission set for changing the Security Role.", "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": "LookupSecurityRoleChangePermissionTree", "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/RoleChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/SecurityRoles/Lookups/LookupSecurityRoleInsertPermissionTree": { "get": { "tags": [ "Security Role" ], "summary": "Lookup the permission set for creating the Security Role.", "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": "LookupSecurityRoleInsertPermissionTree", "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/RoleInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/SecurityRoles/Batch/{ids}": { "get": { "tags": [ "Security Role" ], "summary": "Get a collection of Security Role 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 | SecurityRole->Code | string | |\r\n| createdByUserId | SecurityRole->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SecurityRole->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SecurityRole->CreatedByUser_FullName | string | |\r\n| createdOn | SecurityRole->CreatedOn | string | date-time |\r\n| isActive | SecurityRole->IsActive | boolean | |\r\n| modifiedByUserId | SecurityRole->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SecurityRole->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SecurityRole->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SecurityRole->ModifiedOn | string | date-time |\r\n| permissionTreeId | SecurityRole->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SecurityRole->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SecurityRole->PermissionTree_Description | string | |\r\n| version | SecurityRole->Version | integer | int32 |\r\n| id | SecurityRole->Id | integer | int64 |\r\n| description | SecurityRole->Description | string | |\r\n| isPermissionTreeRole | SecurityRole->IsPermissionTreeRole | boolean | |\r\n| isSystem | SecurityRole->IsSystem | boolean | |\r\n| notes | SecurityRole->Notes | string | |\r\n", "operationId": "BatchGetSecurityRole", "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 Security Role 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 Security Role collection", "schema": { "$ref": "#/definitions/BatchGetSecurityRoleResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/SecurityRoles/Batch": { "post": { "tags": [ "Security Role" ], "summary": "Create a new collection of Security Role 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 | SecurityRole->PermissionTree_Id | integer | int64 |\r\n| code | SecurityRole->Code | string | |\r\n| description | SecurityRole->Description | string | |\r\n| isPermissionTreeRole | SecurityRole->IsPermissionTreeRole | boolean | |\r\n| notes | SecurityRole->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| isPermissionTreeRole | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateSecurityRole", "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/BatchCreateRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Security Role 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": [ "Security Role" ], "summary": "Update a collection of existing Security Role 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 | SecurityRole->Id | integer | int64 |\r\n| version | SecurityRole->Version | integer | int32 |\r\n| code | SecurityRole->Code | string | |\r\n| description | SecurityRole->Description | string | |\r\n| notes | SecurityRole->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| 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": "BatchUpdateSecurityRole", "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/BatchUpdateRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Security Role 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": [ "Security Role" ], "summary": "Delete a collection of existing Security Role 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 | SecurityRole->Id | integer | int64 |\r\n| version | SecurityRole->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": "BatchDeleteSecurityRole", "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/BatchDeleteRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Security Role 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/UAM/SecurityRoles/{id}/Active": { "patch": { "tags": [ "Security Role" ], "summary": "Change the IsActive status for an existing Security Role 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 | SecurityRole->Version | integer | int32 |\r\n| isActive | SecurityRole->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": "ChangeSecurityRoleIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Security Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRoleIsActiveResourceActionRequest" } }, { "$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/UAM/SecurityRoles/{id}/PermissionTree": { "patch": { "tags": [ "Security Role" ], "summary": "Change the PermissionTree for an existing Security Role 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 | SecurityRole->Version | integer | int32 |\r\n| permissionTreeId | SecurityRole->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": "ChangeSecurityRolePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Security Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSecurityRolePermissionTreeResourceActionRequest" } }, { "$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/UAM/SecurityRoles/Batch/Active": { "patch": { "tags": [ "Security Role" ], "summary": "Change the IsActive status for a collection of existing Security Role 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 | SecurityRole->Id | integer | int64 |\r\n| version | SecurityRole->Version | integer | int32 |\r\n| isActive | SecurityRole->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": "BatchChangeSecurityRoleIsActive", "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/BatchChangeRoleIsActiveResourceActionRequest" } }, { "$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/UAM/SecurityRoles/Batch/PermissionTree": { "patch": { "tags": [ "Security Role" ], "summary": "Change the PermissionTree status for a collection of existing Security Role 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 | SecurityRole->Id | integer | int64 |\r\n| version | SecurityRole->Version | integer | int32 |\r\n| permissionTreeId | SecurityRole->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": "BatchChangeSecurityRolePermissionTree", "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/BatchChangeSecurityRolePermissionTreeResourceActionRequest" } }, { "$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/UAM/SecurityRoles/Permissions/{id}": { "get": { "tags": [ "Security Role Permission" ], "summary": "Get a Security Role Permission 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| category | SecurityRolePermission->Category | string | |\r\n| entityName | SecurityRolePermission->EntityName | string | |\r\n| name | SecurityRolePermission->Name | string | |\r\n| subcategory | SecurityRolePermission->Subcategory | string | |\r\n| createdByUserId | SecurityRolePermission->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SecurityRolePermission->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SecurityRolePermission->CreatedByUser_FullName | string | |\r\n| createdOn | SecurityRolePermission->CreatedOn | string | date-time |\r\n| modifiedByUserId | SecurityRolePermission->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SecurityRolePermission->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SecurityRolePermission->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SecurityRolePermission->ModifiedOn | string | date-time |\r\n| version | SecurityRolePermission->Version | integer | int32 |\r\n| id | SecurityRolePermission->Id | integer | int64 |\r\n| excludedProperties | SecurityRolePermission->ExcludedProperties | array | array |\r\n| notes | SecurityRolePermission->Notes | string | |\r\n| permissionId | SecurityRolePermission->PermissionId | integer | int32 |\r\n| securityRoleId | SecurityRolePermission->SecurityRole_Id | integer | int64 |\r\n| securityRoleCode | SecurityRolePermission->SecurityRole_Code | string | |\r\n| securityRoleDescription | SecurityRolePermission->SecurityRole_Description | string | |\r\n| securityRoleCreatedByUserId | SecurityRolePermission->SecurityRole_CreatedByUser_Id | integer | int64 |\r\n| securityRoleCreatedByUserCode | SecurityRolePermission->SecurityRole_CreatedByUser_Code | string | |\r\n| securityRoleCreatedByUserFullName | SecurityRolePermission->SecurityRole_CreatedByUser_FullName | string | |\r\n| securityRoleModifiedByUserId | SecurityRolePermission->SecurityRole_ModifiedByUser_Id | integer | int64 |\r\n| securityRoleModifiedByUserCode | SecurityRolePermission->SecurityRole_ModifiedByUser_Code | string | |\r\n| securityRoleModifiedByUserFullName | SecurityRolePermission->SecurityRole_ModifiedByUser_FullName | string | |\r\n", "operationId": "GetSecurityRolePermission", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Security Role Permission Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Security Role Permission", "schema": { "$ref": "#/definitions/GetSecurityRolePermissionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Security Role Permission" ], "summary": "Update an existing Security Role Permission 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 | SecurityRolePermission->Version | integer | int32 |\r\n| securityRoleId | SecurityRolePermission->SecurityRole_Id | integer | int64 |\r\n| permissionId | SecurityRolePermission->PermissionId | integer | int32 |\r\n| excludedProperties | SecurityRolePermission->ExcludedProperties | array | array |\r\n| notes | SecurityRolePermission->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| securityRoleId | Nullable | False | |\r\n| permissionId | Nullable | False | |\r\n\r\n", "operationId": "UpdateSecurityRolePermission", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Security Role Permission Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSecurityRolePermissionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Security Role Permission 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": [ "Security Role Permission" ], "summary": "Delete an existing Security Role Permission 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 | SecurityRolePermission->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": "DeleteSecurityRolePermission", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Security Role Permission Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSecurityRolePermissionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Security Role Permission 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/UAM/SecurityRoles/{securityRoleId}/Permissions": { "get": { "tags": [ "Security Role Permission" ], "summary": "Get a list of Security Role Permission resources for the Security Role.", "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| category | SecurityRolePermission->Category | string | |\r\n| entityName | SecurityRolePermission->EntityName | string | |\r\n| name | SecurityRolePermission->Name | string | |\r\n| subcategory | SecurityRolePermission->Subcategory | string | |\r\n| createdByUserId | SecurityRolePermission->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SecurityRolePermission->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SecurityRolePermission->CreatedByUser_FullName | string | |\r\n| createdOn | SecurityRolePermission->CreatedOn | string | date-time |\r\n| modifiedByUserId | SecurityRolePermission->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SecurityRolePermission->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SecurityRolePermission->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SecurityRolePermission->ModifiedOn | string | date-time |\r\n| version | SecurityRolePermission->Version | integer | int32 |\r\n| id | SecurityRolePermission->Id | integer | int64 |\r\n| notes | SecurityRolePermission->Notes | string | |\r\n| permissionId | SecurityRolePermission->PermissionId | integer | int32 |\r\n| securityRoleId | SecurityRolePermission->SecurityRole_Id | integer | int64 |\r\n| securityRoleCode | SecurityRolePermission->SecurityRole_Code | string | |\r\n| securityRoleDescription | SecurityRolePermission->SecurityRole_Description | string | |\r\n| securityRoleCreatedByUserId | SecurityRolePermission->SecurityRole_CreatedByUser_Id | integer | int64 |\r\n| securityRoleCreatedByUserCode | SecurityRolePermission->SecurityRole_CreatedByUser_Code | string | |\r\n| securityRoleCreatedByUserFullName | SecurityRolePermission->SecurityRole_CreatedByUser_FullName | string | |\r\n| securityRoleModifiedByUserId | SecurityRolePermission->SecurityRole_ModifiedByUser_Id | integer | int64 |\r\n| securityRoleModifiedByUserCode | SecurityRolePermission->SecurityRole_ModifiedByUser_Code | string | |\r\n| securityRoleModifiedByUserFullName | SecurityRolePermission->SecurityRole_ModifiedByUser_FullName | string | |\r\n", "operationId": "GetSecurityRolePermissionListForSecurityRole", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "securityRoleId", "in": "path", "required": true, "description": "Security Role Id", "format": "int64", "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Security Role Permission collection", "schema": { "$ref": "#/definitions/GetSecurityRolePermissionListForSecurityRoleResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/SecurityRoles/Permissions": { "get": { "tags": [ "Security Role Permission" ], "summary": "Get a list of Security Role Permission 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| category | SecurityRolePermission->Category | string | |\r\n| entityName | SecurityRolePermission->EntityName | string | |\r\n| name | SecurityRolePermission->Name | string | |\r\n| subcategory | SecurityRolePermission->Subcategory | string | |\r\n| createdByUserId | SecurityRolePermission->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SecurityRolePermission->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SecurityRolePermission->CreatedByUser_FullName | string | |\r\n| createdOn | SecurityRolePermission->CreatedOn | string | date-time |\r\n| modifiedByUserId | SecurityRolePermission->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SecurityRolePermission->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SecurityRolePermission->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SecurityRolePermission->ModifiedOn | string | date-time |\r\n| version | SecurityRolePermission->Version | integer | int32 |\r\n| id | SecurityRolePermission->Id | integer | int64 |\r\n| notes | SecurityRolePermission->Notes | string | |\r\n| permissionId | SecurityRolePermission->PermissionId | integer | int32 |\r\n| securityRoleId | SecurityRolePermission->SecurityRole_Id | integer | int64 |\r\n| securityRoleCode | SecurityRolePermission->SecurityRole_Code | string | |\r\n| securityRoleDescription | SecurityRolePermission->SecurityRole_Description | string | |\r\n| securityRoleCreatedByUserId | SecurityRolePermission->SecurityRole_CreatedByUser_Id | integer | int64 |\r\n| securityRoleCreatedByUserCode | SecurityRolePermission->SecurityRole_CreatedByUser_Code | string | |\r\n| securityRoleCreatedByUserFullName | SecurityRolePermission->SecurityRole_CreatedByUser_FullName | string | |\r\n| securityRoleModifiedByUserId | SecurityRolePermission->SecurityRole_ModifiedByUser_Id | integer | int64 |\r\n| securityRoleModifiedByUserCode | SecurityRolePermission->SecurityRole_ModifiedByUser_Code | string | |\r\n| securityRoleModifiedByUserFullName | SecurityRolePermission->SecurityRole_ModifiedByUser_FullName | string | |\r\n", "operationId": "GetSecurityRolePermissionList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Security Role Permission collection", "schema": { "$ref": "#/definitions/GetSecurityRolePermissionListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Security Role Permission" ], "summary": "Create a new Security Role Permission 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| securityRoleId | SecurityRolePermission->SecurityRole_Id | integer | int64 |\r\n| permissionId | SecurityRolePermission->PermissionId | integer | int32 |\r\n| excludedProperties | SecurityRolePermission->ExcludedProperties | array | array |\r\n| notes | SecurityRolePermission->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| securityRoleId | Required | True | |\r\n| securityRoleId | Nullable | False | |\r\n| permissionId | Required | True | |\r\n| permissionId | Nullable | False | |\r\n\r\n", "operationId": "CreateSecurityRolePermission", "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/CreateSecurityRolePermissionResourceActionRequest" } }, { "$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/UAM/SecurityRoles/Permissions/Lookups/LookupSecurityRolePermissionEntityProperty": { "get": { "tags": [ "Security Role Permission" ], "summary": "Security Role Permission", "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| path | EntityMetadataPropertySummary->Path | string | |\r\n", "operationId": "LookupSecurityRolePermissionEntityProperty", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Entity Property Metadata Summary collection", "schema": { "$ref": "#/definitions/SecurityRolePermissionEntityPropertyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/SecurityRoles/Permissions/Lookups/LookupSecurityRolePermission": { "get": { "tags": [ "Security Role Permission" ], "summary": "Security Role Permission", "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| permissionId | PermissionView->PermissionId | integer | int32 |\r\n| category | PermissionView->Category | string | |\r\n| subcategory | PermissionView->Subcategory | string | |\r\n| name | PermissionView->Name | string | |\r\n| entityName | PermissionView->EntityName | string | |\r\n", "operationId": "LookupSecurityRolePermission", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable API Resource collection", "schema": { "$ref": "#/definitions/SecurityRolePermissionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/SecurityRoles/Permissions/Lookups/LookupSecurityRolePermissionSecurityRole": { "get": { "tags": [ "Security Role Permission" ], "summary": "Lookup the Security Role for the Security Role Permission.", "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 | SecurityRole->Id | integer | int64 |\r\n| code | SecurityRole->Code | string | |\r\n| description | SecurityRole->Description | string | |\r\n| isPermissionTreeRole | SecurityRole->IsPermissionTreeRole | boolean | |\r\n", "operationId": "LookupSecurityRolePermissionSecurityRole", "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 Security Role collection", "schema": { "$ref": "#/definitions/SecurityRolePermissionSecurityRoleLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/SecurityRoles/Permissions/Batch/{ids}": { "get": { "tags": [ "Security Role Permission" ], "summary": "Get a collection of Security Role Permission 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| category | SecurityRolePermission->Category | string | |\r\n| entityName | SecurityRolePermission->EntityName | string | |\r\n| name | SecurityRolePermission->Name | string | |\r\n| subcategory | SecurityRolePermission->Subcategory | string | |\r\n| createdByUserId | SecurityRolePermission->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SecurityRolePermission->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SecurityRolePermission->CreatedByUser_FullName | string | |\r\n| createdOn | SecurityRolePermission->CreatedOn | string | date-time |\r\n| modifiedByUserId | SecurityRolePermission->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SecurityRolePermission->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SecurityRolePermission->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SecurityRolePermission->ModifiedOn | string | date-time |\r\n| version | SecurityRolePermission->Version | integer | int32 |\r\n| id | SecurityRolePermission->Id | integer | int64 |\r\n| excludedProperties | SecurityRolePermission->ExcludedProperties | array | array |\r\n| notes | SecurityRolePermission->Notes | string | |\r\n| permissionId | SecurityRolePermission->PermissionId | integer | int32 |\r\n| securityRoleId | SecurityRolePermission->SecurityRole_Id | integer | int64 |\r\n| securityRoleCode | SecurityRolePermission->SecurityRole_Code | string | |\r\n| securityRoleDescription | SecurityRolePermission->SecurityRole_Description | string | |\r\n| securityRoleCreatedByUserId | SecurityRolePermission->SecurityRole_CreatedByUser_Id | integer | int64 |\r\n| securityRoleCreatedByUserCode | SecurityRolePermission->SecurityRole_CreatedByUser_Code | string | |\r\n| securityRoleCreatedByUserFullName | SecurityRolePermission->SecurityRole_CreatedByUser_FullName | string | |\r\n| securityRoleModifiedByUserId | SecurityRolePermission->SecurityRole_ModifiedByUser_Id | integer | int64 |\r\n| securityRoleModifiedByUserCode | SecurityRolePermission->SecurityRole_ModifiedByUser_Code | string | |\r\n| securityRoleModifiedByUserFullName | SecurityRolePermission->SecurityRole_ModifiedByUser_FullName | string | |\r\n", "operationId": "BatchGetSecurityRolePermission", "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 Security Role Permission 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 Security Role Permission collection", "schema": { "$ref": "#/definitions/BatchGetSecurityRolePermissionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/SecurityRoles/Permissions/Batch": { "post": { "tags": [ "Security Role Permission" ], "summary": "Create a new collection of Security Role Permission 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| securityRoleId | SecurityRolePermission->SecurityRole_Id | integer | int64 |\r\n| permissionId | SecurityRolePermission->PermissionId | integer | int32 |\r\n| excludedProperties | SecurityRolePermission->ExcludedProperties | array | array |\r\n| notes | SecurityRolePermission->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| securityRoleId | Required | True | |\r\n| securityRoleId | Nullable | False | |\r\n| permissionId | Required | True | |\r\n| permissionId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateSecurityRolePermission", "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/BatchCreateSecurityRolePermissionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Security Role Permission 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": [ "Security Role Permission" ], "summary": "Update a collection of existing Security Role Permission 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 | SecurityRolePermission->Id | integer | int64 |\r\n| version | SecurityRolePermission->Version | integer | int32 |\r\n| securityRoleId | SecurityRolePermission->SecurityRole_Id | integer | int64 |\r\n| permissionId | SecurityRolePermission->PermissionId | integer | int32 |\r\n| excludedProperties | SecurityRolePermission->ExcludedProperties | array | array |\r\n| notes | SecurityRolePermission->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| securityRoleId | Nullable | False | |\r\n| permissionId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateSecurityRolePermission", "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/BatchUpdateSecurityRolePermissionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Security Role Permission 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": [ "Security Role Permission" ], "summary": "Delete a collection of existing Security Role Permission 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 | SecurityRolePermission->Id | integer | int64 |\r\n| version | SecurityRolePermission->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": "BatchDeleteSecurityRolePermission", "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/BatchDeleteSecurityRolePermissionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Security Role Permission 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/UAM/TermsAndConditions/{id}": { "get": { "tags": [ "Terms And Conditions" ], "summary": "Get a Terms And Conditions 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 | TermsAndCondition->Code | string | |\r\n| isActive | TermsAndCondition->IsActive | boolean | |\r\n| createdByUserId | TermsAndCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TermsAndCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TermsAndCondition->CreatedByUser_FullName | string | |\r\n| createdOn | TermsAndCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | TermsAndCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TermsAndCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TermsAndCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TermsAndCondition->ModifiedOn | string | date-time |\r\n| version | TermsAndCondition->Version | integer | int32 |\r\n| permissionTreeId | TermsAndCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TermsAndCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TermsAndCondition->PermissionTree_Description | string | |\r\n| id | TermsAndCondition->Id | integer | int64 |\r\n| compulsory | TermsAndCondition->Compulsory | boolean | |\r\n| description | TermsAndCondition->Description | string | |\r\n| name | TermsAndCondition->Name | string | |\r\n| notes | TermsAndCondition->Notes | string | |\r\n| targetSiteId | TermsAndCondition->TargetSite_Id | integer | int64 |\r\n| targetSiteCode | TermsAndCondition->TargetSite_Code | string | |\r\n| targetSiteDescription | TermsAndCondition->TargetSite_Description | string | |\r\n", "operationId": "GetTermsAndCondition", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Terms And Conditions Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Terms And Conditions", "schema": { "$ref": "#/definitions/GetTermsAndConditionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Terms And Conditions" ], "summary": "Update an existing Terms And Conditions 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 | TermsAndCondition->Version | integer | int32 |\r\n| code | TermsAndCondition->Code | string | |\r\n| description | TermsAndCondition->Description | string | |\r\n| name | TermsAndCondition->Name | string | |\r\n| compulsory | TermsAndCondition->Compulsory | boolean | |\r\n| targetSiteId | TermsAndCondition->TargetSite_Id | integer | int64 |\r\n| notes | TermsAndCondition->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| 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 | <= 500 chars| |\r\n| name | Nullable | False | |\r\n| name | Min Length | >= 1 chars| |\r\n| name | Max Length | <= 200 chars| |\r\n| compulsory | Nullable | False | |\r\n\r\n", "operationId": "UpdateTermsAndCondition", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Terms And Conditions Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateTermsAndConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Terms And Conditions 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": [ "Terms And Conditions" ], "summary": "Delete an existing Terms And Conditions 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 | TermsAndCondition->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": "DeleteTermsAndCondition", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Terms And Conditions Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteTermsAndConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Terms And Conditions 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/UAM/TermsAndConditions": { "get": { "tags": [ "Terms And Conditions" ], "summary": "Get a collection of Terms And Conditions 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 | TermsAndCondition->Version | integer | int32 |\r\n| id | TermsAndCondition->Id | integer | int64 |\r\n| code | TermsAndCondition->Code | string | |\r\n| description | TermsAndCondition->Description | string | |\r\n| name | TermsAndCondition->Name | string | |\r\n| targetSiteCode | TermsAndCondition->TargetSite_Code | string | |\r\n| compulsory | TermsAndCondition->Compulsory | boolean | |\r\n", "operationId": "GetTermsAndConditionCollection", "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 Terms And Conditions collection", "schema": { "$ref": "#/definitions/GetTermsAndConditionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Terms And Conditions" ], "summary": "Create a new Terms And Conditions 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 | TermsAndCondition->Code | string | |\r\n| description | TermsAndCondition->Description | string | |\r\n| name | TermsAndCondition->Name | string | |\r\n| compulsory | TermsAndCondition->Compulsory | boolean | |\r\n| targetSiteId | TermsAndCondition->TargetSite_Id | integer | int64 |\r\n| permissionTreeId | TermsAndCondition->PermissionTree_Id | integer | int64 |\r\n| notes | TermsAndCondition->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| 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 | <= 500 chars| |\r\n| name | Required | True | |\r\n| name | Nullable | False | |\r\n| name | Min Length | >= 1 chars| |\r\n| name | Max Length | <= 200 chars| |\r\n| compulsory | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateTermsAndCondition", "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/CreateTermsAndConditionResourceActionRequest" } }, { "$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/UAM/TermsAndConditions/Lookups/LookupTermsAndConditionChangePermissionTree": { "get": { "tags": [ "Terms And Conditions" ], "summary": "Lookup the permission set for changing the Terms And Conditions.", "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": "LookupTermsAndConditionChangePermissionTree", "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/TermsAndConditionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/TermsAndConditions/Lookups/LookupTermsAndConditionInsertPermissionTree": { "get": { "tags": [ "Terms And Conditions" ], "summary": "Lookup the permission set for creating the Terms And Conditions.", "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": "LookupTermsAndConditionInsertPermissionTree", "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/TermsAndConditionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/TermsAndConditions/Lookups/LookupTermsAndConditionTargetSite": { "get": { "tags": [ "Terms And Conditions" ], "summary": "Lookup the Site for the Terms And Conditions.", "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 | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n", "operationId": "LookupTermsAndConditionTargetSite", "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 Site collection", "schema": { "$ref": "#/definitions/TermsAndConditionTargetSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/TermsAndConditions/Batch/{ids}": { "get": { "tags": [ "Terms And Conditions" ], "summary": "Get a collection of Terms And Conditions 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 | TermsAndCondition->Code | string | |\r\n| isActive | TermsAndCondition->IsActive | boolean | |\r\n| createdByUserId | TermsAndCondition->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TermsAndCondition->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TermsAndCondition->CreatedByUser_FullName | string | |\r\n| createdOn | TermsAndCondition->CreatedOn | string | date-time |\r\n| modifiedByUserId | TermsAndCondition->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TermsAndCondition->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TermsAndCondition->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TermsAndCondition->ModifiedOn | string | date-time |\r\n| version | TermsAndCondition->Version | integer | int32 |\r\n| permissionTreeId | TermsAndCondition->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TermsAndCondition->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TermsAndCondition->PermissionTree_Description | string | |\r\n| id | TermsAndCondition->Id | integer | int64 |\r\n| compulsory | TermsAndCondition->Compulsory | boolean | |\r\n| description | TermsAndCondition->Description | string | |\r\n| name | TermsAndCondition->Name | string | |\r\n| notes | TermsAndCondition->Notes | string | |\r\n| targetSiteId | TermsAndCondition->TargetSite_Id | integer | int64 |\r\n| targetSiteCode | TermsAndCondition->TargetSite_Code | string | |\r\n| targetSiteDescription | TermsAndCondition->TargetSite_Description | string | |\r\n", "operationId": "BatchGetTermsAndCondition", "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 Terms And Conditions 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 Terms And Conditions collection", "schema": { "$ref": "#/definitions/BatchGetTermsAndConditionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/TermsAndConditions/Batch": { "post": { "tags": [ "Terms And Conditions" ], "summary": "Create a new collection of Terms And Conditions 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 | TermsAndCondition->Code | string | |\r\n| description | TermsAndCondition->Description | string | |\r\n| name | TermsAndCondition->Name | string | |\r\n| compulsory | TermsAndCondition->Compulsory | boolean | |\r\n| targetSiteId | TermsAndCondition->TargetSite_Id | integer | int64 |\r\n| permissionTreeId | TermsAndCondition->PermissionTree_Id | integer | int64 |\r\n| notes | TermsAndCondition->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| 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 | <= 500 chars| |\r\n| name | Required | True | |\r\n| name | Nullable | False | |\r\n| name | Min Length | >= 1 chars| |\r\n| name | Max Length | <= 200 chars| |\r\n| compulsory | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateTermsAndCondition", "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/BatchCreateTermsAndConditionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Terms And Conditions 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": [ "Terms And Conditions" ], "summary": "Update a collection of existing Terms And Conditions 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 | TermsAndCondition->Id | integer | int64 |\r\n| version | TermsAndCondition->Version | integer | int32 |\r\n| code | TermsAndCondition->Code | string | |\r\n| description | TermsAndCondition->Description | string | |\r\n| name | TermsAndCondition->Name | string | |\r\n| compulsory | TermsAndCondition->Compulsory | boolean | |\r\n| targetSiteId | TermsAndCondition->TargetSite_Id | integer | int64 |\r\n| notes | TermsAndCondition->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| 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 | <= 500 chars| |\r\n| name | Nullable | False | |\r\n| name | Min Length | >= 1 chars| |\r\n| name | Max Length | <= 200 chars| |\r\n| compulsory | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateTermsAndCondition", "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/BatchUpdateTermsAndConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Terms And Conditions 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": [ "Terms And Conditions" ], "summary": "Delete a collection of existing Terms And Conditions 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 | TermsAndCondition->Id | integer | int64 |\r\n| version | TermsAndCondition->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": "BatchDeleteTermsAndCondition", "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/BatchDeleteTermsAndConditionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Terms And Conditions 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/UAM/TermsAndConditions/{id}/Active": { "patch": { "tags": [ "Terms And Conditions" ], "summary": "Change the IsActive status for an existing Terms And Conditions 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 | TermsAndCondition->Version | integer | int32 |\r\n| isActive | TermsAndCondition->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": "ChangeTermsAndConditionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Terms And Conditions Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTermsAndConditionIsActiveResourceActionRequest" } }, { "$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/UAM/TermsAndConditions/{id}/PermissionTree": { "patch": { "tags": [ "Terms And Conditions" ], "summary": "Change the PermissionTree for an existing Terms And Conditions 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 | TermsAndCondition->Version | integer | int32 |\r\n| permissionTreeId | TermsAndCondition->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": "ChangeTermsAndConditionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Terms And Conditions Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTermsAndConditionPermissionTreeResourceActionRequest" } }, { "$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/UAM/TermsAndConditions/Batch/Active": { "patch": { "tags": [ "Terms And Conditions" ], "summary": "Change the IsActive status for a collection of existing Terms And Conditions 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 | TermsAndCondition->Id | integer | int64 |\r\n| version | TermsAndCondition->Version | integer | int32 |\r\n| isActive | TermsAndCondition->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": "BatchChangeTermsAndConditionIsActive", "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/BatchChangeTermsAndConditionIsActiveResourceActionRequest" } }, { "$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/UAM/TermsAndConditions/Batch/PermissionTree": { "patch": { "tags": [ "Terms And Conditions" ], "summary": "Change the PermissionTree status for a collection of existing Terms And Conditions 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 | TermsAndCondition->Id | integer | int64 |\r\n| version | TermsAndCondition->Version | integer | int32 |\r\n| permissionTreeId | TermsAndCondition->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": "BatchChangeTermsAndConditionPermissionTree", "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/BatchChangeTermsAndConditionPermissionTreeResourceActionRequest" } }, { "$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/UAM/TermsAndConditions/OperationalRoles/{id}": { "get": { "tags": [ "Terms And Conditions Operational Role" ], "summary": "Get a Terms And Conditions Operational Role 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| isActive | TermsAndConditionOperationalRole->IsActive | boolean | |\r\n| createdByUserId | TermsAndConditionOperationalRole->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TermsAndConditionOperationalRole->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TermsAndConditionOperationalRole->CreatedByUser_FullName | string | |\r\n| createdOn | TermsAndConditionOperationalRole->CreatedOn | string | date-time |\r\n| modifiedByUserId | TermsAndConditionOperationalRole->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TermsAndConditionOperationalRole->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TermsAndConditionOperationalRole->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TermsAndConditionOperationalRole->ModifiedOn | string | date-time |\r\n| version | TermsAndConditionOperationalRole->Version | integer | int32 |\r\n| permissionTreeId | TermsAndConditionOperationalRole->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TermsAndConditionOperationalRole->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TermsAndConditionOperationalRole->PermissionTree_Description | string | |\r\n| id | TermsAndConditionOperationalRole->Id | integer | int64 |\r\n| notes | TermsAndConditionOperationalRole->Notes | string | |\r\n| operationalRoleId | TermsAndConditionOperationalRole->OperationalRole_Id | integer | int64 |\r\n| operationalRoleCode | TermsAndConditionOperationalRole->OperationalRole_Code | string | |\r\n| operationalRoleDescription | TermsAndConditionOperationalRole->OperationalRole_Description | string | |\r\n| sequenceNumber | TermsAndConditionOperationalRole->SequenceNumber | integer | int32 |\r\n| termsAndConditionId | TermsAndConditionOperationalRole->TermsAndCondition_Id | integer | int64 |\r\n| termsAndConditionCode | TermsAndConditionOperationalRole->TermsAndCondition_Code | string | |\r\n| termsAndConditionDescription | TermsAndConditionOperationalRole->TermsAndCondition_Description | string | |\r\n", "operationId": "GetTermsAndConditionOperationalRole", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Terms And Conditions Operational Role Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Terms And Conditions Operational Role", "schema": { "$ref": "#/definitions/GetTermsAndConditionOperationalRoleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Terms And Conditions Operational Role" ], "summary": "Update an existing Terms And Conditions Operational Role 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 | TermsAndConditionOperationalRole->Version | integer | int32 |\r\n| sequenceNumber | TermsAndConditionOperationalRole->SequenceNumber | integer | int32 |\r\n| notes | TermsAndConditionOperationalRole->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\r\n", "operationId": "UpdateTermsAndConditionOperationalRole", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Terms And Conditions Operational Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateTermsAndConditionOperationalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Terms And Conditions Operational Role 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": [ "Terms And Conditions Operational Role" ], "summary": "Delete an existing Terms And Conditions Operational Role 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 | TermsAndConditionOperationalRole->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": "DeleteTermsAndConditionOperationalRole", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Terms And Conditions Operational Role Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteTermsAndConditionOperationalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Terms And Conditions Operational Role 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/UAM/TermsAndConditions/OperationalRoles": { "get": { "tags": [ "Terms And Conditions Operational Role" ], "summary": "Get a collection of Terms And Conditions Operational Role 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 | TermsAndConditionOperationalRole->Version | integer | int32 |\r\n| id | TermsAndConditionOperationalRole->Id | integer | int64 |\r\n| termsAndConditionCode | TermsAndConditionOperationalRole->TermsAndCondition_Code | string | |\r\n| operationalRoleCode | TermsAndConditionOperationalRole->OperationalRole_Code | string | |\r\n| sequenceNumber | TermsAndConditionOperationalRole->SequenceNumber | integer | int32 |\r\n", "operationId": "GetTermsAndConditionOperationalRoleCollection", "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 Terms And Conditions Operational Role collection", "schema": { "$ref": "#/definitions/GetTermsAndConditionOperationalRoleCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Terms And Conditions Operational Role" ], "summary": "Create a new Terms And Conditions Operational Role 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| termsAndConditionId | TermsAndConditionOperationalRole->TermsAndCondition_Id | integer | int64 |\r\n| operationalRoleId | TermsAndConditionOperationalRole->OperationalRole_Id | integer | int64 |\r\n| sequenceNumber | TermsAndConditionOperationalRole->SequenceNumber | integer | int32 |\r\n| notes | TermsAndConditionOperationalRole->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| termsAndConditionId | Required | True | |\r\n| termsAndConditionId | Nullable | False | |\r\n| operationalRoleId | Required | True | |\r\n| operationalRoleId | Nullable | False | |\r\n\r\n", "operationId": "CreateTermsAndConditionOperationalRole", "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/CreateTermsAndConditionOperationalRoleResourceActionRequest" } }, { "$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/UAM/TermsAndConditions/{termsAndConditionId}/OperationalRoles": { "get": { "tags": [ "Terms And Conditions Operational Role" ], "summary": "Get a collection of Terms And Conditions Operational Role resources for the Terms And Conditions.", "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 | TermsAndConditionOperationalRole->Version | integer | int32 |\r\n| id | TermsAndConditionOperationalRole->Id | integer | int64 |\r\n| operationalRoleCode | TermsAndConditionOperationalRole->OperationalRole_Code | string | |\r\n| sequenceNumber | TermsAndConditionOperationalRole->SequenceNumber | integer | int32 |\r\n", "operationId": "GetTermsAndConditionOperationalRoleForTermsAndConditionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "termsAndConditionId", "in": "path", "required": true, "description": "Terms And Conditions 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 Terms And Conditions Operational Role collection", "schema": { "$ref": "#/definitions/GetTermsAndConditionOperationalRoleForTermsAndConditionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/TermsAndConditions/OperationalRoles/Lookups/LookupTermsAndConditionOperationalRoleTermsAndCondition": { "get": { "tags": [ "Terms And Conditions Operational Role" ], "summary": "Lookup the Terms And Conditions for the Terms And Conditions Operational Role.", "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 | TermsAndCondition->Id | integer | int64 |\r\n| code | TermsAndCondition->Code | string | |\r\n| description | TermsAndCondition->Description | string | |\r\n", "operationId": "LookupTermsAndConditionOperationalRoleTermsAndCondition", "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 Terms And Conditions collection", "schema": { "$ref": "#/definitions/TermsAndConditionOperationalRoleTermsAndConditionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/TermsAndConditions/OperationalRoles/Lookups/LookupTermsAndConditionOperationalRoleOperationalRole": { "get": { "tags": [ "Terms And Conditions Operational Role" ], "summary": "Lookup the Operational Role for the Terms And Conditions Operational Role.", "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 | OperationalRole->Id | integer | int64 |\r\n| code | OperationalRole->Code | string | |\r\n| description | OperationalRole->Description | string | |\r\n", "operationId": "LookupTermsAndConditionOperationalRoleOperationalRole", "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 Operational Role collection", "schema": { "$ref": "#/definitions/TermsAndConditionOperationalRoleLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/TermsAndConditions/OperationalRoles/Batch/{ids}": { "get": { "tags": [ "Terms And Conditions Operational Role" ], "summary": "Get a collection of Terms And Conditions Operational Role 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| isActive | TermsAndConditionOperationalRole->IsActive | boolean | |\r\n| createdByUserId | TermsAndConditionOperationalRole->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TermsAndConditionOperationalRole->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TermsAndConditionOperationalRole->CreatedByUser_FullName | string | |\r\n| createdOn | TermsAndConditionOperationalRole->CreatedOn | string | date-time |\r\n| modifiedByUserId | TermsAndConditionOperationalRole->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TermsAndConditionOperationalRole->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TermsAndConditionOperationalRole->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TermsAndConditionOperationalRole->ModifiedOn | string | date-time |\r\n| version | TermsAndConditionOperationalRole->Version | integer | int32 |\r\n| permissionTreeId | TermsAndConditionOperationalRole->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TermsAndConditionOperationalRole->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TermsAndConditionOperationalRole->PermissionTree_Description | string | |\r\n| id | TermsAndConditionOperationalRole->Id | integer | int64 |\r\n| notes | TermsAndConditionOperationalRole->Notes | string | |\r\n| operationalRoleId | TermsAndConditionOperationalRole->OperationalRole_Id | integer | int64 |\r\n| operationalRoleCode | TermsAndConditionOperationalRole->OperationalRole_Code | string | |\r\n| operationalRoleDescription | TermsAndConditionOperationalRole->OperationalRole_Description | string | |\r\n| sequenceNumber | TermsAndConditionOperationalRole->SequenceNumber | integer | int32 |\r\n| termsAndConditionId | TermsAndConditionOperationalRole->TermsAndCondition_Id | integer | int64 |\r\n| termsAndConditionCode | TermsAndConditionOperationalRole->TermsAndCondition_Code | string | |\r\n| termsAndConditionDescription | TermsAndConditionOperationalRole->TermsAndCondition_Description | string | |\r\n", "operationId": "BatchGetTermsAndConditionOperationalRole", "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 Terms And Conditions Operational Role 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 Terms And Conditions Operational Role collection", "schema": { "$ref": "#/definitions/BatchGetTermsAndConditionOperationalRoleResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/TermsAndConditions/OperationalRoles/Batch": { "post": { "tags": [ "Terms And Conditions Operational Role" ], "summary": "Create a new collection of Terms And Conditions Operational Role 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| termsAndConditionId | TermsAndConditionOperationalRole->TermsAndCondition_Id | integer | int64 |\r\n| operationalRoleId | TermsAndConditionOperationalRole->OperationalRole_Id | integer | int64 |\r\n| sequenceNumber | TermsAndConditionOperationalRole->SequenceNumber | integer | int32 |\r\n| notes | TermsAndConditionOperationalRole->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| termsAndConditionId | Required | True | |\r\n| termsAndConditionId | Nullable | False | |\r\n| operationalRoleId | Required | True | |\r\n| operationalRoleId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateTermsAndConditionOperationalRole", "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/BatchCreateTermsAndConditionOperationalRoleRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Terms And Conditions Operational Role 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": [ "Terms And Conditions Operational Role" ], "summary": "Update a collection of existing Terms And Conditions Operational Role 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 | TermsAndConditionOperationalRole->Id | integer | int64 |\r\n| version | TermsAndConditionOperationalRole->Version | integer | int32 |\r\n| sequenceNumber | TermsAndConditionOperationalRole->SequenceNumber | integer | int32 |\r\n| notes | TermsAndConditionOperationalRole->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\r\n", "operationId": "BatchUpdateTermsAndConditionOperationalRole", "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/BatchUpdateTermsAndConditionOperationalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Terms And Conditions Operational Role 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": [ "Terms And Conditions Operational Role" ], "summary": "Delete a collection of existing Terms And Conditions Operational Role 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 | TermsAndConditionOperationalRole->Id | integer | int64 |\r\n| version | TermsAndConditionOperationalRole->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": "BatchDeleteTermsAndConditionOperationalRole", "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/BatchDeleteTermsAndConditionOperationalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Terms And Conditions Operational Role 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/UAM/TermsAndConditions/OperationalRoles/{id}/Active": { "patch": { "tags": [ "Terms And Conditions Operational Role" ], "summary": "Change the IsActive status for an existing Terms And Conditions Operational Role 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 | TermsAndConditionOperationalRole->Version | integer | int32 |\r\n| isActive | TermsAndConditionOperationalRole->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": "ChangeTermsAndConditionOperationalRoleIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Terms And Conditions Operational Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTermsAndConditionOperationalRoleIsActiveResourceActionRequest" } }, { "$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/UAM/TermsAndConditions/OperationalRoles/Batch/Active": { "patch": { "tags": [ "Terms And Conditions Operational Role" ], "summary": "Change the IsActive status for a collection of existing Terms And Conditions Operational Role 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 | TermsAndConditionOperationalRole->Id | integer | int64 |\r\n| version | TermsAndConditionOperationalRole->Version | integer | int32 |\r\n| isActive | TermsAndConditionOperationalRole->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": "BatchChangeTermsAndConditionOperationalRoleIsActive", "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/BatchChangeTermsAndConditionOperationalRoleIsActiveResourceActionRequest" } }, { "$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/UAM/TermsAndConditions/Versions/{id}": { "get": { "tags": [ "Terms And Conditions Version" ], "summary": "Get a Terms And Conditions Version 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 | TermsAndConditionVersion->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TermsAndConditionVersion->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TermsAndConditionVersion->CreatedByUser_FullName | string | |\r\n| createdOn | TermsAndConditionVersion->CreatedOn | string | date-time |\r\n| modifiedByUserId | TermsAndConditionVersion->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TermsAndConditionVersion->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TermsAndConditionVersion->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TermsAndConditionVersion->ModifiedOn | string | date-time |\r\n| version | TermsAndConditionVersion->Version | integer | int32 |\r\n| permissionTreeId | TermsAndConditionVersion->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TermsAndConditionVersion->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TermsAndConditionVersion->PermissionTree_Description | string | |\r\n| id | TermsAndConditionVersion->Id | integer | int64 |\r\n| content | TermsAndConditionVersion->Content | string | |\r\n| contentVersion | TermsAndConditionVersion->ContentVersion | integer | int32 |\r\n| isDefault | TermsAndConditionVersion->IsDefault | boolean | |\r\n| languageId | TermsAndConditionVersion->Language_Id | integer | int64 |\r\n| languageCode | TermsAndConditionVersion->Language_Code | string | |\r\n| languageDescription | TermsAndConditionVersion->Language_Description | string | |\r\n| notes | TermsAndConditionVersion->Notes | string | |\r\n| published | TermsAndConditionVersion->Published | boolean | |\r\n| publishedOn | TermsAndConditionVersion->PublishedOn | string | date-time |\r\n| termsAndConditionId | TermsAndConditionVersion->TermsAndCondition_Id | integer | int64 |\r\n| termsAndConditionCode | TermsAndConditionVersion->TermsAndCondition_Code | string | |\r\n| termsAndConditionDescription | TermsAndConditionVersion->TermsAndCondition_Description | string | |\r\n", "operationId": "GetTermsAndConditionVersion", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Terms And Conditions Version Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Terms And Conditions Version", "schema": { "$ref": "#/definitions/GetTermsAndConditionVersionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Terms And Conditions Version" ], "summary": "Update an existing Terms And Conditions Version 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 | TermsAndConditionVersion->Version | integer | int32 |\r\n| content | TermsAndConditionVersion->Content | string | |\r\n| notes | TermsAndConditionVersion->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| content | Nullable | False | TermsAndConditionVersion->Published eq true |\r\n| content | Read-only | True | TermsAndConditionVersion->Published eq true |\r\n\r\n", "operationId": "UpdateTermsAndConditionVersion", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Terms And Conditions Version Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateTermsAndConditionVersionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Terms And Conditions Version 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": [ "Terms And Conditions Version" ], "summary": "Delete an existing Terms And Conditions Version 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 | TermsAndConditionVersion->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": "DeleteTermsAndConditionVersion", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Terms And Conditions Version Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteTermsAndConditionVersionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Terms And Conditions Version 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/UAM/TermsAndConditions/Versions": { "get": { "tags": [ "Terms And Conditions Version" ], "summary": "Get a collection of Terms And Conditions Version 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 | TermsAndConditionVersion->Version | integer | int32 |\r\n| id | TermsAndConditionVersion->Id | integer | int64 |\r\n| contentVersion | TermsAndConditionVersion->ContentVersion | integer | int32 |\r\n| isDefault | TermsAndConditionVersion->IsDefault | boolean | |\r\n| published | TermsAndConditionVersion->Published | boolean | |\r\n| publishedOn | TermsAndConditionVersion->PublishedOn | string | date-time |\r\n| termsAndConditionId | TermsAndConditionVersion->TermsAndCondition_Id | integer | int64 |\r\n| termsAndConditionCode | TermsAndConditionVersion->TermsAndCondition_Code | string | |\r\n| termsAndConditionName | TermsAndConditionVersion->TermsAndCondition_Name | string | |\r\n| termsAndConditionDescription | TermsAndConditionVersion->TermsAndCondition_Description | string | |\r\n| languageId | TermsAndConditionVersion->Language_Id | integer | int64 |\r\n| languageCode | TermsAndConditionVersion->Language_Code | string | |\r\n| languageDescription | TermsAndConditionVersion->Language_Description | string | |\r\n", "operationId": "GetTermsAndConditionVersionCollection", "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 Terms And Conditions Version collection", "schema": { "$ref": "#/definitions/GetTermsAndConditionVersionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Terms And Conditions Version" ], "summary": "Create a new Terms And Conditions Version 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| termsAndConditionId | TermsAndConditionVersion->TermsAndCondition_Id | integer | int64 |\r\n| languageId | TermsAndConditionVersion->Language_Id | integer | int64 |\r\n| notes | TermsAndConditionVersion->Notes | string | |\r\n| content | TermsAndConditionVersion->Content | 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| termsAndConditionId | Required | True | |\r\n| termsAndConditionId | Nullable | False | |\r\n| languageId | Required | True | |\r\n| languageId | Nullable | False | |\r\n| content | Required | True | |\r\n| content | Nullable | False | |\r\n\r\n", "operationId": "CreateTermsAndConditionVersion", "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/CreateTermsAndConditionVersionResourceActionRequest" } }, { "$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/UAM/TermsAndConditions/{termsAndConditionId}/Versions": { "get": { "tags": [ "Terms And Conditions Version" ], "summary": "Get a collection of Terms And Conditions Version resources for the Terms And Conditions", "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 | TermsAndConditionVersion->Version | integer | int32 |\r\n| id | TermsAndConditionVersion->Id | integer | int64 |\r\n| contentVersion | TermsAndConditionVersion->ContentVersion | integer | int32 |\r\n| isDefault | TermsAndConditionVersion->IsDefault | boolean | |\r\n| published | TermsAndConditionVersion->Published | boolean | |\r\n| publishedOn | TermsAndConditionVersion->PublishedOn | string | date-time |\r\n| termsAndConditionId | TermsAndConditionVersion->TermsAndCondition_Id | integer | int64 |\r\n| termsAndConditionCode | TermsAndConditionVersion->TermsAndCondition_Code | string | |\r\n| termsAndConditionName | TermsAndConditionVersion->TermsAndCondition_Name | string | |\r\n| termsAndConditionDescription | TermsAndConditionVersion->TermsAndCondition_Description | string | |\r\n| languageId | TermsAndConditionVersion->Language_Id | integer | int64 |\r\n| languageCode | TermsAndConditionVersion->Language_Code | string | |\r\n| languageDescription | TermsAndConditionVersion->Language_Description | string | |\r\n", "operationId": "GetTermsAndConditionVersionForTermsAndConditionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "termsAndConditionId", "in": "path", "required": true, "description": "Terms And Conditions 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 Terms And Conditions Version collection", "schema": { "$ref": "#/definitions/GetTermsAndConditionVersionForTermsAndConditionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/TermsAndConditions/Versions/Lookups/LookupTermsAndConditionVersionLanguage": { "get": { "tags": [ "Terms And Conditions Version" ], "summary": "Lookup the Language for the Terms And Conditions Version.", "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 | Language->Id | integer | int64 |\r\n| code | Language->Code | string | |\r\n| description | Language->Description | string | |\r\n", "operationId": "LookupTermsAndConditionVersionLanguage", "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 Language collection", "schema": { "$ref": "#/definitions/TermsAndConditionVersionLanguageLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/TermsAndConditions/Versions/Lookups/LookupTermsAndConditionVersionTermsAndCondition": { "get": { "tags": [ "Terms And Conditions Version" ], "summary": "Lookup the Terms And Conditions for the Terms And Conditions Version.", "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 | TermsAndCondition->Id | integer | int64 |\r\n| code | TermsAndCondition->Code | string | |\r\n| description | TermsAndCondition->Description | string | |\r\n", "operationId": "LookupTermsAndConditionVersionTermsAndCondition", "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 Terms And Conditions collection", "schema": { "$ref": "#/definitions/TermsAndConditionVersionTermsAndConditionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/TermsAndConditions/Versions/Batch/{ids}": { "get": { "tags": [ "Terms And Conditions Version" ], "summary": "Get a collection of Terms And Conditions Version 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 | TermsAndConditionVersion->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TermsAndConditionVersion->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TermsAndConditionVersion->CreatedByUser_FullName | string | |\r\n| createdOn | TermsAndConditionVersion->CreatedOn | string | date-time |\r\n| modifiedByUserId | TermsAndConditionVersion->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TermsAndConditionVersion->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TermsAndConditionVersion->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TermsAndConditionVersion->ModifiedOn | string | date-time |\r\n| version | TermsAndConditionVersion->Version | integer | int32 |\r\n| permissionTreeId | TermsAndConditionVersion->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TermsAndConditionVersion->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TermsAndConditionVersion->PermissionTree_Description | string | |\r\n| id | TermsAndConditionVersion->Id | integer | int64 |\r\n| content | TermsAndConditionVersion->Content | string | |\r\n| contentVersion | TermsAndConditionVersion->ContentVersion | integer | int32 |\r\n| isDefault | TermsAndConditionVersion->IsDefault | boolean | |\r\n| languageId | TermsAndConditionVersion->Language_Id | integer | int64 |\r\n| languageCode | TermsAndConditionVersion->Language_Code | string | |\r\n| languageDescription | TermsAndConditionVersion->Language_Description | string | |\r\n| notes | TermsAndConditionVersion->Notes | string | |\r\n| published | TermsAndConditionVersion->Published | boolean | |\r\n| publishedOn | TermsAndConditionVersion->PublishedOn | string | date-time |\r\n| termsAndConditionId | TermsAndConditionVersion->TermsAndCondition_Id | integer | int64 |\r\n| termsAndConditionCode | TermsAndConditionVersion->TermsAndCondition_Code | string | |\r\n| termsAndConditionDescription | TermsAndConditionVersion->TermsAndCondition_Description | string | |\r\n", "operationId": "BatchGetTermsAndConditionVersion", "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 Terms And Conditions Version 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 Terms And Conditions Version collection", "schema": { "$ref": "#/definitions/BatchGetTermsAndConditionVersionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/TermsAndConditions/Versions/Batch": { "post": { "tags": [ "Terms And Conditions Version" ], "summary": "Create a new collection of Terms And Conditions Version 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| termsAndConditionId | TermsAndConditionVersion->TermsAndCondition_Id | integer | int64 |\r\n| languageId | TermsAndConditionVersion->Language_Id | integer | int64 |\r\n| notes | TermsAndConditionVersion->Notes | string | |\r\n| content | TermsAndConditionVersion->Content | 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| termsAndConditionId | Required | True | |\r\n| termsAndConditionId | Nullable | False | |\r\n| languageId | Required | True | |\r\n| languageId | Nullable | False | |\r\n| content | Required | True | |\r\n| content | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateTermsAndConditionVersion", "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/BatchCreateTermsAndConditionVersionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Terms And Conditions Version 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": [ "Terms And Conditions Version" ], "summary": "Update a collection of existing Terms And Conditions Version 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 | TermsAndConditionVersion->Id | integer | int64 |\r\n| version | TermsAndConditionVersion->Version | integer | int32 |\r\n| published | TermsAndConditionVersion->Published | boolean | |\r\n| publishedOn | TermsAndConditionVersion->PublishedOn | string | date-time |\r\n| isDefault | TermsAndConditionVersion->IsDefault | boolean | |\r\n| content | TermsAndConditionVersion->Content | string | |\r\n| notes | TermsAndConditionVersion->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| published | Nullable | False | |\r\n| isDefault | Nullable | False | |\r\n| content | Nullable | False | TermsAndConditionVersion->Published eq true |\r\n| content | Read-only | True | TermsAndConditionVersion->Published eq true |\r\n\r\n", "operationId": "BatchUpdateTermsAndConditionVersion", "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/BatchUpdateTermsAndConditionVersionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Terms And Conditions Version 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": [ "Terms And Conditions Version" ], "summary": "Delete a collection of existing Terms And Conditions Version 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 | TermsAndConditionVersion->Id | integer | int64 |\r\n| version | TermsAndConditionVersion->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": "BatchDeleteTermsAndConditionVersion", "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/BatchDeleteTermsAndConditionVersionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Terms And Conditions Version 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/UAM/TermsAndConditions/Versions/Publish/{termsAndConditionVersionIds}": { "post": { "tags": [ "Terms And Conditions Version" ], "summary": "Publish Terms And Conditions Version", "description": "", "operationId": "PublishTermsAndConditionVersion", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "termsAndConditionVersionIds", "in": "path", "required": true, "description": "A comma separated list of Terms And Conditions Version id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "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/UAM/Users/{id}": { "get": { "tags": [ "User" ], "summary": "Get a User 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 | User->Code | string | |\r\n| isActive | User->IsActive | boolean | |\r\n| createdByUserId | User->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | User->CreatedByUser_Code | string | |\r\n| createdByUserFullName | User->CreatedByUser_FullName | string | |\r\n| createdOn | User->CreatedOn | string | date-time |\r\n| modifiedByUserId | User->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | User->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | User->ModifiedByUser_FullName | string | |\r\n| modifiedOn | User->ModifiedOn | string | date-time |\r\n| version | User->Version | integer | int32 |\r\n| permissionTreeId | User->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | User->PermissionTree_Code | string | |\r\n| permissionTreeDescription | User->PermissionTree_Description | string | |\r\n| siteId | User->Site_Id | integer | int64 |\r\n| siteCode | User->Site_Code | string | |\r\n| siteDescription | User->Site_Description | string | |\r\n| id | User->Id | integer | int64 |\r\n| associatedStaffMemberId | User->AssociatedStaffMember_Id | integer | int64 |\r\n| associatedStaffMemberCode | User->AssociatedStaffMember_Code | string | |\r\n| associatedStaffMemberContactDetailId | User->AssociatedStaffMember_ContactDetailId | integer | int64 |\r\n| associatedStaffMemberContactDetailFirstName | User->AssociatedStaffMember_ContactDetailFirstName | string | |\r\n| associatedStaffMemberContactDetailLastName | User->AssociatedStaffMember_ContactDetailLastName | string | |\r\n| associatedSupplierId | User->AssociatedSupplier_Id | integer | int64 |\r\n| associatedSupplierCode | User->AssociatedSupplier_Code | string | |\r\n| associatedSupplierDescription | User->AssociatedSupplier_Description | string | |\r\n| contentTranslate | User->ContentTranslate | boolean | |\r\n| dateFormat | User->DateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| dateSeparator | User->DateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| defaultLanguageId | User->DefaultLanguage_Id | integer | int64 |\r\n| defaultLanguageCode | User->DefaultLanguage_Code | string | |\r\n| defaultLanguageDescription | User->DefaultLanguage_Description | string | |\r\n| fullName | User->FullName | string | |\r\n| isAdministrator | User->IsAdministrator | boolean | |\r\n| notes | User->Notes | string | |\r\n| operationalRoleRule | User->OperationalRoleRule | string (Allowed values: [Strict, Limited, Open]) | enum |\r\n| permissionsChanged | User->PermissionsChanged | boolean | |\r\n| primaryEmail | User->PrimaryEmail | string | email |\r\n| receiveSystemAlerts | User->ReceiveSystemAlerts | boolean | |\r\n| timeFormat | User->TimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| userAuthenticationStatusId | User->UserAuthenticationStatusId | integer | int64 |\r\n| isAuthenticationDisabled | User->IsAuthenticationDisabled | boolean | |\r\n| disabledAuthenticationIds | User->DisabledAuthenticationIds | array | array |\r\n", "operationId": "GetUser", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User", "schema": { "$ref": "#/definitions/GetUserResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "User" ], "summary": "Update an existing User 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 | User->Version | integer | int32 |\r\n| code | User->Code | string | |\r\n| fullName | User->FullName | string | |\r\n| primaryEmail | User->PrimaryEmail | string | email |\r\n| operationalRoleRule | User->OperationalRoleRule | string (Allowed values: [Strict, Limited, Open]) | enum |\r\n| siteId | User->Site_Id | integer | int64 |\r\n| defaultLanguageId | User->DefaultLanguage_Id | integer | int64 |\r\n| associatedStaffMemberId | User->AssociatedStaffMember_Id | integer | int64 |\r\n| associatedSupplierId | User->AssociatedSupplier_Id | integer | int64 |\r\n| contentTranslate | User->ContentTranslate | boolean | |\r\n| dateFormat | User->DateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| dateSeparator | User->DateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| timeFormat | User->TimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| notes | User->Notes | string | |\r\n| receiveSystemAlerts | User->ReceiveSystemAlerts | 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| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| fullName | Nullable | False | |\r\n| fullName | Min Length | >= 1 chars| |\r\n| fullName | Max Length | <= 200 chars| |\r\n| primaryEmail | Nullable | False | |\r\n| primaryEmail | Min Length | >= 1 chars| |\r\n| primaryEmail | Max Length | <= 255 chars| |\r\n| operationalRoleRule | Nullable | False | |\r\n\r\n", "operationId": "UpdateUser", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateUserResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User 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": [ "User" ], "summary": "Delete an existing User 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 | User->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": "DeleteUser", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteUserResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User 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/UAM/Users": { "get": { "tags": [ "User" ], "summary": "Get a collection of User 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 | User->Version | integer | int32 |\r\n| id | User->Id | integer | int64 |\r\n| code | User->Code | string | |\r\n| fullName | User->FullName | string | |\r\n| primaryEmail | User->PrimaryEmail | string | email |\r\n| permissionsChanged | User->PermissionsChanged | boolean | |\r\n| isActive | User->IsActive | boolean | |\r\n| isAdministrator | User->IsAdministrator | boolean | |\r\n", "operationId": "GetUserCollection", "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 User collection", "schema": { "$ref": "#/definitions/GetUserCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "User" ], "summary": "Create a new User 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 | User->PermissionTree_Id | integer | int64 |\r\n| code | User->Code | string | |\r\n| fullName | User->FullName | string | |\r\n| primaryEmail | User->PrimaryEmail | string | email |\r\n| isAdministrator | User->IsAdministrator | boolean | |\r\n| operationalRoleRule | User->OperationalRoleRule | string (Allowed values: [Strict, Limited, Open]) | enum |\r\n| siteId | User->Site_Id | integer | int64 |\r\n| defaultLanguageId | User->DefaultLanguage_Id | integer | int64 |\r\n| associatedStaffMemberId | User->AssociatedStaffMember_Id | integer | int64 |\r\n| associatedSupplierId | User->AssociatedSupplier_Id | integer | int64 |\r\n| contentTranslate | User->ContentTranslate | boolean | |\r\n| dateFormat | User->DateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| dateSeparator | User->DateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| timeFormat | User->TimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| notes | User->Notes | string | |\r\n| receiveSystemAlerts | User->ReceiveSystemAlerts | 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| permissionTreeId | System Generated | true | If no value specified |\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| fullName | Required | True | |\r\n| fullName | Nullable | False | |\r\n| fullName | Min Length | >= 1 chars| |\r\n| fullName | Max Length | <= 200 chars| |\r\n| primaryEmail | Required | True | |\r\n| primaryEmail | Nullable | False | |\r\n| primaryEmail | Min Length | >= 1 chars| |\r\n| primaryEmail | Max Length | <= 255 chars| |\r\n| isAdministrator | Required | True | |\r\n| isAdministrator | Nullable | False | |\r\n| operationalRoleRule | Required | True | |\r\n| operationalRoleRule | Nullable | False | |\r\n\r\n", "operationId": "CreateUser", "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/CreateUserResourceActionRequest" } }, { "$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/UAM/Users/{userId}/UserSiteApprovalRoleForUser": { "get": { "tags": [ "User" ], "summary": "Get a collection of User Site Approval Role resources for the User.", "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 | UserSiteApprovalRole->Id | integer | int64 |\r\n| version | UserSiteApprovalRole->Version | integer | int32 |\r\n| allSites | UserSiteApprovalRole->AllSites | boolean | |\r\n| permissionTreeCode | UserSiteApprovalRole->PermissionTree_Code | string | |\r\n| approvalRoleCode | UserSiteApprovalRole->ApprovalRole_Code | string | |\r\n| approvalRoleDescription | UserSiteApprovalRole->ApprovalRole_Description | string | |\r\n", "operationId": "GetUserSiteApprovalRoleForUserCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "userId", "in": "path", "required": true, "description": "User 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 User collection", "schema": { "$ref": "#/definitions/GetUserSiteApprovalRoleForUserCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Lookups/LookupAssociatedStaffMember": { "get": { "tags": [ "User" ], "summary": "Lookup the Resource for the User.", "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 | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| contactDetailFirstName | Resource->ContactDetailFirstName | string | |\r\n| contactDetailLastName | Resource->ContactDetailLastName | string | |\r\n", "operationId": "LookupAssociatedStaffMember", "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 Resource collection", "schema": { "$ref": "#/definitions/AssociatedStaffMemberLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Lookups/LookupAssociatedSupplier": { "get": { "tags": [ "User" ], "summary": "Lookup the Supplier for the User.", "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 | Supplier->Id | integer | int64 |\r\n| code | Supplier->Code | string | |\r\n| description | Supplier->Description | string | |\r\n", "operationId": "LookupAssociatedSupplier", "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 Supplier collection", "schema": { "$ref": "#/definitions/AssociatedSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Lookups/LookupDefaultLanguage": { "get": { "tags": [ "User" ], "summary": "Lookup the Language for the User.", "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 | Language->Id | integer | int64 |\r\n| code | Language->Code | string | |\r\n| description | Language->Description | string | |\r\n", "operationId": "LookupDefaultLanguage", "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 Language collection", "schema": { "$ref": "#/definitions/DefaultLanguageLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Lookups/LookupSite": { "get": { "tags": [ "User" ], "summary": "Lookup the Site for the User.", "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 | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n", "operationId": "LookupSite", "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 Site collection", "schema": { "$ref": "#/definitions/SiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Lookups/LookupUserChangePermissionTree": { "get": { "tags": [ "User" ], "summary": "Lookup the permission set for changing the User.", "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": "LookupUserChangePermissionTree", "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/UserChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Lookups/LookupUserInsertPermissionTree": { "get": { "tags": [ "User" ], "summary": "Lookup the permission set for creating the User.", "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": "LookupUserInsertPermissionTree", "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/UserInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Batch/{ids}": { "get": { "tags": [ "User" ], "summary": "Get a collection of User 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 | User->Code | string | |\r\n| isActive | User->IsActive | boolean | |\r\n| createdByUserId | User->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | User->CreatedByUser_Code | string | |\r\n| createdByUserFullName | User->CreatedByUser_FullName | string | |\r\n| createdOn | User->CreatedOn | string | date-time |\r\n| modifiedByUserId | User->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | User->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | User->ModifiedByUser_FullName | string | |\r\n| modifiedOn | User->ModifiedOn | string | date-time |\r\n| version | User->Version | integer | int32 |\r\n| permissionTreeId | User->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | User->PermissionTree_Code | string | |\r\n| permissionTreeDescription | User->PermissionTree_Description | string | |\r\n| siteId | User->Site_Id | integer | int64 |\r\n| siteCode | User->Site_Code | string | |\r\n| siteDescription | User->Site_Description | string | |\r\n| id | User->Id | integer | int64 |\r\n| associatedStaffMemberId | User->AssociatedStaffMember_Id | integer | int64 |\r\n| associatedStaffMemberCode | User->AssociatedStaffMember_Code | string | |\r\n| associatedStaffMemberContactDetailId | User->AssociatedStaffMember_ContactDetailId | integer | int64 |\r\n| associatedStaffMemberContactDetailFirstName | User->AssociatedStaffMember_ContactDetailFirstName | string | |\r\n| associatedStaffMemberContactDetailLastName | User->AssociatedStaffMember_ContactDetailLastName | string | |\r\n| associatedSupplierId | User->AssociatedSupplier_Id | integer | int64 |\r\n| associatedSupplierCode | User->AssociatedSupplier_Code | string | |\r\n| associatedSupplierDescription | User->AssociatedSupplier_Description | string | |\r\n| contentTranslate | User->ContentTranslate | boolean | |\r\n| dateFormat | User->DateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| dateSeparator | User->DateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| defaultLanguageId | User->DefaultLanguage_Id | integer | int64 |\r\n| defaultLanguageCode | User->DefaultLanguage_Code | string | |\r\n| defaultLanguageDescription | User->DefaultLanguage_Description | string | |\r\n| fullName | User->FullName | string | |\r\n| isAdministrator | User->IsAdministrator | boolean | |\r\n| notes | User->Notes | string | |\r\n| operationalRoleRule | User->OperationalRoleRule | string (Allowed values: [Strict, Limited, Open]) | enum |\r\n| permissionsChanged | User->PermissionsChanged | boolean | |\r\n| primaryEmail | User->PrimaryEmail | string | email |\r\n| receiveSystemAlerts | User->ReceiveSystemAlerts | boolean | |\r\n| timeFormat | User->TimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| userAuthenticationStatusId | User->UserAuthenticationStatusId | integer | int64 |\r\n| isAuthenticationDisabled | User->IsAuthenticationDisabled | boolean | |\r\n| disabledAuthenticationIds | User->DisabledAuthenticationIds | array | array |\r\n", "operationId": "BatchGetUser", "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 User 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 User collection", "schema": { "$ref": "#/definitions/BatchGetUserResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Batch": { "post": { "tags": [ "User" ], "summary": "Create a new collection of User 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 | User->PermissionTree_Id | integer | int64 |\r\n| code | User->Code | string | |\r\n| fullName | User->FullName | string | |\r\n| primaryEmail | User->PrimaryEmail | string | email |\r\n| isAdministrator | User->IsAdministrator | boolean | |\r\n| operationalRoleRule | User->OperationalRoleRule | string (Allowed values: [Strict, Limited, Open]) | enum |\r\n| siteId | User->Site_Id | integer | int64 |\r\n| defaultLanguageId | User->DefaultLanguage_Id | integer | int64 |\r\n| associatedStaffMemberId | User->AssociatedStaffMember_Id | integer | int64 |\r\n| associatedSupplierId | User->AssociatedSupplier_Id | integer | int64 |\r\n| contentTranslate | User->ContentTranslate | boolean | |\r\n| dateFormat | User->DateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| dateSeparator | User->DateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| timeFormat | User->TimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| notes | User->Notes | string | |\r\n| receiveSystemAlerts | User->ReceiveSystemAlerts | 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| permissionTreeId | System Generated | true | If no value specified |\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| fullName | Required | True | |\r\n| fullName | Nullable | False | |\r\n| fullName | Min Length | >= 1 chars| |\r\n| fullName | Max Length | <= 200 chars| |\r\n| primaryEmail | Required | True | |\r\n| primaryEmail | Nullable | False | |\r\n| primaryEmail | Min Length | >= 1 chars| |\r\n| primaryEmail | Max Length | <= 255 chars| |\r\n| isAdministrator | Required | True | |\r\n| isAdministrator | Nullable | False | |\r\n| operationalRoleRule | Required | True | |\r\n| operationalRoleRule | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateUser", "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/BatchCreateUserResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - User 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": [ "User" ], "summary": "Update a collection of existing User 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 | User->Id | integer | int64 |\r\n| version | User->Version | integer | int32 |\r\n| code | User->Code | string | |\r\n| fullName | User->FullName | string | |\r\n| primaryEmail | User->PrimaryEmail | string | email |\r\n| operationalRoleRule | User->OperationalRoleRule | string (Allowed values: [Strict, Limited, Open]) | enum |\r\n| siteId | User->Site_Id | integer | int64 |\r\n| defaultLanguageId | User->DefaultLanguage_Id | integer | int64 |\r\n| associatedStaffMemberId | User->AssociatedStaffMember_Id | integer | int64 |\r\n| associatedSupplierId | User->AssociatedSupplier_Id | integer | int64 |\r\n| contentTranslate | User->ContentTranslate | boolean | |\r\n| dateFormat | User->DateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| dateSeparator | User->DateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| timeFormat | User->TimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| notes | User->Notes | string | |\r\n| receiveSystemAlerts | User->ReceiveSystemAlerts | 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| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| fullName | Nullable | False | |\r\n| fullName | Min Length | >= 1 chars| |\r\n| fullName | Max Length | <= 200 chars| |\r\n| primaryEmail | Nullable | False | |\r\n| primaryEmail | Min Length | >= 1 chars| |\r\n| primaryEmail | Max Length | <= 255 chars| |\r\n| operationalRoleRule | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateUser", "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/BatchUpdateUserResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User 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": [ "User" ], "summary": "Delete a collection of existing User 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 | User->Id | integer | int64 |\r\n| version | User->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": "BatchDeleteUser", "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/BatchDeleteUserResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User 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/UAM/Users/Batch/{ids}/CalculateUserPermissions": { "post": { "tags": [ "User" ], "summary": "Batch Calculate User Permissions", "description": "", "operationId": "BatchCalculateUserPermissions", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of User id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "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/UAM/Users/Batch/ChangeIsAdministrator": { "patch": { "tags": [ "User" ], "summary": "Batch Change Is Administrator Flag", "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 | ChangeUserIsAdministrator->Id | integer | int64 |\r\n| version | ChangeUserIsAdministrator->Version | integer | int32 |\r\n| isAdministrator | ChangeUserIsAdministrator->IsAdministrator | 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| isAdministrator | Required | True | |\r\n| isAdministrator | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeIsAdministrator", "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/BatchChangeUserIsAdministratorResourceActionRequest" } }, { "$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/UAM/Users/Batch/{userIds}/Invite": { "post": { "tags": [ "User" ], "summary": "Batch Invite Users", "description": "", "operationId": "BatchCreateUserInviteToken", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "userIds", "in": "path", "required": true, "description": "A comma separated list of User id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$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/UAM/Users/{id}/CalculateUserPermissions": { "post": { "tags": [ "User" ], "summary": "Calculate User Permissions", "description": "", "operationId": "CalculateUserPermissions", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ScheduleFrom" } ], "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/UAM/Users/AuthenticationStatus": { "post": { "tags": [ "User" ], "summary": "Change User Authentication Status", "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| isAuthenticationDisabled | ChangeUserAuthenticationStatus->IsAuthenticationDisabled | boolean | |\r\n| userIds | ChangeUserAuthenticationStatus->UserIds | array | array |\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\r\n", "operationId": "ChangeUserAuthenticationStatus", "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/ChangeUserAuthenticationStatusResourceActionRequest" } }, { "$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/UAM/Users/{id}/Active": { "patch": { "tags": [ "User" ], "summary": "Change the IsActive status for an existing User 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 | User->Version | integer | int32 |\r\n| isActive | User->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": "ChangeUserIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUserIsActiveResourceActionRequest" } }, { "$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/UAM/Users/{id}/ChangeIsAdministrator": { "patch": { "tags": [ "User" ], "summary": "Change Is Administrator Flag", "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 | ChangeUserIsAdministrator->Version | integer | int32 |\r\n| isAdministrator | ChangeUserIsAdministrator->IsAdministrator | 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| isAdministrator | Required | True | |\r\n| isAdministrator | Nullable | False | |\r\n\r\n", "operationId": "ChangeIsAdministrator", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUserIsAdministratorResourceActionRequest" } }, { "$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/UAM/Users/{id}/PermissionTree": { "patch": { "tags": [ "User" ], "summary": "Change the PermissionTree for an existing User 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 | User->Version | integer | int32 |\r\n| permissionTreeId | User->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": "ChangeUserPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUserPermissionTreeResourceActionRequest" } }, { "$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/UAM/Users/{id}/Site": { "patch": { "tags": [ "User" ], "summary": "Change the Site status for an existing User 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 | User->Version | integer | int32 |\r\n| siteId | User->Site_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| siteId | Required | True | |\r\n| siteId | Nullable | False | |\r\n\r\n", "operationId": "ChangeUserSite", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUserSiteResourceActionRequest" } }, { "$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/UAM/Users/{id}/Invite": { "post": { "tags": [ "User" ], "summary": "Create and send an e-mail invitation to activate the User", "description": "", "operationId": "CreateUserInviteToken", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Id", "format": "int64", "x-nullable": false }, { "$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/UAM/Users/Identity/Link": { "post": { "tags": [ "User" ], "summary": "Link the invited User to On Key", "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| inviteToken | LinkUserIdentity->InviteToken | string | |\r\n| accessToken | LinkUserIdentity->AccessToken | 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\r\n", "operationId": "LinkUserIdentity", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "identity", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/LinkUserIdentityResourceActionRequest" } }, { "$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/UAM/Users/Batch/Active": { "patch": { "tags": [ "User" ], "summary": "Change the IsActive status for a collection of existing User 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 | User->Id | integer | int64 |\r\n| version | User->Version | integer | int32 |\r\n| isActive | User->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": "BatchChangeUserIsActive", "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/BatchChangeUserIsActiveResourceActionRequest" } }, { "$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/UAM/Users/Batch/PermissionTree": { "patch": { "tags": [ "User" ], "summary": "Change the PermissionTree status for a collection of existing User 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 | User->Id | integer | int64 |\r\n| version | User->Version | integer | int32 |\r\n| permissionTreeId | User->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": "BatchChangeUserPermissionTree", "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/BatchChangeUserPermissionTreeResourceActionRequest" } }, { "$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/UAM/Users/Batch/Site": { "patch": { "tags": [ "User" ], "summary": "Change the Site status for a collection of existing User 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 | User->Id | integer | int64 |\r\n| version | User->Version | integer | int32 |\r\n| siteId | User->Site_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| siteId | Required | True | |\r\n| siteId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeUserSite", "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/BatchChangeUserSiteResourceActionRequest" } }, { "$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/UAM/Users/MatchBatch": { "patch": { "tags": [ "User" ], "summary": "Update a collection of existing User 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 | User->Id | integer | int64 |\r\n| version | User->Version | integer | int32 |\r\n| siteId | User->Site_Id | integer | int64 |\r\n| operationalRoleRule | User->OperationalRoleRule | string (Allowed values: [Strict, Limited, Open]) | enum |\r\n| contentTranslate | User->ContentTranslate | boolean | |\r\n| dateSeparator | User->DateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| dateFormat | User->DateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| timeFormat | User->TimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| receiveSystemAlerts | User->ReceiveSystemAlerts | boolean | |\r\n| defaultLanguageId | User->DefaultLanguage_Id | integer | int64 |\r\n| notes | User->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| operationalRoleRule | Nullable | False | |\r\n\r\n", "operationId": "MatchUpdateUser", "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/MatchUpdateUserResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User 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/UAM/Users/Attributes/{id}": { "get": { "tags": [ "User Attribute" ], "summary": "Get a User Attribute 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| userId | UserAttribute->User_Id | integer | int64 |\r\n| userCode | UserAttribute->User_Code | string | |\r\n| userFullName | UserAttribute->User_FullName | string | |\r\n| createdByUserId | UserAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | UserAttribute->CreatedOn | string | date-time |\r\n| isActive | UserAttribute->IsActive | boolean | |\r\n| modifiedByUserId | UserAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | UserAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UserAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UserAttribute->PermissionTree_Description | string | |\r\n| version | UserAttribute->Version | integer | int32 |\r\n| id | UserAttribute->Id | integer | int64 |\r\n| attributeId | UserAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | UserAttribute->Attribute_Code | string | |\r\n| attributeDescription | UserAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | UserAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | UserAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | UserAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | UserAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | UserAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | UserAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | UserAttribute->Notes | string | |\r\n| predefinedValueId | UserAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | UserAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | UserAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | UserAttribute->SequenceNumber | integer | int32 |\r\n| value | UserAttribute->Value | object | composite |\r\n", "operationId": "GetUserAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Attribute", "schema": { "$ref": "#/definitions/GetUserAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "User Attribute" ], "summary": "Update an existing User Attribute 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 | UserAttribute->Version | integer | int32 |\r\n| value | UserAttribute->Value | object | composite |\r\n| predefinedValueId | UserAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | UserAttribute->SequenceNumber | integer | int32 |\r\n| notes | UserAttribute->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| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "UpdateUserAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateUserAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Attribute 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": [ "User Attribute" ], "summary": "Delete an existing User Attribute 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 | UserAttribute->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": "DeleteUserAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteUserAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Attribute 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/UAM/Users/{userId}/Attributes": { "get": { "tags": [ "User Attribute" ], "summary": "Get a collection of User Attribute resources for the User.", "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 | UserAttribute->Id | integer | int64 |\r\n| version | UserAttribute->Version | integer | int32 |\r\n| sequenceNumber | UserAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | UserAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | UserAttribute->Attribute_Code | string | |\r\n| attributeDescription | UserAttribute->Attribute_Description | string | |\r\n| attributeDataType | UserAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | UserAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | UserAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | UserAttribute->PredefinedValue_Value | object | composite |\r\n| value | UserAttribute->Value | object | composite |\r\n| notes | UserAttribute->Notes | string | |\r\n| createdOn | UserAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | UserAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetUserAttributeCollectionForUser", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "userId", "in": "path", "required": true, "description": "User 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 User Attribute collection", "schema": { "$ref": "#/definitions/GetUserAttributeCollectionForUserResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Attributes": { "get": { "tags": [ "User Attribute" ], "summary": "Get a collection of User Attribute 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 | UserAttribute->Id | integer | int64 |\r\n| version | UserAttribute->Version | integer | int32 |\r\n| userId | UserAttribute->User_Id | integer | int64 |\r\n| userFullName | UserAttribute->User_FullName | string | |\r\n| userCode | UserAttribute->User_Code | string | |\r\n| sequenceNumber | UserAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | UserAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | UserAttribute->Attribute_Code | string | |\r\n| attributeDescription | UserAttribute->Attribute_Description | string | |\r\n| attributeDataType | UserAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | UserAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | UserAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | UserAttribute->PredefinedValue_Value | object | composite |\r\n| value | UserAttribute->Value | object | composite |\r\n| notes | UserAttribute->Notes | string | |\r\n| createdOn | UserAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | UserAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetUserAttributeCollection", "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 User Attribute collection", "schema": { "$ref": "#/definitions/GetUserAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "User Attribute" ], "summary": "Create a new User Attribute 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| userId | UserAttribute->User_Id | integer | int64 |\r\n| attributeId | UserAttribute->Attribute_Id | integer | int64 |\r\n| value | UserAttribute->Value | object | composite |\r\n| predefinedValueId | UserAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | UserAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | UserAttribute->SequenceNumber | integer | int32 |\r\n| notes | UserAttribute->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| userId | Required | True | |\r\n| userId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateUserAttribute", "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/CreateUserAttributeResourceActionRequest" } }, { "$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/UAM/Users/Attributes/Lookups/LookupUserAttributeAllowedValue": { "get": { "tags": [ "User Attribute" ], "summary": "Lookup the Attribute Allowed Value for the User Attribute.", "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 | AttributeAllowedValue->Id | integer | int64 |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n", "operationId": "LookupUserAttributeAllowedValue", "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 Attribute Allowed Value collection", "schema": { "$ref": "#/definitions/UserAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Attributes/Lookups/LookupUserAttribute": { "get": { "tags": [ "User Attribute" ], "summary": "User Attribute", "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 | Attribute->Id | integer | int64 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| allowAnyValue | Attribute->AllowAnyValue | boolean | |\r\n| dataType | Attribute->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| defaultValue | Attribute->DefaultValue | object | composite |\r\n| defaultAllowedValueId | Attribute->DefaultAllowedValue_Id | integer | int64 |\r\n| defaultAllowedValueValue | Attribute->DefaultAllowedValue_Value | object | composite |\r\n| defaultAllowedValueDescription | Attribute->DefaultAllowedValue_Description | string | |\r\n| explanation | Attribute->Explanation | string | |\r\n", "operationId": "LookupUserAttribute", "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 Attribute collection", "schema": { "$ref": "#/definitions/UserAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Attributes/Lookups/LookupUserAttributeChangePermissionTree": { "get": { "tags": [ "User Attribute" ], "summary": "Lookup the permission set for changing the User Attribute.", "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": "LookupUserAttributeChangePermissionTree", "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/UserAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Attributes/Lookups/LookupUserAttributeInsertPermissionTree": { "get": { "tags": [ "User Attribute" ], "summary": "Lookup the permission set for creating the User Attribute.", "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": "LookupUserAttributeInsertPermissionTree", "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/UserAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Attributes/Lookups/LookupUserAttributeUser": { "get": { "tags": [ "User Attribute" ], "summary": "Lookup the User Attribute for the User Attribute.", "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 | User->Id | integer | int64 |\r\n| code | User->Code | string | |\r\n| fullName | User->FullName | string | |\r\n", "operationId": "LookupUserAttributeUser", "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 User collection", "schema": { "$ref": "#/definitions/UserAttributeUserLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Attributes/Batch/{ids}": { "get": { "tags": [ "User Attribute" ], "summary": "Get a collection of User Attribute 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| userId | UserAttribute->User_Id | integer | int64 |\r\n| userCode | UserAttribute->User_Code | string | |\r\n| userFullName | UserAttribute->User_FullName | string | |\r\n| createdByUserId | UserAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | UserAttribute->CreatedOn | string | date-time |\r\n| isActive | UserAttribute->IsActive | boolean | |\r\n| modifiedByUserId | UserAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | UserAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UserAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UserAttribute->PermissionTree_Description | string | |\r\n| version | UserAttribute->Version | integer | int32 |\r\n| id | UserAttribute->Id | integer | int64 |\r\n| attributeId | UserAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | UserAttribute->Attribute_Code | string | |\r\n| attributeDescription | UserAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | UserAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | UserAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | UserAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | UserAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | UserAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | UserAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | UserAttribute->Notes | string | |\r\n| predefinedValueId | UserAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | UserAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | UserAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | UserAttribute->SequenceNumber | integer | int32 |\r\n| value | UserAttribute->Value | object | composite |\r\n", "operationId": "BatchGetUserAttribute", "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 User Attribute 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 User Attribute collection", "schema": { "$ref": "#/definitions/BatchGetUserAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Attributes/Batch": { "post": { "tags": [ "User Attribute" ], "summary": "Create a new collection of User Attribute 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| userId | UserAttribute->User_Id | integer | int64 |\r\n| attributeId | UserAttribute->Attribute_Id | integer | int64 |\r\n| value | UserAttribute->Value | object | composite |\r\n| predefinedValueId | UserAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | UserAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | UserAttribute->SequenceNumber | integer | int32 |\r\n| notes | UserAttribute->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| userId | Required | True | |\r\n| userId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateUserAttribute", "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/BatchCreateUserAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - User Attribute 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": [ "User Attribute" ], "summary": "Update a collection of existing User Attribute 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 | UserAttribute->Id | integer | int64 |\r\n| version | UserAttribute->Version | integer | int32 |\r\n| value | UserAttribute->Value | object | composite |\r\n| predefinedValueId | UserAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | UserAttribute->SequenceNumber | integer | int32 |\r\n| notes | UserAttribute->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| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "BatchUpdateUserAttribute", "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/BatchUpdateUserAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Attribute 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": [ "User Attribute" ], "summary": "Delete a collection of existing User Attribute 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 | UserAttribute->Id | integer | int64 |\r\n| version | UserAttribute->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": "BatchDeleteUserAttribute", "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/BatchDeleteUserAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Attribute 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/UAM/Users/Attributes/{id}/Active": { "patch": { "tags": [ "User Attribute" ], "summary": "Change the IsActive status for an existing User Attribute 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 | UserAttribute->Version | integer | int32 |\r\n| isActive | UserAttribute->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": "ChangeUserAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUserAttributeIsActiveResourceActionRequest" } }, { "$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/UAM/Users/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "User Attribute" ], "summary": "Change the PermissionTree for an existing User Attribute 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 | UserAttribute->Version | integer | int32 |\r\n| permissionTreeId | UserAttribute->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": "ChangeUserAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUserAttributePermissionTreeResourceActionRequest" } }, { "$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/UAM/Users/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "User Attribute" ], "summary": "Change the PermissionTree status for a collection of existing User Attribute 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 | UserAttribute->Id | integer | int64 |\r\n| version | UserAttribute->Version | integer | int32 |\r\n| permissionTreeId | UserAttribute->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": "BatchChangeUserAttributePermissionTree", "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/BatchChangeUserAttributePermissionTreeResourceActionRequest" } }, { "$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/UAM/Users/Attributes/Batch/Active": { "patch": { "tags": [ "User Attribute" ], "summary": "Change the IsActive status for a collection of existing User Attribute 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 | UserAttribute->Id | integer | int64 |\r\n| version | UserAttribute->Version | integer | int32 |\r\n| isActive | UserAttribute->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": "BatchChangeUserAttributeIsActive", "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/BatchChangeUserAttributeIsActiveResourceActionRequest" } }, { "$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/UAM/Users/Authentications/{id}": { "get": { "tags": [ "User Authentication" ], "summary": "Get a User Authentication 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| isActive | UserAuthentication->IsActive | boolean | |\r\n| createdByUserId | UserAuthentication->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserAuthentication->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserAuthentication->CreatedByUser_FullName | string | |\r\n| createdOn | UserAuthentication->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserAuthentication->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserAuthentication->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserAuthentication->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserAuthentication->ModifiedOn | string | date-time |\r\n| version | UserAuthentication->Version | integer | int32 |\r\n| id | UserAuthentication->Id | integer | int64 |\r\n| authProviderId | UserAuthentication->AuthProviderId | string | |\r\n| authProviderName | UserAuthentication->AuthProviderName | string | |\r\n| authProviderSubject | UserAuthentication->AuthProviderSubject | string | |\r\n| authProviderType | UserAuthentication->AuthProviderType | string (Allowed values: [AzureAD, ADFS, Ping, Okta, Auth0, Generic, Internal]) | enum |\r\n| notes | UserAuthentication->Notes | string | |\r\n| userId | UserAuthentication->User_Id | integer | int64 |\r\n| userCode | UserAuthentication->User_Code | string | |\r\n| userFullName | UserAuthentication->User_FullName | string | |\r\n", "operationId": "GetUserAuthentication", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Authentication Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Authentication", "schema": { "$ref": "#/definitions/GetUserAuthenticationResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "User Authentication" ], "summary": "Update an existing User Authentication 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 | UserAuthentication->Version | integer | int32 |\r\n| authProviderId | UserAuthentication->AuthProviderId | string | |\r\n| authProviderSubject | UserAuthentication->AuthProviderSubject | string | |\r\n| notes | UserAuthentication->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| authProviderId | Min Length | >= 1 chars| |\r\n| authProviderSubject | Min Length | >= 1 chars| |\r\n\r\n", "operationId": "UpdateUserAuthentication", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Authentication Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateUserAuthenticationResourceActionResponse" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Authentication 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": [ "User Authentication" ], "summary": "Delete an existing User Authentication 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 | UserAuthentication->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": "DeleteUserAuthentication", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Authentication Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteDeleteUserAuthenticationResourceActionResponse" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Authentication 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/UAM/Users/Authentications/LookupUserAuthenticationProvider": { "get": { "tags": [ "User Authentication" ], "summary": "Get a collection of User Authentication 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| providerKey | WebApplicationIdentityProviderConfig->ProviderKey | string | |\r\n| providerType | WebApplicationIdentityProviderConfig->ProviderType | string (Allowed values: [AzureAD, ADFS, Ping, Okta, Auth0, Generic, Internal]) | enum |\r\n| providerName | WebApplicationIdentityProviderConfig->ProviderName | string | |\r\n| clientId | WebApplicationIdentityProviderConfig->ClientId | string | |\r\n| authorizeEndpoint | WebApplicationIdentityProviderConfig->AuthorizeEndpoint | string | |\r\n| tokenRequestEndpoint | WebApplicationIdentityProviderConfig->TokenRequestEndpoint | string | |\r\n| tokenRequestBody | WebApplicationIdentityProviderConfig->TokenRequestBody | string | |\r\n| tokenRequestHeader | WebApplicationIdentityProviderConfig->TokenRequestHeader | string | |\r\n| signOutEndpoint | WebApplicationIdentityProviderConfig->SignOutEndpoint | string | |\r\n", "operationId": "LookupUserAuthenticationProvider", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Authentication collection", "schema": { "$ref": "#/definitions/UserAuthenticationProviderLookupResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Authentications": { "get": { "tags": [ "User Authentication" ], "summary": "Get a collection of User Authentication 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 | UserAuthentication->Id | integer | int64 |\r\n| version | UserAuthentication->Version | integer | int32 |\r\n| userCode | UserAuthentication->User_Code | string | |\r\n| userFullName | UserAuthentication->User_FullName | string | |\r\n| authProviderType | UserAuthentication->AuthProviderType | string (Allowed values: [AzureAD, ADFS, Ping, Okta, Auth0, Generic, Internal]) | enum |\r\n| authProviderSubject | UserAuthentication->AuthProviderSubject | string | |\r\n| authProviderName | UserAuthentication->AuthProviderName | string | |\r\n| authProviderId | UserAuthentication->AuthProviderId | string | |\r\n| notes | UserAuthentication->Notes | string | |\r\n| createdOn | UserAuthentication->CreatedOn | string | date-time |\r\n| modifiedOn | UserAuthentication->ModifiedOn | string | date-time |\r\n", "operationId": "GetUserAuthenticationCollection", "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 User Authentication collection", "schema": { "$ref": "#/definitions/GetUserAuthenticationCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "User Authentication" ], "summary": "Create a new User Authentication 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| userId | UserAuthentication->User_Id | integer | int64 |\r\n| authProviderId | UserAuthentication->AuthProviderId | string | |\r\n| authProviderSubject | UserAuthentication->AuthProviderSubject | string | |\r\n| notes | UserAuthentication->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| userId | Required | True | |\r\n| userId | Nullable | False | |\r\n| authProviderId | Required | True | |\r\n| authProviderId | Nullable | False | |\r\n| authProviderId | Min Length | >= 1 chars| |\r\n| authProviderSubject | Required | True | |\r\n| authProviderSubject | Nullable | False | |\r\n| authProviderSubject | Min Length | >= 1 chars| |\r\n\r\n", "operationId": "CreateUserAuthentication", "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/CreateUserAuthenticationResourceActionResponse" } }, { "$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/UAM/Users/{userId}/Authentications": { "get": { "tags": [ "User Authentication" ], "summary": "Get a collection of User Authentication resources for the User.", "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 | UserAuthentication->Id | integer | int64 |\r\n| version | UserAuthentication->Version | integer | int32 |\r\n| authProviderType | UserAuthentication->AuthProviderType | string (Allowed values: [AzureAD, ADFS, Ping, Okta, Auth0, Generic, Internal]) | enum |\r\n| authProviderSubject | UserAuthentication->AuthProviderSubject | string | |\r\n| authProviderName | UserAuthentication->AuthProviderName | string | |\r\n| authProviderId | UserAuthentication->AuthProviderId | string | |\r\n", "operationId": "GetUserAuthenticationForUserCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "userId", "in": "path", "required": true, "description": "User 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 User Authentication collection", "schema": { "$ref": "#/definitions/GetUserAuthenticationForUserCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Authentications/Lookups/LookupUserAuthenticationUser": { "get": { "tags": [ "User Authentication" ], "summary": "Lookup the User Authentication for the User Authentication.", "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 | User->Id | integer | int64 |\r\n| fullName | User->FullName | string | |\r\n| code | User->Code | string | |\r\n", "operationId": "LookupUserAuthenticationUser", "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 User collection", "schema": { "$ref": "#/definitions/UserAuthenticationUserLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Authentications/Batch/{ids}": { "get": { "tags": [ "User Authentication" ], "summary": "Get a collection of User Authentication 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| isActive | UserAuthentication->IsActive | boolean | |\r\n| createdByUserId | UserAuthentication->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserAuthentication->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserAuthentication->CreatedByUser_FullName | string | |\r\n| createdOn | UserAuthentication->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserAuthentication->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserAuthentication->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserAuthentication->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserAuthentication->ModifiedOn | string | date-time |\r\n| version | UserAuthentication->Version | integer | int32 |\r\n| id | UserAuthentication->Id | integer | int64 |\r\n| authProviderId | UserAuthentication->AuthProviderId | string | |\r\n| authProviderName | UserAuthentication->AuthProviderName | string | |\r\n| authProviderSubject | UserAuthentication->AuthProviderSubject | string | |\r\n| authProviderType | UserAuthentication->AuthProviderType | string (Allowed values: [AzureAD, ADFS, Ping, Okta, Auth0, Generic, Internal]) | enum |\r\n| notes | UserAuthentication->Notes | string | |\r\n| userId | UserAuthentication->User_Id | integer | int64 |\r\n| userCode | UserAuthentication->User_Code | string | |\r\n| userFullName | UserAuthentication->User_FullName | string | |\r\n", "operationId": "BatchGetUserAuthentication", "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 User Authentication 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 User Authentication collection", "schema": { "$ref": "#/definitions/BatchGetUserAuthenticationResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Authentications/Batch": { "post": { "tags": [ "User Authentication" ], "summary": "Create a new collection of User Authentication 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| userId | UserAuthentication->User_Id | integer | int64 |\r\n| authProviderId | UserAuthentication->AuthProviderId | string | |\r\n| authProviderSubject | UserAuthentication->AuthProviderSubject | string | |\r\n| notes | UserAuthentication->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| userId | Required | True | |\r\n| userId | Nullable | False | |\r\n| authProviderId | Required | True | |\r\n| authProviderId | Nullable | False | |\r\n| authProviderId | Min Length | >= 1 chars| |\r\n| authProviderSubject | Required | True | |\r\n| authProviderSubject | Nullable | False | |\r\n| authProviderSubject | Min Length | >= 1 chars| |\r\n\r\n", "operationId": "BatchCreateUserAuthentication", "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/BatchCreateUserAuthenticationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - User Authentication 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": [ "User Authentication" ], "summary": "Update a collection of existing User Authentication 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 | UserAuthentication->Id | integer | int64 |\r\n| version | UserAuthentication->Version | integer | int32 |\r\n| authProviderId | UserAuthentication->AuthProviderId | string | |\r\n| authProviderSubject | UserAuthentication->AuthProviderSubject | string | |\r\n| notes | UserAuthentication->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| authProviderId | Min Length | >= 1 chars| |\r\n| authProviderSubject | Min Length | >= 1 chars| |\r\n\r\n", "operationId": "BatchUpdateUserAuthentication", "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/BatchUpdateUserAuthenticationResourceActionResponse" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Authentication 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": [ "User Authentication" ], "summary": "Delete a collection of existing User Authentication 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 | UserAuthentication->Id | integer | int64 |\r\n| version | UserAuthentication->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": "BatchDeleteUserAuthentication", "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/BatchDeleteUserAuthenticationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Authentication 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/UAM/Users/Authentications/{id}/Active": { "patch": { "tags": [ "User Authentication" ], "summary": "Change the IsActive status for an existing User Authentication 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 | UserAuthentication->Version | integer | int32 |\r\n| isActive | UserAuthentication->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": "ChangeUserAuthenticationIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Authentication Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUserAuthenticationIsActiveResourceActionRequest" } }, { "$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/UAM/Users/Authentications/Batch/Active": { "patch": { "tags": [ "User Authentication" ], "summary": "Change the IsActive status for a collection of existing User Authentication 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 | UserAuthentication->Id | integer | int64 |\r\n| version | UserAuthentication->Version | integer | int32 |\r\n| isActive | UserAuthentication->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": "BatchChangeUserAuthenticationIsActive", "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/BatchChangeUserAuthenticationIsActiveResourceActionRequest" } }, { "$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/UAM/Users/CustomPermissions/{id}": { "get": { "tags": [ "User Custom Permission" ], "summary": "Get a User Custom Permission 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| category | UserCustomPermission->Category | string | |\r\n| entityName | UserCustomPermission->EntityName | string | |\r\n| name | UserCustomPermission->Name | string | |\r\n| subcategory | UserCustomPermission->Subcategory | string | |\r\n| createdByUserId | UserCustomPermission->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserCustomPermission->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserCustomPermission->CreatedByUser_FullName | string | |\r\n| createdOn | UserCustomPermission->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserCustomPermission->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserCustomPermission->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserCustomPermission->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserCustomPermission->ModifiedOn | string | date-time |\r\n| version | UserCustomPermission->Version | integer | int32 |\r\n| id | UserCustomPermission->Id | integer | int64 |\r\n| applyDownPermissionTree | UserCustomPermission->ApplyDownPermissionTree | boolean | |\r\n| excludedProperties | UserCustomPermission->ExcludedProperties | array | array |\r\n| notes | UserCustomPermission->Notes | string | |\r\n| permissionId | UserCustomPermission->PermissionId | integer | int32 |\r\n| permissionsChanged | UserCustomPermission->PermissionsChanged | boolean | |\r\n| permissionTrees | UserCustomPermission->PermissionTrees | array | array |\r\n| userId | UserCustomPermission->User_Id | integer | int64 |\r\n| userCode | UserCustomPermission->User_Code | string | |\r\n| userFullName | UserCustomPermission->User_FullName | string | |\r\n", "operationId": "GetUserCustomPermission", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Custom Permission Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Custom Permission", "schema": { "$ref": "#/definitions/GetUserCustomPermissionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "User Custom Permission" ], "summary": "Update an existing User Custom Permission 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 | UserCustomPermission->Version | integer | int32 |\r\n| applyDownPermissionTree | UserCustomPermission->ApplyDownPermissionTree | boolean | |\r\n| userId | UserCustomPermission->User_Id | integer | int64 |\r\n| permissionId | UserCustomPermission->PermissionId | integer | int32 |\r\n| excludedProperties | UserCustomPermission->ExcludedProperties | array | array |\r\n| permissionTrees | UserCustomPermission->PermissionTrees | array | array |\r\n| notes | UserCustomPermission->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| userId | Nullable | False | |\r\n| permissionId | Nullable | False | |\r\n\r\n", "operationId": "UpdateUserCustomPermission", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Custom Permission Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateUserCustomPermissionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Custom Permission 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": [ "User Custom Permission" ], "summary": "Delete an existing User Custom Permission 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 | UserCustomPermission->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": "DeleteUserCustomPermission", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Custom Permission Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteUserCustomPermissionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Custom Permission 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/UAM/Users/{userId}/CustomPermissions": { "get": { "tags": [ "User Custom Permission" ], "summary": "Get a list of User Custom Permission resources for the User.", "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 | UserCustomPermission->Id | integer | int64 |\r\n| userId | UserCustomPermission->User_Id | integer | int64 |\r\n| userFullName | UserCustomPermission->User_FullName | string | |\r\n| category | UserCustomPermission->Category | string | |\r\n| subcategory | UserCustomPermission->Subcategory | string | |\r\n| name | UserCustomPermission->Name | string | |\r\n| entityName | UserCustomPermission->EntityName | string | |\r\n| permissionId | UserCustomPermission->PermissionId | integer | int32 |\r\n| version | UserCustomPermission->Version | integer | int32 |\r\n", "operationId": "GetUserCustomPermissionListForUser", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "userId", "in": "path", "required": true, "description": "User Id", "format": "int64", "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Custom Permission collection", "schema": { "$ref": "#/definitions/GetUserCustomPermissionListForUserResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/CustomPermissions": { "get": { "tags": [ "User Custom Permission" ], "summary": "Get a collection of User Custom Permission 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 | UserCustomPermission->Id | integer | int64 |\r\n| userFullName | UserCustomPermission->User_FullName | string | |\r\n| category | UserCustomPermission->Category | string | |\r\n| subcategory | UserCustomPermission->Subcategory | string | |\r\n| name | UserCustomPermission->Name | string | |\r\n| entityName | UserCustomPermission->EntityName | string | |\r\n| permissionId | UserCustomPermission->PermissionId | integer | int32 |\r\n| version | UserCustomPermission->Version | integer | int32 |\r\n", "operationId": "GetUserCustomPermissionList", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Custom Permission collection", "schema": { "$ref": "#/definitions/GetUserCustomPermissionListResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "User Custom Permission" ], "summary": "Create a new User Custom Permission 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| userId | UserCustomPermission->User_Id | integer | int64 |\r\n| permissionId | UserCustomPermission->PermissionId | integer | int32 |\r\n| applyDownPermissionTree | UserCustomPermission->ApplyDownPermissionTree | boolean | |\r\n| excludedProperties | UserCustomPermission->ExcludedProperties | array | array |\r\n| permissionTrees | UserCustomPermission->PermissionTrees | array | array |\r\n| notes | UserCustomPermission->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| userId | Required | True | |\r\n| userId | Nullable | False | |\r\n| permissionId | Required | True | |\r\n| permissionId | Nullable | False | |\r\n| applyDownPermissionTree | Required | True | |\r\n| applyDownPermissionTree | Nullable | False | |\r\n\r\n", "operationId": "CreateUserCustomPermission", "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/CreateUserCustomPermissionResourceActionRequest" } }, { "$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/UAM/Users/CustomPermissions/{userCustomPermissionId}/PermissionTrees": { "get": { "tags": [ "User Custom Permission" ], "summary": "Get a list of Permission Tree resources for the User Custom Permission.", "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| isActive | PermissionTree->IsActive | boolean | |\r\n", "operationId": "GetUserCustomPermissionPermissionTreeCollection", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "userCustomPermissionId", "in": "path", "required": true, "format": "int64", "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Custom Permission collection", "schema": { "$ref": "#/definitions/GetUserCustomPermissionPermissionTreeCollectionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/CustomPermissions/Lookups/LookupUserCustomPermissionEntityProperty": { "get": { "tags": [ "User Custom Permission" ], "summary": "User Custom Permission", "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| path | EntityMetadataPropertySummary->Path | string | |\r\n", "operationId": "LookupUserCustomPermissionEntityProperty", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Entity Property Metadata Summary collection", "schema": { "$ref": "#/definitions/UserCustomPermissionEntityPropertyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/CustomPermissions/Lookups/LookupUserCustomPermission": { "get": { "tags": [ "User Custom Permission" ], "summary": "User Custom Permission", "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| permissionId | PermissionView->PermissionId | integer | int32 |\r\n| category | PermissionView->Category | string | |\r\n| subcategory | PermissionView->Subcategory | string | |\r\n| name | PermissionView->Name | string | |\r\n| entityName | PermissionView->EntityName | string | |\r\n", "operationId": "LookupUserCustomPermission", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable API Resource collection", "schema": { "$ref": "#/definitions/UserCustomPermissionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/CustomPermissions/Lookups/LookupUserCustomPermissionPermissionTree": { "get": { "tags": [ "User Custom Permission" ], "summary": "User Custom Permission", "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| isActive | PermissionTree->IsActive | boolean | |\r\n", "operationId": "LookupUserCustomPermissionPermissionTree", "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 Permission Tree collection", "schema": { "$ref": "#/definitions/UserCustomPermissionPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/CustomPermissions/Lookups/LookupUserCustomPermissionUser": { "get": { "tags": [ "User Custom Permission" ], "summary": "Lookup the User for the User Custom Permission.", "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 | User->Id | integer | int64 |\r\n| fullName | User->FullName | string | |\r\n", "operationId": "LookupUserCustomPermissionUser", "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 User collection", "schema": { "$ref": "#/definitions/UserCustomPermissionUserLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/CustomPermissions/Batch/{ids}": { "get": { "tags": [ "User Custom Permission" ], "summary": "Get a collection of User Custom Permission 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| category | UserCustomPermission->Category | string | |\r\n| entityName | UserCustomPermission->EntityName | string | |\r\n| name | UserCustomPermission->Name | string | |\r\n| subcategory | UserCustomPermission->Subcategory | string | |\r\n| createdByUserId | UserCustomPermission->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserCustomPermission->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserCustomPermission->CreatedByUser_FullName | string | |\r\n| createdOn | UserCustomPermission->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserCustomPermission->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserCustomPermission->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserCustomPermission->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserCustomPermission->ModifiedOn | string | date-time |\r\n| version | UserCustomPermission->Version | integer | int32 |\r\n| id | UserCustomPermission->Id | integer | int64 |\r\n| applyDownPermissionTree | UserCustomPermission->ApplyDownPermissionTree | boolean | |\r\n| excludedProperties | UserCustomPermission->ExcludedProperties | array | array |\r\n| notes | UserCustomPermission->Notes | string | |\r\n| permissionId | UserCustomPermission->PermissionId | integer | int32 |\r\n| permissionsChanged | UserCustomPermission->PermissionsChanged | boolean | |\r\n| permissionTrees | UserCustomPermission->PermissionTrees | array | array |\r\n| userId | UserCustomPermission->User_Id | integer | int64 |\r\n| userCode | UserCustomPermission->User_Code | string | |\r\n| userFullName | UserCustomPermission->User_FullName | string | |\r\n", "operationId": "BatchGetUserCustomPermission", "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 User Custom Permission 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 User Custom Permission collection", "schema": { "$ref": "#/definitions/BatchGetUserCustomPermissionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/CustomPermissions/Batch": { "post": { "tags": [ "User Custom Permission" ], "summary": "Create a new collection of User Custom Permission 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| userId | UserCustomPermission->User_Id | integer | int64 |\r\n| permissionId | UserCustomPermission->PermissionId | integer | int32 |\r\n| applyDownPermissionTree | UserCustomPermission->ApplyDownPermissionTree | boolean | |\r\n| excludedProperties | UserCustomPermission->ExcludedProperties | array | array |\r\n| permissionTrees | UserCustomPermission->PermissionTrees | array | array |\r\n| notes | UserCustomPermission->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| userId | Required | True | |\r\n| userId | Nullable | False | |\r\n| permissionId | Required | True | |\r\n| permissionId | Nullable | False | |\r\n| applyDownPermissionTree | Required | True | |\r\n| applyDownPermissionTree | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateUserCustomPermission", "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/BatchCreateUserCustomPermissionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - User Custom Permission 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": [ "User Custom Permission" ], "summary": "Update a collection of existing User Custom Permission 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 | UserCustomPermission->Id | integer | int64 |\r\n| version | UserCustomPermission->Version | integer | int32 |\r\n| applyDownPermissionTree | UserCustomPermission->ApplyDownPermissionTree | boolean | |\r\n| userId | UserCustomPermission->User_Id | integer | int64 |\r\n| permissionId | UserCustomPermission->PermissionId | integer | int32 |\r\n| excludedProperties | UserCustomPermission->ExcludedProperties | array | array |\r\n| permissionTrees | UserCustomPermission->PermissionTrees | array | array |\r\n| notes | UserCustomPermission->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| userId | Nullable | False | |\r\n| permissionId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateUserCustomPermission", "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/BatchUpdateUserCustomPermissionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Custom Permission 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": [ "User Custom Permission" ], "summary": "Delete a collection of existing User Custom Permission 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 | UserCustomPermission->Id | integer | int64 |\r\n| version | UserCustomPermission->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": "BatchDeleteUserCustomPermission", "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/BatchDeleteUserCustomPermissionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Custom Permission 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/UAM/Users/Documents/{id}": { "get": { "tags": [ "User Document" ], "summary": "Get a User Document 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| userId | UserDocument->User_Id | integer | int64 |\r\n| userCode | UserDocument->User_Code | string | |\r\n| userFullName | UserDocument->User_FullName | string | |\r\n| isActive | UserDocument->IsActive | boolean | |\r\n| createdByUserId | UserDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserDocument->CreatedByUser_FullName | string | |\r\n| createdOn | UserDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserDocument->ModifiedOn | string | date-time |\r\n| version | UserDocument->Version | integer | int32 |\r\n| permissionTreeId | UserDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UserDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UserDocument->PermissionTree_Description | string | |\r\n| id | UserDocument->Id | integer | int64 |\r\n| documentRecordId | UserDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | UserDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | UserDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | UserDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | UserDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | UserDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | UserDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | UserDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | UserDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | UserDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | UserDocument->Notes | string | |\r\n| sequenceNumber | UserDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetUserDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Document", "schema": { "$ref": "#/definitions/GetUserDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "User Document" ], "summary": "Update an existing User Document 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 | UserDocument->Version | integer | int32 |\r\n| sequenceNumber | UserDocument->SequenceNumber | integer | int32 |\r\n| notes | UserDocument->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\r\n", "operationId": "UpdateUserDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateUserDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Document 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": [ "User Document" ], "summary": "Delete an existing User Document 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 | UserDocument->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": "DeleteUserDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteUserDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Document 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/UAM/Users/{id}/Documents": { "get": { "tags": [ "User Document" ], "summary": "Get a collection of User Document resources for the User.", "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 | UserDocument->Id | integer | int64 |\r\n| version | UserDocument->Version | integer | int32 |\r\n| sequenceNumber | UserDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | UserDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | UserDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | UserDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | UserDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | UserDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | UserDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | UserDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetUserDocumentCollectionForUser", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User 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 User Document collection", "schema": { "$ref": "#/definitions/GetUserDocumentCollectionForUserResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Documents": { "get": { "tags": [ "User Document" ], "summary": "Get a collection of User Document 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 | UserDocument->Id | integer | int64 |\r\n| version | UserDocument->Version | integer | int32 |\r\n| userId | UserDocument->User_Id | integer | int64 |\r\n| userCode | UserDocument->User_Code | string | |\r\n| userFullName | UserDocument->User_FullName | string | |\r\n| sequenceNumber | UserDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | UserDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | UserDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | UserDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | UserDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | UserDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | UserDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | UserDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetUserDocumentCollection", "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 User Document collection", "schema": { "$ref": "#/definitions/GetUserDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "User Document" ], "summary": "Create a new User Document 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| userId | UserDocument->User_Id | integer | int64 |\r\n| documentRecordId | UserDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | UserDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | UserDocument->SequenceNumber | integer | int32 |\r\n| notes | UserDocument->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| userId | Required | True | |\r\n| userId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateUserDocument", "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/CreateUserDocumentResourceActionRequest" } }, { "$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/UAM/Users/Documents/Lookups/LookupUserDocumentChangePermissionTree": { "get": { "tags": [ "User Document" ], "summary": "Lookup the permission set for changing the User Document.", "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": "LookupUserDocumentChangePermissionTree", "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/UserDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Documents/Lookups/LookupUserDocument": { "get": { "tags": [ "User Document" ], "summary": "User Document", "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 | DocumentRecord->Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n", "operationId": "LookupUserDocument", "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 Document Record collection", "schema": { "$ref": "#/definitions/UserDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Documents/Lookups/LookupUserDocumentInsertPermissionTree": { "get": { "tags": [ "User Document" ], "summary": "Lookup the permission set for creating the User Document.", "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": "LookupUserDocumentInsertPermissionTree", "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/UserDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Documents/Lookups/LookupUserDocumentUser": { "get": { "tags": [ "User Document" ], "summary": "Lookup the User Document for the User Document.", "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 | User->Id | integer | int64 |\r\n| code | User->Code | string | |\r\n| fullName | User->FullName | string | |\r\n", "operationId": "LookupUserDocumentUser", "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 User collection", "schema": { "$ref": "#/definitions/UserDocumentUserLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Documents/Batch/{ids}": { "get": { "tags": [ "User Document" ], "summary": "Get a collection of User Document 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| userId | UserDocument->User_Id | integer | int64 |\r\n| userCode | UserDocument->User_Code | string | |\r\n| userFullName | UserDocument->User_FullName | string | |\r\n| isActive | UserDocument->IsActive | boolean | |\r\n| createdByUserId | UserDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserDocument->CreatedByUser_FullName | string | |\r\n| createdOn | UserDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserDocument->ModifiedOn | string | date-time |\r\n| version | UserDocument->Version | integer | int32 |\r\n| permissionTreeId | UserDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UserDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UserDocument->PermissionTree_Description | string | |\r\n| id | UserDocument->Id | integer | int64 |\r\n| documentRecordId | UserDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | UserDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | UserDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | UserDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | UserDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | UserDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | UserDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | UserDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | UserDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | UserDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | UserDocument->Notes | string | |\r\n| sequenceNumber | UserDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetUserDocument", "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 User Document 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 User Document collection", "schema": { "$ref": "#/definitions/BatchGetUserDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Documents/Batch": { "post": { "tags": [ "User Document" ], "summary": "Create a new collection of User Document 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| userId | UserDocument->User_Id | integer | int64 |\r\n| documentRecordId | UserDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | UserDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | UserDocument->SequenceNumber | integer | int32 |\r\n| notes | UserDocument->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| userId | Required | True | |\r\n| userId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateUserDocument", "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/BatchCreateUserDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - User Document 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": [ "User Document" ], "summary": "Update a collection of existing User Document 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 | UserDocument->Id | integer | int64 |\r\n| version | UserDocument->Version | integer | int32 |\r\n| sequenceNumber | UserDocument->SequenceNumber | integer | int32 |\r\n| notes | UserDocument->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\r\n", "operationId": "BatchUpdateUserDocument", "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/BatchUpdateUserDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Document 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": [ "User Document" ], "summary": "Delete a collection of existing User Document 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 | UserDocument->Id | integer | int64 |\r\n| version | UserDocument->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": "BatchDeleteUserDocument", "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/BatchDeleteUserDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Document 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/UAM/Users/Documents/{id}/Active": { "patch": { "tags": [ "User Document" ], "summary": "Change the IsActive status for an existing User Document 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 | UserDocument->Version | integer | int32 |\r\n| isActive | UserDocument->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": "ChangeUserDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUserDocumentIsActiveResourceActionRequest" } }, { "$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/UAM/Users/Documents/{id}/PermissionTree": { "patch": { "tags": [ "User Document" ], "summary": "Change the PermissionTree for an existing User Document 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 | UserDocument->Version | integer | int32 |\r\n| permissionTreeId | UserDocument->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": "ChangeUserDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUserDocumentPermissionTreeResourceActionRequest" } }, { "$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/UAM/Users/Documents/Batch/PermissionTree": { "patch": { "tags": [ "User Document" ], "summary": "Change the PermissionTree status for a collection of existing User Document 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 | UserDocument->Id | integer | int64 |\r\n| version | UserDocument->Version | integer | int32 |\r\n| permissionTreeId | UserDocument->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": "BatchChangeUserDocumentPermissionTree", "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/BatchChangeUserDocumentPermissionTreeResourceActionRequest" } }, { "$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/UAM/Users/Documents/Batch/Active": { "patch": { "tags": [ "User Document" ], "summary": "Change the IsActive status for a collection of existing User Document 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 | UserDocument->Id | integer | int64 |\r\n| version | UserDocument->Version | integer | int32 |\r\n| isActive | UserDocument->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": "BatchChangeUserDocumentIsActive", "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/BatchChangeUserDocumentIsActiveResourceActionRequest" } }, { "$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/UAM/Users/OperationalRoles/{id}": { "get": { "tags": [ "User Operational Role" ], "summary": "Get a User Operational Role 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| isActive | UserOperationalRole->IsActive | boolean | |\r\n| createdByUserId | UserOperationalRole->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserOperationalRole->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserOperationalRole->CreatedByUser_FullName | string | |\r\n| createdOn | UserOperationalRole->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserOperationalRole->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserOperationalRole->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserOperationalRole->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserOperationalRole->ModifiedOn | string | date-time |\r\n| version | UserOperationalRole->Version | integer | int32 |\r\n| permissionTreeId | UserOperationalRole->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UserOperationalRole->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UserOperationalRole->PermissionTree_Description | string | |\r\n| id | UserOperationalRole->Id | integer | int64 |\r\n| isDefault | UserOperationalRole->IsDefault | boolean | |\r\n| notes | UserOperationalRole->Notes | string | |\r\n| operationalRoleId | UserOperationalRole->OperationalRole_Id | integer | int64 |\r\n| operationalRoleCode | UserOperationalRole->OperationalRole_Code | string | |\r\n| operationalRoleDescription | UserOperationalRole->OperationalRole_Description | string | |\r\n| sequenceNumber | UserOperationalRole->SequenceNumber | integer | int32 |\r\n| userId | UserOperationalRole->User_Id | integer | int64 |\r\n| userCode | UserOperationalRole->User_Code | string | |\r\n| userFullName | UserOperationalRole->User_FullName | string | |\r\n", "operationId": "GetUserOperationalRole", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Operational Role", "schema": { "$ref": "#/definitions/GetUserOperationalRoleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "User Operational Role" ], "summary": "Update an existing User Operational Role 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 | UserOperationalRole->Version | integer | int32 |\r\n| isDefault | UserOperationalRole->IsDefault | boolean | |\r\n| notes | UserOperationalRole->Notes | string | |\r\n| sequenceNumber | UserOperationalRole->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\r\n", "operationId": "UpdateUserOperationalRole", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateUserOperationalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Operational Role 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": [ "User Operational Role" ], "summary": "Delete an existing User Operational Role 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 | UserOperationalRole->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": "DeleteUserOperationalRole", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteUserOperationalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Operational Role 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/UAM/Users/OperationalRoles": { "get": { "tags": [ "User Operational Role" ], "summary": "Get a collection of User Operational Role 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 | UserOperationalRole->Id | integer | int64 |\r\n| version | UserOperationalRole->Version | integer | int32 |\r\n| isActive | UserOperationalRole->IsActive | boolean | |\r\n| userId | UserOperationalRole->User_Id | integer | int64 |\r\n| userFullName | UserOperationalRole->User_FullName | string | |\r\n| operationalRoleId | UserOperationalRole->OperationalRole_Id | integer | int64 |\r\n| operationalRoleCode | UserOperationalRole->OperationalRole_Code | string | |\r\n| operationalRoleDescription | UserOperationalRole->OperationalRole_Description | string | |\r\n| isDefault | UserOperationalRole->IsDefault | boolean | |\r\n", "operationId": "GetUserOperationalRoleCollection", "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 User Operational Role collection", "schema": { "$ref": "#/definitions/GetUserOperationalRoleCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "User Operational Role" ], "summary": "Create a new User Operational Role 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| notes | UserOperationalRole->Notes | string | |\r\n| isDefault | UserOperationalRole->IsDefault | boolean | |\r\n| userId | UserOperationalRole->User_Id | integer | int64 |\r\n| operationalRoleId | UserOperationalRole->OperationalRole_Id | integer | int64 |\r\n| permissionTreeId | UserOperationalRole->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | UserOperationalRole->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| isDefault | Required | True | |\r\n| isDefault | Nullable | False | |\r\n| userId | Required | True | |\r\n| userId | Nullable | False | |\r\n| operationalRoleId | Required | True | |\r\n| operationalRoleId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateUserOperationalRole", "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/CreateUserOperationalRoleResourceActionRequest" } }, { "$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/UAM/Users/OperationalRoles/{userId}/UserOperationalRoles": { "get": { "tags": [ "User Operational Role" ], "summary": "Get a collection of User Operational Role 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 | UserOperationalRole->Id | integer | int64 |\r\n| version | UserOperationalRole->Version | integer | int32 |\r\n| isActive | UserOperationalRole->IsActive | boolean | |\r\n| userId | UserOperationalRole->User_Id | integer | int64 |\r\n| userFullName | UserOperationalRole->User_FullName | string | |\r\n| operationalRoleId | UserOperationalRole->OperationalRole_Id | integer | int64 |\r\n| operationalRoleCode | UserOperationalRole->OperationalRole_Code | string | |\r\n| operationalRoleDescription | UserOperationalRole->OperationalRole_Description | string | |\r\n| isDefault | UserOperationalRole->IsDefault | boolean | |\r\n", "operationId": "GetUserOperationalRoleForOperationalRoleCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "userId", "in": "path", "required": true, "description": "User 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 User Operational Role collection", "schema": { "$ref": "#/definitions/GetUserOperationalRoleForOperationalRoleCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/OperationalRoles/Lookups/LookupUserOperationalRoleChangePermissionTree": { "get": { "tags": [ "User Operational Role" ], "summary": "Lookup the permission set for changing the User Operational Role.", "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": "LookupUserOperationalRoleChangePermissionTree", "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/UserOperationalRoleChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/OperationalRoles/Lookups/LookupUserOperationalRoleInsertPermissionTree": { "get": { "tags": [ "User Operational Role" ], "summary": "Lookup the permission set for creating the User Operational Role.", "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": "LookupUserOperationalRoleInsertPermissionTree", "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/UserOperationalRoleInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/OperationalRoles/Lookups/LookupUserOperationalRoleOperationalRole": { "get": { "tags": [ "User Operational Role" ], "summary": "Lookup the Operational Role for the User Operational Role.", "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 | OperationalRole->Id | integer | int64 |\r\n| code | OperationalRole->Code | string | |\r\n| description | OperationalRole->Description | string | |\r\n", "operationId": "LookupUserOperationalRoleOperationalRole", "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 Operational Role collection", "schema": { "$ref": "#/definitions/UserOperationalRoleOperationalRoleLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/OperationalRoles/Lookups/LookupUserOperationalRoleUser": { "get": { "tags": [ "User Operational Role" ], "summary": "Lookup the User for the User Operational Role.", "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 | User->Id | integer | int64 |\r\n| fullName | User->FullName | string | |\r\n", "operationId": "LookupUserOperationalRoleUser", "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 User collection", "schema": { "$ref": "#/definitions/UserOperationalRoleUserLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/OperationalRoles/Batch/{ids}": { "get": { "tags": [ "User Operational Role" ], "summary": "Get a collection of User Operational Role 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| isActive | UserOperationalRole->IsActive | boolean | |\r\n| createdByUserId | UserOperationalRole->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserOperationalRole->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserOperationalRole->CreatedByUser_FullName | string | |\r\n| createdOn | UserOperationalRole->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserOperationalRole->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserOperationalRole->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserOperationalRole->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserOperationalRole->ModifiedOn | string | date-time |\r\n| version | UserOperationalRole->Version | integer | int32 |\r\n| permissionTreeId | UserOperationalRole->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UserOperationalRole->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UserOperationalRole->PermissionTree_Description | string | |\r\n| id | UserOperationalRole->Id | integer | int64 |\r\n| isDefault | UserOperationalRole->IsDefault | boolean | |\r\n| notes | UserOperationalRole->Notes | string | |\r\n| operationalRoleId | UserOperationalRole->OperationalRole_Id | integer | int64 |\r\n| operationalRoleCode | UserOperationalRole->OperationalRole_Code | string | |\r\n| operationalRoleDescription | UserOperationalRole->OperationalRole_Description | string | |\r\n| sequenceNumber | UserOperationalRole->SequenceNumber | integer | int32 |\r\n| userId | UserOperationalRole->User_Id | integer | int64 |\r\n| userCode | UserOperationalRole->User_Code | string | |\r\n| userFullName | UserOperationalRole->User_FullName | string | |\r\n", "operationId": "BatchGetUserOperationalRole", "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 User Operational Role 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 User Operational Role collection", "schema": { "$ref": "#/definitions/BatchGetUserOperationalRoleResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/OperationalRoles/Batch": { "post": { "tags": [ "User Operational Role" ], "summary": "Create a new collection of User Operational Role 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| notes | UserOperationalRole->Notes | string | |\r\n| isDefault | UserOperationalRole->IsDefault | boolean | |\r\n| userId | UserOperationalRole->User_Id | integer | int64 |\r\n| operationalRoleId | UserOperationalRole->OperationalRole_Id | integer | int64 |\r\n| permissionTreeId | UserOperationalRole->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | UserOperationalRole->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| isDefault | Required | True | |\r\n| isDefault | Nullable | False | |\r\n| userId | Required | True | |\r\n| userId | Nullable | False | |\r\n| operationalRoleId | Required | True | |\r\n| operationalRoleId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateUserOperationalRole", "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/BatchCreateUserOperationalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - User Operational Role 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": [ "User Operational Role" ], "summary": "Update a collection of existing User Operational Role 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 | UserOperationalRole->Id | integer | int64 |\r\n| version | UserOperationalRole->Version | integer | int32 |\r\n| isDefault | UserOperationalRole->IsDefault | boolean | |\r\n| notes | UserOperationalRole->Notes | string | |\r\n| sequenceNumber | UserOperationalRole->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\r\n", "operationId": "BatchUpdateUserOperationalRole", "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/BatchUpdateUserOperationalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Operational Role 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": [ "User Operational Role" ], "summary": "Delete a collection of existing User Operational Role 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 | UserOperationalRole->Id | integer | int64 |\r\n| version | UserOperationalRole->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": "BatchDeleteUserOperationalRole", "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/BatchDeleteUserOperationalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Operational Role 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/UAM/Users/OperationalRoles/{id}/Active": { "patch": { "tags": [ "User Operational Role" ], "summary": "Change the IsActive status for an existing User Operational Role 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 | UserOperationalRole->Version | integer | int32 |\r\n| isActive | UserOperationalRole->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": "ChangeUserOperationalRoleIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUserOperationalRoleIsActiveResourceActionRequest" } }, { "$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/UAM/Users/OperationalRoles/{id}/PermissionTree": { "patch": { "tags": [ "User Operational Role" ], "summary": "Change the PermissionTree for an existing User Operational Role 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 | UserOperationalRole->Version | integer | int32 |\r\n| permissionTreeId | UserOperationalRole->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": "ChangeUserOperationalRolePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUserOperationalRolePermissionTreeResourceActionRequest" } }, { "$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/UAM/Users/OperationalRoles/Batch/Active": { "patch": { "tags": [ "User Operational Role" ], "summary": "Change the IsActive status for a collection of existing User Operational Role 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 | UserOperationalRole->Id | integer | int64 |\r\n| version | UserOperationalRole->Version | integer | int32 |\r\n| isActive | UserOperationalRole->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": "BatchChangeUserOperationalRoleIsActive", "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/BatchChangeUserOperationalRoleIsActiveResourceActionRequest" } }, { "$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/UAM/Users/OperationalRoles/Batch/PermissionTree": { "patch": { "tags": [ "User Operational Role" ], "summary": "Change the PermissionTree status for a collection of existing User Operational Role 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 | UserOperationalRole->Id | integer | int64 |\r\n| version | UserOperationalRole->Version | integer | int32 |\r\n| permissionTreeId | UserOperationalRole->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": "BatchChangeUserOperationalRolePermissionTree", "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/BatchChangeUserOperationalRolePermissionTreeResourceActionRequest" } }, { "$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/UAM/Users/OperationalRoles/Resources/{id}": { "get": { "tags": [ "User Operational Role Resource" ], "summary": "Get a User Operational Role Resource 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 | UserOperationalRoleResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserOperationalRoleResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserOperationalRoleResource->CreatedByUser_FullName | string | |\r\n| createdOn | UserOperationalRoleResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserOperationalRoleResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserOperationalRoleResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserOperationalRoleResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserOperationalRoleResource->ModifiedOn | string | date-time |\r\n| version | UserOperationalRoleResource->Version | integer | int32 |\r\n| id | UserOperationalRoleResource->Id | integer | int64 |\r\n| inheritedFromId | UserOperationalRoleResource->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromResourceAction | UserOperationalRoleResource->InheritedFrom_ResourceAction | string | |\r\n| isDefault | UserOperationalRoleResource->IsDefault | boolean | |\r\n| isInherited | UserOperationalRoleResource->IsInherited | boolean | |\r\n| isUserDefault | UserOperationalRoleResource->IsUserDefault | boolean | |\r\n| module | UserOperationalRoleResource->Module | string | |\r\n| notes | UserOperationalRoleResource->Notes | string | |\r\n| privateUserOperationalRoleTemplateId | UserOperationalRoleResource->PrivateUserOperationalRoleTemplate_Id | integer | int64 |\r\n| resource | UserOperationalRoleResource->Resource | string | |\r\n| resourceAction | UserOperationalRoleResource->ResourceAction | string | |\r\n| resourceActionCustomisationId | UserOperationalRoleResource->ResourceActionCustomisation_Id | integer | int64 |\r\n| resourceActionCustomisationName | UserOperationalRoleResource->ResourceActionCustomisation_Name | string | |\r\n| resourceActionCustomisationDescription | UserOperationalRoleResource->ResourceActionCustomisation_Description | string | |\r\n| resourceActionCustomisationRestrictionLevel | UserOperationalRoleResource->ResourceActionCustomisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| sequenceNumber | UserOperationalRoleResource->SequenceNumber | integer | int32 |\r\n| userOperationalRoleId | UserOperationalRoleResource->UserOperationalRole_Id | integer | int64 |\r\n| userOperationalRoleOperationalRoleId | UserOperationalRoleResource->UserOperationalRole_OperationalRole_Id | integer | int64 |\r\n| userOperationalRoleOperationalRoleCode | UserOperationalRoleResource->UserOperationalRole_OperationalRole_Code | string | |\r\n| userOperationalRoleOperationalRoleDescription | UserOperationalRoleResource->UserOperationalRole_OperationalRole_Description | string | |\r\n| userOperationalRoleUserId | UserOperationalRoleResource->UserOperationalRole_User_Id | integer | int64 |\r\n| userOperationalRoleUserFullName | UserOperationalRoleResource->UserOperationalRole_User_FullName | string | |\r\n", "operationId": "GetUserOperationalRoleResource", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Resource Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Operational Role Resource", "schema": { "$ref": "#/definitions/GetUserOperationalRoleResourceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "User Operational Role Resource" ], "summary": "Update an existing User Operational Role Resource 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 | UserOperationalRoleResource->Version | integer | int32 |\r\n| isUserDefault | UserOperationalRoleResource->IsUserDefault | boolean | |\r\n| sequenceNumber | UserOperationalRoleResource->SequenceNumber | integer | int32 |\r\n| notes | UserOperationalRoleResource->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| isUserDefault | Nullable | False | |\r\n\r\n", "operationId": "UpdateUserOperationalRoleResource", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateUserOperationalRoleResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Operational Role Resource 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": [ "User Operational Role Resource" ], "summary": "Delete an existing User Operational Role Resource 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 | UserOperationalRoleResource->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": "DeleteUserOperationalRoleResource", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Resource Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteUserOperationalRoleResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Operational Role Resource 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/UAM/Users/OperationalRoles/Resources": { "get": { "tags": [ "User Operational Role Resource" ], "summary": "Get a collection of User Operational Role Resource 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 | UserOperationalRoleResource->Version | integer | int32 |\r\n| id | UserOperationalRoleResource->Id | integer | int64 |\r\n| userOperationalRoleId | UserOperationalRoleResource->UserOperationalRole_Id | integer | int64 |\r\n| userOperationalRoleOperationalRoleId | UserOperationalRoleResource->UserOperationalRole_OperationalRole_Id | integer | int64 |\r\n| userOperationalRoleOperationalRoleCode | UserOperationalRoleResource->UserOperationalRole_OperationalRole_Code | string | |\r\n| userOperationalRoleOperationalRoleDescription | UserOperationalRoleResource->UserOperationalRole_OperationalRole_Description | string | |\r\n| userOperationalRoleUserId | UserOperationalRoleResource->UserOperationalRole_User_Id | integer | int64 |\r\n| userOperationalRoleUserFullName | UserOperationalRoleResource->UserOperationalRole_User_FullName | string | |\r\n| resourceActionCustomisationId | UserOperationalRoleResource->ResourceActionCustomisation_Id | integer | int64 |\r\n| resourceActionCustomisationName | UserOperationalRoleResource->ResourceActionCustomisation_Name | string | |\r\n| resourceActionCustomisationRestrictionLevel | UserOperationalRoleResource->ResourceActionCustomisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| module | UserOperationalRoleResource->Module | string | |\r\n| resource | UserOperationalRoleResource->Resource | string | |\r\n| resourceAction | UserOperationalRoleResource->ResourceAction | string | |\r\n| sequenceNumber | UserOperationalRoleResource->SequenceNumber | integer | int32 |\r\n| isDefault | UserOperationalRoleResource->IsDefault | boolean | |\r\n| isUserDefault | UserOperationalRoleResource->IsUserDefault | boolean | |\r\n| isInherited | UserOperationalRoleResource->IsInherited | boolean | |\r\n", "operationId": "GetUserOperationalRoleResourceCollection", "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 User Operational Role Resource collection", "schema": { "$ref": "#/definitions/GetUserOperationalRoleResourceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "User Operational Role Resource" ], "summary": "Create a new User Operational Role Resource 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| userOperationalRoleId | UserOperationalRoleResource->UserOperationalRole_Id | integer | int64 |\r\n| module | UserOperationalRoleResource->Module | string | |\r\n| resource | UserOperationalRoleResource->Resource | string | |\r\n| resourceAction | UserOperationalRoleResource->ResourceAction | string | |\r\n| resourceActionCustomisationId | UserOperationalRoleResource->ResourceActionCustomisation_Id | integer | int64 |\r\n| isUserDefault | UserOperationalRoleResource->IsUserDefault | boolean | |\r\n| sequenceNumber | UserOperationalRoleResource->SequenceNumber | integer | int32 |\r\n| notes | UserOperationalRoleResource->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| userOperationalRoleId | Required | True | |\r\n| userOperationalRoleId | Nullable | False | |\r\n| module | Nullable | False | |\r\n| resource | Nullable | False | |\r\n| resourceAction | Nullable | False | |\r\n| isUserDefault | Required | True | |\r\n| isUserDefault | Nullable | False | |\r\n\r\n", "operationId": "CreateUserOperationalRoleResource", "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/CreateUserOperationalRoleResourceResourceActionRequest" } }, { "$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/UAM/Users/OperationalRoles/{userOperationalRoleId}/Resources": { "get": { "tags": [ "User Operational Role Resource" ], "summary": "Get a collection of User Operational Role Resource resources for the User Operational Role.", "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 | UserOperationalRoleResource->Id | integer | int64 |\r\n| version | UserOperationalRoleResource->Version | integer | int32 |\r\n| resourceActionCustomisationId | UserOperationalRoleResource->ResourceActionCustomisation_Id | integer | int64 |\r\n| resourceActionCustomisationName | UserOperationalRoleResource->ResourceActionCustomisation_Name | string | |\r\n| resourceActionCustomisationDescription | UserOperationalRoleResource->ResourceActionCustomisation_Description | string | |\r\n| resourceActionCustomisationRestrictionLevel | UserOperationalRoleResource->ResourceActionCustomisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| module | UserOperationalRoleResource->Module | string | |\r\n| resource | UserOperationalRoleResource->Resource | string | |\r\n| resourceAction | UserOperationalRoleResource->ResourceAction | string | |\r\n| sequenceNumber | UserOperationalRoleResource->SequenceNumber | integer | int32 |\r\n| isDefault | UserOperationalRoleResource->IsDefault | boolean | |\r\n| isUserDefault | UserOperationalRoleResource->IsUserDefault | boolean | |\r\n| isInherited | UserOperationalRoleResource->IsInherited | boolean | |\r\n| inheritedFromInheritedFromTemplate | UserOperationalRoleResource->InheritedFrom_InheritedFrom_Template | string | |\r\n| inheritedFromInheritedFromTemplateCustomisationName | UserOperationalRoleResource->InheritedFrom_InheritedFrom_TemplateCustomisation_Name | string | |\r\n", "operationId": "GetUserOperationalRoleResourceForUserOperationalRoleCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "userOperationalRoleId", "in": "path", "required": true, "description": "User Operational Role 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 User Operational Role Resource collection", "schema": { "$ref": "#/definitions/GetUserOperationalRoleResourceForUserOperationalRoleCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/OperationalRoles/Resources/Lookups/LookupUserOperationalRoleResourceResourceActionCustomisation": { "get": { "tags": [ "User Operational Role Resource" ], "summary": "Lookup the API Resource Action Customisation for the User Operational Role 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| id | ResourceActionCustomisation->Id | integer | int64 |\r\n| name | ResourceActionCustomisation->Name | string | |\r\n| description | ResourceActionCustomisation->Description | string | |\r\n| restrictionLevel | ResourceActionCustomisation->RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| module | ResourceActionCustomisation->Module | string | |\r\n| resource | ResourceActionCustomisation->Resource | string | |\r\n| resourceAction | ResourceActionCustomisation->ResourceAction | string | |\r\n", "operationId": "LookupUserOperationalRoleResourceResourceActionCustomisation", "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 API Resource Action Customisation collection", "schema": { "$ref": "#/definitions/UserOperationalRoleResourceResourceActionCustomisationLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/OperationalRoles/Resources/Lookups/LookupUserOperationalRoleResourceResourceAction": { "get": { "tags": [ "User Operational Role Resource" ], "summary": "User Operational Role 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| resourceActionName | ResourceActionSummary->ResourceActionName | string | |\r\n| moduleName | ResourceActionSummary->ModuleName | string | |\r\n| resourceName | ResourceActionSummary->ResourceName | string | |\r\n| resourceActionType | ResourceActionSummary->ResourceActionType | string | |\r\n", "operationId": "LookupUserOperationalRoleResourceResourceAction", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable API Resource collection", "schema": { "$ref": "#/definitions/UserOperationalRoleResourceResourceActionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/OperationalRoles/Resources/Lookups/LookupUserOperationalRoleResourceResource": { "get": { "tags": [ "User Operational Role Resource" ], "summary": "User Operational Role 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| resourceName | ResourceSummary->ResourceName | string | |\r\n| moduleName | ResourceSummary->ModuleName | string | |\r\n| resourceDescription | ResourceSummary->ResourceDescription | string | |\r\n", "operationId": "LookupUserOperationalRoleResourceResource", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable API Resource collection", "schema": { "$ref": "#/definitions/UserOperationalRoleResourceResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/OperationalRoles/Resources/Lookups/LookupUserOperationalRoleResourceUserOperationalRole": { "get": { "tags": [ "User Operational Role Resource" ], "summary": "Lookup the User Operational Role for the User Operational Role 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| id | UserOperationalRole->Id | integer | int64 |\r\n| operationalRoleId | UserOperationalRole->OperationalRole_Id | integer | int64 |\r\n| operationalRoleCode | UserOperationalRole->OperationalRole_Code | string | |\r\n| operationalRoleDescription | UserOperationalRole->OperationalRole_Description | string | |\r\n| userId | UserOperationalRole->User_Id | integer | int64 |\r\n| userFullName | UserOperationalRole->User_FullName | string | |\r\n", "operationId": "LookupUserOperationalRoleResourceUserOperationalRole", "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 User Operational Role collection", "schema": { "$ref": "#/definitions/UserOperationalRoleResourceUserOperationalRoleLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/OperationalRoles/Resources/Batch/{ids}": { "get": { "tags": [ "User Operational Role Resource" ], "summary": "Get a collection of User Operational Role Resource 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 | UserOperationalRoleResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserOperationalRoleResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserOperationalRoleResource->CreatedByUser_FullName | string | |\r\n| createdOn | UserOperationalRoleResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserOperationalRoleResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserOperationalRoleResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserOperationalRoleResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserOperationalRoleResource->ModifiedOn | string | date-time |\r\n| version | UserOperationalRoleResource->Version | integer | int32 |\r\n| id | UserOperationalRoleResource->Id | integer | int64 |\r\n| inheritedFromId | UserOperationalRoleResource->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromResourceAction | UserOperationalRoleResource->InheritedFrom_ResourceAction | string | |\r\n| isDefault | UserOperationalRoleResource->IsDefault | boolean | |\r\n| isInherited | UserOperationalRoleResource->IsInherited | boolean | |\r\n| isUserDefault | UserOperationalRoleResource->IsUserDefault | boolean | |\r\n| module | UserOperationalRoleResource->Module | string | |\r\n| notes | UserOperationalRoleResource->Notes | string | |\r\n| privateUserOperationalRoleTemplateId | UserOperationalRoleResource->PrivateUserOperationalRoleTemplate_Id | integer | int64 |\r\n| resource | UserOperationalRoleResource->Resource | string | |\r\n| resourceAction | UserOperationalRoleResource->ResourceAction | string | |\r\n| resourceActionCustomisationId | UserOperationalRoleResource->ResourceActionCustomisation_Id | integer | int64 |\r\n| resourceActionCustomisationName | UserOperationalRoleResource->ResourceActionCustomisation_Name | string | |\r\n| resourceActionCustomisationDescription | UserOperationalRoleResource->ResourceActionCustomisation_Description | string | |\r\n| resourceActionCustomisationRestrictionLevel | UserOperationalRoleResource->ResourceActionCustomisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| sequenceNumber | UserOperationalRoleResource->SequenceNumber | integer | int32 |\r\n| userOperationalRoleId | UserOperationalRoleResource->UserOperationalRole_Id | integer | int64 |\r\n| userOperationalRoleOperationalRoleId | UserOperationalRoleResource->UserOperationalRole_OperationalRole_Id | integer | int64 |\r\n| userOperationalRoleOperationalRoleCode | UserOperationalRoleResource->UserOperationalRole_OperationalRole_Code | string | |\r\n| userOperationalRoleOperationalRoleDescription | UserOperationalRoleResource->UserOperationalRole_OperationalRole_Description | string | |\r\n| userOperationalRoleUserId | UserOperationalRoleResource->UserOperationalRole_User_Id | integer | int64 |\r\n| userOperationalRoleUserFullName | UserOperationalRoleResource->UserOperationalRole_User_FullName | string | |\r\n", "operationId": "BatchGetUserOperationalRoleResource", "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 User Operational Role Resource 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 User Operational Role Resource collection", "schema": { "$ref": "#/definitions/BatchGetUserOperationalRoleResourceResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/OperationalRoles/Resources/Batch": { "post": { "tags": [ "User Operational Role Resource" ], "summary": "Create a new collection of User Operational Role Resource 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| userOperationalRoleId | UserOperationalRoleResource->UserOperationalRole_Id | integer | int64 |\r\n| module | UserOperationalRoleResource->Module | string | |\r\n| resource | UserOperationalRoleResource->Resource | string | |\r\n| resourceAction | UserOperationalRoleResource->ResourceAction | string | |\r\n| resourceActionCustomisationId | UserOperationalRoleResource->ResourceActionCustomisation_Id | integer | int64 |\r\n| isUserDefault | UserOperationalRoleResource->IsUserDefault | boolean | |\r\n| sequenceNumber | UserOperationalRoleResource->SequenceNumber | integer | int32 |\r\n| notes | UserOperationalRoleResource->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| userOperationalRoleId | Required | True | |\r\n| userOperationalRoleId | Nullable | False | |\r\n| module | Nullable | False | |\r\n| resource | Nullable | False | |\r\n| resourceAction | Nullable | False | |\r\n| isUserDefault | Required | True | |\r\n| isUserDefault | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateUserOperationalRoleResource", "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/BatchCreateUserOperationalRoleResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - User Operational Role Resource 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": [ "User Operational Role Resource" ], "summary": "Update a collection of existing User Operational Role Resource 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 | UserOperationalRoleResource->Id | integer | int64 |\r\n| version | UserOperationalRoleResource->Version | integer | int32 |\r\n| isUserDefault | UserOperationalRoleResource->IsUserDefault | boolean | |\r\n| sequenceNumber | UserOperationalRoleResource->SequenceNumber | integer | int32 |\r\n| notes | UserOperationalRoleResource->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| isUserDefault | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateUserOperationalRoleResource", "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/BatchUpdateUserOperationalRoleResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Operational Role Resource 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": [ "User Operational Role Resource" ], "summary": "Delete a collection of existing User Operational Role Resource 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 | UserOperationalRoleResource->Id | integer | int64 |\r\n| version | UserOperationalRoleResource->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": "BatchDeleteUserOperationalRoleResource", "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/BatchDeleteUserOperationalRoleResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Operational Role Resource 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/UAM/Users/OperationalRoles/Templates/{id}": { "get": { "tags": [ "User Operational Role Template" ], "summary": "Get a User Operational Role Template 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 | UserOperationalRoleTemplate->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserOperationalRoleTemplate->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserOperationalRoleTemplate->CreatedByUser_FullName | string | |\r\n| createdOn | UserOperationalRoleTemplate->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserOperationalRoleTemplate->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserOperationalRoleTemplate->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserOperationalRoleTemplate->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserOperationalRoleTemplate->ModifiedOn | string | date-time |\r\n| version | UserOperationalRoleTemplate->Version | integer | int32 |\r\n| id | UserOperationalRoleTemplate->Id | integer | int64 |\r\n| inheritedFromId | UserOperationalRoleTemplate->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromTemplate | UserOperationalRoleTemplate->InheritedFrom_Template | string | |\r\n| isDefault | UserOperationalRoleTemplate->IsDefault | boolean | |\r\n| isInherited | UserOperationalRoleTemplate->IsInherited | boolean | |\r\n| isUserDefault | UserOperationalRoleTemplate->IsUserDefault | boolean | |\r\n| module | UserOperationalRoleTemplate->Module | string | |\r\n| notes | UserOperationalRoleTemplate->Notes | string | |\r\n| sequenceNumber | UserOperationalRoleTemplate->SequenceNumber | integer | int32 |\r\n| template | UserOperationalRoleTemplate->Template | string | |\r\n| templateCustomisationId | UserOperationalRoleTemplate->TemplateCustomisation_Id | integer | int64 |\r\n| templateCustomisationName | UserOperationalRoleTemplate->TemplateCustomisation_Name | string | |\r\n| templateCustomisationDescription | UserOperationalRoleTemplate->TemplateCustomisation_Description | string | |\r\n| templateCustomisationRestrictionLevel | UserOperationalRoleTemplate->TemplateCustomisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| type | UserOperationalRoleTemplate->Type | string | |\r\n| userOperationalRoleId | UserOperationalRoleTemplate->UserOperationalRole_Id | integer | int64 |\r\n| userOperationalRoleOperationalRoleId | UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Id | integer | int64 |\r\n| userOperationalRoleOperationalRoleCode | UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Code | string | |\r\n| userOperationalRoleOperationalRoleDescription | UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Description | string | |\r\n| userOperationalRoleUserId | UserOperationalRoleTemplate->UserOperationalRole_User_Id | integer | int64 |\r\n| userOperationalRoleUserFullName | UserOperationalRoleTemplate->UserOperationalRole_User_FullName | string | |\r\n", "operationId": "GetUserOperationalRoleTemplate", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Template Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Operational Role Template", "schema": { "$ref": "#/definitions/GetUserOperationalRoleTemplateResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "User Operational Role Template" ], "summary": "Update an existing User Operational Role Template 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 | UserOperationalRoleTemplate->Version | integer | int32 |\r\n| isUserDefault | UserOperationalRoleTemplate->IsUserDefault | boolean | |\r\n| sequenceNumber | UserOperationalRoleTemplate->SequenceNumber | integer | int32 |\r\n| notes | UserOperationalRoleTemplate->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| isUserDefault | Nullable | False | |\r\n\r\n", "operationId": "UpdateUserOperationalRoleTemplate", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Template Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateUserOperationalRoleTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Operational Role Template 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": [ "User Operational Role Template" ], "summary": "Delete an existing User Operational Role Template 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 | UserOperationalRoleTemplate->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": "DeleteUserOperationalRoleTemplate", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Operational Role Template Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteUserOperationalRoleTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Operational Role Template 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/UAM/Users/OperationalRoles/Templates": { "get": { "tags": [ "User Operational Role Template" ], "summary": "Get a collection of User Operational Role Template 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 | UserOperationalRoleTemplate->Version | integer | int32 |\r\n| id | UserOperationalRoleTemplate->Id | integer | int64 |\r\n| userOperationalRoleId | UserOperationalRoleTemplate->UserOperationalRole_Id | integer | int64 |\r\n| userOperationalRoleOperationalRoleId | UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Id | integer | int64 |\r\n| userOperationalRoleOperationalRoleCode | UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Code | string | |\r\n| userOperationalRoleOperationalRoleDescription | UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Description | string | |\r\n| userOperationalRoleUserId | UserOperationalRoleTemplate->UserOperationalRole_User_Id | integer | int64 |\r\n| userOperationalRoleUserFullName | UserOperationalRoleTemplate->UserOperationalRole_User_FullName | string | |\r\n| templateCustomisationId | UserOperationalRoleTemplate->TemplateCustomisation_Id | integer | int64 |\r\n| templateCustomisationName | UserOperationalRoleTemplate->TemplateCustomisation_Name | string | |\r\n| templateCustomisationDescription | UserOperationalRoleTemplate->TemplateCustomisation_Description | string | |\r\n| templateCustomisationRestrictionLevel | UserOperationalRoleTemplate->TemplateCustomisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| module | UserOperationalRoleTemplate->Module | string | |\r\n| template | UserOperationalRoleTemplate->Template | string | |\r\n| type | UserOperationalRoleTemplate->Type | string | |\r\n| sequenceNumber | UserOperationalRoleTemplate->SequenceNumber | integer | int32 |\r\n| isDefault | UserOperationalRoleTemplate->IsDefault | boolean | |\r\n| isUserDefault | UserOperationalRoleTemplate->IsUserDefault | boolean | |\r\n| isInherited | UserOperationalRoleTemplate->IsInherited | boolean | |\r\n", "operationId": "GetUserOperationalRoleTemplateCollection", "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 User Operational Role Template collection", "schema": { "$ref": "#/definitions/GetUserOperationalRoleTemplateCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "User Operational Role Template" ], "summary": "Create a new User Operational Role Template 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| userOperationalRoleId | UserOperationalRoleTemplate->UserOperationalRole_Id | integer | int64 |\r\n| module | UserOperationalRoleTemplate->Module | string | |\r\n| template | UserOperationalRoleTemplate->Template | string | |\r\n| type | UserOperationalRoleTemplate->Type | string | |\r\n| templateCustomisationId | UserOperationalRoleTemplate->TemplateCustomisation_Id | integer | int64 |\r\n| isUserDefault | UserOperationalRoleTemplate->IsUserDefault | boolean | |\r\n| sequenceNumber | UserOperationalRoleTemplate->SequenceNumber | integer | int32 |\r\n| notes | UserOperationalRoleTemplate->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| userOperationalRoleId | Required | True | |\r\n| userOperationalRoleId | Nullable | False | |\r\n| module | Required | True | |\r\n| module | Nullable | False | |\r\n| template | Required | True | |\r\n| template | Nullable | False | |\r\n| type | Required | True | |\r\n| type | Nullable | False | |\r\n| isUserDefault | Required | True | |\r\n| isUserDefault | Nullable | False | |\r\n\r\n", "operationId": "CreateUserOperationalRoleTemplate", "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/CreateUserOperationalRoleTemplateResourceActionRequest" } }, { "$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/UAM/Users/OperationalRoles/{userOperationalRoleId}/Templates": { "get": { "tags": [ "User Operational Role Template" ], "summary": "Get a collection of User Operational Role Template resources for the User Operational Role.", "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 | UserOperationalRoleTemplate->Id | integer | int64 |\r\n| version | UserOperationalRoleTemplate->Version | integer | int32 |\r\n| template | UserOperationalRoleTemplate->Template | string | |\r\n| type | UserOperationalRoleTemplate->Type | string | |\r\n| module | UserOperationalRoleTemplate->Module | string | |\r\n| templateCustomisationId | UserOperationalRoleTemplate->TemplateCustomisation_Id | integer | int64 |\r\n| templateCustomisationName | UserOperationalRoleTemplate->TemplateCustomisation_Name | string | |\r\n| templateCustomisationDescription | UserOperationalRoleTemplate->TemplateCustomisation_Description | string | |\r\n| templateCustomisationRestrictionLevel | UserOperationalRoleTemplate->TemplateCustomisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| isDefault | UserOperationalRoleTemplate->IsDefault | boolean | |\r\n| isUserDefault | UserOperationalRoleTemplate->IsUserDefault | boolean | |\r\n| isInherited | UserOperationalRoleTemplate->IsInherited | boolean | |\r\n", "operationId": "GetUserOperationalRoleTemplateForUserOperationalRoleCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "userOperationalRoleId", "in": "path", "required": true, "description": "User Operational Role 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 User Operational Role Template collection", "schema": { "$ref": "#/definitions/GetUserOperationalRoleTemplateForUserOperationalRoleCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/OperationalRoles/Templates/Lookups/LookupUserOperationalRoleTemplateTemplateCustomisation": { "get": { "tags": [ "User Operational Role Template" ], "summary": "Lookup the Template Customisation for the User Operational Role Template.", "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 | TemplateCustomisation->Id | integer | int64 |\r\n| name | TemplateCustomisation->Name | string | |\r\n| description | TemplateCustomisation->Description | string | |\r\n| restrictionLevel | TemplateCustomisation->RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| module | TemplateCustomisation->Module | string | |\r\n| template | TemplateCustomisation->Template | string | |\r\n| type | TemplateCustomisation->Type | string | |\r\n", "operationId": "LookupUserOperationalRoleTemplateTemplateCustomisation", "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 Template Customisation collection", "schema": { "$ref": "#/definitions/UserOperationalRoleTemplateTemplateCustomisationLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/OperationalRoles/Templates/Lookups/LookupUserOperationalRoleTemplateTemplate": { "get": { "tags": [ "User Operational Role Template" ], "summary": "User Operational Role Template", "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| templateName | TemplateSummary->TemplateName | string | |\r\n| moduleName | TemplateSummary->ModuleName | string | |\r\n| templateType | TemplateSummary->TemplateType | string | |\r\n", "operationId": "LookupUserOperationalRoleTemplateTemplate", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Template collection", "schema": { "$ref": "#/definitions/UserOperationalRoleTemplateTemplateLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/OperationalRoles/Templates/Lookups/LookupUserOperationalRoleTemplateUserOperationalRole": { "get": { "tags": [ "User Operational Role Template" ], "summary": "Lookup the User Operational Role for the User Operational Role Template.", "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 | UserOperationalRole->Id | integer | int64 |\r\n| operationalRoleCode | UserOperationalRole->OperationalRole_Code | string | |\r\n| operationalRoleDescription | UserOperationalRole->OperationalRole_Description | string | |\r\n| userId | UserOperationalRole->User_Id | integer | int64 |\r\n| userFullName | UserOperationalRole->User_FullName | string | |\r\n", "operationId": "LookupUserOperationalRoleTemplateUserOperationalRole", "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 User Operational Role collection", "schema": { "$ref": "#/definitions/UserOperationalRoleTemplateUserOperationalRoleLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/OperationalRoles/Templates/Batch/{ids}": { "get": { "tags": [ "User Operational Role Template" ], "summary": "Get a collection of User Operational Role Template 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 | UserOperationalRoleTemplate->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserOperationalRoleTemplate->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserOperationalRoleTemplate->CreatedByUser_FullName | string | |\r\n| createdOn | UserOperationalRoleTemplate->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserOperationalRoleTemplate->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserOperationalRoleTemplate->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserOperationalRoleTemplate->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserOperationalRoleTemplate->ModifiedOn | string | date-time |\r\n| version | UserOperationalRoleTemplate->Version | integer | int32 |\r\n| id | UserOperationalRoleTemplate->Id | integer | int64 |\r\n| inheritedFromId | UserOperationalRoleTemplate->InheritedFrom_Id | integer | int64 |\r\n| inheritedFromTemplate | UserOperationalRoleTemplate->InheritedFrom_Template | string | |\r\n| isDefault | UserOperationalRoleTemplate->IsDefault | boolean | |\r\n| isInherited | UserOperationalRoleTemplate->IsInherited | boolean | |\r\n| isUserDefault | UserOperationalRoleTemplate->IsUserDefault | boolean | |\r\n| module | UserOperationalRoleTemplate->Module | string | |\r\n| notes | UserOperationalRoleTemplate->Notes | string | |\r\n| sequenceNumber | UserOperationalRoleTemplate->SequenceNumber | integer | int32 |\r\n| template | UserOperationalRoleTemplate->Template | string | |\r\n| templateCustomisationId | UserOperationalRoleTemplate->TemplateCustomisation_Id | integer | int64 |\r\n| templateCustomisationName | UserOperationalRoleTemplate->TemplateCustomisation_Name | string | |\r\n| templateCustomisationDescription | UserOperationalRoleTemplate->TemplateCustomisation_Description | string | |\r\n| templateCustomisationRestrictionLevel | UserOperationalRoleTemplate->TemplateCustomisation_RestrictionLevel | string (Allowed values: [Public, PublicReadOnly, Private]) | enum |\r\n| type | UserOperationalRoleTemplate->Type | string | |\r\n| userOperationalRoleId | UserOperationalRoleTemplate->UserOperationalRole_Id | integer | int64 |\r\n| userOperationalRoleOperationalRoleId | UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Id | integer | int64 |\r\n| userOperationalRoleOperationalRoleCode | UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Code | string | |\r\n| userOperationalRoleOperationalRoleDescription | UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Description | string | |\r\n| userOperationalRoleUserId | UserOperationalRoleTemplate->UserOperationalRole_User_Id | integer | int64 |\r\n| userOperationalRoleUserFullName | UserOperationalRoleTemplate->UserOperationalRole_User_FullName | string | |\r\n", "operationId": "BatchGetUserOperationalRoleTemplate", "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 User Operational Role Template 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 User Operational Role Template collection", "schema": { "$ref": "#/definitions/BatchGetUserOperationalRoleTemplateResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/OperationalRoles/Templates/Batch": { "post": { "tags": [ "User Operational Role Template" ], "summary": "Create a new collection of User Operational Role Template 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| userOperationalRoleId | UserOperationalRoleTemplate->UserOperationalRole_Id | integer | int64 |\r\n| module | UserOperationalRoleTemplate->Module | string | |\r\n| template | UserOperationalRoleTemplate->Template | string | |\r\n| type | UserOperationalRoleTemplate->Type | string | |\r\n| templateCustomisationId | UserOperationalRoleTemplate->TemplateCustomisation_Id | integer | int64 |\r\n| isUserDefault | UserOperationalRoleTemplate->IsUserDefault | boolean | |\r\n| sequenceNumber | UserOperationalRoleTemplate->SequenceNumber | integer | int32 |\r\n| notes | UserOperationalRoleTemplate->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| userOperationalRoleId | Required | True | |\r\n| userOperationalRoleId | Nullable | False | |\r\n| module | Required | True | |\r\n| module | Nullable | False | |\r\n| template | Required | True | |\r\n| template | Nullable | False | |\r\n| type | Required | True | |\r\n| type | Nullable | False | |\r\n| isUserDefault | Required | True | |\r\n| isUserDefault | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateUserOperationalRoleTemplate", "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/BatchCreateUserOperationalRoleTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - User Operational Role Template 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": [ "User Operational Role Template" ], "summary": "Update a collection of existing User Operational Role Template 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 | UserOperationalRoleTemplate->Id | integer | int64 |\r\n| version | UserOperationalRoleTemplate->Version | integer | int32 |\r\n| isUserDefault | UserOperationalRoleTemplate->IsUserDefault | boolean | |\r\n| sequenceNumber | UserOperationalRoleTemplate->SequenceNumber | integer | int32 |\r\n| notes | UserOperationalRoleTemplate->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| isUserDefault | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateUserOperationalRoleTemplate", "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/BatchUpdateUserOperationalRoleTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Operational Role Template 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": [ "User Operational Role Template" ], "summary": "Delete a collection of existing User Operational Role Template 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 | UserOperationalRoleTemplate->Id | integer | int64 |\r\n| version | UserOperationalRoleTemplate->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": "BatchDeleteUserOperationalRoleTemplate", "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/BatchDeleteUserOperationalRoleTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Operational Role Template 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/UAM/Users/{id}/Options": { "get": { "tags": [ "User Option" ], "summary": "Get a User Option 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 | UserOption->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserOption->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserOption->CreatedByUser_FullName | string | |\r\n| createdOn | UserOption->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserOption->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserOption->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserOption->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserOption->ModifiedOn | string | date-time |\r\n| version | UserOption->Version | integer | int32 |\r\n| id | UserOption->Id | integer | int64 |\r\n| adHocCostElementId | UserOption->AdHocCostElement_Id | integer | int64 |\r\n| adHocCostElementCode | UserOption->AdHocCostElement_Code | string | |\r\n| adHocCostElementDescription | UserOption->AdHocCostElement_Description | string | |\r\n| applyWorkOrderStatusRules | UserOption->ApplyWorkOrderStatusRules | boolean | |\r\n| assetConsumptionCostElementId | UserOption->AssetConsumptionCostElement_Id | integer | int64 |\r\n| assetConsumptionCostElementCode | UserOption->AssetConsumptionCostElement_Code | string | |\r\n| assetConsumptionCostElementDescription | UserOption->AssetConsumptionCostElement_Description | string | |\r\n| contractorsCostElementId | UserOption->ContractorsCostElement_Id | integer | int64 |\r\n| contractorsCostElementCode | UserOption->ContractorsCostElement_Code | string | |\r\n| contractorsCostElementDescription | UserOption->ContractorsCostElement_Description | string | |\r\n| defaultCreateSaveAction | UserOption->DefaultCreateSaveAction | string (Allowed values: [SaveAndClose, SaveAndNew, SaveAndUpdate]) | enum |\r\n| defaultUpdateSaveAction | UserOption->DefaultUpdateSaveAction | string (Allowed values: [SaveAndClose, Save]) | enum |\r\n| defaultWorkOrderTaskResourceCostElementId | UserOption->DefaultWorkOrderTaskResourceCostElement_Id | integer | int64 |\r\n| defaultWorkOrderTaskResourceCostElementCode | UserOption->DefaultWorkOrderTaskResourceCostElement_Code | string | |\r\n| defaultWorkOrderTaskResourceCostElementDescription | UserOption->DefaultWorkOrderTaskResourceCostElement_Description | string | |\r\n| directPurchasesCostElementId | UserOption->DirectPurchasesCostElement_Id | integer | int64 |\r\n| directPurchasesCostElementCode | UserOption->DirectPurchasesCostElement_Code | string | |\r\n| directPurchasesCostElementDescription | UserOption->DirectPurchasesCostElement_Description | string | |\r\n| insightsUserId | UserOption->InsightsUserId | string | |\r\n| isReportUser | UserOption->IsReportUser | boolean | |\r\n| maximumOrderAmount | UserOption->MaximumOrderAmount | number | decimal |\r\n| notes | UserOption->Notes | string | |\r\n| purchaseOrderCanBeQueued | UserOption->PurchaseOrderCanBeQueued | boolean | |\r\n| reportServerReportLanguage | UserOption->ReportServerReportLanguage | string | |\r\n| reportServerReportLanguageDisplayName | UserOption->ReportServerReportLanguageDisplayName | string | |\r\n| reportServerUILanguage | UserOption->ReportServerUILanguage | string | |\r\n| reportServerUILanguageDisplayName | UserOption->ReportServerUILanguageDisplayName | string | |\r\n| reportUserId | UserOption->ReportUserId | string | |\r\n| reportUserName | UserOption->ReportUserName | string | |\r\n| reportUserRoles | UserOption->ReportUserRoles | array | array |\r\n| requisitionLimit | UserOption->RequisitionLimit | number | decimal |\r\n| rootAssetId | UserOption->RootAsset_Id | integer | int64 |\r\n| rootAssetCode | UserOption->RootAsset_Code | string | |\r\n| rootAssetDescription | UserOption->RootAsset_Description | string | |\r\n| stockItemsCostElementId | UserOption->StockItemsCostElement_Id | integer | int64 |\r\n| stockItemsCostElementCode | UserOption->StockItemsCostElement_Code | string | |\r\n| stockItemsCostElementDescription | UserOption->StockItemsCostElement_Description | string | |\r\n| taskClassification1Id | UserOption->TaskClassification1_Id | integer | int64 |\r\n| taskClassification1Code | UserOption->TaskClassification1_Code | string | |\r\n| taskClassification1Description | UserOption->TaskClassification1_Description | string | |\r\n| taskClassification2Id | UserOption->TaskClassification2_Id | integer | int64 |\r\n| taskClassification2Code | UserOption->TaskClassification2_Code | string | |\r\n| taskClassification2Description | UserOption->TaskClassification2_Description | string | |\r\n| taskClassification3Id | UserOption->TaskClassification3_Id | integer | int64 |\r\n| taskClassification3Code | UserOption->TaskClassification3_Code | string | |\r\n| taskClassification3Description | UserOption->TaskClassification3_Description | string | |\r\n| taskClassification4Id | UserOption->TaskClassification4_Id | integer | int64 |\r\n| taskClassification4Code | UserOption->TaskClassification4_Code | string | |\r\n| taskClassification4Description | UserOption->TaskClassification4_Description | string | |\r\n| taskClassification5Id | UserOption->TaskClassification5_Id | integer | int64 |\r\n| taskClassification5Code | UserOption->TaskClassification5_Code | string | |\r\n| taskClassification5Description | UserOption->TaskClassification5_Description | string | |\r\n| taskClassification6Id | UserOption->TaskClassification6_Id | integer | int64 |\r\n| taskClassification6Code | UserOption->TaskClassification6_Code | string | |\r\n| taskClassification6Description | UserOption->TaskClassification6_Description | string | |\r\n| taskClassification7Id | UserOption->TaskClassification7_Id | integer | int64 |\r\n| taskClassification7Code | UserOption->TaskClassification7_Code | string | |\r\n| taskClassification7Description | UserOption->TaskClassification7_Description | string | |\r\n| taskClassification8Id | UserOption->TaskClassification8_Id | integer | int64 |\r\n| taskClassification8Code | UserOption->TaskClassification8_Code | string | |\r\n| taskClassification8Description | UserOption->TaskClassification8_Description | string | |\r\n| taskImportanceId | UserOption->TaskImportance_Id | integer | int64 |\r\n| taskImportanceCode | UserOption->TaskImportance_Code | string | |\r\n| taskImportanceDescription | UserOption->TaskImportance_Description | string | |\r\n| taskResponsibleSectionId | UserOption->TaskResponsibleSection_Id | integer | int64 |\r\n| taskResponsibleSectionCode | UserOption->TaskResponsibleSection_Code | string | |\r\n| taskResponsibleSectionDescription | UserOption->TaskResponsibleSection_Description | string | |\r\n| taskResponsibleStaffId | UserOption->TaskResponsibleStaff_Id | integer | int64 |\r\n| taskResponsibleStaffCode | UserOption->TaskResponsibleStaff_Code | string | |\r\n| taskResponsibleStaffDescription | UserOption->TaskResponsibleStaff_Description | string | |\r\n| taskResponsibleTradeId | UserOption->TaskResponsibleTrade_Id | integer | int64 |\r\n| taskResponsibleTradeCode | UserOption->TaskResponsibleTrade_Code | string | |\r\n| taskResponsibleTradeDescription | UserOption->TaskResponsibleTrade_Description | string | |\r\n| taskTypeOfWorkId | UserOption->TaskTypeOfWork_Id | integer | int64 |\r\n| taskTypeOfWorkCode | UserOption->TaskTypeOfWork_Code | string | |\r\n| taskTypeOfWorkDescription | UserOption->TaskTypeOfWork_Description | string | |\r\n| travelCostElementId | UserOption->TravelCostElement_Id | integer | int64 |\r\n| travelCostElementCode | UserOption->TravelCostElement_Code | string | |\r\n| travelCostElementDescription | UserOption->TravelCostElement_Description | string | |\r\n| userId | UserOption->User_Id | integer | int64 |\r\n| userCode | UserOption->User_Code | string | |\r\n| userFullName | UserOption->User_FullName | string | |\r\n| workClassification1Id | UserOption->WorkClassification1_Id | integer | int64 |\r\n| workClassification1Code | UserOption->WorkClassification1_Code | string | |\r\n| workClassification1Description | UserOption->WorkClassification1_Description | string | |\r\n| workClassification2Id | UserOption->WorkClassification2_Id | integer | int64 |\r\n| workClassification2Code | UserOption->WorkClassification2_Code | string | |\r\n| workClassification2Description | UserOption->WorkClassification2_Description | string | |\r\n| workClassification3Id | UserOption->WorkClassification3_Id | integer | int64 |\r\n| workClassification3Code | UserOption->WorkClassification3_Code | string | |\r\n| workClassification3Description | UserOption->WorkClassification3_Description | string | |\r\n| workClassification4Id | UserOption->WorkClassification4_Id | integer | int64 |\r\n| workClassification4Code | UserOption->WorkClassification4_Code | string | |\r\n| workClassification4Description | UserOption->WorkClassification4_Description | string | |\r\n| workClassification5Id | UserOption->WorkClassification5_Id | integer | int64 |\r\n| workClassification5Code | UserOption->WorkClassification5_Code | string | |\r\n| workClassification5Description | UserOption->WorkClassification5_Description | string | |\r\n| workOrderCanBeQueued | UserOption->WorkOrderCanBeQueued | boolean | |\r\n| workOrderImportanceId | UserOption->WorkOrderImportance_Id | integer | int64 |\r\n| workOrderImportanceCode | UserOption->WorkOrderImportance_Code | string | |\r\n| workOrderImportanceDescription | UserOption->WorkOrderImportance_Description | string | |\r\n| workOrderLimit | UserOption->WorkOrderLimit | number | decimal |\r\n| workOrderResponsibleSectionId | UserOption->WorkOrderResponsibleSection_Id | integer | int64 |\r\n| workOrderResponsibleSectionCode | UserOption->WorkOrderResponsibleSection_Code | string | |\r\n| workOrderResponsibleSectionDescription | UserOption->WorkOrderResponsibleSection_Description | string | |\r\n| workOrderResponsibleStaffId | UserOption->WorkOrderResponsibleStaff_Id | integer | int64 |\r\n| workOrderResponsibleStaffCode | UserOption->WorkOrderResponsibleStaff_Code | string | |\r\n| workOrderResponsibleStaffDescription | UserOption->WorkOrderResponsibleStaff_Description | string | |\r\n| workOrderResponsibleTradeId | UserOption->WorkOrderResponsibleTrade_Id | integer | int64 |\r\n| workOrderResponsibleTradeCode | UserOption->WorkOrderResponsibleTrade_Code | string | |\r\n| workOrderResponsibleTradeDescription | UserOption->WorkOrderResponsibleTrade_Description | string | |\r\n| workOrderTypeOfWorkId | UserOption->WorkOrderTypeOfWork_Id | integer | int64 |\r\n| workOrderTypeOfWorkCode | UserOption->WorkOrderTypeOfWork_Code | string | |\r\n| workOrderTypeOfWorkDescription | UserOption->WorkOrderTypeOfWork_Description | string | |\r\n| workOrderTypeOfWorkForConditionMonitoringId | UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Id | integer | int64 |\r\n| workOrderTypeOfWorkForConditionMonitoringCode | UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Code | string | |\r\n| workOrderTypeOfWorkForConditionMonitoringDescription | UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Description | string | |\r\n", "operationId": "GetUserOptionForUser", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Option", "schema": { "$ref": "#/definitions/GetUserOptionForUserResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/{id}": { "get": { "tags": [ "User Option" ], "summary": "Get a User Option 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 | UserOption->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserOption->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserOption->CreatedByUser_FullName | string | |\r\n| createdOn | UserOption->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserOption->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserOption->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserOption->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserOption->ModifiedOn | string | date-time |\r\n| version | UserOption->Version | integer | int32 |\r\n| id | UserOption->Id | integer | int64 |\r\n| adHocCostElementId | UserOption->AdHocCostElement_Id | integer | int64 |\r\n| adHocCostElementCode | UserOption->AdHocCostElement_Code | string | |\r\n| adHocCostElementDescription | UserOption->AdHocCostElement_Description | string | |\r\n| applyWorkOrderStatusRules | UserOption->ApplyWorkOrderStatusRules | boolean | |\r\n| assetConsumptionCostElementId | UserOption->AssetConsumptionCostElement_Id | integer | int64 |\r\n| assetConsumptionCostElementCode | UserOption->AssetConsumptionCostElement_Code | string | |\r\n| assetConsumptionCostElementDescription | UserOption->AssetConsumptionCostElement_Description | string | |\r\n| contractorsCostElementId | UserOption->ContractorsCostElement_Id | integer | int64 |\r\n| contractorsCostElementCode | UserOption->ContractorsCostElement_Code | string | |\r\n| contractorsCostElementDescription | UserOption->ContractorsCostElement_Description | string | |\r\n| defaultCreateSaveAction | UserOption->DefaultCreateSaveAction | string (Allowed values: [SaveAndClose, SaveAndNew, SaveAndUpdate]) | enum |\r\n| defaultUpdateSaveAction | UserOption->DefaultUpdateSaveAction | string (Allowed values: [SaveAndClose, Save]) | enum |\r\n| defaultWorkOrderTaskResourceCostElementId | UserOption->DefaultWorkOrderTaskResourceCostElement_Id | integer | int64 |\r\n| defaultWorkOrderTaskResourceCostElementCode | UserOption->DefaultWorkOrderTaskResourceCostElement_Code | string | |\r\n| defaultWorkOrderTaskResourceCostElementDescription | UserOption->DefaultWorkOrderTaskResourceCostElement_Description | string | |\r\n| directPurchasesCostElementId | UserOption->DirectPurchasesCostElement_Id | integer | int64 |\r\n| directPurchasesCostElementCode | UserOption->DirectPurchasesCostElement_Code | string | |\r\n| directPurchasesCostElementDescription | UserOption->DirectPurchasesCostElement_Description | string | |\r\n| insightsUserId | UserOption->InsightsUserId | string | |\r\n| isReportUser | UserOption->IsReportUser | boolean | |\r\n| maximumOrderAmount | UserOption->MaximumOrderAmount | number | decimal |\r\n| notes | UserOption->Notes | string | |\r\n| purchaseOrderCanBeQueued | UserOption->PurchaseOrderCanBeQueued | boolean | |\r\n| reportServerReportLanguage | UserOption->ReportServerReportLanguage | string | |\r\n| reportServerReportLanguageDisplayName | UserOption->ReportServerReportLanguageDisplayName | string | |\r\n| reportServerUILanguage | UserOption->ReportServerUILanguage | string | |\r\n| reportServerUILanguageDisplayName | UserOption->ReportServerUILanguageDisplayName | string | |\r\n| reportUserId | UserOption->ReportUserId | string | |\r\n| reportUserName | UserOption->ReportUserName | string | |\r\n| reportUserRoles | UserOption->ReportUserRoles | array | array |\r\n| requisitionLimit | UserOption->RequisitionLimit | number | decimal |\r\n| rootAssetId | UserOption->RootAsset_Id | integer | int64 |\r\n| rootAssetCode | UserOption->RootAsset_Code | string | |\r\n| rootAssetDescription | UserOption->RootAsset_Description | string | |\r\n| stockItemsCostElementId | UserOption->StockItemsCostElement_Id | integer | int64 |\r\n| stockItemsCostElementCode | UserOption->StockItemsCostElement_Code | string | |\r\n| stockItemsCostElementDescription | UserOption->StockItemsCostElement_Description | string | |\r\n| taskClassification1Id | UserOption->TaskClassification1_Id | integer | int64 |\r\n| taskClassification1Code | UserOption->TaskClassification1_Code | string | |\r\n| taskClassification1Description | UserOption->TaskClassification1_Description | string | |\r\n| taskClassification2Id | UserOption->TaskClassification2_Id | integer | int64 |\r\n| taskClassification2Code | UserOption->TaskClassification2_Code | string | |\r\n| taskClassification2Description | UserOption->TaskClassification2_Description | string | |\r\n| taskClassification3Id | UserOption->TaskClassification3_Id | integer | int64 |\r\n| taskClassification3Code | UserOption->TaskClassification3_Code | string | |\r\n| taskClassification3Description | UserOption->TaskClassification3_Description | string | |\r\n| taskClassification4Id | UserOption->TaskClassification4_Id | integer | int64 |\r\n| taskClassification4Code | UserOption->TaskClassification4_Code | string | |\r\n| taskClassification4Description | UserOption->TaskClassification4_Description | string | |\r\n| taskClassification5Id | UserOption->TaskClassification5_Id | integer | int64 |\r\n| taskClassification5Code | UserOption->TaskClassification5_Code | string | |\r\n| taskClassification5Description | UserOption->TaskClassification5_Description | string | |\r\n| taskClassification6Id | UserOption->TaskClassification6_Id | integer | int64 |\r\n| taskClassification6Code | UserOption->TaskClassification6_Code | string | |\r\n| taskClassification6Description | UserOption->TaskClassification6_Description | string | |\r\n| taskClassification7Id | UserOption->TaskClassification7_Id | integer | int64 |\r\n| taskClassification7Code | UserOption->TaskClassification7_Code | string | |\r\n| taskClassification7Description | UserOption->TaskClassification7_Description | string | |\r\n| taskClassification8Id | UserOption->TaskClassification8_Id | integer | int64 |\r\n| taskClassification8Code | UserOption->TaskClassification8_Code | string | |\r\n| taskClassification8Description | UserOption->TaskClassification8_Description | string | |\r\n| taskImportanceId | UserOption->TaskImportance_Id | integer | int64 |\r\n| taskImportanceCode | UserOption->TaskImportance_Code | string | |\r\n| taskImportanceDescription | UserOption->TaskImportance_Description | string | |\r\n| taskResponsibleSectionId | UserOption->TaskResponsibleSection_Id | integer | int64 |\r\n| taskResponsibleSectionCode | UserOption->TaskResponsibleSection_Code | string | |\r\n| taskResponsibleSectionDescription | UserOption->TaskResponsibleSection_Description | string | |\r\n| taskResponsibleStaffId | UserOption->TaskResponsibleStaff_Id | integer | int64 |\r\n| taskResponsibleStaffCode | UserOption->TaskResponsibleStaff_Code | string | |\r\n| taskResponsibleStaffDescription | UserOption->TaskResponsibleStaff_Description | string | |\r\n| taskResponsibleTradeId | UserOption->TaskResponsibleTrade_Id | integer | int64 |\r\n| taskResponsibleTradeCode | UserOption->TaskResponsibleTrade_Code | string | |\r\n| taskResponsibleTradeDescription | UserOption->TaskResponsibleTrade_Description | string | |\r\n| taskTypeOfWorkId | UserOption->TaskTypeOfWork_Id | integer | int64 |\r\n| taskTypeOfWorkCode | UserOption->TaskTypeOfWork_Code | string | |\r\n| taskTypeOfWorkDescription | UserOption->TaskTypeOfWork_Description | string | |\r\n| travelCostElementId | UserOption->TravelCostElement_Id | integer | int64 |\r\n| travelCostElementCode | UserOption->TravelCostElement_Code | string | |\r\n| travelCostElementDescription | UserOption->TravelCostElement_Description | string | |\r\n| userId | UserOption->User_Id | integer | int64 |\r\n| userCode | UserOption->User_Code | string | |\r\n| userFullName | UserOption->User_FullName | string | |\r\n| workClassification1Id | UserOption->WorkClassification1_Id | integer | int64 |\r\n| workClassification1Code | UserOption->WorkClassification1_Code | string | |\r\n| workClassification1Description | UserOption->WorkClassification1_Description | string | |\r\n| workClassification2Id | UserOption->WorkClassification2_Id | integer | int64 |\r\n| workClassification2Code | UserOption->WorkClassification2_Code | string | |\r\n| workClassification2Description | UserOption->WorkClassification2_Description | string | |\r\n| workClassification3Id | UserOption->WorkClassification3_Id | integer | int64 |\r\n| workClassification3Code | UserOption->WorkClassification3_Code | string | |\r\n| workClassification3Description | UserOption->WorkClassification3_Description | string | |\r\n| workClassification4Id | UserOption->WorkClassification4_Id | integer | int64 |\r\n| workClassification4Code | UserOption->WorkClassification4_Code | string | |\r\n| workClassification4Description | UserOption->WorkClassification4_Description | string | |\r\n| workClassification5Id | UserOption->WorkClassification5_Id | integer | int64 |\r\n| workClassification5Code | UserOption->WorkClassification5_Code | string | |\r\n| workClassification5Description | UserOption->WorkClassification5_Description | string | |\r\n| workOrderCanBeQueued | UserOption->WorkOrderCanBeQueued | boolean | |\r\n| workOrderImportanceId | UserOption->WorkOrderImportance_Id | integer | int64 |\r\n| workOrderImportanceCode | UserOption->WorkOrderImportance_Code | string | |\r\n| workOrderImportanceDescription | UserOption->WorkOrderImportance_Description | string | |\r\n| workOrderLimit | UserOption->WorkOrderLimit | number | decimal |\r\n| workOrderResponsibleSectionId | UserOption->WorkOrderResponsibleSection_Id | integer | int64 |\r\n| workOrderResponsibleSectionCode | UserOption->WorkOrderResponsibleSection_Code | string | |\r\n| workOrderResponsibleSectionDescription | UserOption->WorkOrderResponsibleSection_Description | string | |\r\n| workOrderResponsibleStaffId | UserOption->WorkOrderResponsibleStaff_Id | integer | int64 |\r\n| workOrderResponsibleStaffCode | UserOption->WorkOrderResponsibleStaff_Code | string | |\r\n| workOrderResponsibleStaffDescription | UserOption->WorkOrderResponsibleStaff_Description | string | |\r\n| workOrderResponsibleTradeId | UserOption->WorkOrderResponsibleTrade_Id | integer | int64 |\r\n| workOrderResponsibleTradeCode | UserOption->WorkOrderResponsibleTrade_Code | string | |\r\n| workOrderResponsibleTradeDescription | UserOption->WorkOrderResponsibleTrade_Description | string | |\r\n| workOrderTypeOfWorkId | UserOption->WorkOrderTypeOfWork_Id | integer | int64 |\r\n| workOrderTypeOfWorkCode | UserOption->WorkOrderTypeOfWork_Code | string | |\r\n| workOrderTypeOfWorkDescription | UserOption->WorkOrderTypeOfWork_Description | string | |\r\n| workOrderTypeOfWorkForConditionMonitoringId | UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Id | integer | int64 |\r\n| workOrderTypeOfWorkForConditionMonitoringCode | UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Code | string | |\r\n| workOrderTypeOfWorkForConditionMonitoringDescription | UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Description | string | |\r\n", "operationId": "GetUserOption", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Option Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Option", "schema": { "$ref": "#/definitions/GetUserOptionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "User Option" ], "summary": "Update an existing User Option 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 | UserOption->Version | integer | int32 |\r\n| adHocCostElementId | UserOption->AdHocCostElement_Id | integer | int64 |\r\n| applyWorkOrderStatusRules | UserOption->ApplyWorkOrderStatusRules | boolean | |\r\n| assetConsumptionCostElementId | UserOption->AssetConsumptionCostElement_Id | integer | int64 |\r\n| contractorsCostElementId | UserOption->ContractorsCostElement_Id | integer | int64 |\r\n| directPurchasesCostElementId | UserOption->DirectPurchasesCostElement_Id | integer | int64 |\r\n| defaultWorkOrderTaskResourceCostElementId | UserOption->DefaultWorkOrderTaskResourceCostElement_Id | integer | int64 |\r\n| maximumOrderAmount | UserOption->MaximumOrderAmount | number | decimal |\r\n| notes | UserOption->Notes | string | |\r\n| purchaseOrderCanBeQueued | UserOption->PurchaseOrderCanBeQueued | boolean | |\r\n| requisitionLimit | UserOption->RequisitionLimit | number | decimal |\r\n| workOrderResponsibleSectionId | UserOption->WorkOrderResponsibleSection_Id | integer | int64 |\r\n| workOrderResponsibleStaffId | UserOption->WorkOrderResponsibleStaff_Id | integer | int64 |\r\n| workOrderResponsibleTradeId | UserOption->WorkOrderResponsibleTrade_Id | integer | int64 |\r\n| taskResponsibleSectionId | UserOption->TaskResponsibleSection_Id | integer | int64 |\r\n| taskResponsibleStaffId | UserOption->TaskResponsibleStaff_Id | integer | int64 |\r\n| taskResponsibleTradeId | UserOption->TaskResponsibleTrade_Id | integer | int64 |\r\n| rootAssetId | UserOption->RootAsset_Id | integer | int64 |\r\n| stockItemsCostElementId | UserOption->StockItemsCostElement_Id | integer | int64 |\r\n| taskClassification1Id | UserOption->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | UserOption->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | UserOption->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | UserOption->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | UserOption->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | UserOption->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | UserOption->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | UserOption->TaskClassification8_Id | integer | int64 |\r\n| taskImportanceId | UserOption->TaskImportance_Id | integer | int64 |\r\n| travelCostElementId | UserOption->TravelCostElement_Id | integer | int64 |\r\n| taskTypeOfWorkId | UserOption->TaskTypeOfWork_Id | integer | int64 |\r\n| workOrderTypeOfWorkId | UserOption->WorkOrderTypeOfWork_Id | integer | int64 |\r\n| workOrderTypeOfWorkForConditionMonitoringId | UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Id | integer | int64 |\r\n| workOrderImportanceId | UserOption->WorkOrderImportance_Id | integer | int64 |\r\n| workClassification1Id | UserOption->WorkClassification1_Id | integer | int64 |\r\n| workClassification2Id | UserOption->WorkClassification2_Id | integer | int64 |\r\n| workClassification3Id | UserOption->WorkClassification3_Id | integer | int64 |\r\n| workClassification4Id | UserOption->WorkClassification4_Id | integer | int64 |\r\n| workClassification5Id | UserOption->WorkClassification5_Id | integer | int64 |\r\n| workOrderCanBeQueued | UserOption->WorkOrderCanBeQueued | boolean | |\r\n| workOrderLimit | UserOption->WorkOrderLimit | number | decimal |\r\n| isReportUser | UserOption->IsReportUser | boolean | |\r\n| reportUserRoles | UserOption->ReportUserRoles | array | array |\r\n| reportServerUILanguage | UserOption->ReportServerUILanguage | string | |\r\n| reportServerReportLanguage | UserOption->ReportServerReportLanguage | string | |\r\n| insightsUserId | UserOption->InsightsUserId | string | |\r\n| defaultCreateSaveAction | UserOption->DefaultCreateSaveAction | string (Allowed values: [SaveAndClose, SaveAndNew, SaveAndUpdate]) | enum |\r\n| defaultUpdateSaveAction | UserOption->DefaultUpdateSaveAction | string (Allowed values: [SaveAndClose, Save]) | enum |\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| reportServerUILanguage | Max Length | <= 50 chars| |\r\n| reportServerReportLanguage | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "UpdateUserOption", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Option Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateUserOptionResourceActionResponse" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Option 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/UAM/Users/Options": { "get": { "tags": [ "User Option" ], "summary": "Get a collection of User Option 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 | UserOption->Id | integer | int64 |\r\n| applyWorkOrderStatusRules | UserOption->ApplyWorkOrderStatusRules | boolean | |\r\n| maximumOrderAmount | UserOption->MaximumOrderAmount | number | decimal |\r\n| purchaseOrderCanBeQueued | UserOption->PurchaseOrderCanBeQueued | boolean | |\r\n| requisitionLimit | UserOption->RequisitionLimit | number | decimal |\r\n| userId | UserOption->User_Id | integer | int64 |\r\n| userCode | UserOption->User_Code | string | |\r\n| userFullName | UserOption->User_FullName | string | |\r\n| userIsAdministrator | UserOption->User_IsAdministrator | boolean | |\r\n| isReportUser | UserOption->IsReportUser | boolean | |\r\n| reportUserRoles | UserOption->ReportUserRoles | array | array |\r\n| insightsUserId | UserOption->InsightsUserId | string | |\r\n| rootAssetTreePathItems | UserOption->RootAsset_TreePathItems | array | array |\r\n| version | UserOption->Version | integer | int32 |\r\n", "operationId": "GetUserOptionCollection", "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 User Option collection", "schema": { "$ref": "#/definitions/GetUserOptionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionAdHocCostElement": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Cost Element for the User Option.", "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 | CostElement->Id | integer | int64 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n", "operationId": "LookupUserOptionAdHocCostElement", "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 Cost Element collection", "schema": { "$ref": "#/definitions/LookupUserOptionAdHocCostElementResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionAssetConsumptionCostElement": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Cost Element for the User Option.", "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 | CostElement->Id | integer | int64 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n", "operationId": "LookupUserOptionAssetConsumptionCostElement", "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 Cost Element collection", "schema": { "$ref": "#/definitions/LookupUserOptionAssetConsumptionCostElementResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionContractorsCostElement": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Cost Element for the User Option.", "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 | CostElement->Id | integer | int64 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n", "operationId": "LookupUserOptionContractorsCostElement", "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 Cost Element collection", "schema": { "$ref": "#/definitions/LookupUserOptionContractorsCostElementResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionDirectPurchasesCostElement": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Cost Element for the User Option.", "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 | CostElement->Id | integer | int64 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n", "operationId": "LookupUserOptionDirectPurchasesCostElement", "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 Cost Element collection", "schema": { "$ref": "#/definitions/LookupUserOptionDirectPurchasesCostElementResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionRootAsset": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Asset for the User Option.", "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 | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n", "operationId": "LookupUserOptionRootAsset", "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 collection", "schema": { "$ref": "#/definitions/LookupUserOptionRootAssetResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionStockItemsCostElement": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Cost Element for the User Option.", "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 | CostElement->Id | integer | int64 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n", "operationId": "LookupUserOptionStockItemsCostElement", "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 Cost Element collection", "schema": { "$ref": "#/definitions/LookupUserOptionStockItemsCostElementResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionTaskClassification1": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Classification Allowed Value for the User Option.", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupUserOptionTaskClassification1", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/LookupUserOptionTaskClassification1ResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionTaskClassification2": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Classification Allowed Value for the User Option.", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupUserOptionTaskClassification2", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/LookupUserOptionTaskClassification2ResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionTaskClassification3": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Classification Allowed Value for the User Option.", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupUserOptionTaskClassification3", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/LookupUserOptionTaskClassification3ResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionTaskClassification4": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Classification Allowed Value for the User Option.", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupUserOptionTaskClassification4", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/LookupUserOptionTaskClassification4ResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionTaskClassification5": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Classification Allowed Value for the User Option.", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupUserOptionTaskClassification5", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/LookupUserOptionTaskClassification5ResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionTaskClassification6": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Classification Allowed Value for the User Option.", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupUserOptionTaskClassification6", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/LookupUserOptionTaskClassification6ResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionTaskClassification7": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Classification Allowed Value for the User Option.", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupUserOptionTaskClassification7", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/LookupUserOptionTaskClassification7ResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionTaskClassification8": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Classification Allowed Value for the User Option.", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupUserOptionTaskClassification8", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/LookupUserOptionTaskClassification8ResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionTaskImportance": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Task Importance for the User Option.", "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 | TaskImportance->Id | integer | int64 |\r\n| code | TaskImportance->Code | string | |\r\n| description | TaskImportance->Description | string | |\r\n", "operationId": "LookupUserOptionTaskImportance", "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 Task Importance collection", "schema": { "$ref": "#/definitions/LookupUserOptionTaskImportanceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionTaskResponsibleSection": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Section for the User Option.", "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 | Section->Id | integer | int64 |\r\n| code | Section->Code | string | |\r\n| description | Section->Description | string | |\r\n", "operationId": "LookupUserOptionTaskResponsibleSection", "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 Section collection", "schema": { "$ref": "#/definitions/LookupUserOptionTaskResponsibleSectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionTaskResponsibleStaff": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Resource for the User Option.", "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 | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| contactDetailFirstName | Resource->ContactDetailFirstName | string | |\r\n| contactDetailLastName | Resource->ContactDetailLastName | string | |\r\n", "operationId": "LookupUserOptionTaskResponsibleStaff", "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 Resource collection", "schema": { "$ref": "#/definitions/LookupUserOptionTaskResponsibleStaffResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionTaskResponsibleTrade": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Trade for the User Option.", "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 | Trade->Id | integer | int64 |\r\n| code | Trade->Code | string | |\r\n| description | Trade->Description | string | |\r\n", "operationId": "LookupUserOptionTaskResponsibleTrade", "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 Trade collection", "schema": { "$ref": "#/definitions/LookupUserOptionTaskResponsibleTradeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionTaskTypeOfWork": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Type of Work for the User Option.", "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 | TypeOfWork->Id | integer | int64 |\r\n| code | TypeOfWork->Code | string | |\r\n| description | TypeOfWork->Description | string | |\r\n", "operationId": "LookupUserOptionTaskTypeOfWork", "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 Type of Work collection", "schema": { "$ref": "#/definitions/LookupUserOptionTaskTypeOfWorkResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionTravelCostElement": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Cost Element for the User Option.", "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 | CostElement->Id | integer | int64 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n", "operationId": "LookupUserOptionTravelCostElement", "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 Cost Element collection", "schema": { "$ref": "#/definitions/LookupUserOptionTravelCostElementResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionWorkClassification1": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Classification Allowed Value for the User Option.", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupUserOptionWorkClassification1", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/LookupUserOptionWorkClassification1ResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionWorkClassification2": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Classification Allowed Value for the User Option.", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupUserOptionWorkClassification2", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/LookupUserOptionWorkClassification2ResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionWorkClassification3": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Classification Allowed Value for the User Option.", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupUserOptionWorkClassification3", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/LookupUserOptionWorkClassification3ResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionWorkClassification4": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Classification Allowed Value for the User Option.", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupUserOptionWorkClassification4", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/LookupUserOptionWorkClassification4ResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionWorkClassification5": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Classification Allowed Value for the User Option.", "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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n", "operationId": "LookupUserOptionWorkClassification5", "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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/LookupUserOptionWorkClassification5ResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionWorkOrderImportance": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Task Importance for the User Option.", "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 | WorkOrderImportance->Id | integer | int64 |\r\n| code | WorkOrderImportance->Code | string | |\r\n| description | WorkOrderImportance->Description | string | |\r\n", "operationId": "LookupUserOptionWorkOrderImportance", "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 Work Order Importance collection", "schema": { "$ref": "#/definitions/LookupUserOptionWorkOrderImportanceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionWorkOrderResponsibleSection": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Section for the User Option.", "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 | Section->Id | integer | int64 |\r\n| code | Section->Code | string | |\r\n| description | Section->Description | string | |\r\n", "operationId": "LookupUserOptionWorkOrderResponsibleSection", "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 Section collection", "schema": { "$ref": "#/definitions/LookupUserOptionWorkOrderResponsibleSectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionWorkOrderResponsibleStaff": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Resource for the User Option.", "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 | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| contactDetailFirstName | Resource->ContactDetailFirstName | string | |\r\n| contactDetailLastName | Resource->ContactDetailLastName | string | |\r\n", "operationId": "LookupUserOptionWorkOrderResponsibleStaff", "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 Resource collection", "schema": { "$ref": "#/definitions/LookupUserOptionWorkOrderResponsibleStaffResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionWorkOrderResponsibleTrade": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Trade for the User Option.", "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 | Trade->Id | integer | int64 |\r\n| code | Trade->Code | string | |\r\n| description | Trade->Description | string | |\r\n", "operationId": "LookupUserOptionWorkOrderResponsibleTrade", "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 Trade collection", "schema": { "$ref": "#/definitions/LookupUserOptionWorkOrderResponsibleTradeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionWorkOrderTypeOfWorkForConditionMonitoring": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Type of Work for the User Option.", "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 | TypeOfWork->Id | integer | int64 |\r\n| code | TypeOfWork->Code | string | |\r\n| description | TypeOfWork->Description | string | |\r\n", "operationId": "LookupUserOptionWorkOrderTypeOfWorkForConditionMonitoring", "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 Type of Work collection", "schema": { "$ref": "#/definitions/LookupUserOptionWorkOrderTypeOfWorkForConditionMonitoringResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionWorkOrderTypeOfWork": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Type of Work for the User Option.", "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 | TypeOfWork->Id | integer | int64 |\r\n| code | TypeOfWork->Code | string | |\r\n| description | TypeOfWork->Description | string | |\r\n", "operationId": "LookupUserOptionWorkOrderTypeOfWork", "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 Type of Work collection", "schema": { "$ref": "#/definitions/LookupUserOptionWorkOrderTypeOfWorkResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Lookups/LookupUserOptionDefaultWorkOrderTaskResourceCostElement": { "get": { "tags": [ "User Option" ], "summary": "Lookup the Section for the User Option.", "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 | CostElement->Id | integer | int64 |\r\n| code | CostElement->Code | string | |\r\n| description | CostElement->Description | string | |\r\n", "operationId": "LookupUserOptionDefaultWorkOrderTaskResourceCostElement", "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 Cost Element collection", "schema": { "$ref": "#/definitions/UserOptionDefaultWorkOrderTaskResourceCostElementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Batch/{ids}": { "get": { "tags": [ "User Option" ], "summary": "Get a collection of User Option 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 | UserOption->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserOption->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserOption->CreatedByUser_FullName | string | |\r\n| createdOn | UserOption->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserOption->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserOption->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserOption->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserOption->ModifiedOn | string | date-time |\r\n| version | UserOption->Version | integer | int32 |\r\n| id | UserOption->Id | integer | int64 |\r\n| adHocCostElementId | UserOption->AdHocCostElement_Id | integer | int64 |\r\n| adHocCostElementCode | UserOption->AdHocCostElement_Code | string | |\r\n| adHocCostElementDescription | UserOption->AdHocCostElement_Description | string | |\r\n| applyWorkOrderStatusRules | UserOption->ApplyWorkOrderStatusRules | boolean | |\r\n| assetConsumptionCostElementId | UserOption->AssetConsumptionCostElement_Id | integer | int64 |\r\n| assetConsumptionCostElementCode | UserOption->AssetConsumptionCostElement_Code | string | |\r\n| assetConsumptionCostElementDescription | UserOption->AssetConsumptionCostElement_Description | string | |\r\n| contractorsCostElementId | UserOption->ContractorsCostElement_Id | integer | int64 |\r\n| contractorsCostElementCode | UserOption->ContractorsCostElement_Code | string | |\r\n| contractorsCostElementDescription | UserOption->ContractorsCostElement_Description | string | |\r\n| defaultCreateSaveAction | UserOption->DefaultCreateSaveAction | string (Allowed values: [SaveAndClose, SaveAndNew, SaveAndUpdate]) | enum |\r\n| defaultUpdateSaveAction | UserOption->DefaultUpdateSaveAction | string (Allowed values: [SaveAndClose, Save]) | enum |\r\n| defaultWorkOrderTaskResourceCostElementId | UserOption->DefaultWorkOrderTaskResourceCostElement_Id | integer | int64 |\r\n| defaultWorkOrderTaskResourceCostElementCode | UserOption->DefaultWorkOrderTaskResourceCostElement_Code | string | |\r\n| defaultWorkOrderTaskResourceCostElementDescription | UserOption->DefaultWorkOrderTaskResourceCostElement_Description | string | |\r\n| directPurchasesCostElementId | UserOption->DirectPurchasesCostElement_Id | integer | int64 |\r\n| directPurchasesCostElementCode | UserOption->DirectPurchasesCostElement_Code | string | |\r\n| directPurchasesCostElementDescription | UserOption->DirectPurchasesCostElement_Description | string | |\r\n| insightsUserId | UserOption->InsightsUserId | string | |\r\n| isReportUser | UserOption->IsReportUser | boolean | |\r\n| maximumOrderAmount | UserOption->MaximumOrderAmount | number | decimal |\r\n| notes | UserOption->Notes | string | |\r\n| purchaseOrderCanBeQueued | UserOption->PurchaseOrderCanBeQueued | boolean | |\r\n| reportServerReportLanguage | UserOption->ReportServerReportLanguage | string | |\r\n| reportServerReportLanguageDisplayName | UserOption->ReportServerReportLanguageDisplayName | string | |\r\n| reportServerUILanguage | UserOption->ReportServerUILanguage | string | |\r\n| reportServerUILanguageDisplayName | UserOption->ReportServerUILanguageDisplayName | string | |\r\n| reportUserId | UserOption->ReportUserId | string | |\r\n| reportUserName | UserOption->ReportUserName | string | |\r\n| reportUserRoles | UserOption->ReportUserRoles | array | array |\r\n| requisitionLimit | UserOption->RequisitionLimit | number | decimal |\r\n| rootAssetId | UserOption->RootAsset_Id | integer | int64 |\r\n| rootAssetCode | UserOption->RootAsset_Code | string | |\r\n| rootAssetDescription | UserOption->RootAsset_Description | string | |\r\n| stockItemsCostElementId | UserOption->StockItemsCostElement_Id | integer | int64 |\r\n| stockItemsCostElementCode | UserOption->StockItemsCostElement_Code | string | |\r\n| stockItemsCostElementDescription | UserOption->StockItemsCostElement_Description | string | |\r\n| taskClassification1Id | UserOption->TaskClassification1_Id | integer | int64 |\r\n| taskClassification1Code | UserOption->TaskClassification1_Code | string | |\r\n| taskClassification1Description | UserOption->TaskClassification1_Description | string | |\r\n| taskClassification2Id | UserOption->TaskClassification2_Id | integer | int64 |\r\n| taskClassification2Code | UserOption->TaskClassification2_Code | string | |\r\n| taskClassification2Description | UserOption->TaskClassification2_Description | string | |\r\n| taskClassification3Id | UserOption->TaskClassification3_Id | integer | int64 |\r\n| taskClassification3Code | UserOption->TaskClassification3_Code | string | |\r\n| taskClassification3Description | UserOption->TaskClassification3_Description | string | |\r\n| taskClassification4Id | UserOption->TaskClassification4_Id | integer | int64 |\r\n| taskClassification4Code | UserOption->TaskClassification4_Code | string | |\r\n| taskClassification4Description | UserOption->TaskClassification4_Description | string | |\r\n| taskClassification5Id | UserOption->TaskClassification5_Id | integer | int64 |\r\n| taskClassification5Code | UserOption->TaskClassification5_Code | string | |\r\n| taskClassification5Description | UserOption->TaskClassification5_Description | string | |\r\n| taskClassification6Id | UserOption->TaskClassification6_Id | integer | int64 |\r\n| taskClassification6Code | UserOption->TaskClassification6_Code | string | |\r\n| taskClassification6Description | UserOption->TaskClassification6_Description | string | |\r\n| taskClassification7Id | UserOption->TaskClassification7_Id | integer | int64 |\r\n| taskClassification7Code | UserOption->TaskClassification7_Code | string | |\r\n| taskClassification7Description | UserOption->TaskClassification7_Description | string | |\r\n| taskClassification8Id | UserOption->TaskClassification8_Id | integer | int64 |\r\n| taskClassification8Code | UserOption->TaskClassification8_Code | string | |\r\n| taskClassification8Description | UserOption->TaskClassification8_Description | string | |\r\n| taskImportanceId | UserOption->TaskImportance_Id | integer | int64 |\r\n| taskImportanceCode | UserOption->TaskImportance_Code | string | |\r\n| taskImportanceDescription | UserOption->TaskImportance_Description | string | |\r\n| taskResponsibleSectionId | UserOption->TaskResponsibleSection_Id | integer | int64 |\r\n| taskResponsibleSectionCode | UserOption->TaskResponsibleSection_Code | string | |\r\n| taskResponsibleSectionDescription | UserOption->TaskResponsibleSection_Description | string | |\r\n| taskResponsibleStaffId | UserOption->TaskResponsibleStaff_Id | integer | int64 |\r\n| taskResponsibleStaffCode | UserOption->TaskResponsibleStaff_Code | string | |\r\n| taskResponsibleStaffDescription | UserOption->TaskResponsibleStaff_Description | string | |\r\n| taskResponsibleTradeId | UserOption->TaskResponsibleTrade_Id | integer | int64 |\r\n| taskResponsibleTradeCode | UserOption->TaskResponsibleTrade_Code | string | |\r\n| taskResponsibleTradeDescription | UserOption->TaskResponsibleTrade_Description | string | |\r\n| taskTypeOfWorkId | UserOption->TaskTypeOfWork_Id | integer | int64 |\r\n| taskTypeOfWorkCode | UserOption->TaskTypeOfWork_Code | string | |\r\n| taskTypeOfWorkDescription | UserOption->TaskTypeOfWork_Description | string | |\r\n| travelCostElementId | UserOption->TravelCostElement_Id | integer | int64 |\r\n| travelCostElementCode | UserOption->TravelCostElement_Code | string | |\r\n| travelCostElementDescription | UserOption->TravelCostElement_Description | string | |\r\n| userId | UserOption->User_Id | integer | int64 |\r\n| userCode | UserOption->User_Code | string | |\r\n| userFullName | UserOption->User_FullName | string | |\r\n| workClassification1Id | UserOption->WorkClassification1_Id | integer | int64 |\r\n| workClassification1Code | UserOption->WorkClassification1_Code | string | |\r\n| workClassification1Description | UserOption->WorkClassification1_Description | string | |\r\n| workClassification2Id | UserOption->WorkClassification2_Id | integer | int64 |\r\n| workClassification2Code | UserOption->WorkClassification2_Code | string | |\r\n| workClassification2Description | UserOption->WorkClassification2_Description | string | |\r\n| workClassification3Id | UserOption->WorkClassification3_Id | integer | int64 |\r\n| workClassification3Code | UserOption->WorkClassification3_Code | string | |\r\n| workClassification3Description | UserOption->WorkClassification3_Description | string | |\r\n| workClassification4Id | UserOption->WorkClassification4_Id | integer | int64 |\r\n| workClassification4Code | UserOption->WorkClassification4_Code | string | |\r\n| workClassification4Description | UserOption->WorkClassification4_Description | string | |\r\n| workClassification5Id | UserOption->WorkClassification5_Id | integer | int64 |\r\n| workClassification5Code | UserOption->WorkClassification5_Code | string | |\r\n| workClassification5Description | UserOption->WorkClassification5_Description | string | |\r\n| workOrderCanBeQueued | UserOption->WorkOrderCanBeQueued | boolean | |\r\n| workOrderImportanceId | UserOption->WorkOrderImportance_Id | integer | int64 |\r\n| workOrderImportanceCode | UserOption->WorkOrderImportance_Code | string | |\r\n| workOrderImportanceDescription | UserOption->WorkOrderImportance_Description | string | |\r\n| workOrderLimit | UserOption->WorkOrderLimit | number | decimal |\r\n| workOrderResponsibleSectionId | UserOption->WorkOrderResponsibleSection_Id | integer | int64 |\r\n| workOrderResponsibleSectionCode | UserOption->WorkOrderResponsibleSection_Code | string | |\r\n| workOrderResponsibleSectionDescription | UserOption->WorkOrderResponsibleSection_Description | string | |\r\n| workOrderResponsibleStaffId | UserOption->WorkOrderResponsibleStaff_Id | integer | int64 |\r\n| workOrderResponsibleStaffCode | UserOption->WorkOrderResponsibleStaff_Code | string | |\r\n| workOrderResponsibleStaffDescription | UserOption->WorkOrderResponsibleStaff_Description | string | |\r\n| workOrderResponsibleTradeId | UserOption->WorkOrderResponsibleTrade_Id | integer | int64 |\r\n| workOrderResponsibleTradeCode | UserOption->WorkOrderResponsibleTrade_Code | string | |\r\n| workOrderResponsibleTradeDescription | UserOption->WorkOrderResponsibleTrade_Description | string | |\r\n| workOrderTypeOfWorkId | UserOption->WorkOrderTypeOfWork_Id | integer | int64 |\r\n| workOrderTypeOfWorkCode | UserOption->WorkOrderTypeOfWork_Code | string | |\r\n| workOrderTypeOfWorkDescription | UserOption->WorkOrderTypeOfWork_Description | string | |\r\n| workOrderTypeOfWorkForConditionMonitoringId | UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Id | integer | int64 |\r\n| workOrderTypeOfWorkForConditionMonitoringCode | UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Code | string | |\r\n| workOrderTypeOfWorkForConditionMonitoringDescription | UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Description | string | |\r\n", "operationId": "BatchGetUserOption", "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 User Option 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 User Option collection", "schema": { "$ref": "#/definitions/BatchGetUserOptionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/Options/Batch": { "patch": { "tags": [ "User Option" ], "summary": "Update a collection of existing User Option 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 | UserOption->Id | integer | int64 |\r\n| version | UserOption->Version | integer | int32 |\r\n| adHocCostElementId | UserOption->AdHocCostElement_Id | integer | int64 |\r\n| applyWorkOrderStatusRules | UserOption->ApplyWorkOrderStatusRules | boolean | |\r\n| assetConsumptionCostElementId | UserOption->AssetConsumptionCostElement_Id | integer | int64 |\r\n| contractorsCostElementId | UserOption->ContractorsCostElement_Id | integer | int64 |\r\n| directPurchasesCostElementId | UserOption->DirectPurchasesCostElement_Id | integer | int64 |\r\n| defaultWorkOrderTaskResourceCostElementId | UserOption->DefaultWorkOrderTaskResourceCostElement_Id | integer | int64 |\r\n| maximumOrderAmount | UserOption->MaximumOrderAmount | number | decimal |\r\n| notes | UserOption->Notes | string | |\r\n| purchaseOrderCanBeQueued | UserOption->PurchaseOrderCanBeQueued | boolean | |\r\n| requisitionLimit | UserOption->RequisitionLimit | number | decimal |\r\n| workOrderResponsibleSectionId | UserOption->WorkOrderResponsibleSection_Id | integer | int64 |\r\n| workOrderResponsibleStaffId | UserOption->WorkOrderResponsibleStaff_Id | integer | int64 |\r\n| workOrderResponsibleTradeId | UserOption->WorkOrderResponsibleTrade_Id | integer | int64 |\r\n| taskResponsibleSectionId | UserOption->TaskResponsibleSection_Id | integer | int64 |\r\n| taskResponsibleStaffId | UserOption->TaskResponsibleStaff_Id | integer | int64 |\r\n| taskResponsibleTradeId | UserOption->TaskResponsibleTrade_Id | integer | int64 |\r\n| rootAssetId | UserOption->RootAsset_Id | integer | int64 |\r\n| stockItemsCostElementId | UserOption->StockItemsCostElement_Id | integer | int64 |\r\n| taskClassification1Id | UserOption->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | UserOption->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | UserOption->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | UserOption->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | UserOption->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | UserOption->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | UserOption->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | UserOption->TaskClassification8_Id | integer | int64 |\r\n| taskImportanceId | UserOption->TaskImportance_Id | integer | int64 |\r\n| travelCostElementId | UserOption->TravelCostElement_Id | integer | int64 |\r\n| taskTypeOfWorkId | UserOption->TaskTypeOfWork_Id | integer | int64 |\r\n| workOrderTypeOfWorkId | UserOption->WorkOrderTypeOfWork_Id | integer | int64 |\r\n| workOrderTypeOfWorkForConditionMonitoringId | UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Id | integer | int64 |\r\n| workClassification1Id | UserOption->WorkClassification1_Id | integer | int64 |\r\n| workClassification2Id | UserOption->WorkClassification2_Id | integer | int64 |\r\n| workClassification3Id | UserOption->WorkClassification3_Id | integer | int64 |\r\n| workClassification4Id | UserOption->WorkClassification4_Id | integer | int64 |\r\n| workClassification5Id | UserOption->WorkClassification5_Id | integer | int64 |\r\n| workOrderCanBeQueued | UserOption->WorkOrderCanBeQueued | boolean | |\r\n| reportUserRoles | UserOption->ReportUserRoles | array | array |\r\n| isReportUser | UserOption->IsReportUser | boolean | |\r\n| workOrderImportanceId | UserOption->WorkOrderImportance_Id | integer | int64 |\r\n| workOrderLimit | UserOption->WorkOrderLimit | number | decimal |\r\n| reportServerUILanguage | UserOption->ReportServerUILanguage | string | |\r\n| reportServerReportLanguage | UserOption->ReportServerReportLanguage | string | |\r\n| defaultCreateSaveAction | UserOption->DefaultCreateSaveAction | string (Allowed values: [SaveAndClose, SaveAndNew, SaveAndUpdate]) | enum |\r\n| defaultUpdateSaveAction | UserOption->DefaultUpdateSaveAction | string (Allowed values: [SaveAndClose, Save]) | enum |\r\n| insightsUserId | UserOption->InsightsUserId | 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| reportServerUILanguage | Max Length | <= 50 chars| |\r\n| reportServerReportLanguage | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "BatchUpdateUserOption", "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/BatchUpdateUserOptionResourceActionResponse" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Option 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/UAM/Users/Options/MatchBatch": { "patch": { "tags": [ "User Option" ], "summary": "Update a collection of existing User Option 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 | UserOption->Id | integer | int64 |\r\n| version | UserOption->Version | integer | int32 |\r\n| applyWorkOrderStatusRules | UserOption->ApplyWorkOrderStatusRules | boolean | |\r\n| assetConsumptionCostElementId | UserOption->AssetConsumptionCostElement_Id | integer | int64 |\r\n| contractorsCostElementId | UserOption->ContractorsCostElement_Id | integer | int64 |\r\n| directPurchasesCostElementId | UserOption->DirectPurchasesCostElement_Id | integer | int64 |\r\n| defaultWorkOrderTaskResourceCostElementId | UserOption->DefaultWorkOrderTaskResourceCostElement_Id | integer | int64 |\r\n| notes | UserOption->Notes | string | |\r\n| requisitionLimit | UserOption->RequisitionLimit | number | decimal |\r\n| workOrderResponsibleSectionId | UserOption->WorkOrderResponsibleSection_Id | integer | int64 |\r\n| workOrderResponsibleStaffId | UserOption->WorkOrderResponsibleStaff_Id | integer | int64 |\r\n| workOrderResponsibleTradeId | UserOption->WorkOrderResponsibleTrade_Id | integer | int64 |\r\n| taskResponsibleSectionId | UserOption->TaskResponsibleSection_Id | integer | int64 |\r\n| taskResponsibleStaffId | UserOption->TaskResponsibleStaff_Id | integer | int64 |\r\n| taskResponsibleTradeId | UserOption->TaskResponsibleTrade_Id | integer | int64 |\r\n| rootAssetId | UserOption->RootAsset_Id | integer | int64 |\r\n| stockItemsCostElementId | UserOption->StockItemsCostElement_Id | integer | int64 |\r\n| taskClassification1Id | UserOption->TaskClassification1_Id | integer | int64 |\r\n| taskClassification2Id | UserOption->TaskClassification2_Id | integer | int64 |\r\n| taskClassification3Id | UserOption->TaskClassification3_Id | integer | int64 |\r\n| taskClassification4Id | UserOption->TaskClassification4_Id | integer | int64 |\r\n| taskClassification5Id | UserOption->TaskClassification5_Id | integer | int64 |\r\n| taskClassification6Id | UserOption->TaskClassification6_Id | integer | int64 |\r\n| taskClassification7Id | UserOption->TaskClassification7_Id | integer | int64 |\r\n| taskClassification8Id | UserOption->TaskClassification8_Id | integer | int64 |\r\n| taskImportanceId | UserOption->TaskImportance_Id | integer | int64 |\r\n| taskTypeOfWorkId | UserOption->TaskTypeOfWork_Id | integer | int64 |\r\n| workOrderTypeOfWorkId | UserOption->WorkOrderTypeOfWork_Id | integer | int64 |\r\n| workOrderImportanceId | UserOption->WorkOrderImportance_Id | integer | int64 |\r\n| workClassification1Id | UserOption->WorkClassification1_Id | integer | int64 |\r\n| workClassification2Id | UserOption->WorkClassification2_Id | integer | int64 |\r\n| workClassification3Id | UserOption->WorkClassification3_Id | integer | int64 |\r\n| workClassification4Id | UserOption->WorkClassification4_Id | integer | int64 |\r\n| workClassification5Id | UserOption->WorkClassification5_Id | integer | int64 |\r\n| workOrderLimit | UserOption->WorkOrderLimit | number | decimal |\r\n| isReportUser | UserOption->IsReportUser | boolean | |\r\n| reportUserRoles | UserOption->ReportUserRoles | array | array |\r\n| reportServerUILanguage | UserOption->ReportServerUILanguage | string | |\r\n| reportServerReportLanguage | UserOption->ReportServerReportLanguage | string | |\r\n| insightsUserId | UserOption->InsightsUserId | 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| reportServerUILanguage | Max Length | <= 50 chars| |\r\n| reportServerReportLanguage | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "MatchUpdateUserOption", "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/MatchUpdateUserOptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Option 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/UAM/Users/SecurityRoles/{id}": { "get": { "tags": [ "User Security Role" ], "summary": "Get a User Security Role 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 | UserSecurityRole->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserSecurityRole->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserSecurityRole->CreatedByUser_FullName | string | |\r\n| createdOn | UserSecurityRole->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserSecurityRole->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserSecurityRole->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserSecurityRole->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserSecurityRole->ModifiedOn | string | date-time |\r\n| version | UserSecurityRole->Version | integer | int32 |\r\n| id | UserSecurityRole->Id | integer | int64 |\r\n| applyDownPermissionTree | UserSecurityRole->ApplyDownPermissionTree | boolean | |\r\n| notes | UserSecurityRole->Notes | string | |\r\n| rolePermissionTreeId | UserSecurityRole->RolePermissionTreeId | array | array |\r\n| securityRoleId | UserSecurityRole->SecurityRole_Id | integer | int64 |\r\n| securityRoleDescription | UserSecurityRole->SecurityRole_Description | string | |\r\n| securityRoleCode | UserSecurityRole->SecurityRole_Code | string | |\r\n| securityRoleIsPermissionTreeRole | UserSecurityRole->SecurityRole_IsPermissionTreeRole | boolean | |\r\n| userId | UserSecurityRole->User_Id | integer | int64 |\r\n| userCode | UserSecurityRole->User_Code | string | |\r\n| userFullName | UserSecurityRole->User_FullName | string | |\r\n| validFrom | UserSecurityRole->ValidFrom | string | date-time |\r\n| validInRange | UserSecurityRole->ValidInRange | boolean | |\r\n| validTo | UserSecurityRole->ValidTo | string | date-time |\r\n", "operationId": "GetUserSecurityRole", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Security Role Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Security Role", "schema": { "$ref": "#/definitions/GetRoleResourceActionResponse2" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "User Security Role" ], "summary": "Update an existing User Security Role 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| rolePermissionTreeId | UserSecurityRole->RolePermissionTreeId | array | array |\r\n| applyDownPermissionTree | UserSecurityRole->ApplyDownPermissionTree | boolean | |\r\n| version | UserSecurityRole->Version | integer | int32 |\r\n| validFrom | UserSecurityRole->ValidFrom | string | date-time |\r\n| validTo | UserSecurityRole->ValidTo | string | date-time |\r\n| notes | UserSecurityRole->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\r\n", "operationId": "UpdateUserSecurityRole", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Security Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRoleResourceActionRequest2" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Security Role 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": [ "User Security Role" ], "summary": "Delete an existing User Security Role 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 | UserSecurityRole->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": "DeleteUserSecurityRole", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Security Role Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRoleResourceActionRequest2" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Security Role 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/UAM/Users/SecurityRoles/{userSecurityRoleId}/PermissionTrees": { "get": { "tags": [ "User Security Role" ], "summary": "Get a list of Permission Tree resources for the User Security Role.", "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| isActive | PermissionTree->IsActive | boolean | |\r\n", "operationId": "GetUserSecurityRolePermissionTreeCollection", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "userSecurityRoleId", "in": "path", "required": true, "format": "int64", "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Security Role collection", "schema": { "$ref": "#/definitions/GetUserSecurityRolePermissionTreeCollectionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/SecurityRoles": { "get": { "tags": [ "User Security Role" ], "summary": "Get a collection of User Security Role 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 | UserSecurityRole->Version | integer | int32 |\r\n| id | UserSecurityRole->Id | integer | int64 |\r\n| userFullName | UserSecurityRole->User_FullName | string | |\r\n| securityRoleCode | UserSecurityRole->SecurityRole_Code | string | |\r\n| securityRoleDescription | UserSecurityRole->SecurityRole_Description | string | |\r\n| applyDownPermissionTree | UserSecurityRole->ApplyDownPermissionTree | boolean | |\r\n| validFrom | UserSecurityRole->ValidFrom | string | date-time |\r\n| validTo | UserSecurityRole->ValidTo | string | date-time |\r\n| validInRange | UserSecurityRole->ValidInRange | boolean | |\r\n| notes | UserSecurityRole->Notes | string | |\r\n", "operationId": "GetUserSecurityRoleCollection", "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 User Security Role collection", "schema": { "$ref": "#/definitions/GetRoleCollectionResourceActionResponse2" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "User Security Role" ], "summary": "Create a new User Security Role 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| userId | UserSecurityRole->User_Id | integer | int64 |\r\n| securityRoleId | UserSecurityRole->SecurityRole_Id | integer | int64 |\r\n| applyDownPermissionTree | UserSecurityRole->ApplyDownPermissionTree | boolean | |\r\n| rolePermissionTreeId | UserSecurityRole->RolePermissionTreeId | array | array |\r\n| validFrom | UserSecurityRole->ValidFrom | string | date-time |\r\n| validTo | UserSecurityRole->ValidTo | string | date-time |\r\n| notes | UserSecurityRole->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| userId | Required | True | |\r\n| userId | Nullable | False | |\r\n| securityRoleId | Required | True | |\r\n| securityRoleId | Nullable | False | |\r\n| applyDownPermissionTree | Required | True | |\r\n| applyDownPermissionTree | Nullable | False | |\r\n\r\n", "operationId": "CreateUserSecurityRole", "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/CreateRoleResourceActionRequest2" } }, { "$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/UAM/Users/{userId}/SecurityRoles": { "get": { "tags": [ "User Security Role" ], "summary": "Get a collection of User Security Role resources for the User.", "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 | UserSecurityRole->Version | integer | int32 |\r\n| id | UserSecurityRole->Id | integer | int64 |\r\n| userFullName | UserSecurityRole->User_FullName | string | |\r\n| securityRoleCode | UserSecurityRole->SecurityRole_Code | string | |\r\n| securityRoleDescription | UserSecurityRole->SecurityRole_Description | string | |\r\n| applyDownPermissionTree | UserSecurityRole->ApplyDownPermissionTree | boolean | |\r\n| validFrom | UserSecurityRole->ValidFrom | string | date-time |\r\n| validTo | UserSecurityRole->ValidTo | string | date-time |\r\n| notes | UserSecurityRole->Notes | string | |\r\n", "operationId": "GetUserSecurityRoleForUserCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "userId", "in": "path", "required": true, "description": "User 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 User Security Role collection", "schema": { "$ref": "#/definitions/GetUserSecurityRoleForUserCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/SecurityRoles/Lookups/LookupUserSecurityRolePermissionTree": { "get": { "tags": [ "User Security Role" ], "summary": "User Security Role", "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| isActive | PermissionTree->IsActive | boolean | |\r\n", "operationId": "LookupUserSecurityRolePermissionTree", "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 Permission Tree collection", "schema": { "$ref": "#/definitions/UserSecurityRolePermissionPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/SecurityRoles/Lookups/LookupUserSecurityRoleSecurityRole": { "get": { "tags": [ "User Security Role" ], "summary": "Lookup the User Security Role for the User Security Role.", "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 | SecurityRole->Id | integer | int64 |\r\n| code | SecurityRole->Code | string | |\r\n| description | SecurityRole->Description | string | |\r\n| isPermissionTreeRole | SecurityRole->IsPermissionTreeRole | boolean | |\r\n", "operationId": "LookupUserSecurityRoleSecurityRole", "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 Security Role collection", "schema": { "$ref": "#/definitions/UserSecurityRoleSecurityRoleLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/SecurityRoles/Lookups/LookupUserSecurityRoleUser": { "get": { "tags": [ "User Security Role" ], "summary": "Lookup the User Security Role for the User Security Role.", "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 | User->Id | integer | int64 |\r\n| fullName | User->FullName | string | |\r\n", "operationId": "LookupUserSecurityRoleUser", "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 User collection", "schema": { "$ref": "#/definitions/UserSecurityRoleUserLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/SecurityRoles/Batch/{ids}": { "get": { "tags": [ "User Security Role" ], "summary": "Get a collection of User Security Role 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 | UserSecurityRole->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserSecurityRole->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserSecurityRole->CreatedByUser_FullName | string | |\r\n| createdOn | UserSecurityRole->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserSecurityRole->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserSecurityRole->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserSecurityRole->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserSecurityRole->ModifiedOn | string | date-time |\r\n| version | UserSecurityRole->Version | integer | int32 |\r\n| id | UserSecurityRole->Id | integer | int64 |\r\n| applyDownPermissionTree | UserSecurityRole->ApplyDownPermissionTree | boolean | |\r\n| notes | UserSecurityRole->Notes | string | |\r\n| rolePermissionTreeId | UserSecurityRole->RolePermissionTreeId | array | array |\r\n| securityRoleId | UserSecurityRole->SecurityRole_Id | integer | int64 |\r\n| securityRoleDescription | UserSecurityRole->SecurityRole_Description | string | |\r\n| securityRoleCode | UserSecurityRole->SecurityRole_Code | string | |\r\n| securityRoleIsPermissionTreeRole | UserSecurityRole->SecurityRole_IsPermissionTreeRole | boolean | |\r\n| userId | UserSecurityRole->User_Id | integer | int64 |\r\n| userCode | UserSecurityRole->User_Code | string | |\r\n| userFullName | UserSecurityRole->User_FullName | string | |\r\n| validFrom | UserSecurityRole->ValidFrom | string | date-time |\r\n| validInRange | UserSecurityRole->ValidInRange | boolean | |\r\n| validTo | UserSecurityRole->ValidTo | string | date-time |\r\n", "operationId": "BatchGetUserSecurityRole", "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 User Security Role 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 User Security Role collection", "schema": { "$ref": "#/definitions/BatchGetUserSecurityRoleResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/SecurityRoles/Batch": { "post": { "tags": [ "User Security Role" ], "summary": "Create a new collection of User Security Role 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| userId | UserSecurityRole->User_Id | integer | int64 |\r\n| securityRoleId | UserSecurityRole->SecurityRole_Id | integer | int64 |\r\n| applyDownPermissionTree | UserSecurityRole->ApplyDownPermissionTree | boolean | |\r\n| rolePermissionTreeId | UserSecurityRole->RolePermissionTreeId | array | array |\r\n| validFrom | UserSecurityRole->ValidFrom | string | date-time |\r\n| validTo | UserSecurityRole->ValidTo | string | date-time |\r\n| notes | UserSecurityRole->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| userId | Required | True | |\r\n| userId | Nullable | False | |\r\n| securityRoleId | Required | True | |\r\n| securityRoleId | Nullable | False | |\r\n| applyDownPermissionTree | Required | True | |\r\n| applyDownPermissionTree | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateUserSecurityRole", "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/BatchCreateRoleResourceActionRequest2" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - User Security Role 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": [ "User Security Role" ], "summary": "Update a collection of existing User Security Role 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 | UserSecurityRole->Id | integer | int64 |\r\n| version | UserSecurityRole->Version | integer | int32 |\r\n| applyDownPermissionTree | UserSecurityRole->ApplyDownPermissionTree | boolean | |\r\n| rolePermissionTreeId | UserSecurityRole->RolePermissionTreeId | array | array |\r\n| validFrom | UserSecurityRole->ValidFrom | string | date-time |\r\n| validTo | UserSecurityRole->ValidTo | string | date-time |\r\n| notes | UserSecurityRole->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\r\n", "operationId": "BatchUpdateUserSecurityRole", "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/BatchUpdateRoleResourceActionRequest2" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Security Role 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": [ "User Security Role" ], "summary": "Delete a collection of existing User Security Role 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 | UserSecurityRole->Id | integer | int64 |\r\n| version | UserSecurityRole->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": "BatchDeleteUserSecurityRole", "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/BatchDeleteRoleResourceActionRequest2" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Security Role 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/UAM/User/TermsAndConditionVersions/{id}": { "get": { "tags": [ "User Terms And Conditions Version" ], "summary": "Get a User Terms And Conditions Version 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 | UserTermsAndConditionVersion->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserTermsAndConditionVersion->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserTermsAndConditionVersion->CreatedByUser_FullName | string | |\r\n| createdOn | UserTermsAndConditionVersion->CreatedOn | string | date-time |\r\n| permissionTreeId | UserTermsAndConditionVersion->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UserTermsAndConditionVersion->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UserTermsAndConditionVersion->PermissionTree_Description | string | |\r\n| id | UserTermsAndConditionVersion->Id | integer | int64 |\r\n| version | UserTermsAndConditionVersion->Version | integer | int32 |\r\n| accepted | UserTermsAndConditionVersion->Accepted | boolean | |\r\n| acceptedDate | UserTermsAndConditionVersion->AcceptedDate | string | date |\r\n| deprecated | UserTermsAndConditionVersion->Deprecated | boolean | |\r\n| termsAndConditionVersionId | UserTermsAndConditionVersion->TermsAndConditionVersion_Id | integer | int64 |\r\n| termsAndConditionVersionContentVersion | UserTermsAndConditionVersion->TermsAndConditionVersion_ContentVersion | integer | int32 |\r\n| termsAndConditionVersionLanguageId | UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Id | integer | int64 |\r\n| termsAndConditionVersionLanguageCode | UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Code | string | |\r\n| termsAndConditionVersionTermsAndConditionId | UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Id | integer | int64 |\r\n| termsAndConditionVersionTermsAndConditionName | UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Name | string | |\r\n| termsAndConditionVersionContent | UserTermsAndConditionVersion->TermsAndConditionVersion_Content | string | |\r\n| userId | UserTermsAndConditionVersion->User_Id | integer | int64 |\r\n| userCode | UserTermsAndConditionVersion->User_Code | string | |\r\n| userFullName | UserTermsAndConditionVersion->User_FullName | string | |\r\n", "operationId": "GetUserTermsAndConditionVersion", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Terms And Conditions Version Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Terms And Conditions Version", "schema": { "$ref": "#/definitions/GetUserTermsAndConditionVersionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/User/TermsAndConditionVersions": { "get": { "tags": [ "User Terms And Conditions Version" ], "summary": "Get a collection of User Terms And Conditions Version 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 | UserTermsAndConditionVersion->Id | integer | int64 |\r\n| version | UserTermsAndConditionVersion->Version | integer | int32 |\r\n| userCode | UserTermsAndConditionVersion->User_Code | string | |\r\n| termsAndConditionVersionTermsAndConditionCode | UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Code | string | |\r\n| termsAndConditionVersionTermsAndConditionName | UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Name | string | |\r\n| termsAndConditionVersionLanguageCode | UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Code | string | |\r\n| termsAndConditionVersionPublished | UserTermsAndConditionVersion->TermsAndConditionVersion_Published | boolean | |\r\n| termsAndConditionVersionContentVersion | UserTermsAndConditionVersion->TermsAndConditionVersion_ContentVersion | integer | int32 |\r\n| deprecated | UserTermsAndConditionVersion->Deprecated | boolean | |\r\n| accepted | UserTermsAndConditionVersion->Accepted | boolean | |\r\n| acceptedDate | UserTermsAndConditionVersion->AcceptedDate | string | date |\r\n", "operationId": "GetUserTermsAndConditionVersionCollection", "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 User Terms And Conditions Version collection", "schema": { "$ref": "#/definitions/GetUserTermsAndConditionVersionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/Users/{id}/TermsAndConditionVersion": { "get": { "tags": [ "User Terms And Conditions Version" ], "summary": "Get a collection of User Terms And Conditions Version 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 | UserTermsAndConditionVersion->Id | integer | int64 |\r\n| version | UserTermsAndConditionVersion->Version | integer | int32 |\r\n| termsAndConditionVersionTermsAndConditionCode | UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Code | string | |\r\n| termsAndConditionVersionTermsAndConditionName | UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Name | string | |\r\n| termsAndConditionVersionLanguageCode | UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Code | string | |\r\n| termsAndConditionVersionPublished | UserTermsAndConditionVersion->TermsAndConditionVersion_Published | boolean | |\r\n| termsAndConditionVersionContentVersion | UserTermsAndConditionVersion->TermsAndConditionVersion_ContentVersion | integer | int32 |\r\n| deprecated | UserTermsAndConditionVersion->Deprecated | boolean | |\r\n| accepted | UserTermsAndConditionVersion->Accepted | boolean | |\r\n| acceptedDate | UserTermsAndConditionVersion->AcceptedDate | string | date |\r\n", "operationId": "GetUserTermsAndConditionVersionForUserCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User 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 User Terms And Conditions Version collection", "schema": { "$ref": "#/definitions/GetUserTermsAndConditionVersionForUserCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/UAM/User/TermsAndConditionVersions/Batch/{ids}": { "get": { "tags": [ "User Terms And Conditions Version" ], "summary": "Get a collection of User Terms And Conditions Version 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 | UserTermsAndConditionVersion->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserTermsAndConditionVersion->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserTermsAndConditionVersion->CreatedByUser_FullName | string | |\r\n| createdOn | UserTermsAndConditionVersion->CreatedOn | string | date-time |\r\n| permissionTreeId | UserTermsAndConditionVersion->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UserTermsAndConditionVersion->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UserTermsAndConditionVersion->PermissionTree_Description | string | |\r\n| id | UserTermsAndConditionVersion->Id | integer | int64 |\r\n| version | UserTermsAndConditionVersion->Version | integer | int32 |\r\n| accepted | UserTermsAndConditionVersion->Accepted | boolean | |\r\n| acceptedDate | UserTermsAndConditionVersion->AcceptedDate | string | date |\r\n| deprecated | UserTermsAndConditionVersion->Deprecated | boolean | |\r\n| termsAndConditionVersionId | UserTermsAndConditionVersion->TermsAndConditionVersion_Id | integer | int64 |\r\n| termsAndConditionVersionContentVersion | UserTermsAndConditionVersion->TermsAndConditionVersion_ContentVersion | integer | int32 |\r\n| termsAndConditionVersionLanguageId | UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Id | integer | int64 |\r\n| termsAndConditionVersionLanguageCode | UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Code | string | |\r\n| termsAndConditionVersionTermsAndConditionId | UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Id | integer | int64 |\r\n| termsAndConditionVersionTermsAndConditionName | UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Name | string | |\r\n| termsAndConditionVersionContent | UserTermsAndConditionVersion->TermsAndConditionVersion_Content | string | |\r\n| userId | UserTermsAndConditionVersion->User_Id | integer | int64 |\r\n| userCode | UserTermsAndConditionVersion->User_Code | string | |\r\n| userFullName | UserTermsAndConditionVersion->User_FullName | string | |\r\n", "operationId": "BatchGetUserTermsAndConditionVersion", "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 User Terms And Conditions Version 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 User Terms And Conditions Version collection", "schema": { "$ref": "#/definitions/BatchGetUserTermsAndConditionVersionResourceAction" } }, "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" ] }, "GetOperationalRoleResourceActionResponse": { "title": "GetOperationalRoleResourceActionResponse", "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": "GetOperationalRoleResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRole->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "OperationalRole->IsActive" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "OperationalRole->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRole->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRole->PermissionTree_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OperationalRole->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRole->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRole->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "OperationalRole->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OperationalRole->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRole->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRole->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "OperationalRole->ModifiedOn" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRole->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRole->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "OperationalRole->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" } } }, "GetOperationalRoleCollectionResourceActionResponse": { "title": "GetOperationalRoleCollectionResourceActionResponse", "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": "GetOperationalRoleCollectionResourceActionResponseItem", "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": "GetOperationalRoleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRole->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRole->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "OperationalRole->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "OperationalRole->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" } } } }, "OperationalRoleChangePermissionTreeLookupResourceActionResponse": { "title": "OperationalRoleChangePermissionTreeLookupResourceActionResponse", "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": "OperationalRoleChangePermissionTreeLookupResourceActionResponseItem", "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": "OperationalRoleChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "OperationalRoleInsertPermissionTreeLookupResourceActionResponse": { "title": "OperationalRoleInsertPermissionTreeLookupResourceActionResponse", "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": "OperationalRoleInsertPermissionTreeLookupResourceActionResponseItem", "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": "OperationalRoleInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateOperationalRoleResourceActionRequest": { "title": "CreateOperationalRoleResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateOperationalRoleResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "OperationalRole->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "OperationalRole->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "OperationalRole->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "OperationalRole->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRole->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" } } }, "UpdateOperationalRoleResourceActionRequest": { "title": "UpdateOperationalRoleResourceActionRequest", "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": "OperationalRole->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "OperationalRole->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "OperationalRole->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRole->Notes" } ] } } }, "DeleteOperationalRoleResourceActionRequest": { "title": "DeleteOperationalRoleResourceActionRequest", "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 } } }, "BatchGetOperationalRoleResourceAction": { "title": "BatchGetOperationalRoleResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Operational Role entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Operational Role entities", "items": { "$ref": "#/definitions/GetOperationalRoleResourceActionResponse" } }, "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" } } }, "BatchCreateOperationalRoleResourceActionRequest": { "title": "BatchCreateOperationalRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateOperationalRoleResourceActionRequest" } }, "BatchUpdateOperationalRoleResourceActionRequest": { "title": "BatchUpdateOperationalRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateOperationalRoleResourceActionRequest" } }, "BatchDeleteOperationalRoleResourceActionRequest": { "title": "BatchDeleteOperationalRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteOperationalRoleResourceActionRequest" } }, "ChangeOperationalRoleIsActiveResourceActionRequest": { "title": "ChangeOperationalRoleIsActiveResourceActionRequest", "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": "OperationalRole->IsActive" } ] } } }, "ChangeOperationalRolePermissionTreeResourceActionRequest": { "title": "ChangeOperationalRolePermissionTreeResourceActionRequest", "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": "OperationalRole->PermissionTree_Id" } ] } } }, "BatchChangeOperationalRoleIsActiveResourceActionRequest": { "title": "BatchChangeOperationalRoleIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeOperationalRoleIsActiveResourceActionRequest" } }, "BatchChangeOperationalRolePermissionTreeResourceActionRequest": { "title": "BatchChangeOperationalRolePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeOperationalRolePermissionTreeResourceActionRequest" } }, "GetOperationalRoleResourceResourceActionResponse": { "title": "GetOperationalRoleResourceResourceActionResponse", "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": "GetOperationalRoleResourceResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "OperationalRoleResource->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "OperationalRoleResource->ModifiedOn" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->InheritedFrom_Id" }, "inheritedFromType": { "title": "inheritedFromType", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->InheritedFrom_Type" }, "inheritedFromModule": { "title": "inheritedFromModule", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->InheritedFrom_Module" }, "inheritedFromIsDefault": { "title": "inheritedFromIsDefault", "type": "boolean", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->InheritedFrom_IsDefault" }, "inheritedFromTemplate": { "title": "inheritedFromTemplate", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->InheritedFrom_Template" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->IsDefault" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->IsInherited" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->Module" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->Notes" }, "operationalRoleId": { "title": "operationalRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->OperationalRole_Id" }, "operationalRoleCode": { "title": "operationalRoleCode", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->OperationalRole_Code" }, "operationalRoleDescription": { "title": "operationalRoleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->OperationalRole_Description" }, "resource": { "title": "resource", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->Resource" }, "resourceAction": { "title": "resourceAction", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->ResourceAction" }, "resourceActionCustomisationId": { "title": "resourceActionCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->ResourceActionCustomisation_Id" }, "resourceActionCustomisationName": { "title": "resourceActionCustomisationName", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->ResourceActionCustomisation_Name" }, "resourceActionCustomisationDescription": { "title": "resourceActionCustomisationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->ResourceActionCustomisation_Description" }, "resourceActionCustomisationRestrictionLevel": { "title": "resourceActionCustomisationRestrictionLevel", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->ResourceActionCustomisation_RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->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" } } }, "GetOperationalRoleResourceCollectionResourceActionResponse": { "title": "GetOperationalRoleResourceCollectionResourceActionResponse", "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": "GetOperationalRoleResourceCollectionResourceActionResponseItem", "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": "GetOperationalRoleResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "operationalRoleId": { "title": "operationalRoleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->OperationalRole_Id" }, "operationalRoleCode": { "title": "operationalRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->OperationalRole_Code" }, "operationalRoleDescription": { "title": "operationalRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->OperationalRole_Description" }, "resourceActionCustomisationId": { "title": "resourceActionCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->ResourceActionCustomisation_Id" }, "resourceActionCustomisationName": { "title": "resourceActionCustomisationName", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->ResourceActionCustomisation_Name" }, "resourceActionCustomisationRestrictionLevel": { "title": "resourceActionCustomisationRestrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->ResourceActionCustomisation_RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->Module" }, "resource": { "title": "resource", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->Resource" }, "resourceAction": { "title": "resourceAction", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->ResourceAction" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->SequenceNumber" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->IsDefault" } } }, "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" } } } }, "GetOperationalRoleResourceForOperationalRoleCollectionResourceActionResponse": { "title": "GetOperationalRoleResourceForOperationalRoleCollectionResourceActionResponse", "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": "GetOperationalRoleResourceForOperationalRoleCollectionResourceActionResponseItem", "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": "GetOperationalRoleResourceForOperationalRoleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "resourceActionCustomisationId": { "title": "resourceActionCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->ResourceActionCustomisation_Id" }, "resourceActionCustomisationName": { "title": "resourceActionCustomisationName", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->ResourceActionCustomisation_Name" }, "resourceActionCustomisationDescription": { "title": "resourceActionCustomisationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->ResourceActionCustomisation_Description" }, "resourceActionCustomisationRestrictionLevel": { "title": "resourceActionCustomisationRestrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->ResourceActionCustomisation_RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->Module" }, "resource": { "title": "resource", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->Resource" }, "resourceAction": { "title": "resourceAction", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->ResourceAction" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->SequenceNumber" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->IsDefault" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->IsInherited" }, "inheritedFromTemplate": { "title": "inheritedFromTemplate", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->InheritedFrom_Template" }, "inheritedFromTemplateCustomisationName": { "title": "inheritedFromTemplateCustomisationName", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->InheritedFrom_TemplateCustomisation_Name" } } }, "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" } } } }, "OperationalRoleResourceOperationalRoleLookupResourceActionResponse": { "title": "OperationalRoleResourceOperationalRoleLookupResourceActionResponse", "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": "OperationalRoleResourceOperationalRoleLookupResourceActionResponseItem", "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": "OperationalRoleResourceOperationalRoleLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRole->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRole->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" } } } }, "OperationalRoleResourceResourceActionCustomisationLookupResourceActionResponse": { "title": "OperationalRoleResourceResourceActionCustomisationLookupResourceActionResponse", "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": "OperationalRoleResourceResourceActionCustomisationLookupResourceActionResponseItem", "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": "OperationalRoleResourceResourceActionCustomisationLookupResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceActionCustomisation->Name" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionCustomisation->Description" }, "restrictionLevel": { "title": "restrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ResourceActionCustomisation->RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceActionCustomisation->Module" }, "resource": { "title": "resource", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceActionCustomisation->Resource" }, "resourceAction": { "title": "resourceAction", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceActionCustomisation->ResourceAction" } } }, "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" } } } }, "OperationalRoleResourceResourceActionLookupResourceActionResponse": { "title": "OperationalRoleResourceResourceActionLookupResourceActionResponse", "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": "OperationalRoleResourceResourceActionLookupResourceActionResponseItem", "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": "OperationalRoleResourceResourceActionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "resourceActionName": { "title": "resourceActionName", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionSummary->ResourceActionName" }, "moduleName": { "title": "moduleName", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionSummary->ModuleName" }, "resourceName": { "title": "resourceName", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionSummary->ResourceName" }, "resourceActionType": { "title": "resourceActionType", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionSummary->ResourceActionType" } } }, "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" } } } }, "OperationalRoleResourceResourceLookupResourceActionResponse": { "title": "OperationalRoleResourceResourceLookupResourceActionResponse", "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": "OperationalRoleResourceResourceLookupResourceActionResponseItem", "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": "OperationalRoleResourceResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "resourceName": { "title": "resourceName", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceSummary->ResourceName" }, "moduleName": { "title": "moduleName", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceSummary->ModuleName" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceSummary->ResourceDescription" } } }, "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" } } } }, "CreateOperationalRoleResourceResourceActionRequest": { "title": "CreateOperationalRoleResourceResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateOperationalRoleResourceResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "operationalRoleId", "isDefault" ], "properties": { "operationalRoleId": { "title": "operationalRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->OperationalRole_Id" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->Module" }, "resource": { "title": "resource", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->Resource" }, "resourceAction": { "title": "resourceAction", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->ResourceAction" }, "resourceActionCustomisationId": { "title": "resourceActionCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->ResourceActionCustomisation_Id" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->IsDefault" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateOperationalRoleResourceResourceActionRequest": { "title": "UpdateOperationalRoleResourceResourceActionRequest", "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": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "OperationalRoleResource->IsDefault" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleResource->Notes" } ] } } }, "DeleteOperationalRoleResourceResourceActionRequest": { "title": "DeleteOperationalRoleResourceResourceActionRequest", "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 } } }, "BatchGetOperationalRoleResourceResourceAction": { "title": "BatchGetOperationalRoleResourceResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Operational Role Resource entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Operational Role Resource entities", "items": { "$ref": "#/definitions/GetOperationalRoleResourceResourceActionResponse" } }, "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" } } }, "BatchCreateOperationalRoleResourceResourceActionRequest": { "title": "BatchCreateOperationalRoleResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateOperationalRoleResourceResourceActionRequest" } }, "BatchUpdateOperationalRoleResourceResourceActionRequest": { "title": "BatchUpdateOperationalRoleResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateOperationalRoleResourceResourceActionRequest" } }, "BatchDeleteOperationalRoleResourceResourceActionRequest": { "title": "BatchDeleteOperationalRoleResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteOperationalRoleResourceResourceActionRequest" } }, "GetOperationalRoleTemplateResourceActionResponse": { "title": "GetOperationalRoleTemplateResourceActionResponse", "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": "GetOperationalRoleTemplateResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "OperationalRoleTemplate->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "OperationalRoleTemplate->ModifiedOn" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->IsDefault" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->Module" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->Notes" }, "operationalRoleId": { "title": "operationalRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->OperationalRole_Id" }, "operationalRoleCode": { "title": "operationalRoleCode", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->OperationalRole_Code" }, "operationalRoleDescription": { "title": "operationalRoleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->OperationalRole_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->SequenceNumber" }, "template": { "title": "template", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->Template" }, "templateCustomisationId": { "title": "templateCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->TemplateCustomisation_Id" }, "templateCustomisationName": { "title": "templateCustomisationName", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->TemplateCustomisation_Name" }, "templateCustomisationDescription": { "title": "templateCustomisationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->TemplateCustomisation_Description" }, "templateCustomisationRestrictionLevel": { "title": "templateCustomisationRestrictionLevel", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->TemplateCustomisation_RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "type": { "title": "type", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->Type" } } }, "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" } } }, "GetOperationalRoleTemplateCollectionResourceActionResponse": { "title": "GetOperationalRoleTemplateCollectionResourceActionResponse", "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": "GetOperationalRoleTemplateCollectionResourceActionResponseItem", "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": "GetOperationalRoleTemplateCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "operationalRoleId": { "title": "operationalRoleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->OperationalRole_Id" }, "operationalRoleCode": { "title": "operationalRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->OperationalRole_Code" }, "operationalRoleDescription": { "title": "operationalRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->OperationalRole_Description" }, "templateCustomisationId": { "title": "templateCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->TemplateCustomisation_Id" }, "templateCustomisationName": { "title": "templateCustomisationName", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->TemplateCustomisation_Name" }, "templateCustomisationDescription": { "title": "templateCustomisationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->TemplateCustomisation_Description" }, "templateCustomisationRestrictionLevel": { "title": "templateCustomisationRestrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->TemplateCustomisation_RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->Module" }, "template": { "title": "template", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->Template" }, "type": { "title": "type", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->Type" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->SequenceNumber" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->IsDefault" } } }, "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" } } } }, "GetOperationalRoleTemplateForOperationalRoleCollectionResourceActionResponse": { "title": "GetOperationalRoleTemplateForOperationalRoleCollectionResourceActionResponse", "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": "GetOperationalRoleTemplateForOperationalRoleCollectionResourceActionResponseItem", "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": "GetOperationalRoleTemplateForOperationalRoleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "template": { "title": "template", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->Template" }, "type": { "title": "type", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->Type" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->Module" }, "templateCustomisationId": { "title": "templateCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->TemplateCustomisation_Id" }, "templateCustomisationName": { "title": "templateCustomisationName", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->TemplateCustomisation_Name" }, "templateCustomisationDescription": { "title": "templateCustomisationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->TemplateCustomisation_Description" }, "templateCustomisationRestrictionLevel": { "title": "templateCustomisationRestrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->TemplateCustomisation_RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->IsDefault" } } }, "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" } } } }, "OperationalRoleTemplateOperationalRoleLookupResourceActionResponse": { "title": "OperationalRoleTemplateOperationalRoleLookupResourceActionResponse", "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": "OperationalRoleTemplateOperationalRoleLookupResourceActionResponseItem", "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": "OperationalRoleTemplateOperationalRoleLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRole->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRole->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" } } } }, "OperationalRoleTemplateTemplateCustomisationLookupResourceActionResponse": { "title": "OperationalRoleTemplateTemplateCustomisationLookupResourceActionResponse", "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": "OperationalRoleTemplateTemplateCustomisationLookupResourceActionResponseItem", "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": "OperationalRoleTemplateTemplateCustomisationLookupResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "TemplateCustomisation->Name" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateCustomisation->Description" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "TemplateCustomisation->Module" }, "template": { "title": "template", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateCustomisation->Template" }, "type": { "title": "type", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateCustomisation->Type" }, "restrictionLevel": { "title": "restrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "TemplateCustomisation->RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" } } }, "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" } } } }, "OperationalRoleTemplateTemplateLookupResourceActionResponse": { "title": "OperationalRoleTemplateTemplateLookupResourceActionResponse", "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": "OperationalRoleTemplateTemplateLookupResourceActionResponseItem", "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": "OperationalRoleTemplateTemplateLookupResourceActionResponseItemProperties", "type": "object", "properties": { "templateName": { "title": "templateName", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateSummary->TemplateName" }, "moduleName": { "title": "moduleName", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateSummary->ModuleName" }, "templateType": { "title": "templateType", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateSummary->TemplateType" } } }, "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" } } } }, "CreateOperationalRoleTemplateResourceActionRequest": { "title": "CreateOperationalRoleTemplateResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateOperationalRoleTemplateResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "operationalRoleId", "isDefault" ], "properties": { "operationalRoleId": { "title": "operationalRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->OperationalRole_Id" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->Module" }, "template": { "title": "template", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->Template" }, "type": { "title": "type", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->Type" }, "templateCustomisationId": { "title": "templateCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->TemplateCustomisation_Id" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->IsDefault" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateOperationalRoleTemplateResourceActionRequest": { "title": "UpdateOperationalRoleTemplateResourceActionRequest", "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": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "OperationalRoleTemplate->IsDefault" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "OperationalRoleTemplate->Notes" } ] } } }, "DeleteOperationalRoleTemplateResourceActionRequest": { "title": "DeleteOperationalRoleTemplateResourceActionRequest", "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 } } }, "BatchGetOperationalRoleTemplateResourceAction": { "title": "BatchGetOperationalRoleTemplateResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Operational Role Template entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Operational Role Template entities", "items": { "$ref": "#/definitions/GetOperationalRoleTemplateResourceActionResponse" } }, "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" } } }, "BatchCreateOperationalRoleTemplateResourceActionRequest": { "title": "BatchCreateOperationalRoleTemplateResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateOperationalRoleTemplateResourceActionRequest" } }, "BatchUpdateOperationalRoleTemplateResourceActionRequest": { "title": "BatchUpdateOperationalRoleTemplateResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateOperationalRoleTemplateResourceActionRequest" } }, "BatchDeleteOperationalRoleTemplateResourceActionRequest": { "title": "BatchDeleteOperationalRoleTemplateResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteOperationalRoleTemplateResourceActionRequest" } }, "GetPermissionReleaseLogListResourceActionResponse": { "title": "GetPermissionReleaseLogListResourceActionResponse", "type": "object", "properties": { "category": { "title": "category", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionReleaseLog->Category" }, "subcategory": { "title": "subcategory", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionReleaseLog->Subcategory" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionReleaseLog->Name" }, "entityName": { "title": "entityName", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionReleaseLog->EntityName" }, "isStandardPermission": { "title": "isStandardPermission", "type": "boolean", "x-nullable": true, "x-propertyPath": "PermissionReleaseLog->IsStandardPermission" }, "isDomainEntityPermission": { "title": "isDomainEntityPermission", "type": "boolean", "x-nullable": true, "x-propertyPath": "PermissionReleaseLog->IsDomainEntityPermission" }, "isTreePermission": { "title": "isTreePermission", "type": "boolean", "x-nullable": true, "x-propertyPath": "PermissionReleaseLog->IsTreePermission" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionReleaseLog->PermissionId" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionReleaseLog->Id" }, "onKeyVersionNumber": { "title": "onKeyVersionNumber", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionReleaseLog->OnKeyVersionNumber" }, "onKeyBuildNumber": { "title": "onKeyBuildNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionReleaseLog->OnKeyBuildNumber" } } }, "GetPermissionReleaseLogListResourceAction": { "title": "GetPermissionReleaseLogListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Permission entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Permission entities", "items": { "$ref": "#/definitions/GetPermissionReleaseLogListResourceActionResponse" } }, "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" } } }, "LookupPermissionsResourceActionResponse": { "title": "LookupPermissionsResourceActionResponse", "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": "LookupPermissionsResourceActionResponseItem", "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": "LookupPermissionsResourceActionResponseItemProperties", "type": "object", "properties": { "permissionId": { "title": "permissionId", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionView->PermissionId" }, "entityName": { "title": "entityName", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionView->EntityName" }, "category": { "title": "category", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionView->Category" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionView->Name" }, "standardRight": { "title": "standardRight", "type": "boolean", "x-nullable": true, "x-propertyPath": "PermissionView->StandardRight" }, "subcategory": { "title": "subcategory", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionView->Subcategory" }, "treePermission": { "title": "treePermission", "type": "boolean", "x-nullable": true, "x-propertyPath": "PermissionView->TreePermission" } } }, "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" } } } }, "GetPermissionTreeResourceActionResponse": { "title": "GetPermissionTreeResourceActionResponse", "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": "GetPermissionTreeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionTree->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionTree->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PermissionTree->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "PermissionTree->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionTree->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionTree->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PermissionTree->ModifiedOn" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->InheritedFrom_Id" }, "inheritedFromCode": { "title": "inheritedFromCode", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionTree->InheritedFrom_Code" }, "inheritedFromDescription": { "title": "inheritedFromDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionTree->InheritedFrom_Description" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PermissionTree->IsInherited" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" }, "parentPermissionTreeCode": { "title": "parentPermissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Code" }, "parentPermissionTreeDescription": { "title": "parentPermissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Description" } } }, "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" } } }, "GetPermissionTreeCollectionResourceActionResponse": { "title": "GetPermissionTreeCollectionResourceActionResponse", "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": "GetPermissionTreeCollectionResourceActionResponseItem", "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": "GetPermissionTreeCollectionResourceActionResponseItemProperties", "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" }, "parentPermissionTreeCode": { "title": "parentPermissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->ParentPermissionTree_Code" }, "parentPermissionTreeDescription": { "title": "parentPermissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->ParentPermissionTree_Description" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PermissionTree->IsInherited" }, "inheritedFromCode": { "title": "inheritedFromCode", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->InheritedFrom_Code" }, "inheritedFromDescription": { "title": "inheritedFromDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->InheritedFrom_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PermissionTree->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PermissionTree->ModifiedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "PermissionTree->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" } } } }, "LookupPermissionTreeInsertParentPermissionTreeResourceActionResponse": { "title": "LookupPermissionTreeInsertParentPermissionTreeResourceActionResponse", "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": "LookupPermissionTreeInsertParentPermissionTreeResourceActionResponseItem", "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": "LookupPermissionTreeInsertParentPermissionTreeResourceActionResponseItemProperties", "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" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "PermissionTree->IsInherited" }, "inheritedFromCode": { "title": "inheritedFromCode", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->InheritedFrom_Code" }, "inheritedFromDescription": { "title": "inheritedFromDescription", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->InheritedFrom_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" } } } }, "CreatePermissionTreeResourceActionRequest": { "title": "CreatePermissionTreeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePermissionTreeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "parentPermissionTreeId", "code" ], "properties": { "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "PermissionTree->Description" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePermissionTreeResourceActionRequest": { "title": "UpdatePermissionTreeResourceActionRequest", "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": "PermissionTree->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "PermissionTree->Description" } ] } } }, "DeletePermissionTreeResourceActionRequest": { "title": "DeletePermissionTreeResourceActionRequest", "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 } } }, "BatchGetPermissionTreeResourceAction": { "title": "BatchGetPermissionTreeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Permission Tree entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Permission Tree entities", "items": { "$ref": "#/definitions/GetPermissionTreeResourceActionResponse" } }, "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" } } }, "BatchCreatePermissionTreeResourceActionRequest": { "title": "BatchCreatePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePermissionTreeResourceActionRequest" } }, "BatchUpdatePermissionTreeResourceActionRequest": { "title": "BatchUpdatePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePermissionTreeResourceActionRequest" } }, "BatchDeletePermissionTreeResourceActionRequest": { "title": "BatchDeletePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePermissionTreeResourceActionRequest" } }, "ChangePermissionTreeIsActiveResourceActionRequest": { "title": "ChangePermissionTreeIsActiveResourceActionRequest", "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": "PermissionTree->IsActive" } ] } } }, "BatchChangePermissionTreeIsActiveResourceActionRequest": { "title": "BatchChangePermissionTreeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePermissionTreeIsActiveResourceActionRequest" } }, "GetPermissionTreeTreePathMapResourceActionResponse": { "title": "GetPermissionTreeTreePathMapResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TreePathMapNode->Id" }, "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "TreePathMapNode->Code" }, "recordType": { "title": "recordType", "type": "string", "x-nullable": true, "x-propertyPath": "TreePathMapNode->RecordType" }, "treeLevel": { "title": "treeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TreePathMapNode->TreeLevel" }, "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "TreePathMapNode->Type", "x-formatSpecifier": "EntityType" } } }, "GetPermissionTreeTreePathMapResourceAction": { "title": "GetPermissionTreeTreePathMapResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Permission Tree Tree entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Permission Tree Tree entities", "items": { "$ref": "#/definitions/GetPermissionTreeTreePathMapResourceActionResponse" } }, "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" } } }, "AssetRegisterTreeNodeSchema": { "type": "object", "required": [ "properties", "childCounts", "links" ], "properties": { "entityType": { "type": "string" }, "id": { "type": "integer", "description": "Id of Resource", "format": "int64" }, "version": { "type": "integer", "description": "Version of Resource", "format": "int32" }, "properties": { "type": "object", "description": "List of properties as a map `{ \"name\" : value, ...}`", "additionalProperties": {} }, "permissionViolations": { "type": "array", "description": "List of permission violations for resource data", "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "childCounts": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "permissionViolationsLookup": { "description": "List of permission violations for resource data", "$ref": "#/definitions/PermissionViolationLookupSchema" }, "messages": { "type": "array", "description": "List of messages for Resource data", "items": { "$ref": "#/definitions/NotificationItemSchema" } }, "translations": { "type": "array", "description": "Translations for resource data", "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "links": { "type": "array", "description": "Hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "description": "Self link to re-execute", "$ref": "#/definitions/Link" } } }, "PermissionViolationLookupSchema": { "type": "object", "properties": { "permissions": { "type": "array", "description": "Lookup table to find more information about the permissions for the violations", "items": { "$ref": "#/definitions/PermissionViolationPermissionLookupSchema" } }, "permissionTrees": { "type": "array", "description": "Lookup table to find more information about the permission trees for the violations", "items": { "$ref": "#/definitions/PermissionViolationTreeCodeLookupSchema" } } } }, "PermissionViolationPermissionLookupSchema": { "type": "object", "required": [ "permissionId", "permissionCategory", "permissionSubcategory", "permissionEntityName", "permissionName" ], "properties": { "permissionId": { "type": "integer", "format": "int64" }, "permissionCategory": { "type": "string" }, "permissionSubcategory": { "type": "string" }, "permissionEntityName": { "type": "string" }, "permissionName": { "type": "string" } } }, "PermissionViolationTreeCodeLookupSchema": { "type": "object", "required": [ "permissionTreeId", "permissionTreeCode" ], "properties": { "permissionTreeId": { "type": "integer", "format": "int64" }, "permissionTreeCode": { "type": "string" } } }, "AssetRegisterTreeNodeCollectionPageSchema": { "type": "object", "required": [ "count", "items", "links" ], "properties": { "count": { "type": "integer", "description": "Number of resource items", "format": "int32" }, "self": { "description": "Self link to re-execute", "$ref": "#/definitions/Link" }, "prev": { "description": "Link to previous page of resource data", "$ref": "#/definitions/Link" }, "next": { "description": "Link to next page of resource data", "$ref": "#/definitions/Link" }, "items": { "type": "array", "description": "List of resource items", "items": { "$ref": "#/definitions/AssetRegisterTreeNodeSchema" } }, "messages": { "type": "array", "description": "List of messages for Resource data", "items": { "$ref": "#/definitions/NotificationItemSchema" } }, "links": { "type": "array", "description": "Hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetRoleResourceActionResponse": { "title": "GetRoleResourceActionResponse", "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": "GetRoleResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "SecurityRole->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SecurityRole->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRole->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRole->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SecurityRole->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "SecurityRole->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SecurityRole->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRole->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRole->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SecurityRole->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SecurityRole->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRole->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRole->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "SecurityRole->Description" }, "isPermissionTreeRole": { "title": "isPermissionTreeRole", "type": "boolean", "x-nullable": false, "x-propertyPath": "SecurityRole->IsPermissionTreeRole" }, "isSystem": { "title": "isSystem", "type": "boolean", "x-nullable": true, "x-propertyPath": "SecurityRole->IsSystem" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRole->Notes" } } }, "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" } } }, "GetRoleCollectionResourceActionResponse": { "title": "GetRoleCollectionResourceActionResponse", "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": "GetRoleCollectionResourceActionResponseItem", "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": "GetRoleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "SecurityRole->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "SecurityRole->Description" }, "isPermissionTreeRole": { "title": "isPermissionTreeRole", "type": "boolean", "x-nullable": false, "x-propertyPath": "SecurityRole->IsPermissionTreeRole" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "SecurityRole->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" } } } }, "RoleChangePermissionTreeLookupResourceActionResponse": { "title": "RoleChangePermissionTreeLookupResourceActionResponse", "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": "RoleChangePermissionTreeLookupResourceActionResponseItem", "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": "RoleChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RoleInsertPermissionTreeLookupResourceActionResponse": { "title": "RoleInsertPermissionTreeLookupResourceActionResponse", "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": "RoleInsertPermissionTreeLookupResourceActionResponseItem", "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": "RoleInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateRoleResourceActionRequest": { "title": "CreateRoleResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRoleResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SecurityRole->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "SecurityRole->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "SecurityRole->Description" }, "isPermissionTreeRole": { "title": "isPermissionTreeRole", "type": "boolean", "x-nullable": false, "x-propertyPath": "SecurityRole->IsPermissionTreeRole" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRole->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRoleResourceActionRequest": { "title": "UpdateRoleResourceActionRequest", "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": "SecurityRole->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "SecurityRole->Description" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRole->Notes" } ] } } }, "DeleteRoleResourceActionRequest": { "title": "DeleteRoleResourceActionRequest", "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 } } }, "BatchGetSecurityRoleResourceAction": { "title": "BatchGetSecurityRoleResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Security Role entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Security Role entities", "items": { "$ref": "#/definitions/GetRoleResourceActionResponse" } }, "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" } } }, "BatchCreateRoleResourceActionRequest": { "title": "BatchCreateRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRoleResourceActionRequest" } }, "BatchUpdateRoleResourceActionRequest": { "title": "BatchUpdateRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRoleResourceActionRequest" } }, "BatchDeleteRoleResourceActionRequest": { "title": "BatchDeleteRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRoleResourceActionRequest" } }, "ChangeRoleIsActiveResourceActionRequest": { "title": "ChangeRoleIsActiveResourceActionRequest", "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": "SecurityRole->IsActive" } ] } } }, "ChangeSecurityRolePermissionTreeResourceActionRequest": { "title": "ChangeSecurityRolePermissionTreeResourceActionRequest", "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": "SecurityRole->PermissionTree_Id" } ] } } }, "BatchChangeRoleIsActiveResourceActionRequest": { "title": "BatchChangeRoleIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRoleIsActiveResourceActionRequest" } }, "BatchChangeSecurityRolePermissionTreeResourceActionRequest": { "title": "BatchChangeSecurityRolePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSecurityRolePermissionTreeResourceActionRequest" } }, "GetSecurityRolePermissionResourceActionResponse": { "title": "GetSecurityRolePermissionResourceActionResponse", "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": "GetSecurityRolePermissionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "category": { "title": "category", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Category" }, "entityName": { "title": "entityName", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->EntityName" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Name" }, "subcategory": { "title": "subcategory", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Subcategory" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SecurityRolePermission->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SecurityRolePermission->ModifiedOn" }, "excludedProperties": { "title": "excludedProperties", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "SecurityRolePermission->ExcludedProperties", "x-formatSpecifier": "String" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Notes" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "SecurityRolePermission->PermissionId" }, "securityRoleId": { "title": "securityRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SecurityRolePermission->SecurityRole_Id" }, "securityRoleCode": { "title": "securityRoleCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_Code" }, "securityRoleDescription": { "title": "securityRoleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_Description" }, "securityRoleCreatedByUserId": { "title": "securityRoleCreatedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_CreatedByUser_Id" }, "securityRoleCreatedByUserCode": { "title": "securityRoleCreatedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_CreatedByUser_Code" }, "securityRoleCreatedByUserFullName": { "title": "securityRoleCreatedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_CreatedByUser_FullName" }, "securityRoleModifiedByUserId": { "title": "securityRoleModifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_ModifiedByUser_Id" }, "securityRoleModifiedByUserCode": { "title": "securityRoleModifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_ModifiedByUser_Code" }, "securityRoleModifiedByUserFullName": { "title": "securityRoleModifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_ModifiedByUser_FullName" } } }, "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" } } }, "GetSecurityRolePermissionListForSecurityRoleResponse": { "title": "GetSecurityRolePermissionListForSecurityRoleResponse", "type": "object", "properties": { "category": { "title": "category", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Category" }, "entityName": { "title": "entityName", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->EntityName" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Name" }, "subcategory": { "title": "subcategory", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Subcategory" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SecurityRolePermission->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SecurityRolePermission->ModifiedOn" }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Version" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Notes" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "SecurityRolePermission->PermissionId" }, "securityRoleId": { "title": "securityRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SecurityRolePermission->SecurityRole_Id" }, "securityRoleCode": { "title": "securityRoleCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_Code" }, "securityRoleDescription": { "title": "securityRoleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_Description" }, "securityRoleCreatedByUserId": { "title": "securityRoleCreatedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_CreatedByUser_Id" }, "securityRoleCreatedByUserCode": { "title": "securityRoleCreatedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_CreatedByUser_Code" }, "securityRoleCreatedByUserFullName": { "title": "securityRoleCreatedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_CreatedByUser_FullName" }, "securityRoleModifiedByUserId": { "title": "securityRoleModifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_ModifiedByUser_Id" }, "securityRoleModifiedByUserCode": { "title": "securityRoleModifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_ModifiedByUser_Code" }, "securityRoleModifiedByUserFullName": { "title": "securityRoleModifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_ModifiedByUser_FullName" } } }, "GetSecurityRolePermissionListForSecurityRoleResourceAction": { "title": "GetSecurityRolePermissionListForSecurityRoleResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Security Role Permission entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Security Role Permission entities", "items": { "$ref": "#/definitions/GetSecurityRolePermissionListForSecurityRoleResponse" } }, "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" } } }, "GetSecurityRolePermissionListResourceActionResponse": { "title": "GetSecurityRolePermissionListResourceActionResponse", "type": "object", "properties": { "category": { "title": "category", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Category" }, "entityName": { "title": "entityName", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->EntityName" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Name" }, "subcategory": { "title": "subcategory", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Subcategory" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SecurityRolePermission->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SecurityRolePermission->ModifiedOn" }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Version" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Notes" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "SecurityRolePermission->PermissionId" }, "securityRoleId": { "title": "securityRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SecurityRolePermission->SecurityRole_Id" }, "securityRoleCode": { "title": "securityRoleCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_Code" }, "securityRoleDescription": { "title": "securityRoleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_Description" }, "securityRoleCreatedByUserId": { "title": "securityRoleCreatedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_CreatedByUser_Id" }, "securityRoleCreatedByUserCode": { "title": "securityRoleCreatedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_CreatedByUser_Code" }, "securityRoleCreatedByUserFullName": { "title": "securityRoleCreatedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_CreatedByUser_FullName" }, "securityRoleModifiedByUserId": { "title": "securityRoleModifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_ModifiedByUser_Id" }, "securityRoleModifiedByUserCode": { "title": "securityRoleModifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_ModifiedByUser_Code" }, "securityRoleModifiedByUserFullName": { "title": "securityRoleModifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->SecurityRole_ModifiedByUser_FullName" } } }, "GetSecurityRolePermissionListResourceAction": { "title": "GetSecurityRolePermissionListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Security Role Permission entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Security Role Permission entities", "items": { "$ref": "#/definitions/GetSecurityRolePermissionListResourceActionResponse" } }, "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" } } }, "SecurityRolePermissionEntityPropertyLookupResourceActionResponse": { "title": "SecurityRolePermissionEntityPropertyLookupResourceActionResponse", "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": "SecurityRolePermissionEntityPropertyLookupResourceActionResponseItem", "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": "SecurityRolePermissionEntityPropertyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "path": { "title": "path", "type": "string", "x-nullable": true, "x-propertyPath": "EntityMetadataPropertySummary->Path" } } }, "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" } } } }, "SecurityRolePermissionLookupResourceActionResponse": { "title": "SecurityRolePermissionLookupResourceActionResponse", "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": "SecurityRolePermissionLookupResourceActionResponseItem", "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": "SecurityRolePermissionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "permissionId": { "title": "permissionId", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionView->PermissionId" }, "category": { "title": "category", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionView->Category" }, "subcategory": { "title": "subcategory", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionView->Subcategory" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionView->Name" }, "entityName": { "title": "entityName", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionView->EntityName" } } }, "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" } } } }, "SecurityRolePermissionSecurityRoleLookupResourceActionResponse": { "title": "SecurityRolePermissionSecurityRoleLookupResourceActionResponse", "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": "SecurityRolePermissionSecurityRoleLookupResourceActionResponseItem", "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": "SecurityRolePermissionSecurityRoleLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "SecurityRole->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "SecurityRole->Description" }, "isPermissionTreeRole": { "title": "isPermissionTreeRole", "type": "boolean", "x-nullable": false, "x-propertyPath": "SecurityRole->IsPermissionTreeRole" } } }, "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" } } } }, "CreateSecurityRolePermissionResourceActionRequest": { "title": "CreateSecurityRolePermissionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSecurityRolePermissionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "securityRoleId", "permissionId" ], "properties": { "securityRoleId": { "title": "securityRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SecurityRolePermission->SecurityRole_Id" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "SecurityRolePermission->PermissionId" }, "excludedProperties": { "title": "excludedProperties", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "SecurityRolePermission->ExcludedProperties", "x-formatSpecifier": "String" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSecurityRolePermissionResourceActionRequest": { "title": "UpdateSecurityRolePermissionResourceActionRequest", "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": "securityRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SecurityRolePermission->SecurityRole_Id" }, { "title": "permissionId", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "SecurityRolePermission->PermissionId" }, { "title": "excludedProperties", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "SecurityRolePermission->ExcludedProperties", "x-formatSpecifier": "String" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SecurityRolePermission->Notes" } ] } } }, "DeleteSecurityRolePermissionResourceActionRequest": { "title": "DeleteSecurityRolePermissionResourceActionRequest", "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 } } }, "BatchGetSecurityRolePermissionResourceAction": { "title": "BatchGetSecurityRolePermissionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Security Role Permission entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Security Role Permission entities", "items": { "$ref": "#/definitions/GetSecurityRolePermissionResourceActionResponse" } }, "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" } } }, "BatchCreateSecurityRolePermissionResourceActionRequest": { "title": "BatchCreateSecurityRolePermissionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSecurityRolePermissionResourceActionRequest" } }, "BatchUpdateSecurityRolePermissionResourceActionRequest": { "title": "BatchUpdateSecurityRolePermissionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSecurityRolePermissionResourceActionRequest" } }, "BatchDeleteSecurityRolePermissionResourceActionRequest": { "title": "BatchDeleteSecurityRolePermissionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSecurityRolePermissionResourceActionRequest" } }, "GetTermsAndConditionResourceActionResponse": { "title": "GetTermsAndConditionResourceActionResponse", "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": "GetTermsAndConditionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndCondition->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "TermsAndCondition->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TermsAndCondition->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndCondition->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndCondition->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TermsAndCondition->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TermsAndCondition->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndCondition->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndCondition->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TermsAndCondition->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TermsAndCondition->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndCondition->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndCondition->PermissionTree_Description" }, "compulsory": { "title": "compulsory", "type": "boolean", "x-nullable": false, "x-propertyPath": "TermsAndCondition->Compulsory" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndCondition->Description" }, "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndCondition->Name" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndCondition->Notes" }, "targetSiteId": { "title": "targetSiteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TermsAndCondition->TargetSite_Id" }, "targetSiteCode": { "title": "targetSiteCode", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndCondition->TargetSite_Code" }, "targetSiteDescription": { "title": "targetSiteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndCondition->TargetSite_Description" } } }, "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" } } }, "GetTermsAndConditionCollectionResourceActionResponse": { "title": "GetTermsAndConditionCollectionResourceActionResponse", "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": "GetTermsAndConditionCollectionResourceActionResponseItem", "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": "GetTermsAndConditionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndCondition->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndCondition->Description" }, "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndCondition->Name" }, "targetSiteCode": { "title": "targetSiteCode", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndCondition->TargetSite_Code" }, "compulsory": { "title": "compulsory", "type": "boolean", "x-nullable": false, "x-propertyPath": "TermsAndCondition->Compulsory" } } }, "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" } } } }, "TermsAndConditionChangePermissionTreeLookupResourceActionResponse": { "title": "TermsAndConditionChangePermissionTreeLookupResourceActionResponse", "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": "TermsAndConditionChangePermissionTreeLookupResourceActionResponseItem", "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": "TermsAndConditionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "TermsAndConditionInsertPermissionTreeLookupResourceActionResponse": { "title": "TermsAndConditionInsertPermissionTreeLookupResourceActionResponse", "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": "TermsAndConditionInsertPermissionTreeLookupResourceActionResponseItem", "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": "TermsAndConditionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "TermsAndConditionTargetSiteLookupResourceActionResponse": { "title": "TermsAndConditionTargetSiteLookupResourceActionResponse", "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": "TermsAndConditionTargetSiteLookupResourceActionResponseItem", "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": "TermsAndConditionTargetSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Site->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" } } } }, "CreateTermsAndConditionResourceActionRequest": { "title": "CreateTermsAndConditionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateTermsAndConditionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "name", "permissionTreeId" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "TermsAndCondition->Code" }, "description": { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "x-nullable": false, "x-propertyPath": "TermsAndCondition->Description" }, "name": { "title": "name", "type": "string", "maxLength": 200, "minLength": 1, "x-nullable": false, "x-propertyPath": "TermsAndCondition->Name" }, "compulsory": { "title": "compulsory", "type": "boolean", "x-nullable": false, "x-propertyPath": "TermsAndCondition->Compulsory" }, "targetSiteId": { "title": "targetSiteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TermsAndCondition->TargetSite_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TermsAndCondition->PermissionTree_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndCondition->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateTermsAndConditionResourceActionRequest": { "title": "UpdateTermsAndConditionResourceActionRequest", "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": "TermsAndCondition->Code" }, { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "x-nullable": false, "x-propertyPath": "TermsAndCondition->Description" }, { "title": "name", "type": "string", "maxLength": 200, "minLength": 1, "x-nullable": false, "x-propertyPath": "TermsAndCondition->Name" }, { "title": "compulsory", "type": "boolean", "x-nullable": false, "x-propertyPath": "TermsAndCondition->Compulsory" }, { "title": "targetSiteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TermsAndCondition->TargetSite_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndCondition->Notes" } ] } } }, "DeleteTermsAndConditionResourceActionRequest": { "title": "DeleteTermsAndConditionResourceActionRequest", "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 } } }, "BatchGetTermsAndConditionResourceAction": { "title": "BatchGetTermsAndConditionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Terms And Conditions entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Terms And Conditions entities", "items": { "$ref": "#/definitions/GetTermsAndConditionResourceActionResponse" } }, "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" } } }, "BatchCreateTermsAndConditionRequest": { "title": "BatchCreateTermsAndConditionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateTermsAndConditionResourceActionRequest" } }, "BatchUpdateTermsAndConditionResourceActionRequest": { "title": "BatchUpdateTermsAndConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateTermsAndConditionResourceActionRequest" } }, "BatchDeleteTermsAndConditionResourceActionRequest": { "title": "BatchDeleteTermsAndConditionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteTermsAndConditionResourceActionRequest" } }, "ChangeTermsAndConditionIsActiveResourceActionRequest": { "title": "ChangeTermsAndConditionIsActiveResourceActionRequest", "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": "TermsAndCondition->IsActive" } ] } } }, "ChangeTermsAndConditionPermissionTreeResourceActionRequest": { "title": "ChangeTermsAndConditionPermissionTreeResourceActionRequest", "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": "TermsAndCondition->PermissionTree_Id" } ] } } }, "BatchChangeTermsAndConditionIsActiveResourceActionRequest": { "title": "BatchChangeTermsAndConditionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTermsAndConditionIsActiveResourceActionRequest" } }, "BatchChangeTermsAndConditionPermissionTreeResourceActionRequest": { "title": "BatchChangeTermsAndConditionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTermsAndConditionPermissionTreeResourceActionRequest" } }, "GetTermsAndConditionOperationalRoleResourceActionResponse": { "title": "GetTermsAndConditionOperationalRoleResourceActionResponse", "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": "GetTermsAndConditionOperationalRoleResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "TermsAndConditionOperationalRole->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TermsAndConditionOperationalRole->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TermsAndConditionOperationalRole->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TermsAndConditionOperationalRole->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->PermissionTree_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->Notes" }, "operationalRoleId": { "title": "operationalRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TermsAndConditionOperationalRole->OperationalRole_Id" }, "operationalRoleCode": { "title": "operationalRoleCode", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->OperationalRole_Code" }, "operationalRoleDescription": { "title": "operationalRoleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->OperationalRole_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->SequenceNumber" }, "termsAndConditionId": { "title": "termsAndConditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TermsAndConditionOperationalRole->TermsAndCondition_Id" }, "termsAndConditionCode": { "title": "termsAndConditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->TermsAndCondition_Code" }, "termsAndConditionDescription": { "title": "termsAndConditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->TermsAndCondition_Description" } } }, "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" } } }, "GetTermsAndConditionOperationalRoleCollectionResourceActionResponse": { "title": "GetTermsAndConditionOperationalRoleCollectionResourceActionResponse", "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": "GetTermsAndConditionOperationalRoleCollectionResourceActionResponseItem", "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": "GetTermsAndConditionOperationalRoleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "termsAndConditionCode": { "title": "termsAndConditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndConditionOperationalRole->TermsAndCondition_Code" }, "operationalRoleCode": { "title": "operationalRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndConditionOperationalRole->OperationalRole_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->SequenceNumber" } } }, "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" } } } }, "GetTermsAndConditionOperationalRoleForTermsAndConditionCollectionResourceActionResponse": { "title": "GetTermsAndConditionOperationalRoleForTermsAndConditionCollectionResourceActionResponse", "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": "GetTermsAndConditionOperationalRoleForTermsAndConditionCollectionResourceActionResponseItem", "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": "GetTermsAndConditionOperationalRoleForTermsAndConditionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "operationalRoleCode": { "title": "operationalRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndConditionOperationalRole->OperationalRole_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->SequenceNumber" } } }, "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" } } } }, "TermsAndConditionOperationalRoleTermsAndConditionLookupResourceActionResponse": { "title": "TermsAndConditionOperationalRoleTermsAndConditionLookupResourceActionResponse", "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": "TermsAndConditionOperationalRoleTermsAndConditionLookupResourceActionResponseItem", "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": "TermsAndConditionOperationalRoleTermsAndConditionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndCondition->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndCondition->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" } } } }, "TermsAndConditionOperationalRoleLookupResourceActionResponse": { "title": "TermsAndConditionOperationalRoleLookupResourceActionResponse", "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": "TermsAndConditionOperationalRoleLookupResourceActionResponseItem", "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": "TermsAndConditionOperationalRoleLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRole->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRole->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" } } } }, "CreateTermsAndConditionOperationalRoleResourceActionRequest": { "title": "CreateTermsAndConditionOperationalRoleResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateTermsAndConditionOperationalRoleResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "termsAndConditionId", "operationalRoleId" ], "properties": { "termsAndConditionId": { "title": "termsAndConditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TermsAndConditionOperationalRole->TermsAndCondition_Id" }, "operationalRoleId": { "title": "operationalRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TermsAndConditionOperationalRole->OperationalRole_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateTermsAndConditionOperationalRoleResourceActionRequest": { "title": "UpdateTermsAndConditionOperationalRoleResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionOperationalRole->Notes" } ] } } }, "DeleteTermsAndConditionOperationalRoleResourceActionRequest": { "title": "DeleteTermsAndConditionOperationalRoleResourceActionRequest", "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 } } }, "BatchGetTermsAndConditionOperationalRoleResourceAction": { "title": "BatchGetTermsAndConditionOperationalRoleResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Terms And Conditions Operational Role entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Terms And Conditions Operational Role entities", "items": { "$ref": "#/definitions/GetTermsAndConditionOperationalRoleResourceActionResponse" } }, "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" } } }, "BatchCreateTermsAndConditionOperationalRoleRequest": { "title": "BatchCreateTermsAndConditionOperationalRoleRequest", "type": "array", "items": { "$ref": "#/definitions/CreateTermsAndConditionOperationalRoleResourceActionRequest" } }, "BatchUpdateTermsAndConditionOperationalRoleResourceActionRequest": { "title": "BatchUpdateTermsAndConditionOperationalRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateTermsAndConditionOperationalRoleResourceActionRequest" } }, "BatchDeleteTermsAndConditionOperationalRoleResourceActionRequest": { "title": "BatchDeleteTermsAndConditionOperationalRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteTermsAndConditionOperationalRoleResourceActionRequest" } }, "ChangeTermsAndConditionOperationalRoleIsActiveResourceActionRequest": { "title": "ChangeTermsAndConditionOperationalRoleIsActiveResourceActionRequest", "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": "TermsAndConditionOperationalRole->IsActive" } ] } } }, "BatchChangeTermsAndConditionOperationalRoleIsActiveResourceActionRequest": { "title": "BatchChangeTermsAndConditionOperationalRoleIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTermsAndConditionOperationalRoleIsActiveResourceActionRequest" } }, "GetTermsAndConditionVersionResourceActionResponse": { "title": "GetTermsAndConditionVersionResourceActionResponse", "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": "GetTermsAndConditionVersionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TermsAndConditionVersion->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TermsAndConditionVersion->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->PermissionTree_Description" }, "content": { "title": "content", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->Content", "x-NullExpression": "TermsAndConditionVersion->Published eq true" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->ContentVersion" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->IsDefault" }, "languageId": { "title": "languageId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->Language_Id" }, "languageCode": { "title": "languageCode", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->Language_Code" }, "languageDescription": { "title": "languageDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->Language_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->Notes" }, "published": { "title": "published", "type": "boolean", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->Published" }, "publishedOn": { "title": "publishedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TermsAndConditionVersion->PublishedOn" }, "termsAndConditionId": { "title": "termsAndConditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->TermsAndCondition_Id" }, "termsAndConditionCode": { "title": "termsAndConditionCode", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->TermsAndCondition_Code" }, "termsAndConditionDescription": { "title": "termsAndConditionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->TermsAndCondition_Description" } } }, "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" } } }, "GetTermsAndConditionVersionCollectionResourceActionResponse": { "title": "GetTermsAndConditionVersionCollectionResourceActionResponse", "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": "GetTermsAndConditionVersionCollectionResourceActionResponseItem", "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": "GetTermsAndConditionVersionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->ContentVersion" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->IsDefault" }, "published": { "title": "published", "type": "boolean", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->Published" }, "publishedOn": { "title": "publishedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TermsAndConditionVersion->PublishedOn" }, "termsAndConditionId": { "title": "termsAndConditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->TermsAndCondition_Id" }, "termsAndConditionCode": { "title": "termsAndConditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->TermsAndCondition_Code" }, "termsAndConditionName": { "title": "termsAndConditionName", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->TermsAndCondition_Name" }, "termsAndConditionDescription": { "title": "termsAndConditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->TermsAndCondition_Description" }, "languageId": { "title": "languageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->Language_Id" }, "languageCode": { "title": "languageCode", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->Language_Code" }, "languageDescription": { "title": "languageDescription", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->Language_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" } } } }, "GetTermsAndConditionVersionForTermsAndConditionCollectionResourceActionResponse": { "title": "GetTermsAndConditionVersionForTermsAndConditionCollectionResourceActionResponse", "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": "GetTermsAndConditionVersionForTermsAndConditionCollectionResourceActionResponseItem", "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": "GetTermsAndConditionVersionForTermsAndConditionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->ContentVersion" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->IsDefault" }, "published": { "title": "published", "type": "boolean", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->Published" }, "publishedOn": { "title": "publishedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TermsAndConditionVersion->PublishedOn" }, "termsAndConditionId": { "title": "termsAndConditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->TermsAndCondition_Id" }, "termsAndConditionCode": { "title": "termsAndConditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->TermsAndCondition_Code" }, "termsAndConditionName": { "title": "termsAndConditionName", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->TermsAndCondition_Name" }, "termsAndConditionDescription": { "title": "termsAndConditionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->TermsAndCondition_Description" }, "languageId": { "title": "languageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->Language_Id" }, "languageCode": { "title": "languageCode", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->Language_Code" }, "languageDescription": { "title": "languageDescription", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->Language_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" } } } }, "TermsAndConditionVersionLanguageLookupResourceActionResponse": { "title": "TermsAndConditionVersionLanguageLookupResourceActionResponse", "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": "TermsAndConditionVersionLanguageLookupResourceActionResponseItem", "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": "TermsAndConditionVersionLanguageLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Language->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Language->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" } } } }, "TermsAndConditionVersionTermsAndConditionLookupResourceActionResponse": { "title": "TermsAndConditionVersionTermsAndConditionLookupResourceActionResponse", "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": "TermsAndConditionVersionTermsAndConditionLookupResourceActionResponseItem", "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": "TermsAndConditionVersionTermsAndConditionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndCondition->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndCondition->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" } } } }, "CreateTermsAndConditionVersionResourceActionRequest": { "title": "CreateTermsAndConditionVersionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateTermsAndConditionVersionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "termsAndConditionId", "languageId", "content" ], "properties": { "termsAndConditionId": { "title": "termsAndConditionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->TermsAndCondition_Id" }, "languageId": { "title": "languageId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->Language_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->Notes" }, "content": { "title": "content", "type": "string", "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->Content" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateTermsAndConditionVersionResourceActionRequest": { "title": "UpdateTermsAndConditionVersionResourceActionRequest", "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": "content", "type": "string", "readOnly": true, "x-nullable": false, "x-propertyPath": "TermsAndConditionVersion->Content", "x-NullExpression": "TermsAndConditionVersion->Published eq true", "x-ReadOnlyExpression": "TermsAndConditionVersion->Published eq true" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TermsAndConditionVersion->Notes" } ] } } }, "DeleteTermsAndConditionVersionResourceActionRequest": { "title": "DeleteTermsAndConditionVersionResourceActionRequest", "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 } } }, "BatchGetTermsAndConditionVersionResourceAction": { "title": "BatchGetTermsAndConditionVersionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Terms And Conditions Version entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Terms And Conditions Version entities", "items": { "$ref": "#/definitions/GetTermsAndConditionVersionResourceActionResponse" } }, "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" } } }, "BatchCreateTermsAndConditionVersionRequest": { "title": "BatchCreateTermsAndConditionVersionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateTermsAndConditionVersionResourceActionRequest" } }, "BatchUpdateTermsAndConditionVersionResourceActionRequest": { "title": "BatchUpdateTermsAndConditionVersionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateTermsAndConditionVersionResourceActionRequest" } }, "BatchDeleteTermsAndConditionVersionResourceActionRequest": { "title": "BatchDeleteTermsAndConditionVersionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteTermsAndConditionVersionResourceActionRequest" } }, "GetUserResourceActionResponse": { "title": "GetUserResourceActionResponse", "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": "GetUserResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "User->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "User->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "User->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "User->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "User->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "User->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "User->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "User->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "User->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "User->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "User->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "User->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "User->Site_Description" }, "associatedStaffMemberId": { "title": "associatedStaffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->AssociatedStaffMember_Id" }, "associatedStaffMemberCode": { "title": "associatedStaffMemberCode", "type": "string", "x-nullable": true, "x-propertyPath": "User->AssociatedStaffMember_Code" }, "associatedStaffMemberContactDetailId": { "title": "associatedStaffMemberContactDetailId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->AssociatedStaffMember_ContactDetailId" }, "associatedStaffMemberContactDetailFirstName": { "title": "associatedStaffMemberContactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "User->AssociatedStaffMember_ContactDetailFirstName" }, "associatedStaffMemberContactDetailLastName": { "title": "associatedStaffMemberContactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "User->AssociatedStaffMember_ContactDetailLastName" }, "associatedSupplierId": { "title": "associatedSupplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->AssociatedSupplier_Id" }, "associatedSupplierCode": { "title": "associatedSupplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "User->AssociatedSupplier_Code" }, "associatedSupplierDescription": { "title": "associatedSupplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "User->AssociatedSupplier_Description" }, "contentTranslate": { "title": "contentTranslate", "type": "boolean", "x-nullable": true, "x-propertyPath": "User->ContentTranslate" }, "dateFormat": { "title": "dateFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "User->DateFormat", "x-formatSpecifier": "SystemDateFormat" }, "dateSeparator": { "title": "dateSeparator", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "User->DateSeparator", "x-formatSpecifier": "SystemDateSeparator" }, "defaultLanguageId": { "title": "defaultLanguageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->DefaultLanguage_Id" }, "defaultLanguageCode": { "title": "defaultLanguageCode", "type": "string", "x-nullable": true, "x-propertyPath": "User->DefaultLanguage_Code" }, "defaultLanguageDescription": { "title": "defaultLanguageDescription", "type": "string", "x-nullable": true, "x-propertyPath": "User->DefaultLanguage_Description" }, "fullName": { "title": "fullName", "type": "string", "x-nullable": false, "x-propertyPath": "User->FullName" }, "isAdministrator": { "title": "isAdministrator", "type": "boolean", "x-nullable": false, "x-propertyPath": "User->IsAdministrator" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "User->Notes" }, "operationalRoleRule": { "title": "operationalRoleRule", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "User->OperationalRoleRule", "x-formatSpecifier": "OperationalRoleRuleType" }, "permissionsChanged": { "title": "permissionsChanged", "type": "boolean", "x-nullable": false, "x-propertyPath": "User->PermissionsChanged" }, "primaryEmail": { "title": "primaryEmail", "type": "string", "format": "email", "x-nullable": false, "x-propertyPath": "User->PrimaryEmail" }, "receiveSystemAlerts": { "title": "receiveSystemAlerts", "type": "boolean", "x-nullable": true, "x-propertyPath": "User->ReceiveSystemAlerts" }, "timeFormat": { "title": "timeFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "User->TimeFormat", "x-formatSpecifier": "SystemTimeFormat" }, "userAuthenticationStatusId": { "title": "userAuthenticationStatusId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->UserAuthenticationStatusId" }, "isAuthenticationDisabled": { "title": "isAuthenticationDisabled", "type": "boolean", "x-nullable": true, "x-propertyPath": "User->IsAuthenticationDisabled" }, "disabledAuthenticationIds": { "title": "disabledAuthenticationIds", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "User->DisabledAuthenticationIds", "x-formatSpecifier": "Int64" } } }, "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" } } }, "GetUserCollectionResourceActionResponse": { "title": "GetUserCollectionResourceActionResponse", "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": "GetUserCollectionResourceActionResponseItem", "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": "GetUserCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "User->Code" }, "fullName": { "title": "fullName", "type": "string", "x-nullable": false, "x-propertyPath": "User->FullName" }, "primaryEmail": { "title": "primaryEmail", "type": "string", "format": "email", "x-nullable": false, "x-propertyPath": "User->PrimaryEmail" }, "permissionsChanged": { "title": "permissionsChanged", "type": "boolean", "x-nullable": false, "x-propertyPath": "User->PermissionsChanged" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "User->IsActive" }, "isAdministrator": { "title": "isAdministrator", "type": "boolean", "x-nullable": false, "x-propertyPath": "User->IsAdministrator" } } }, "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" } } } }, "GetUserSiteApprovalRoleForUserCollectionResourceActionResponse": { "title": "GetUserSiteApprovalRoleForUserCollectionResourceActionResponse", "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": "GetUserSiteApprovalRoleForUserCollectionResourceActionResponseItem", "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": "GetUserSiteApprovalRoleForUserCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "allSites": { "title": "allSites", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->AllSites" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->PermissionTree_Code" }, "approvalRoleCode": { "title": "approvalRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->ApprovalRole_Code" }, "approvalRoleDescription": { "title": "approvalRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->ApprovalRole_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" } } } }, "AssociatedStaffMemberLookupResourceActionResponse": { "title": "AssociatedStaffMemberLookupResourceActionResponse", "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": "AssociatedStaffMemberLookupResourceActionResponseItem", "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": "AssociatedStaffMemberLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" } } }, "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" } } } }, "AssociatedSupplierLookupResourceActionResponse": { "title": "AssociatedSupplierLookupResourceActionResponse", "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": "AssociatedSupplierLookupResourceActionResponseItem", "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": "AssociatedSupplierLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->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" } } } }, "DefaultLanguageLookupResourceActionResponse": { "title": "DefaultLanguageLookupResourceActionResponse", "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": "DefaultLanguageLookupResourceActionResponseItem", "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": "DefaultLanguageLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Language->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Language->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" } } } }, "SiteLookupResourceActionResponse": { "title": "SiteLookupResourceActionResponse", "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": "SiteLookupResourceActionResponseItem", "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": "SiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Site->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" } } } }, "UserChangePermissionTreeLookupResourceActionResponse": { "title": "UserChangePermissionTreeLookupResourceActionResponse", "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": "UserChangePermissionTreeLookupResourceActionResponseItem", "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": "UserChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "UserInsertPermissionTreeLookupResourceActionResponse": { "title": "UserInsertPermissionTreeLookupResourceActionResponse", "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": "UserInsertPermissionTreeLookupResourceActionResponseItem", "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": "UserInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateUserResourceActionRequest": { "title": "CreateUserResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateUserResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "fullName", "primaryEmail", "isAdministrator", "operationalRoleRule" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "User->PermissionTree_Id", "x-systemGenerated": true }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "User->Code" }, "fullName": { "title": "fullName", "type": "string", "maxLength": 200, "minLength": 1, "x-nullable": false, "x-propertyPath": "User->FullName" }, "primaryEmail": { "title": "primaryEmail", "type": "string", "format": "email", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "User->PrimaryEmail" }, "isAdministrator": { "title": "isAdministrator", "type": "boolean", "x-nullable": false, "x-propertyPath": "User->IsAdministrator" }, "operationalRoleRule": { "title": "operationalRoleRule", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "User->OperationalRoleRule", "x-formatSpecifier": "OperationalRoleRuleType" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->Site_Id" }, "defaultLanguageId": { "title": "defaultLanguageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->DefaultLanguage_Id" }, "associatedStaffMemberId": { "title": "associatedStaffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->AssociatedStaffMember_Id" }, "associatedSupplierId": { "title": "associatedSupplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->AssociatedSupplier_Id" }, "contentTranslate": { "title": "contentTranslate", "type": "boolean", "x-nullable": true, "x-propertyPath": "User->ContentTranslate" }, "dateFormat": { "title": "dateFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "User->DateFormat", "x-formatSpecifier": "SystemDateFormat" }, "dateSeparator": { "title": "dateSeparator", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "User->DateSeparator", "x-formatSpecifier": "SystemDateSeparator" }, "timeFormat": { "title": "timeFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "User->TimeFormat", "x-formatSpecifier": "SystemTimeFormat" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "User->Notes" }, "receiveSystemAlerts": { "title": "receiveSystemAlerts", "type": "boolean", "x-nullable": true, "x-propertyPath": "User->ReceiveSystemAlerts" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateUserResourceActionRequest": { "title": "UpdateUserResourceActionRequest", "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": "User->Code" }, { "title": "fullName", "type": "string", "maxLength": 200, "minLength": 1, "x-nullable": false, "x-propertyPath": "User->FullName" }, { "title": "primaryEmail", "type": "string", "format": "email", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "User->PrimaryEmail" }, { "title": "operationalRoleRule", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "User->OperationalRoleRule", "x-formatSpecifier": "OperationalRoleRuleType" }, { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->Site_Id" }, { "title": "defaultLanguageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->DefaultLanguage_Id" }, { "title": "associatedStaffMemberId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->AssociatedStaffMember_Id" }, { "title": "associatedSupplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->AssociatedSupplier_Id" }, { "title": "contentTranslate", "type": "boolean", "x-nullable": true, "x-propertyPath": "User->ContentTranslate" }, { "title": "dateFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "User->DateFormat", "x-formatSpecifier": "SystemDateFormat" }, { "title": "dateSeparator", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "User->DateSeparator", "x-formatSpecifier": "SystemDateSeparator" }, { "title": "timeFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "User->TimeFormat", "x-formatSpecifier": "SystemTimeFormat" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "User->Notes" }, { "title": "receiveSystemAlerts", "type": "boolean", "x-nullable": true, "x-propertyPath": "User->ReceiveSystemAlerts" } ] } } }, "DeleteUserResourceActionRequest": { "title": "DeleteUserResourceActionRequest", "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 } } }, "BatchGetUserResourceAction": { "title": "BatchGetUserResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User entities", "items": { "$ref": "#/definitions/GetUserResourceActionResponse" } }, "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" } } }, "BatchCreateUserResourceActionRequest": { "title": "BatchCreateUserResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateUserResourceActionRequest" } }, "BatchUpdateUserResourceActionRequest": { "title": "BatchUpdateUserResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateUserResourceActionRequest" } }, "BatchDeleteUserResourceActionRequest": { "title": "BatchDeleteUserResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteUserResourceActionRequest" } }, "ChangeUserIsAdministratorResourceActionRequest": { "title": "ChangeUserIsAdministratorResourceActionRequest", "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": "isAdministrator", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeUserIsAdministrator->IsAdministrator" } ] } } }, "BatchChangeUserIsAdministratorResourceActionRequest": { "title": "BatchChangeUserIsAdministratorResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUserIsAdministratorResourceActionRequest" } }, "ChangeUserAuthenticationStatusResourceActionRequest": { "title": "ChangeUserAuthenticationStatusResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ChangeUserAuthenticationStatusResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "isAuthenticationDisabled": { "title": "isAuthenticationDisabled", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeUserAuthenticationStatus->IsAuthenticationDisabled" }, "userIds": { "title": "userIds", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "ChangeUserAuthenticationStatus->UserIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "ChangeUserIsActiveResourceActionRequest": { "title": "ChangeUserIsActiveResourceActionRequest", "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": "User->IsActive" } ] } } }, "ChangeUserPermissionTreeResourceActionRequest": { "title": "ChangeUserPermissionTreeResourceActionRequest", "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": "User->PermissionTree_Id" } ] } } }, "ChangeUserSiteResourceActionRequest": { "title": "ChangeUserSiteResourceActionRequest", "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": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "User->Site_Id" } ] } } }, "LinkUserIdentityResourceActionRequest": { "title": "LinkUserIdentityResourceActionRequest", "type": "object", "properties": { "properties": { "title": "LinkUserIdentityResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "inviteToken": { "title": "inviteToken", "type": "string", "x-nullable": true, "x-propertyPath": "LinkUserIdentity->InviteToken" }, "accessToken": { "title": "accessToken", "type": "string", "x-nullable": true, "x-propertyPath": "LinkUserIdentity->AccessToken" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangeUserIsActiveResourceActionRequest": { "title": "BatchChangeUserIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUserIsActiveResourceActionRequest" } }, "BatchChangeUserPermissionTreeResourceActionRequest": { "title": "BatchChangeUserPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUserPermissionTreeResourceActionRequest" } }, "BatchChangeUserSiteResourceActionRequest": { "title": "BatchChangeUserSiteResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUserSiteResourceActionRequest" } }, "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 } } }, "MatchUpdateUserResourceActionRequest": { "title": "MatchUpdateUserResourceActionRequest", "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": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->Site_Id" }, { "title": "operationalRoleRule", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "User->OperationalRoleRule", "x-formatSpecifier": "OperationalRoleRuleType" }, { "title": "contentTranslate", "type": "boolean", "x-nullable": true, "x-propertyPath": "User->ContentTranslate" }, { "title": "dateSeparator", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "User->DateSeparator", "x-formatSpecifier": "SystemDateSeparator" }, { "title": "dateFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "User->DateFormat", "x-formatSpecifier": "SystemDateFormat" }, { "title": "timeFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "User->TimeFormat", "x-formatSpecifier": "SystemTimeFormat" }, { "title": "receiveSystemAlerts", "type": "boolean", "x-nullable": true, "x-propertyPath": "User->ReceiveSystemAlerts" }, { "title": "defaultLanguageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "User->DefaultLanguage_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "User->Notes" } ] } } }, "DynamicValueSchema": { "title": "DynamicValueSchema", "type": "object", "properties": { "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": false, "x-formatSpecifier": "DynamicValueType", "x-enumNames": [ "String", "Email", "Integer", "Long", "Float", "Currency", "DateTime", "Date", "Time", "Duration", "Boolean" ] }, "value": { "title": "value", "type": "object" } } }, "GetUserAttributeResourceActionResponse": { "title": "GetUserAttributeResourceActionResponse", "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": "GetUserAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserAttribute->User_Id" }, "userCode": { "title": "userCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->User_Code" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->User_FullName" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "UserAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "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" } } }, "GetUserAttributeCollectionForUserResourceActionResponse": { "title": "GetUserAttributeCollectionForUserResourceActionResponse", "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": "GetUserAttributeCollectionForUserResourceActionResponseItem", "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": "GetUserAttributeCollectionForUserResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserAttribute->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" } } } }, "GetUserAttributeCollectionResourceActionResponse": { "title": "GetUserAttributeCollectionResourceActionResponse", "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": "GetUserAttributeCollectionResourceActionResponseItem", "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": "GetUserAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserAttribute->User_Id" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": false, "x-propertyPath": "UserAttribute->User_FullName" }, "userCode": { "title": "userCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserAttribute->User_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserAttribute->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" } } } }, "UserAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "UserAttributeAttributeAllowedValueLookupResourceActionResponse", "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": "UserAttributeAttributeAllowedValueLookupResourceActionResponseItem", "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": "UserAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "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" } } } }, "UserAttributeAttributeLookupResourceActionResponse": { "title": "UserAttributeAttributeLookupResourceActionResponse", "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": "UserAttributeAttributeLookupResourceActionResponseItem", "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": "UserAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "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" } } } }, "UserAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "UserAttributeChangePermissionTreeLookupResourceActionResponse", "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": "UserAttributeChangePermissionTreeLookupResourceActionResponseItem", "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": "UserAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "UserAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "UserAttributeInsertPermissionTreeLookupResourceActionResponse", "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": "UserAttributeInsertPermissionTreeLookupResourceActionResponseItem", "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": "UserAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "UserAttributeUserLookupResourceActionResponse": { "title": "UserAttributeUserLookupResourceActionResponse", "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": "UserAttributeUserLookupResourceActionResponseItem", "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": "UserAttributeUserLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "User->Code" }, "fullName": { "title": "fullName", "type": "string", "x-nullable": false, "x-propertyPath": "User->FullName" } } }, "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" } } } }, "CreateUserAttributeResourceActionRequest": { "title": "CreateUserAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateUserAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "userId", "attributeId" ], "properties": { "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserAttribute->User_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "UserAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateUserAttributeResourceActionRequest": { "title": "UpdateUserAttributeResourceActionRequest", "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": "value", "format": "composite", "x-nullable": true, "x-propertyPath": "UserAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserAttribute->Notes" } ] } } }, "DeleteUserAttributeResourceActionRequest": { "title": "DeleteUserAttributeResourceActionRequest", "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 } } }, "BatchGetUserAttributeResourceAction": { "title": "BatchGetUserAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Attribute entities", "items": { "$ref": "#/definitions/GetUserAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateUserAttributeResourceActionRequest": { "title": "BatchCreateUserAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateUserAttributeResourceActionRequest" } }, "BatchUpdateUserAttributeResourceActionRequest": { "title": "BatchUpdateUserAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateUserAttributeResourceActionRequest" } }, "BatchDeleteUserAttributeResourceActionRequest": { "title": "BatchDeleteUserAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteUserAttributeResourceActionRequest" } }, "ChangeUserAttributeIsActiveResourceActionRequest": { "title": "ChangeUserAttributeIsActiveResourceActionRequest", "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": "UserAttribute->IsActive" } ] } } }, "ChangeUserAttributePermissionTreeResourceActionRequest": { "title": "ChangeUserAttributePermissionTreeResourceActionRequest", "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": "UserAttribute->PermissionTree_Id" } ] } } }, "BatchChangeUserAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeUserAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUserAttributePermissionTreeResourceActionRequest" } }, "BatchChangeUserAttributeIsActiveResourceActionRequest": { "title": "BatchChangeUserAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUserAttributeIsActiveResourceActionRequest" } }, "GetUserAuthenticationResourceActionResponse": { "title": "GetUserAuthenticationResourceActionResponse", "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": "GetUserAuthenticationResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserAuthentication->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserAuthentication->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserAuthentication->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserAuthentication->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserAuthentication->ModifiedOn" }, "authProviderId": { "title": "authProviderId", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->AuthProviderId" }, "authProviderName": { "title": "authProviderName", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->AuthProviderName" }, "authProviderSubject": { "title": "authProviderSubject", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->AuthProviderSubject" }, "authProviderType": { "title": "authProviderType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "UserAuthentication->AuthProviderType", "x-formatSpecifier": "AuthProviderType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->Notes" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserAuthentication->User_Id" }, "userCode": { "title": "userCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->User_Code" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->User_FullName" } } }, "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" } } }, "UserAuthenticationProviderLookupResourceActionResponse": { "title": "UserAuthenticationProviderLookupResourceActionResponse", "type": "object", "properties": { "providerName": { "title": "providerName", "type": "string", "x-nullable": true, "x-propertyPath": "WebApplicationIdentityProviderConfig->ProviderName" }, "clientId": { "title": "clientId", "type": "string", "x-nullable": true, "x-propertyPath": "WebApplicationIdentityProviderConfig->ClientId" }, "authorizeEndpoint": { "title": "authorizeEndpoint", "type": "string", "x-nullable": true, "x-propertyPath": "WebApplicationIdentityProviderConfig->AuthorizeEndpoint" }, "tokenRequestEndpoint": { "title": "tokenRequestEndpoint", "type": "string", "x-nullable": true, "x-propertyPath": "WebApplicationIdentityProviderConfig->TokenRequestEndpoint" }, "tokenRequestBody": { "title": "tokenRequestBody", "type": "string", "x-nullable": true, "x-propertyPath": "WebApplicationIdentityProviderConfig->TokenRequestBody" }, "tokenRequestHeader": { "title": "tokenRequestHeader", "type": "string", "x-nullable": true, "x-propertyPath": "WebApplicationIdentityProviderConfig->TokenRequestHeader" }, "signOutEndpoint": { "title": "signOutEndpoint", "type": "string", "x-nullable": true, "x-propertyPath": "WebApplicationIdentityProviderConfig->SignOutEndpoint" } } }, "UserAuthenticationProviderLookupResourceAction": { "title": "UserAuthenticationProviderLookupResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Authentication entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Authentication entities", "items": { "$ref": "#/definitions/UserAuthenticationProviderLookupResourceActionResponse" } }, "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" } } }, "GetUserAuthenticationCollectionResourceActionResponse": { "title": "GetUserAuthenticationCollectionResourceActionResponse", "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": "GetUserAuthenticationCollectionResourceActionResponseItem", "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": "GetUserAuthenticationCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "userCode": { "title": "userCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserAuthentication->User_Code" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": false, "x-propertyPath": "UserAuthentication->User_FullName" }, "authProviderType": { "title": "authProviderType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "UserAuthentication->AuthProviderType", "x-formatSpecifier": "AuthProviderType" }, "authProviderSubject": { "title": "authProviderSubject", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->AuthProviderSubject" }, "authProviderName": { "title": "authProviderName", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->AuthProviderName" }, "authProviderId": { "title": "authProviderId", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->AuthProviderId" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserAuthentication->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserAuthentication->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" } } } }, "GetUserAuthenticationForUserCollectionResourceActionResponse": { "title": "GetUserAuthenticationForUserCollectionResourceActionResponse", "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": "GetUserAuthenticationForUserCollectionResourceActionResponseItem", "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": "GetUserAuthenticationForUserCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "authProviderType": { "title": "authProviderType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "UserAuthentication->AuthProviderType", "x-formatSpecifier": "AuthProviderType" }, "authProviderSubject": { "title": "authProviderSubject", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->AuthProviderSubject" }, "authProviderName": { "title": "authProviderName", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->AuthProviderName" }, "authProviderId": { "title": "authProviderId", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->AuthProviderId" } } }, "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" } } } }, "UserAuthenticationUserLookupResourceActionResponse": { "title": "UserAuthenticationUserLookupResourceActionResponse", "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": "UserAuthenticationUserLookupResourceActionResponseItem", "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": "UserAuthenticationUserLookupResourceActionResponseItemProperties", "type": "object", "properties": { "fullName": { "title": "fullName", "type": "string", "x-nullable": false, "x-propertyPath": "User->FullName" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "User->Code" } } }, "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" } } } }, "CreateUserAuthenticationResourceActionResponse": { "title": "CreateUserAuthenticationResourceActionResponse", "type": "object", "properties": { "properties": { "title": "CreateUserAuthenticationResourceActionResponseProperties", "type": "object", "x-nullable": false, "required": [ "userId", "authProviderId", "authProviderSubject" ], "properties": { "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserAuthentication->User_Id" }, "authProviderId": { "title": "authProviderId", "type": "string", "minLength": 1, "x-nullable": false, "x-propertyPath": "UserAuthentication->AuthProviderId" }, "authProviderSubject": { "title": "authProviderSubject", "type": "string", "minLength": 1, "x-nullable": false, "x-propertyPath": "UserAuthentication->AuthProviderSubject" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateUserAuthenticationResourceActionResponse": { "title": "UpdateUserAuthenticationResourceActionResponse", "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": "authProviderId", "type": "string", "minLength": 1, "x-nullable": true, "x-propertyPath": "UserAuthentication->AuthProviderId" }, { "title": "authProviderSubject", "type": "string", "minLength": 1, "x-nullable": true, "x-propertyPath": "UserAuthentication->AuthProviderSubject" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserAuthentication->Notes" } ] } } }, "DeleteDeleteUserAuthenticationResourceActionResponse": { "title": "DeleteDeleteUserAuthenticationResourceActionResponse", "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 } } }, "BatchGetUserAuthenticationResourceAction": { "title": "BatchGetUserAuthenticationResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Authentication entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Authentication entities", "items": { "$ref": "#/definitions/GetUserAuthenticationResourceActionResponse" } }, "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" } } }, "BatchCreateUserAuthenticationResourceActionRequest": { "title": "BatchCreateUserAuthenticationResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateUserAuthenticationResourceActionResponse" } }, "BatchUpdateUserAuthenticationResourceActionResponse": { "title": "BatchUpdateUserAuthenticationResourceActionResponse", "type": "array", "items": { "$ref": "#/definitions/UpdateUserAuthenticationResourceActionResponse" } }, "BatchDeleteUserAuthenticationResourceActionRequest": { "title": "BatchDeleteUserAuthenticationResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteDeleteUserAuthenticationResourceActionResponse" } }, "ChangeUserAuthenticationIsActiveResourceActionRequest": { "title": "ChangeUserAuthenticationIsActiveResourceActionRequest", "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": "UserAuthentication->IsActive" } ] } } }, "BatchChangeUserAuthenticationIsActiveResourceActionRequest": { "title": "BatchChangeUserAuthenticationIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUserAuthenticationIsActiveResourceActionRequest" } }, "GetUserCustomPermissionResourceActionResponse": { "title": "GetUserCustomPermissionResourceActionResponse", "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": "GetUserCustomPermissionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "category": { "title": "category", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->Category" }, "entityName": { "title": "entityName", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->EntityName" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->Name" }, "subcategory": { "title": "subcategory", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->Subcategory" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserCustomPermission->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserCustomPermission->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserCustomPermission->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserCustomPermission->ModifiedOn" }, "applyDownPermissionTree": { "title": "applyDownPermissionTree", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserCustomPermission->ApplyDownPermissionTree" }, "excludedProperties": { "title": "excludedProperties", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "UserCustomPermission->ExcludedProperties", "x-formatSpecifier": "String" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->Notes" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "UserCustomPermission->PermissionId" }, "permissionsChanged": { "title": "permissionsChanged", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserCustomPermission->PermissionsChanged" }, "permissionTrees": { "title": "permissionTrees", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "UserCustomPermission->PermissionTrees", "x-formatSpecifier": "Int64" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserCustomPermission->User_Id" }, "userCode": { "title": "userCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->User_Code" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->User_FullName" } } }, "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" } } }, "GetUserCustomPermissionListForUserResponse": { "title": "GetUserCustomPermissionListForUserResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserCustomPermission->Id" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserCustomPermission->User_Id" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->User_FullName" }, "category": { "title": "category", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->Category" }, "subcategory": { "title": "subcategory", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->Subcategory" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->Name" }, "entityName": { "title": "entityName", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->EntityName" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "UserCustomPermission->PermissionId" }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserCustomPermission->Version" } } }, "GetUserCustomPermissionListForUserResourceAction": { "title": "GetUserCustomPermissionListForUserResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Custom Permission entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Custom Permission entities", "items": { "$ref": "#/definitions/GetUserCustomPermissionListForUserResponse" } }, "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" } } }, "GetUserCustomPermissionListResourceActionResponse": { "title": "GetUserCustomPermissionListResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserCustomPermission->Id" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->User_FullName" }, "category": { "title": "category", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->Category" }, "subcategory": { "title": "subcategory", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->Subcategory" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->Name" }, "entityName": { "title": "entityName", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->EntityName" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "UserCustomPermission->PermissionId" }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserCustomPermission->Version" } } }, "GetUserCustomPermissionListResourceAction": { "title": "GetUserCustomPermissionListResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Custom Permission entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Custom Permission entities", "items": { "$ref": "#/definitions/GetUserCustomPermissionListResourceActionResponse" } }, "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" } } }, "GetUserCustomPermissionPermissionTreeCollectionResourceActionResponse": { "title": "GetUserCustomPermissionPermissionTreeCollectionResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->Id" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "PermissionTree->IsActive" } } }, "GetUserCustomPermissionPermissionTreeCollectionResourceAction": { "title": "GetUserCustomPermissionPermissionTreeCollectionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Custom Permission entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Custom Permission entities", "items": { "$ref": "#/definitions/GetUserCustomPermissionPermissionTreeCollectionResourceActionResponse" } }, "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" } } }, "UserCustomPermissionEntityPropertyLookupResourceActionResponse": { "title": "UserCustomPermissionEntityPropertyLookupResourceActionResponse", "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": "UserCustomPermissionEntityPropertyLookupResourceActionResponseItem", "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": "UserCustomPermissionEntityPropertyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "path": { "title": "path", "type": "string", "x-nullable": true, "x-propertyPath": "EntityMetadataPropertySummary->Path" } } }, "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" } } } }, "UserCustomPermissionLookupResourceActionResponse": { "title": "UserCustomPermissionLookupResourceActionResponse", "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": "UserCustomPermissionLookupResourceActionResponseItem", "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": "UserCustomPermissionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "permissionId": { "title": "permissionId", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionView->PermissionId" }, "category": { "title": "category", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionView->Category" }, "subcategory": { "title": "subcategory", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionView->Subcategory" }, "name": { "title": "name", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionView->Name" }, "entityName": { "title": "entityName", "type": "string", "x-nullable": true, "x-propertyPath": "PermissionView->EntityName" } } }, "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" } } } }, "UserCustomPermissionPermissionTreeLookupResourceActionResponse": { "title": "UserCustomPermissionPermissionTreeLookupResourceActionResponse", "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": "UserCustomPermissionPermissionTreeLookupResourceActionResponseItem", "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": "UserCustomPermissionPermissionTreeLookupResourceActionResponseItemProperties", "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" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "PermissionTree->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" } } } }, "UserCustomPermissionUserLookupResourceActionResponse": { "title": "UserCustomPermissionUserLookupResourceActionResponse", "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": "UserCustomPermissionUserLookupResourceActionResponseItem", "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": "UserCustomPermissionUserLookupResourceActionResponseItemProperties", "type": "object", "properties": { "fullName": { "title": "fullName", "type": "string", "x-nullable": false, "x-propertyPath": "User->FullName" } } }, "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" } } } }, "CreateUserCustomPermissionResourceActionRequest": { "title": "CreateUserCustomPermissionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateUserCustomPermissionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "userId", "permissionId", "applyDownPermissionTree" ], "properties": { "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserCustomPermission->User_Id" }, "permissionId": { "title": "permissionId", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "UserCustomPermission->PermissionId" }, "applyDownPermissionTree": { "title": "applyDownPermissionTree", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserCustomPermission->ApplyDownPermissionTree" }, "excludedProperties": { "title": "excludedProperties", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "UserCustomPermission->ExcludedProperties", "x-formatSpecifier": "String" }, "permissionTrees": { "title": "permissionTrees", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "UserCustomPermission->PermissionTrees", "x-formatSpecifier": "Int64" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateUserCustomPermissionResourceActionRequest": { "title": "UpdateUserCustomPermissionResourceActionRequest", "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": "applyDownPermissionTree", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserCustomPermission->ApplyDownPermissionTree" }, { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserCustomPermission->User_Id" }, { "title": "permissionId", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "UserCustomPermission->PermissionId" }, { "title": "excludedProperties", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "UserCustomPermission->ExcludedProperties", "x-formatSpecifier": "String" }, { "title": "permissionTrees", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "UserCustomPermission->PermissionTrees", "x-formatSpecifier": "Int64" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserCustomPermission->Notes" } ] } } }, "DeleteUserCustomPermissionResourceActionRequest": { "title": "DeleteUserCustomPermissionResourceActionRequest", "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 } } }, "BatchGetUserCustomPermissionResourceAction": { "title": "BatchGetUserCustomPermissionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Custom Permission entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Custom Permission entities", "items": { "$ref": "#/definitions/GetUserCustomPermissionResourceActionResponse" } }, "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" } } }, "BatchCreateUserCustomPermissionResourceActionRequest": { "title": "BatchCreateUserCustomPermissionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateUserCustomPermissionResourceActionRequest" } }, "BatchUpdateUserCustomPermissionResourceActionRequest": { "title": "BatchUpdateUserCustomPermissionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateUserCustomPermissionResourceActionRequest" } }, "BatchDeleteUserCustomPermissionResourceActionRequest": { "title": "BatchDeleteUserCustomPermissionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteUserCustomPermissionResourceActionRequest" } }, "GetUserDocumentResourceActionResponse": { "title": "GetUserDocumentResourceActionResponse", "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": "GetUserDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserDocument->User_Id" }, "userCode": { "title": "userCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->User_Code" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->User_FullName" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDocument->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" } } }, "GetUserDocumentCollectionForUserResourceActionResponse": { "title": "GetUserDocumentCollectionForUserResourceActionResponse", "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": "GetUserDocumentCollectionForUserResourceActionResponseItem", "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": "GetUserDocumentCollectionForUserResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_FileType_Extension" } } }, "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" } } } }, "GetUserDocumentCollectionResourceActionResponse": { "title": "GetUserDocumentCollectionResourceActionResponse", "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": "GetUserDocumentCollectionResourceActionResponseItem", "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": "GetUserDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDocument->User_Id" }, "userCode": { "title": "userCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserDocument->User_Code" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": false, "x-propertyPath": "UserDocument->User_FullName" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->DocumentRecord_FileType_Extension" } } }, "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" } } } }, "UserDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "UserDocumentChangePermissionTreeLookupResourceActionResponse", "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": "UserDocumentChangePermissionTreeLookupResourceActionResponseItem", "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": "UserDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "UserDocumentDocumentLookupResourceActionResponse": { "title": "UserDocumentDocumentLookupResourceActionResponse", "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": "UserDocumentDocumentLookupResourceActionResponseItem", "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": "UserDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "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" } } } }, "UserDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "UserDocumentInsertPermissionTreeLookupResourceActionResponse", "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": "UserDocumentInsertPermissionTreeLookupResourceActionResponseItem", "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": "UserDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "UserDocumentUserLookupResourceActionResponse": { "title": "UserDocumentUserLookupResourceActionResponse", "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": "UserDocumentUserLookupResourceActionResponseItem", "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": "UserDocumentUserLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "User->Code" }, "fullName": { "title": "fullName", "type": "string", "x-nullable": false, "x-propertyPath": "User->FullName" } } }, "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" } } } }, "CreateUserDocumentResourceActionRequest": { "title": "CreateUserDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateUserDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "userId", "documentRecordId" ], "properties": { "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserDocument->User_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateUserDocumentResourceActionRequest": { "title": "UpdateUserDocumentResourceActionRequest", "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": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserDocument->Notes" } ] } } }, "DeleteUserDocumentResourceActionRequest": { "title": "DeleteUserDocumentResourceActionRequest", "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 } } }, "BatchGetUserDocumentResourceAction": { "title": "BatchGetUserDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Document entities", "items": { "$ref": "#/definitions/GetUserDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateUserDocumentResourceActionRequest": { "title": "BatchCreateUserDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateUserDocumentResourceActionRequest" } }, "BatchUpdateUserDocumentResourceActionRequest": { "title": "BatchUpdateUserDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateUserDocumentResourceActionRequest" } }, "BatchDeleteUserDocumentResourceActionRequest": { "title": "BatchDeleteUserDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteUserDocumentResourceActionRequest" } }, "ChangeUserDocumentIsActiveResourceActionRequest": { "title": "ChangeUserDocumentIsActiveResourceActionRequest", "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": "UserDocument->IsActive" } ] } } }, "ChangeUserDocumentPermissionTreeResourceActionRequest": { "title": "ChangeUserDocumentPermissionTreeResourceActionRequest", "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": "UserDocument->PermissionTree_Id" } ] } } }, "BatchChangeUserDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeUserDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUserDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeUserDocumentIsActiveResourceActionRequest": { "title": "BatchChangeUserDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUserDocumentIsActiveResourceActionRequest" } }, "GetUserOperationalRoleResourceActionResponse": { "title": "GetUserOperationalRoleResourceActionResponse", "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": "GetUserOperationalRoleResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRole->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRole->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRole->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRole->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserOperationalRole->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRole->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRole->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRole->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserOperationalRole->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserOperationalRole->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRole->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRole->PermissionTree_Description" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOperationalRole->IsDefault" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRole->Notes" }, "operationalRoleId": { "title": "operationalRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserOperationalRole->OperationalRole_Id" }, "operationalRoleCode": { "title": "operationalRoleCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRole->OperationalRole_Code" }, "operationalRoleDescription": { "title": "operationalRoleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRole->OperationalRole_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserOperationalRole->SequenceNumber" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserOperationalRole->User_Id" }, "userCode": { "title": "userCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRole->User_Code" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRole->User_FullName" } } }, "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" } } }, "GetUserOperationalRoleCollectionResourceActionResponse": { "title": "GetUserOperationalRoleCollectionResourceActionResponse", "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": "GetUserOperationalRoleCollectionResourceActionResponseItem", "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": "GetUserOperationalRoleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRole->IsActive" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRole->User_Id" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRole->User_FullName" }, "operationalRoleId": { "title": "operationalRoleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRole->OperationalRole_Id" }, "operationalRoleCode": { "title": "operationalRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRole->OperationalRole_Code" }, "operationalRoleDescription": { "title": "operationalRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRole->OperationalRole_Description" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOperationalRole->IsDefault" } } }, "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" } } } }, "GetUserOperationalRoleForOperationalRoleCollectionResourceActionResponse": { "title": "GetUserOperationalRoleForOperationalRoleCollectionResourceActionResponse", "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": "GetUserOperationalRoleForOperationalRoleCollectionResourceActionResponseItem", "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": "GetUserOperationalRoleForOperationalRoleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRole->IsActive" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRole->User_Id" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRole->User_FullName" }, "operationalRoleId": { "title": "operationalRoleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRole->OperationalRole_Id" }, "operationalRoleCode": { "title": "operationalRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRole->OperationalRole_Code" }, "operationalRoleDescription": { "title": "operationalRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRole->OperationalRole_Description" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOperationalRole->IsDefault" } } }, "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" } } } }, "UserOperationalRoleChangePermissionTreeLookupResourceActionResponse": { "title": "UserOperationalRoleChangePermissionTreeLookupResourceActionResponse", "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": "UserOperationalRoleChangePermissionTreeLookupResourceActionResponseItem", "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": "UserOperationalRoleChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "UserOperationalRoleInsertPermissionTreeLookupResourceActionResponse": { "title": "UserOperationalRoleInsertPermissionTreeLookupResourceActionResponse", "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": "UserOperationalRoleInsertPermissionTreeLookupResourceActionResponseItem", "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": "UserOperationalRoleInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "UserOperationalRoleOperationalRoleLookupResourceActionResponse": { "title": "UserOperationalRoleOperationalRoleLookupResourceActionResponse", "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": "UserOperationalRoleOperationalRoleLookupResourceActionResponseItem", "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": "UserOperationalRoleOperationalRoleLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRole->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "OperationalRole->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" } } } }, "UserOperationalRoleUserLookupResourceActionResponse": { "title": "UserOperationalRoleUserLookupResourceActionResponse", "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": "UserOperationalRoleUserLookupResourceActionResponseItem", "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": "UserOperationalRoleUserLookupResourceActionResponseItemProperties", "type": "object", "properties": { "fullName": { "title": "fullName", "type": "string", "x-nullable": false, "x-propertyPath": "User->FullName" } } }, "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" } } } }, "CreateUserOperationalRoleResourceActionRequest": { "title": "CreateUserOperationalRoleResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateUserOperationalRoleResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "isDefault", "userId", "operationalRoleId" ], "properties": { "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRole->Notes" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRole->IsDefault" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserOperationalRole->User_Id" }, "operationalRoleId": { "title": "operationalRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserOperationalRole->OperationalRole_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserOperationalRole->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserOperationalRole->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateUserOperationalRoleResourceActionRequest": { "title": "UpdateUserOperationalRoleResourceActionRequest", "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": "isDefault", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOperationalRole->IsDefault" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRole->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserOperationalRole->SequenceNumber" } ] } } }, "DeleteUserOperationalRoleResourceActionRequest": { "title": "DeleteUserOperationalRoleResourceActionRequest", "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 } } }, "BatchGetUserOperationalRoleResourceAction": { "title": "BatchGetUserOperationalRoleResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Operational Role entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Operational Role entities", "items": { "$ref": "#/definitions/GetUserOperationalRoleResourceActionResponse" } }, "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" } } }, "BatchCreateUserOperationalRoleResourceActionRequest": { "title": "BatchCreateUserOperationalRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateUserOperationalRoleResourceActionRequest" } }, "BatchUpdateUserOperationalRoleResourceActionRequest": { "title": "BatchUpdateUserOperationalRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateUserOperationalRoleResourceActionRequest" } }, "BatchDeleteUserOperationalRoleResourceActionRequest": { "title": "BatchDeleteUserOperationalRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteUserOperationalRoleResourceActionRequest" } }, "ChangeUserOperationalRoleIsActiveResourceActionRequest": { "title": "ChangeUserOperationalRoleIsActiveResourceActionRequest", "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": "UserOperationalRole->IsActive" } ] } } }, "ChangeUserOperationalRolePermissionTreeResourceActionRequest": { "title": "ChangeUserOperationalRolePermissionTreeResourceActionRequest", "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": "UserOperationalRole->PermissionTree_Id" } ] } } }, "BatchChangeUserOperationalRoleIsActiveResourceActionRequest": { "title": "BatchChangeUserOperationalRoleIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUserOperationalRoleIsActiveResourceActionRequest" } }, "BatchChangeUserOperationalRolePermissionTreeResourceActionRequest": { "title": "BatchChangeUserOperationalRolePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUserOperationalRolePermissionTreeResourceActionRequest" } }, "GetUserOperationalRoleResourceResourceActionResponse": { "title": "GetUserOperationalRoleResourceResourceActionResponse", "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": "GetUserOperationalRoleResourceResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserOperationalRoleResource->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserOperationalRoleResource->ModifiedOn" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->InheritedFrom_Id" }, "inheritedFromResourceAction": { "title": "inheritedFromResourceAction", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->InheritedFrom_ResourceAction" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->IsDefault" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->IsInherited" }, "isUserDefault": { "title": "isUserDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->IsUserDefault" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->Module" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->Notes" }, "privateUserOperationalRoleTemplateId": { "title": "privateUserOperationalRoleTemplateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->PrivateUserOperationalRoleTemplate_Id" }, "resource": { "title": "resource", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->Resource" }, "resourceAction": { "title": "resourceAction", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->ResourceAction" }, "resourceActionCustomisationId": { "title": "resourceActionCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->ResourceActionCustomisation_Id" }, "resourceActionCustomisationName": { "title": "resourceActionCustomisationName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->ResourceActionCustomisation_Name" }, "resourceActionCustomisationDescription": { "title": "resourceActionCustomisationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->ResourceActionCustomisation_Description" }, "resourceActionCustomisationRestrictionLevel": { "title": "resourceActionCustomisationRestrictionLevel", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->ResourceActionCustomisation_RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->SequenceNumber" }, "userOperationalRoleId": { "title": "userOperationalRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_Id" }, "userOperationalRoleOperationalRoleId": { "title": "userOperationalRoleOperationalRoleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_OperationalRole_Id" }, "userOperationalRoleOperationalRoleCode": { "title": "userOperationalRoleOperationalRoleCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_OperationalRole_Code" }, "userOperationalRoleOperationalRoleDescription": { "title": "userOperationalRoleOperationalRoleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_OperationalRole_Description" }, "userOperationalRoleUserId": { "title": "userOperationalRoleUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_User_Id" }, "userOperationalRoleUserFullName": { "title": "userOperationalRoleUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_User_FullName" } } }, "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" } } }, "GetUserOperationalRoleResourceCollectionResourceActionResponse": { "title": "GetUserOperationalRoleResourceCollectionResourceActionResponse", "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": "GetUserOperationalRoleResourceCollectionResourceActionResponseItem", "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": "GetUserOperationalRoleResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "userOperationalRoleId": { "title": "userOperationalRoleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_Id" }, "userOperationalRoleOperationalRoleId": { "title": "userOperationalRoleOperationalRoleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_OperationalRole_Id" }, "userOperationalRoleOperationalRoleCode": { "title": "userOperationalRoleOperationalRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_OperationalRole_Code" }, "userOperationalRoleOperationalRoleDescription": { "title": "userOperationalRoleOperationalRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_OperationalRole_Description" }, "userOperationalRoleUserId": { "title": "userOperationalRoleUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_User_Id" }, "userOperationalRoleUserFullName": { "title": "userOperationalRoleUserFullName", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_User_FullName" }, "resourceActionCustomisationId": { "title": "resourceActionCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->ResourceActionCustomisation_Id" }, "resourceActionCustomisationName": { "title": "resourceActionCustomisationName", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->ResourceActionCustomisation_Name" }, "resourceActionCustomisationRestrictionLevel": { "title": "resourceActionCustomisationRestrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->ResourceActionCustomisation_RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->Module" }, "resource": { "title": "resource", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->Resource" }, "resourceAction": { "title": "resourceAction", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->ResourceAction" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->SequenceNumber" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->IsDefault" }, "isUserDefault": { "title": "isUserDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->IsUserDefault" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->IsInherited" } } }, "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" } } } }, "GetUserOperationalRoleResourceForUserOperationalRoleCollectionResourceActionResponse": { "title": "GetUserOperationalRoleResourceForUserOperationalRoleCollectionResourceActionResponse", "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": "GetUserOperationalRoleResourceForUserOperationalRoleCollectionResourceActionResponseItem", "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": "GetUserOperationalRoleResourceForUserOperationalRoleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "resourceActionCustomisationId": { "title": "resourceActionCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->ResourceActionCustomisation_Id" }, "resourceActionCustomisationName": { "title": "resourceActionCustomisationName", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->ResourceActionCustomisation_Name" }, "resourceActionCustomisationDescription": { "title": "resourceActionCustomisationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->ResourceActionCustomisation_Description" }, "resourceActionCustomisationRestrictionLevel": { "title": "resourceActionCustomisationRestrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->ResourceActionCustomisation_RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->Module" }, "resource": { "title": "resource", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->Resource" }, "resourceAction": { "title": "resourceAction", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->ResourceAction" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->SequenceNumber" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->IsDefault" }, "isUserDefault": { "title": "isUserDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->IsUserDefault" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->IsInherited" }, "inheritedFromInheritedFromTemplate": { "title": "inheritedFromInheritedFromTemplate", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->InheritedFrom_InheritedFrom_Template" }, "inheritedFromInheritedFromTemplateCustomisationName": { "title": "inheritedFromInheritedFromTemplateCustomisationName", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->InheritedFrom_InheritedFrom_TemplateCustomisation_Name" } } }, "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" } } } }, "UserOperationalRoleResourceResourceActionCustomisationLookupResourceActionResponse": { "title": "UserOperationalRoleResourceResourceActionCustomisationLookupResourceActionResponse", "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": "UserOperationalRoleResourceResourceActionCustomisationLookupResourceActionResponseItem", "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": "UserOperationalRoleResourceResourceActionCustomisationLookupResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceActionCustomisation->Name" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionCustomisation->Description" }, "restrictionLevel": { "title": "restrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ResourceActionCustomisation->RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceActionCustomisation->Module" }, "resource": { "title": "resource", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceActionCustomisation->Resource" }, "resourceAction": { "title": "resourceAction", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceActionCustomisation->ResourceAction" } } }, "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" } } } }, "UserOperationalRoleResourceResourceActionLookupResourceActionResponse": { "title": "UserOperationalRoleResourceResourceActionLookupResourceActionResponse", "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": "UserOperationalRoleResourceResourceActionLookupResourceActionResponseItem", "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": "UserOperationalRoleResourceResourceActionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "resourceActionName": { "title": "resourceActionName", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionSummary->ResourceActionName" }, "moduleName": { "title": "moduleName", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionSummary->ModuleName" }, "resourceName": { "title": "resourceName", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionSummary->ResourceName" }, "resourceActionType": { "title": "resourceActionType", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceActionSummary->ResourceActionType" } } }, "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" } } } }, "UserOperationalRoleResourceResourceLookupResourceActionResponse": { "title": "UserOperationalRoleResourceResourceLookupResourceActionResponse", "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": "UserOperationalRoleResourceResourceLookupResourceActionResponseItem", "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": "UserOperationalRoleResourceResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "resourceName": { "title": "resourceName", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceSummary->ResourceName" }, "moduleName": { "title": "moduleName", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceSummary->ModuleName" }, "resourceDescription": { "title": "resourceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ResourceSummary->ResourceDescription" } } }, "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" } } } }, "UserOperationalRoleResourceUserOperationalRoleLookupResourceActionResponse": { "title": "UserOperationalRoleResourceUserOperationalRoleLookupResourceActionResponse", "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": "UserOperationalRoleResourceUserOperationalRoleLookupResourceActionResponseItem", "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": "UserOperationalRoleResourceUserOperationalRoleLookupResourceActionResponseItemProperties", "type": "object", "properties": { "operationalRoleId": { "title": "operationalRoleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRole->OperationalRole_Id" }, "operationalRoleCode": { "title": "operationalRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRole->OperationalRole_Code" }, "operationalRoleDescription": { "title": "operationalRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRole->OperationalRole_Description" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRole->User_Id" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRole->User_FullName" } } }, "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" } } } }, "CreateUserOperationalRoleResourceResourceActionRequest": { "title": "CreateUserOperationalRoleResourceResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateUserOperationalRoleResourceResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "userOperationalRoleId", "isUserDefault" ], "properties": { "userOperationalRoleId": { "title": "userOperationalRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->UserOperationalRole_Id" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->Module" }, "resource": { "title": "resource", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->Resource" }, "resourceAction": { "title": "resourceAction", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->ResourceAction" }, "resourceActionCustomisationId": { "title": "resourceActionCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->ResourceActionCustomisation_Id" }, "isUserDefault": { "title": "isUserDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->IsUserDefault" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateUserOperationalRoleResourceResourceActionRequest": { "title": "UpdateUserOperationalRoleResourceResourceActionRequest", "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": "isUserDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleResource->IsUserDefault" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleResource->Notes" } ] } } }, "DeleteUserOperationalRoleResourceResourceActionRequest": { "title": "DeleteUserOperationalRoleResourceResourceActionRequest", "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 } } }, "BatchGetUserOperationalRoleResourceResourceAction": { "title": "BatchGetUserOperationalRoleResourceResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Operational Role Resource entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Operational Role Resource entities", "items": { "$ref": "#/definitions/GetUserOperationalRoleResourceResourceActionResponse" } }, "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" } } }, "BatchCreateUserOperationalRoleResourceResourceActionRequest": { "title": "BatchCreateUserOperationalRoleResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateUserOperationalRoleResourceResourceActionRequest" } }, "BatchUpdateUserOperationalRoleResourceResourceActionRequest": { "title": "BatchUpdateUserOperationalRoleResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateUserOperationalRoleResourceResourceActionRequest" } }, "BatchDeleteUserOperationalRoleResourceResourceActionRequest": { "title": "BatchDeleteUserOperationalRoleResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteUserOperationalRoleResourceResourceActionRequest" } }, "GetUserOperationalRoleTemplateResourceActionResponse": { "title": "GetUserOperationalRoleTemplateResourceActionResponse", "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": "GetUserOperationalRoleTemplateResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserOperationalRoleTemplate->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserOperationalRoleTemplate->ModifiedOn" }, "inheritedFromId": { "title": "inheritedFromId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->InheritedFrom_Id" }, "inheritedFromTemplate": { "title": "inheritedFromTemplate", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->InheritedFrom_Template" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->IsDefault" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->IsInherited" }, "isUserDefault": { "title": "isUserDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->IsUserDefault" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Module" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->SequenceNumber" }, "template": { "title": "template", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Template" }, "templateCustomisationId": { "title": "templateCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_Id" }, "templateCustomisationName": { "title": "templateCustomisationName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_Name" }, "templateCustomisationDescription": { "title": "templateCustomisationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_Description" }, "templateCustomisationRestrictionLevel": { "title": "templateCustomisationRestrictionLevel", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "type": { "title": "type", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Type" }, "userOperationalRoleId": { "title": "userOperationalRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_Id" }, "userOperationalRoleOperationalRoleId": { "title": "userOperationalRoleOperationalRoleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Id" }, "userOperationalRoleOperationalRoleCode": { "title": "userOperationalRoleOperationalRoleCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Code" }, "userOperationalRoleOperationalRoleDescription": { "title": "userOperationalRoleOperationalRoleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Description" }, "userOperationalRoleUserId": { "title": "userOperationalRoleUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_User_Id" }, "userOperationalRoleUserFullName": { "title": "userOperationalRoleUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_User_FullName" } } }, "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" } } }, "GetUserOperationalRoleTemplateCollectionResourceActionResponse": { "title": "GetUserOperationalRoleTemplateCollectionResourceActionResponse", "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": "GetUserOperationalRoleTemplateCollectionResourceActionResponseItem", "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": "GetUserOperationalRoleTemplateCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "userOperationalRoleId": { "title": "userOperationalRoleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_Id" }, "userOperationalRoleOperationalRoleId": { "title": "userOperationalRoleOperationalRoleId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Id" }, "userOperationalRoleOperationalRoleCode": { "title": "userOperationalRoleOperationalRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Code" }, "userOperationalRoleOperationalRoleDescription": { "title": "userOperationalRoleOperationalRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_OperationalRole_Description" }, "userOperationalRoleUserId": { "title": "userOperationalRoleUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_User_Id" }, "userOperationalRoleUserFullName": { "title": "userOperationalRoleUserFullName", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_User_FullName" }, "templateCustomisationId": { "title": "templateCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_Id" }, "templateCustomisationName": { "title": "templateCustomisationName", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_Name" }, "templateCustomisationDescription": { "title": "templateCustomisationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_Description" }, "templateCustomisationRestrictionLevel": { "title": "templateCustomisationRestrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Module" }, "template": { "title": "template", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Template" }, "type": { "title": "type", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Type" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->SequenceNumber" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->IsDefault" }, "isUserDefault": { "title": "isUserDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->IsUserDefault" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->IsInherited" } } }, "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" } } } }, "GetUserOperationalRoleTemplateForUserOperationalRoleCollectionResourceActionResponse": { "title": "GetUserOperationalRoleTemplateForUserOperationalRoleCollectionResourceActionResponse", "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": "GetUserOperationalRoleTemplateForUserOperationalRoleCollectionResourceActionResponseItem", "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": "GetUserOperationalRoleTemplateForUserOperationalRoleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "template": { "title": "template", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Template" }, "type": { "title": "type", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Type" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Module" }, "templateCustomisationId": { "title": "templateCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_Id" }, "templateCustomisationName": { "title": "templateCustomisationName", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_Name" }, "templateCustomisationDescription": { "title": "templateCustomisationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_Description" }, "templateCustomisationRestrictionLevel": { "title": "templateCustomisationRestrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "isDefault": { "title": "isDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->IsDefault" }, "isUserDefault": { "title": "isUserDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->IsUserDefault" }, "isInherited": { "title": "isInherited", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->IsInherited" } } }, "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" } } } }, "UserOperationalRoleTemplateTemplateCustomisationLookupResourceActionResponse": { "title": "UserOperationalRoleTemplateTemplateCustomisationLookupResourceActionResponse", "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": "UserOperationalRoleTemplateTemplateCustomisationLookupResourceActionResponseItem", "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": "UserOperationalRoleTemplateTemplateCustomisationLookupResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "TemplateCustomisation->Name" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateCustomisation->Description" }, "restrictionLevel": { "title": "restrictionLevel", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "TemplateCustomisation->RestrictionLevel", "x-formatSpecifier": "RestrictionLevel" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "TemplateCustomisation->Module" }, "template": { "title": "template", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateCustomisation->Template" }, "type": { "title": "type", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateCustomisation->Type" } } }, "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" } } } }, "UserOperationalRoleTemplateTemplateLookupResourceActionResponse": { "title": "UserOperationalRoleTemplateTemplateLookupResourceActionResponse", "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": "UserOperationalRoleTemplateTemplateLookupResourceActionResponseItem", "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": "UserOperationalRoleTemplateTemplateLookupResourceActionResponseItemProperties", "type": "object", "properties": { "templateName": { "title": "templateName", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateSummary->TemplateName" }, "moduleName": { "title": "moduleName", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateSummary->ModuleName" }, "templateType": { "title": "templateType", "type": "string", "x-nullable": true, "x-propertyPath": "TemplateSummary->TemplateType" } } }, "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" } } } }, "UserOperationalRoleTemplateUserOperationalRoleLookupResourceActionResponse": { "title": "UserOperationalRoleTemplateUserOperationalRoleLookupResourceActionResponse", "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": "UserOperationalRoleTemplateUserOperationalRoleLookupResourceActionResponseItem", "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": "UserOperationalRoleTemplateUserOperationalRoleLookupResourceActionResponseItemProperties", "type": "object", "properties": { "operationalRoleCode": { "title": "operationalRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRole->OperationalRole_Code" }, "operationalRoleDescription": { "title": "operationalRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRole->OperationalRole_Description" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRole->User_Id" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRole->User_FullName" } } }, "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" } } } }, "CreateUserOperationalRoleTemplateResourceActionRequest": { "title": "CreateUserOperationalRoleTemplateResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateUserOperationalRoleTemplateResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "userOperationalRoleId", "module", "template", "type", "isUserDefault" ], "properties": { "userOperationalRoleId": { "title": "userOperationalRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->UserOperationalRole_Id" }, "module": { "title": "module", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Module" }, "template": { "title": "template", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Template" }, "type": { "title": "type", "type": "string", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->Type" }, "templateCustomisationId": { "title": "templateCustomisationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->TemplateCustomisation_Id" }, "isUserDefault": { "title": "isUserDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->IsUserDefault" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateUserOperationalRoleTemplateResourceActionRequest": { "title": "UpdateUserOperationalRoleTemplateResourceActionRequest", "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": "isUserDefault", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOperationalRoleTemplate->IsUserDefault" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserOperationalRoleTemplate->Notes" } ] } } }, "DeleteUserOperationalRoleTemplateResourceActionRequest": { "title": "DeleteUserOperationalRoleTemplateResourceActionRequest", "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 } } }, "BatchGetUserOperationalRoleTemplateResourceAction": { "title": "BatchGetUserOperationalRoleTemplateResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Operational Role Template entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Operational Role Template entities", "items": { "$ref": "#/definitions/GetUserOperationalRoleTemplateResourceActionResponse" } }, "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" } } }, "BatchCreateUserOperationalRoleTemplateResourceActionRequest": { "title": "BatchCreateUserOperationalRoleTemplateResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateUserOperationalRoleTemplateResourceActionRequest" } }, "BatchUpdateUserOperationalRoleTemplateResourceActionRequest": { "title": "BatchUpdateUserOperationalRoleTemplateResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateUserOperationalRoleTemplateResourceActionRequest" } }, "BatchDeleteUserOperationalRoleTemplateResourceActionRequest": { "title": "BatchDeleteUserOperationalRoleTemplateResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteUserOperationalRoleTemplateResourceActionRequest" } }, "GetUserOptionForUserResourceActionResponse": { "title": "GetUserOptionForUserResourceActionResponse", "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": "GetUserOptionForUserResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserOption->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserOption->ModifiedOn" }, "adHocCostElementId": { "title": "adHocCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->AdHocCostElement_Id" }, "adHocCostElementCode": { "title": "adHocCostElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->AdHocCostElement_Code" }, "adHocCostElementDescription": { "title": "adHocCostElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->AdHocCostElement_Description" }, "applyWorkOrderStatusRules": { "title": "applyWorkOrderStatusRules", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOption->ApplyWorkOrderStatusRules" }, "assetConsumptionCostElementId": { "title": "assetConsumptionCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->AssetConsumptionCostElement_Id" }, "assetConsumptionCostElementCode": { "title": "assetConsumptionCostElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->AssetConsumptionCostElement_Code" }, "assetConsumptionCostElementDescription": { "title": "assetConsumptionCostElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->AssetConsumptionCostElement_Description" }, "contractorsCostElementId": { "title": "contractorsCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->ContractorsCostElement_Id" }, "contractorsCostElementCode": { "title": "contractorsCostElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ContractorsCostElement_Code" }, "contractorsCostElementDescription": { "title": "contractorsCostElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ContractorsCostElement_Description" }, "defaultCreateSaveAction": { "title": "defaultCreateSaveAction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "UserOption->DefaultCreateSaveAction", "x-formatSpecifier": "DefaultCreateSaveAction" }, "defaultUpdateSaveAction": { "title": "defaultUpdateSaveAction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "UserOption->DefaultUpdateSaveAction", "x-formatSpecifier": "DefaultUpdateSaveAction" }, "defaultWorkOrderTaskResourceCostElementId": { "title": "defaultWorkOrderTaskResourceCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->DefaultWorkOrderTaskResourceCostElement_Id" }, "defaultWorkOrderTaskResourceCostElementCode": { "title": "defaultWorkOrderTaskResourceCostElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->DefaultWorkOrderTaskResourceCostElement_Code" }, "defaultWorkOrderTaskResourceCostElementDescription": { "title": "defaultWorkOrderTaskResourceCostElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->DefaultWorkOrderTaskResourceCostElement_Description" }, "directPurchasesCostElementId": { "title": "directPurchasesCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->DirectPurchasesCostElement_Id" }, "directPurchasesCostElementCode": { "title": "directPurchasesCostElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->DirectPurchasesCostElement_Code" }, "directPurchasesCostElementDescription": { "title": "directPurchasesCostElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->DirectPurchasesCostElement_Description" }, "insightsUserId": { "title": "insightsUserId", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->InsightsUserId" }, "isReportUser": { "title": "isReportUser", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOption->IsReportUser" }, "maximumOrderAmount": { "title": "maximumOrderAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UserOption->MaximumOrderAmount" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->Notes" }, "purchaseOrderCanBeQueued": { "title": "purchaseOrderCanBeQueued", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOption->PurchaseOrderCanBeQueued" }, "reportServerReportLanguage": { "title": "reportServerReportLanguage", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ReportServerReportLanguage" }, "reportServerReportLanguageDisplayName": { "title": "reportServerReportLanguageDisplayName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ReportServerReportLanguageDisplayName" }, "reportServerUILanguage": { "title": "reportServerUILanguage", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ReportServerUILanguage" }, "reportServerUILanguageDisplayName": { "title": "reportServerUILanguageDisplayName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ReportServerUILanguageDisplayName" }, "reportUserId": { "title": "reportUserId", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ReportUserId" }, "reportUserName": { "title": "reportUserName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ReportUserName" }, "reportUserRoles": { "title": "reportUserRoles", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "UserOption->ReportUserRoles", "x-formatSpecifier": "String" }, "requisitionLimit": { "title": "requisitionLimit", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UserOption->RequisitionLimit" }, "rootAssetId": { "title": "rootAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->RootAsset_Id" }, "rootAssetCode": { "title": "rootAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->RootAsset_Code" }, "rootAssetDescription": { "title": "rootAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->RootAsset_Description" }, "stockItemsCostElementId": { "title": "stockItemsCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->StockItemsCostElement_Id" }, "stockItemsCostElementCode": { "title": "stockItemsCostElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->StockItemsCostElement_Code" }, "stockItemsCostElementDescription": { "title": "stockItemsCostElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->StockItemsCostElement_Description" }, "taskClassification1Id": { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification1_Id" }, "taskClassification1Code": { "title": "taskClassification1Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification1_Code" }, "taskClassification1Description": { "title": "taskClassification1Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification1_Description" }, "taskClassification2Id": { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification2_Id" }, "taskClassification2Code": { "title": "taskClassification2Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification2_Code" }, "taskClassification2Description": { "title": "taskClassification2Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification2_Description" }, "taskClassification3Id": { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification3_Id" }, "taskClassification3Code": { "title": "taskClassification3Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification3_Code" }, "taskClassification3Description": { "title": "taskClassification3Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification3_Description" }, "taskClassification4Id": { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification4_Id" }, "taskClassification4Code": { "title": "taskClassification4Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification4_Code" }, "taskClassification4Description": { "title": "taskClassification4Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification4_Description" }, "taskClassification5Id": { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification5_Id" }, "taskClassification5Code": { "title": "taskClassification5Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification5_Code" }, "taskClassification5Description": { "title": "taskClassification5Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification5_Description" }, "taskClassification6Id": { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification6_Id" }, "taskClassification6Code": { "title": "taskClassification6Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification6_Code" }, "taskClassification6Description": { "title": "taskClassification6Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification6_Description" }, "taskClassification7Id": { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification7_Id" }, "taskClassification7Code": { "title": "taskClassification7Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification7_Code" }, "taskClassification7Description": { "title": "taskClassification7Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification7_Description" }, "taskClassification8Id": { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification8_Id" }, "taskClassification8Code": { "title": "taskClassification8Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification8_Code" }, "taskClassification8Description": { "title": "taskClassification8Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification8_Description" }, "taskImportanceId": { "title": "taskImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskImportance_Id" }, "taskImportanceCode": { "title": "taskImportanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskImportance_Code" }, "taskImportanceDescription": { "title": "taskImportanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskImportance_Description" }, "taskResponsibleSectionId": { "title": "taskResponsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleSection_Id" }, "taskResponsibleSectionCode": { "title": "taskResponsibleSectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleSection_Code" }, "taskResponsibleSectionDescription": { "title": "taskResponsibleSectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleSection_Description" }, "taskResponsibleStaffId": { "title": "taskResponsibleStaffId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleStaff_Id" }, "taskResponsibleStaffCode": { "title": "taskResponsibleStaffCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleStaff_Code" }, "taskResponsibleStaffDescription": { "title": "taskResponsibleStaffDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleStaff_Description" }, "taskResponsibleTradeId": { "title": "taskResponsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleTrade_Id" }, "taskResponsibleTradeCode": { "title": "taskResponsibleTradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleTrade_Code" }, "taskResponsibleTradeDescription": { "title": "taskResponsibleTradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleTrade_Description" }, "taskTypeOfWorkId": { "title": "taskTypeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskTypeOfWork_Id" }, "taskTypeOfWorkCode": { "title": "taskTypeOfWorkCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskTypeOfWork_Code" }, "taskTypeOfWorkDescription": { "title": "taskTypeOfWorkDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskTypeOfWork_Description" }, "travelCostElementId": { "title": "travelCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TravelCostElement_Id" }, "travelCostElementCode": { "title": "travelCostElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TravelCostElement_Code" }, "travelCostElementDescription": { "title": "travelCostElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TravelCostElement_Description" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserOption->User_Id" }, "userCode": { "title": "userCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->User_Code" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->User_FullName" }, "workClassification1Id": { "title": "workClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification1_Id" }, "workClassification1Code": { "title": "workClassification1Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification1_Code" }, "workClassification1Description": { "title": "workClassification1Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification1_Description" }, "workClassification2Id": { "title": "workClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification2_Id" }, "workClassification2Code": { "title": "workClassification2Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification2_Code" }, "workClassification2Description": { "title": "workClassification2Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification2_Description" }, "workClassification3Id": { "title": "workClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification3_Id" }, "workClassification3Code": { "title": "workClassification3Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification3_Code" }, "workClassification3Description": { "title": "workClassification3Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification3_Description" }, "workClassification4Id": { "title": "workClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification4_Id" }, "workClassification4Code": { "title": "workClassification4Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification4_Code" }, "workClassification4Description": { "title": "workClassification4Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification4_Description" }, "workClassification5Id": { "title": "workClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification5_Id" }, "workClassification5Code": { "title": "workClassification5Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification5_Code" }, "workClassification5Description": { "title": "workClassification5Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification5_Description" }, "workOrderCanBeQueued": { "title": "workOrderCanBeQueued", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderCanBeQueued" }, "workOrderImportanceId": { "title": "workOrderImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderImportance_Id" }, "workOrderImportanceCode": { "title": "workOrderImportanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderImportance_Code" }, "workOrderImportanceDescription": { "title": "workOrderImportanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderImportance_Description" }, "workOrderLimit": { "title": "workOrderLimit", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderLimit" }, "workOrderResponsibleSectionId": { "title": "workOrderResponsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleSection_Id" }, "workOrderResponsibleSectionCode": { "title": "workOrderResponsibleSectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleSection_Code" }, "workOrderResponsibleSectionDescription": { "title": "workOrderResponsibleSectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleSection_Description" }, "workOrderResponsibleStaffId": { "title": "workOrderResponsibleStaffId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleStaff_Id" }, "workOrderResponsibleStaffCode": { "title": "workOrderResponsibleStaffCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleStaff_Code" }, "workOrderResponsibleStaffDescription": { "title": "workOrderResponsibleStaffDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleStaff_Description" }, "workOrderResponsibleTradeId": { "title": "workOrderResponsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleTrade_Id" }, "workOrderResponsibleTradeCode": { "title": "workOrderResponsibleTradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleTrade_Code" }, "workOrderResponsibleTradeDescription": { "title": "workOrderResponsibleTradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleTrade_Description" }, "workOrderTypeOfWorkId": { "title": "workOrderTypeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderTypeOfWork_Id" }, "workOrderTypeOfWorkCode": { "title": "workOrderTypeOfWorkCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderTypeOfWork_Code" }, "workOrderTypeOfWorkDescription": { "title": "workOrderTypeOfWorkDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderTypeOfWork_Description" }, "workOrderTypeOfWorkForConditionMonitoringId": { "title": "workOrderTypeOfWorkForConditionMonitoringId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Id" }, "workOrderTypeOfWorkForConditionMonitoringCode": { "title": "workOrderTypeOfWorkForConditionMonitoringCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Code" }, "workOrderTypeOfWorkForConditionMonitoringDescription": { "title": "workOrderTypeOfWorkForConditionMonitoringDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Description" } } }, "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" } } }, "GetUserOptionResourceActionResponse": { "title": "GetUserOptionResourceActionResponse", "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": "GetUserOptionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserOption->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserOption->ModifiedOn" }, "adHocCostElementId": { "title": "adHocCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->AdHocCostElement_Id" }, "adHocCostElementCode": { "title": "adHocCostElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->AdHocCostElement_Code" }, "adHocCostElementDescription": { "title": "adHocCostElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->AdHocCostElement_Description" }, "applyWorkOrderStatusRules": { "title": "applyWorkOrderStatusRules", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOption->ApplyWorkOrderStatusRules" }, "assetConsumptionCostElementId": { "title": "assetConsumptionCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->AssetConsumptionCostElement_Id" }, "assetConsumptionCostElementCode": { "title": "assetConsumptionCostElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->AssetConsumptionCostElement_Code" }, "assetConsumptionCostElementDescription": { "title": "assetConsumptionCostElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->AssetConsumptionCostElement_Description" }, "contractorsCostElementId": { "title": "contractorsCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->ContractorsCostElement_Id" }, "contractorsCostElementCode": { "title": "contractorsCostElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ContractorsCostElement_Code" }, "contractorsCostElementDescription": { "title": "contractorsCostElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ContractorsCostElement_Description" }, "defaultCreateSaveAction": { "title": "defaultCreateSaveAction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "UserOption->DefaultCreateSaveAction", "x-formatSpecifier": "DefaultCreateSaveAction" }, "defaultUpdateSaveAction": { "title": "defaultUpdateSaveAction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "UserOption->DefaultUpdateSaveAction", "x-formatSpecifier": "DefaultUpdateSaveAction" }, "defaultWorkOrderTaskResourceCostElementId": { "title": "defaultWorkOrderTaskResourceCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->DefaultWorkOrderTaskResourceCostElement_Id" }, "defaultWorkOrderTaskResourceCostElementCode": { "title": "defaultWorkOrderTaskResourceCostElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->DefaultWorkOrderTaskResourceCostElement_Code" }, "defaultWorkOrderTaskResourceCostElementDescription": { "title": "defaultWorkOrderTaskResourceCostElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->DefaultWorkOrderTaskResourceCostElement_Description" }, "directPurchasesCostElementId": { "title": "directPurchasesCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->DirectPurchasesCostElement_Id" }, "directPurchasesCostElementCode": { "title": "directPurchasesCostElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->DirectPurchasesCostElement_Code" }, "directPurchasesCostElementDescription": { "title": "directPurchasesCostElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->DirectPurchasesCostElement_Description" }, "insightsUserId": { "title": "insightsUserId", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->InsightsUserId" }, "isReportUser": { "title": "isReportUser", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOption->IsReportUser" }, "maximumOrderAmount": { "title": "maximumOrderAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UserOption->MaximumOrderAmount" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->Notes" }, "purchaseOrderCanBeQueued": { "title": "purchaseOrderCanBeQueued", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOption->PurchaseOrderCanBeQueued" }, "reportServerReportLanguage": { "title": "reportServerReportLanguage", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ReportServerReportLanguage" }, "reportServerReportLanguageDisplayName": { "title": "reportServerReportLanguageDisplayName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ReportServerReportLanguageDisplayName" }, "reportServerUILanguage": { "title": "reportServerUILanguage", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ReportServerUILanguage" }, "reportServerUILanguageDisplayName": { "title": "reportServerUILanguageDisplayName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ReportServerUILanguageDisplayName" }, "reportUserId": { "title": "reportUserId", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ReportUserId" }, "reportUserName": { "title": "reportUserName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->ReportUserName" }, "reportUserRoles": { "title": "reportUserRoles", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "UserOption->ReportUserRoles", "x-formatSpecifier": "String" }, "requisitionLimit": { "title": "requisitionLimit", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UserOption->RequisitionLimit" }, "rootAssetId": { "title": "rootAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->RootAsset_Id" }, "rootAssetCode": { "title": "rootAssetCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->RootAsset_Code" }, "rootAssetDescription": { "title": "rootAssetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->RootAsset_Description" }, "stockItemsCostElementId": { "title": "stockItemsCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->StockItemsCostElement_Id" }, "stockItemsCostElementCode": { "title": "stockItemsCostElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->StockItemsCostElement_Code" }, "stockItemsCostElementDescription": { "title": "stockItemsCostElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->StockItemsCostElement_Description" }, "taskClassification1Id": { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification1_Id" }, "taskClassification1Code": { "title": "taskClassification1Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification1_Code" }, "taskClassification1Description": { "title": "taskClassification1Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification1_Description" }, "taskClassification2Id": { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification2_Id" }, "taskClassification2Code": { "title": "taskClassification2Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification2_Code" }, "taskClassification2Description": { "title": "taskClassification2Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification2_Description" }, "taskClassification3Id": { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification3_Id" }, "taskClassification3Code": { "title": "taskClassification3Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification3_Code" }, "taskClassification3Description": { "title": "taskClassification3Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification3_Description" }, "taskClassification4Id": { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification4_Id" }, "taskClassification4Code": { "title": "taskClassification4Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification4_Code" }, "taskClassification4Description": { "title": "taskClassification4Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification4_Description" }, "taskClassification5Id": { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification5_Id" }, "taskClassification5Code": { "title": "taskClassification5Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification5_Code" }, "taskClassification5Description": { "title": "taskClassification5Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification5_Description" }, "taskClassification6Id": { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification6_Id" }, "taskClassification6Code": { "title": "taskClassification6Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification6_Code" }, "taskClassification6Description": { "title": "taskClassification6Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification6_Description" }, "taskClassification7Id": { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification7_Id" }, "taskClassification7Code": { "title": "taskClassification7Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification7_Code" }, "taskClassification7Description": { "title": "taskClassification7Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification7_Description" }, "taskClassification8Id": { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification8_Id" }, "taskClassification8Code": { "title": "taskClassification8Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification8_Code" }, "taskClassification8Description": { "title": "taskClassification8Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification8_Description" }, "taskImportanceId": { "title": "taskImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskImportance_Id" }, "taskImportanceCode": { "title": "taskImportanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskImportance_Code" }, "taskImportanceDescription": { "title": "taskImportanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskImportance_Description" }, "taskResponsibleSectionId": { "title": "taskResponsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleSection_Id" }, "taskResponsibleSectionCode": { "title": "taskResponsibleSectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleSection_Code" }, "taskResponsibleSectionDescription": { "title": "taskResponsibleSectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleSection_Description" }, "taskResponsibleStaffId": { "title": "taskResponsibleStaffId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleStaff_Id" }, "taskResponsibleStaffCode": { "title": "taskResponsibleStaffCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleStaff_Code" }, "taskResponsibleStaffDescription": { "title": "taskResponsibleStaffDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleStaff_Description" }, "taskResponsibleTradeId": { "title": "taskResponsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleTrade_Id" }, "taskResponsibleTradeCode": { "title": "taskResponsibleTradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleTrade_Code" }, "taskResponsibleTradeDescription": { "title": "taskResponsibleTradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleTrade_Description" }, "taskTypeOfWorkId": { "title": "taskTypeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskTypeOfWork_Id" }, "taskTypeOfWorkCode": { "title": "taskTypeOfWorkCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskTypeOfWork_Code" }, "taskTypeOfWorkDescription": { "title": "taskTypeOfWorkDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TaskTypeOfWork_Description" }, "travelCostElementId": { "title": "travelCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TravelCostElement_Id" }, "travelCostElementCode": { "title": "travelCostElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TravelCostElement_Code" }, "travelCostElementDescription": { "title": "travelCostElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->TravelCostElement_Description" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserOption->User_Id" }, "userCode": { "title": "userCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->User_Code" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->User_FullName" }, "workClassification1Id": { "title": "workClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification1_Id" }, "workClassification1Code": { "title": "workClassification1Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification1_Code" }, "workClassification1Description": { "title": "workClassification1Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification1_Description" }, "workClassification2Id": { "title": "workClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification2_Id" }, "workClassification2Code": { "title": "workClassification2Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification2_Code" }, "workClassification2Description": { "title": "workClassification2Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification2_Description" }, "workClassification3Id": { "title": "workClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification3_Id" }, "workClassification3Code": { "title": "workClassification3Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification3_Code" }, "workClassification3Description": { "title": "workClassification3Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification3_Description" }, "workClassification4Id": { "title": "workClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification4_Id" }, "workClassification4Code": { "title": "workClassification4Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification4_Code" }, "workClassification4Description": { "title": "workClassification4Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification4_Description" }, "workClassification5Id": { "title": "workClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification5_Id" }, "workClassification5Code": { "title": "workClassification5Code", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification5_Code" }, "workClassification5Description": { "title": "workClassification5Description", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification5_Description" }, "workOrderCanBeQueued": { "title": "workOrderCanBeQueued", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderCanBeQueued" }, "workOrderImportanceId": { "title": "workOrderImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderImportance_Id" }, "workOrderImportanceCode": { "title": "workOrderImportanceCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderImportance_Code" }, "workOrderImportanceDescription": { "title": "workOrderImportanceDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderImportance_Description" }, "workOrderLimit": { "title": "workOrderLimit", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderLimit" }, "workOrderResponsibleSectionId": { "title": "workOrderResponsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleSection_Id" }, "workOrderResponsibleSectionCode": { "title": "workOrderResponsibleSectionCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleSection_Code" }, "workOrderResponsibleSectionDescription": { "title": "workOrderResponsibleSectionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleSection_Description" }, "workOrderResponsibleStaffId": { "title": "workOrderResponsibleStaffId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleStaff_Id" }, "workOrderResponsibleStaffCode": { "title": "workOrderResponsibleStaffCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleStaff_Code" }, "workOrderResponsibleStaffDescription": { "title": "workOrderResponsibleStaffDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleStaff_Description" }, "workOrderResponsibleTradeId": { "title": "workOrderResponsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleTrade_Id" }, "workOrderResponsibleTradeCode": { "title": "workOrderResponsibleTradeCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleTrade_Code" }, "workOrderResponsibleTradeDescription": { "title": "workOrderResponsibleTradeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleTrade_Description" }, "workOrderTypeOfWorkId": { "title": "workOrderTypeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderTypeOfWork_Id" }, "workOrderTypeOfWorkCode": { "title": "workOrderTypeOfWorkCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderTypeOfWork_Code" }, "workOrderTypeOfWorkDescription": { "title": "workOrderTypeOfWorkDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderTypeOfWork_Description" }, "workOrderTypeOfWorkForConditionMonitoringId": { "title": "workOrderTypeOfWorkForConditionMonitoringId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Id" }, "workOrderTypeOfWorkForConditionMonitoringCode": { "title": "workOrderTypeOfWorkForConditionMonitoringCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Code" }, "workOrderTypeOfWorkForConditionMonitoringDescription": { "title": "workOrderTypeOfWorkForConditionMonitoringDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Description" } } }, "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" } } }, "TreePathItem": { "type": "object", "required": [ "sequence" ], "properties": { "sequence": { "type": "integer", "format": "int32" }, "code": { "type": "string" }, "description": { "type": "string" }, "alternativeDescription": { "type": "string" } } }, "GetUserOptionCollectionResourceActionResponse": { "title": "GetUserOptionCollectionResourceActionResponse", "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": "GetUserOptionCollectionResourceActionResponseItem", "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": "GetUserOptionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "applyWorkOrderStatusRules": { "title": "applyWorkOrderStatusRules", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOption->ApplyWorkOrderStatusRules" }, "maximumOrderAmount": { "title": "maximumOrderAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UserOption->MaximumOrderAmount" }, "purchaseOrderCanBeQueued": { "title": "purchaseOrderCanBeQueued", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOption->PurchaseOrderCanBeQueued" }, "requisitionLimit": { "title": "requisitionLimit", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UserOption->RequisitionLimit" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->User_Id" }, "userCode": { "title": "userCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserOption->User_Code" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": false, "x-propertyPath": "UserOption->User_FullName" }, "userIsAdministrator": { "title": "userIsAdministrator", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserOption->User_IsAdministrator" }, "isReportUser": { "title": "isReportUser", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOption->IsReportUser" }, "reportUserRoles": { "title": "reportUserRoles", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "UserOption->ReportUserRoles", "x-formatSpecifier": "String" }, "insightsUserId": { "title": "insightsUserId", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->InsightsUserId" }, "rootAssetTreePathItems": { "title": "rootAssetTreePathItems", "type": "array", "format": "array", "x-nullable": true, "items": { "$ref": "#/definitions/TreePathItem" }, "x-propertyPath": "UserOption->RootAsset_TreePathItems", "x-formatSpecifier": "TreePathItem" } } }, "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" } } } }, "LookupUserOptionAdHocCostElementResourceActionResponse": { "title": "LookupUserOptionAdHocCostElementResourceActionResponse", "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": "LookupUserOptionAdHocCostElementResourceActionResponseItem", "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": "LookupUserOptionAdHocCostElementResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->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" } } } }, "LookupUserOptionAssetConsumptionCostElementResourceActionResponse": { "title": "LookupUserOptionAssetConsumptionCostElementResourceActionResponse", "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": "LookupUserOptionAssetConsumptionCostElementResourceActionResponseItem", "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": "LookupUserOptionAssetConsumptionCostElementResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->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" } } } }, "LookupUserOptionContractorsCostElementResourceActionResponse": { "title": "LookupUserOptionContractorsCostElementResourceActionResponse", "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": "LookupUserOptionContractorsCostElementResourceActionResponseItem", "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": "LookupUserOptionContractorsCostElementResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->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" } } } }, "LookupUserOptionDirectPurchasesCostElementResourceActionResponse": { "title": "LookupUserOptionDirectPurchasesCostElementResourceActionResponse", "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": "LookupUserOptionDirectPurchasesCostElementResourceActionResponseItem", "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": "LookupUserOptionDirectPurchasesCostElementResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->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" } } } }, "LookupUserOptionRootAssetResourceActionResponse": { "title": "LookupUserOptionRootAssetResourceActionResponse", "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": "LookupUserOptionRootAssetResourceActionResponseItem", "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": "LookupUserOptionRootAssetResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Asset->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" } } } }, "LookupUserOptionStockItemsCostElementResourceActionResponse": { "title": "LookupUserOptionStockItemsCostElementResourceActionResponse", "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": "LookupUserOptionStockItemsCostElementResourceActionResponseItem", "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": "LookupUserOptionStockItemsCostElementResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->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" } } } }, "LookupUserOptionTaskClassification1ResourceActionResponse": { "title": "LookupUserOptionTaskClassification1ResourceActionResponse", "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": "LookupUserOptionTaskClassification1ResourceActionResponseItem", "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": "LookupUserOptionTaskClassification1ResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "LookupUserOptionTaskClassification2ResourceActionResponse": { "title": "LookupUserOptionTaskClassification2ResourceActionResponse", "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": "LookupUserOptionTaskClassification2ResourceActionResponseItem", "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": "LookupUserOptionTaskClassification2ResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "LookupUserOptionTaskClassification3ResourceActionResponse": { "title": "LookupUserOptionTaskClassification3ResourceActionResponse", "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": "LookupUserOptionTaskClassification3ResourceActionResponseItem", "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": "LookupUserOptionTaskClassification3ResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "LookupUserOptionTaskClassification4ResourceActionResponse": { "title": "LookupUserOptionTaskClassification4ResourceActionResponse", "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": "LookupUserOptionTaskClassification4ResourceActionResponseItem", "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": "LookupUserOptionTaskClassification4ResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "LookupUserOptionTaskClassification5ResourceActionResponse": { "title": "LookupUserOptionTaskClassification5ResourceActionResponse", "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": "LookupUserOptionTaskClassification5ResourceActionResponseItem", "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": "LookupUserOptionTaskClassification5ResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "LookupUserOptionTaskClassification6ResourceActionResponse": { "title": "LookupUserOptionTaskClassification6ResourceActionResponse", "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": "LookupUserOptionTaskClassification6ResourceActionResponseItem", "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": "LookupUserOptionTaskClassification6ResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "LookupUserOptionTaskClassification7ResourceActionResponse": { "title": "LookupUserOptionTaskClassification7ResourceActionResponse", "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": "LookupUserOptionTaskClassification7ResourceActionResponseItem", "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": "LookupUserOptionTaskClassification7ResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "LookupUserOptionTaskClassification8ResourceActionResponse": { "title": "LookupUserOptionTaskClassification8ResourceActionResponse", "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": "LookupUserOptionTaskClassification8ResourceActionResponseItem", "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": "LookupUserOptionTaskClassification8ResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "LookupUserOptionTaskImportanceResourceActionResponse": { "title": "LookupUserOptionTaskImportanceResourceActionResponse", "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": "LookupUserOptionTaskImportanceResourceActionResponseItem", "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": "LookupUserOptionTaskImportanceResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TaskImportance->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TaskImportance->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" } } } }, "LookupUserOptionTaskResponsibleSectionResourceActionResponse": { "title": "LookupUserOptionTaskResponsibleSectionResourceActionResponse", "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": "LookupUserOptionTaskResponsibleSectionResourceActionResponseItem", "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": "LookupUserOptionTaskResponsibleSectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Section->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Section->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" } } } }, "LookupUserOptionTaskResponsibleStaffResourceActionResponse": { "title": "LookupUserOptionTaskResponsibleStaffResourceActionResponse", "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": "LookupUserOptionTaskResponsibleStaffResourceActionResponseItem", "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": "LookupUserOptionTaskResponsibleStaffResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" } } }, "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" } } } }, "LookupUserOptionTaskResponsibleTradeResourceActionResponse": { "title": "LookupUserOptionTaskResponsibleTradeResourceActionResponse", "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": "LookupUserOptionTaskResponsibleTradeResourceActionResponseItem", "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": "LookupUserOptionTaskResponsibleTradeResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Trade->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Trade->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" } } } }, "LookupUserOptionTaskTypeOfWorkResourceActionResponse": { "title": "LookupUserOptionTaskTypeOfWorkResourceActionResponse", "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": "LookupUserOptionTaskTypeOfWorkResourceActionResponseItem", "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": "LookupUserOptionTaskTypeOfWorkResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->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" } } } }, "LookupUserOptionTravelCostElementResourceActionResponse": { "title": "LookupUserOptionTravelCostElementResourceActionResponse", "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": "LookupUserOptionTravelCostElementResourceActionResponseItem", "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": "LookupUserOptionTravelCostElementResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->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" } } } }, "LookupUserOptionWorkClassification1ResourceActionResponse": { "title": "LookupUserOptionWorkClassification1ResourceActionResponse", "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": "LookupUserOptionWorkClassification1ResourceActionResponseItem", "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": "LookupUserOptionWorkClassification1ResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "LookupUserOptionWorkClassification2ResourceActionResponse": { "title": "LookupUserOptionWorkClassification2ResourceActionResponse", "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": "LookupUserOptionWorkClassification2ResourceActionResponseItem", "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": "LookupUserOptionWorkClassification2ResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "LookupUserOptionWorkClassification3ResourceActionResponse": { "title": "LookupUserOptionWorkClassification3ResourceActionResponse", "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": "LookupUserOptionWorkClassification3ResourceActionResponseItem", "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": "LookupUserOptionWorkClassification3ResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "LookupUserOptionWorkClassification4ResourceActionResponse": { "title": "LookupUserOptionWorkClassification4ResourceActionResponse", "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": "LookupUserOptionWorkClassification4ResourceActionResponseItem", "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": "LookupUserOptionWorkClassification4ResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "LookupUserOptionWorkClassification5ResourceActionResponse": { "title": "LookupUserOptionWorkClassification5ResourceActionResponse", "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": "LookupUserOptionWorkClassification5ResourceActionResponseItem", "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": "LookupUserOptionWorkClassification5ResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "LookupUserOptionWorkOrderImportanceResourceActionResponse": { "title": "LookupUserOptionWorkOrderImportanceResourceActionResponse", "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": "LookupUserOptionWorkOrderImportanceResourceActionResponseItem", "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": "LookupUserOptionWorkOrderImportanceResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderImportance->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "WorkOrderImportance->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" } } } }, "LookupUserOptionWorkOrderResponsibleSectionResourceActionResponse": { "title": "LookupUserOptionWorkOrderResponsibleSectionResourceActionResponse", "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": "LookupUserOptionWorkOrderResponsibleSectionResourceActionResponseItem", "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": "LookupUserOptionWorkOrderResponsibleSectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Section->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Section->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" } } } }, "LookupUserOptionWorkOrderResponsibleStaffResourceActionResponse": { "title": "LookupUserOptionWorkOrderResponsibleStaffResourceActionResponse", "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": "LookupUserOptionWorkOrderResponsibleStaffResourceActionResponseItem", "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": "LookupUserOptionWorkOrderResponsibleStaffResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" } } }, "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" } } } }, "LookupUserOptionWorkOrderResponsibleTradeResourceActionResponse": { "title": "LookupUserOptionWorkOrderResponsibleTradeResourceActionResponse", "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": "LookupUserOptionWorkOrderResponsibleTradeResourceActionResponseItem", "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": "LookupUserOptionWorkOrderResponsibleTradeResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Trade->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Trade->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" } } } }, "LookupUserOptionWorkOrderTypeOfWorkForConditionMonitoringResourceActionResponse": { "title": "LookupUserOptionWorkOrderTypeOfWorkForConditionMonitoringResourceActionResponse", "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": "LookupUserOptionWorkOrderTypeOfWorkForConditionMonitoringResourceActionResponseItem", "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": "LookupUserOptionWorkOrderTypeOfWorkForConditionMonitoringResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->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" } } } }, "LookupUserOptionWorkOrderTypeOfWorkResourceActionResponse": { "title": "LookupUserOptionWorkOrderTypeOfWorkResourceActionResponse", "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": "LookupUserOptionWorkOrderTypeOfWorkResourceActionResponseItem", "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": "LookupUserOptionWorkOrderTypeOfWorkResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TypeOfWork->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" } } } }, "UserOptionDefaultWorkOrderTaskResourceCostElementLookupResourceActionResponse": { "title": "UserOptionDefaultWorkOrderTaskResourceCostElementLookupResourceActionResponse", "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": "UserOptionDefaultWorkOrderTaskResourceCostElementLookupResourceActionResponseItem", "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": "UserOptionDefaultWorkOrderTaskResourceCostElementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CostElement->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" } } } }, "UpdateUserOptionResourceActionResponse": { "title": "UpdateUserOptionResourceActionResponse", "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": "adHocCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->AdHocCostElement_Id" }, { "title": "applyWorkOrderStatusRules", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOption->ApplyWorkOrderStatusRules" }, { "title": "assetConsumptionCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->AssetConsumptionCostElement_Id" }, { "title": "contractorsCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->ContractorsCostElement_Id" }, { "title": "directPurchasesCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->DirectPurchasesCostElement_Id" }, { "title": "defaultWorkOrderTaskResourceCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->DefaultWorkOrderTaskResourceCostElement_Id" }, { "title": "maximumOrderAmount", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UserOption->MaximumOrderAmount" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->Notes" }, { "title": "purchaseOrderCanBeQueued", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOption->PurchaseOrderCanBeQueued" }, { "title": "requisitionLimit", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UserOption->RequisitionLimit" }, { "title": "workOrderResponsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleSection_Id" }, { "title": "workOrderResponsibleStaffId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleStaff_Id" }, { "title": "workOrderResponsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleTrade_Id" }, { "title": "taskResponsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleSection_Id" }, { "title": "taskResponsibleStaffId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleStaff_Id" }, { "title": "taskResponsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleTrade_Id" }, { "title": "rootAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->RootAsset_Id" }, { "title": "stockItemsCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->StockItemsCostElement_Id" }, { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification1_Id" }, { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification2_Id" }, { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification3_Id" }, { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification4_Id" }, { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification5_Id" }, { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification6_Id" }, { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification7_Id" }, { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification8_Id" }, { "title": "taskImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskImportance_Id" }, { "title": "travelCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TravelCostElement_Id" }, { "title": "taskTypeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskTypeOfWork_Id" }, { "title": "workOrderTypeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderTypeOfWork_Id" }, { "title": "workOrderTypeOfWorkForConditionMonitoringId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderTypeOfWorkForConditionMonitoring_Id" }, { "title": "workOrderImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderImportance_Id" }, { "title": "workClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification1_Id" }, { "title": "workClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification2_Id" }, { "title": "workClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification3_Id" }, { "title": "workClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification4_Id" }, { "title": "workClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification5_Id" }, { "title": "workOrderCanBeQueued", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderCanBeQueued" }, { "title": "workOrderLimit", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderLimit" }, { "title": "isReportUser", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOption->IsReportUser" }, { "title": "reportUserRoles", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "UserOption->ReportUserRoles", "x-formatSpecifier": "String" }, { "title": "reportServerUILanguage", "type": "string", "maxLength": 50, "x-nullable": true, "x-propertyPath": "UserOption->ReportServerUILanguage" }, { "title": "reportServerReportLanguage", "type": "string", "maxLength": 50, "x-nullable": true, "x-propertyPath": "UserOption->ReportServerReportLanguage" }, { "title": "insightsUserId", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->InsightsUserId" }, { "title": "defaultCreateSaveAction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "UserOption->DefaultCreateSaveAction", "x-formatSpecifier": "DefaultCreateSaveAction" }, { "title": "defaultUpdateSaveAction", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "UserOption->DefaultUpdateSaveAction", "x-formatSpecifier": "DefaultUpdateSaveAction" } ] } } }, "BatchGetUserOptionResourceAction": { "title": "BatchGetUserOptionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Option entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Option entities", "items": { "$ref": "#/definitions/GetUserOptionResourceActionResponse" } }, "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" } } }, "BatchUpdateUserOptionResourceActionResponse": { "title": "BatchUpdateUserOptionResourceActionResponse", "type": "array", "items": { "$ref": "#/definitions/UpdateUserOptionResourceActionResponse" } }, "MatchUpdateUserOptionResourceActionRequest": { "title": "MatchUpdateUserOptionResourceActionRequest", "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": "applyWorkOrderStatusRules", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOption->ApplyWorkOrderStatusRules" }, { "title": "assetConsumptionCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->AssetConsumptionCostElement_Id" }, { "title": "contractorsCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->ContractorsCostElement_Id" }, { "title": "directPurchasesCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->DirectPurchasesCostElement_Id" }, { "title": "defaultWorkOrderTaskResourceCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->DefaultWorkOrderTaskResourceCostElement_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->Notes" }, { "title": "requisitionLimit", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UserOption->RequisitionLimit" }, { "title": "workOrderResponsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleSection_Id" }, { "title": "workOrderResponsibleStaffId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleStaff_Id" }, { "title": "workOrderResponsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderResponsibleTrade_Id" }, { "title": "taskResponsibleSectionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleSection_Id" }, { "title": "taskResponsibleStaffId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleStaff_Id" }, { "title": "taskResponsibleTradeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskResponsibleTrade_Id" }, { "title": "rootAssetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->RootAsset_Id" }, { "title": "stockItemsCostElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->StockItemsCostElement_Id" }, { "title": "taskClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification1_Id" }, { "title": "taskClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification2_Id" }, { "title": "taskClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification3_Id" }, { "title": "taskClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification4_Id" }, { "title": "taskClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification5_Id" }, { "title": "taskClassification6Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification6_Id" }, { "title": "taskClassification7Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification7_Id" }, { "title": "taskClassification8Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskClassification8_Id" }, { "title": "taskImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskImportance_Id" }, { "title": "taskTypeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->TaskTypeOfWork_Id" }, { "title": "workOrderTypeOfWorkId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderTypeOfWork_Id" }, { "title": "workOrderImportanceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderImportance_Id" }, { "title": "workClassification1Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification1_Id" }, { "title": "workClassification2Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification2_Id" }, { "title": "workClassification3Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification3_Id" }, { "title": "workClassification4Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification4_Id" }, { "title": "workClassification5Id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserOption->WorkClassification5_Id" }, { "title": "workOrderLimit", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UserOption->WorkOrderLimit" }, { "title": "isReportUser", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserOption->IsReportUser" }, { "title": "reportUserRoles", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "UserOption->ReportUserRoles", "x-formatSpecifier": "String" }, { "title": "reportServerUILanguage", "type": "string", "maxLength": 50, "x-nullable": true, "x-propertyPath": "UserOption->ReportServerUILanguage" }, { "title": "reportServerReportLanguage", "type": "string", "maxLength": 50, "x-nullable": true, "x-propertyPath": "UserOption->ReportServerReportLanguage" }, { "title": "insightsUserId", "type": "string", "x-nullable": true, "x-propertyPath": "UserOption->InsightsUserId" } ] } } }, "GetRoleResourceActionResponse2": { "title": "GetRoleResourceActionResponse", "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": "GetRoleResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserSecurityRole->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserSecurityRole->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserSecurityRole->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserSecurityRole->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserSecurityRole->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserSecurityRole->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserSecurityRole->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserSecurityRole->ModifiedOn" }, "applyDownPermissionTree": { "title": "applyDownPermissionTree", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserSecurityRole->ApplyDownPermissionTree" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserSecurityRole->Notes" }, "rolePermissionTreeId": { "title": "rolePermissionTreeId", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "UserSecurityRole->RolePermissionTreeId", "x-formatSpecifier": "Int64" }, "securityRoleId": { "title": "securityRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserSecurityRole->SecurityRole_Id" }, "securityRoleDescription": { "title": "securityRoleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserSecurityRole->SecurityRole_Description" }, "securityRoleCode": { "title": "securityRoleCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserSecurityRole->SecurityRole_Code" }, "securityRoleIsPermissionTreeRole": { "title": "securityRoleIsPermissionTreeRole", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserSecurityRole->SecurityRole_IsPermissionTreeRole" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserSecurityRole->User_Id" }, "userCode": { "title": "userCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserSecurityRole->User_Code" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserSecurityRole->User_FullName" }, "validFrom": { "title": "validFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserSecurityRole->ValidFrom" }, "validInRange": { "title": "validInRange", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserSecurityRole->ValidInRange" }, "validTo": { "title": "validTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserSecurityRole->ValidTo" } } }, "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" } } }, "GetUserSecurityRolePermissionTreeCollectionResourceActionResponse": { "title": "GetUserSecurityRolePermissionTreeCollectionResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->Id" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "PermissionTree->IsActive" } } }, "GetUserSecurityRolePermissionTreeCollectionResourceAction": { "title": "GetUserSecurityRolePermissionTreeCollectionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Security Role entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Security Role entities", "items": { "$ref": "#/definitions/GetUserSecurityRolePermissionTreeCollectionResourceActionResponse" } }, "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" } } }, "GetRoleCollectionResourceActionResponse2": { "title": "GetRoleCollectionResourceActionResponse", "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": "GetRoleCollectionResourceActionResponseItem", "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": "GetRoleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "userFullName": { "title": "userFullName", "type": "string", "x-nullable": false, "x-propertyPath": "UserSecurityRole->User_FullName" }, "securityRoleCode": { "title": "securityRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserSecurityRole->SecurityRole_Code" }, "securityRoleDescription": { "title": "securityRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserSecurityRole->SecurityRole_Description" }, "applyDownPermissionTree": { "title": "applyDownPermissionTree", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserSecurityRole->ApplyDownPermissionTree" }, "validFrom": { "title": "validFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserSecurityRole->ValidFrom" }, "validTo": { "title": "validTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserSecurityRole->ValidTo" }, "validInRange": { "title": "validInRange", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserSecurityRole->ValidInRange" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserSecurityRole->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" } } } }, "GetUserSecurityRoleForUserCollectionResourceActionResponse": { "title": "GetUserSecurityRoleForUserCollectionResourceActionResponse", "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": "GetUserSecurityRoleForUserCollectionResourceActionResponseItem", "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": "GetUserSecurityRoleForUserCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "userFullName": { "title": "userFullName", "type": "string", "x-nullable": false, "x-propertyPath": "UserSecurityRole->User_FullName" }, "securityRoleCode": { "title": "securityRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserSecurityRole->SecurityRole_Code" }, "securityRoleDescription": { "title": "securityRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserSecurityRole->SecurityRole_Description" }, "applyDownPermissionTree": { "title": "applyDownPermissionTree", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserSecurityRole->ApplyDownPermissionTree" }, "validFrom": { "title": "validFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserSecurityRole->ValidFrom" }, "validTo": { "title": "validTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserSecurityRole->ValidTo" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserSecurityRole->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" } } } }, "UserSecurityRolePermissionPermissionTreeLookupResourceActionResponse": { "title": "UserSecurityRolePermissionPermissionTreeLookupResourceActionResponse", "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": "UserSecurityRolePermissionPermissionTreeLookupResourceActionResponseItem", "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": "UserSecurityRolePermissionPermissionTreeLookupResourceActionResponseItemProperties", "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" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "PermissionTree->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" } } } }, "UserSecurityRoleSecurityRoleLookupResourceActionResponse": { "title": "UserSecurityRoleSecurityRoleLookupResourceActionResponse", "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": "UserSecurityRoleSecurityRoleLookupResourceActionResponseItem", "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": "UserSecurityRoleSecurityRoleLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "SecurityRole->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "SecurityRole->Description" }, "isPermissionTreeRole": { "title": "isPermissionTreeRole", "type": "boolean", "x-nullable": false, "x-propertyPath": "SecurityRole->IsPermissionTreeRole" } } }, "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" } } } }, "UserSecurityRoleUserLookupResourceActionResponse": { "title": "UserSecurityRoleUserLookupResourceActionResponse", "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": "UserSecurityRoleUserLookupResourceActionResponseItem", "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": "UserSecurityRoleUserLookupResourceActionResponseItemProperties", "type": "object", "properties": { "fullName": { "title": "fullName", "type": "string", "x-nullable": false, "x-propertyPath": "User->FullName" } } }, "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" } } } }, "CreateRoleResourceActionRequest2": { "title": "CreateRoleResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRoleResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "userId", "securityRoleId", "applyDownPermissionTree" ], "properties": { "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserSecurityRole->User_Id" }, "securityRoleId": { "title": "securityRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserSecurityRole->SecurityRole_Id" }, "applyDownPermissionTree": { "title": "applyDownPermissionTree", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserSecurityRole->ApplyDownPermissionTree" }, "rolePermissionTreeId": { "title": "rolePermissionTreeId", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "UserSecurityRole->RolePermissionTreeId", "x-formatSpecifier": "Int64" }, "validFrom": { "title": "validFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserSecurityRole->ValidFrom" }, "validTo": { "title": "validTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserSecurityRole->ValidTo" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserSecurityRole->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRoleResourceActionRequest2": { "title": "UpdateRoleResourceActionRequest", "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": "rolePermissionTreeId", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "integer" }, "x-propertyPath": "UserSecurityRole->RolePermissionTreeId", "x-formatSpecifier": "Int64" }, { "title": "applyDownPermissionTree", "type": "boolean", "x-nullable": true, "x-propertyPath": "UserSecurityRole->ApplyDownPermissionTree" }, { "title": "validFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserSecurityRole->ValidFrom" }, { "title": "validTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserSecurityRole->ValidTo" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserSecurityRole->Notes" } ] } } }, "DeleteRoleResourceActionRequest2": { "title": "DeleteRoleResourceActionRequest", "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 } } }, "BatchGetUserSecurityRoleResourceAction": { "title": "BatchGetUserSecurityRoleResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Security Role entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Security Role entities", "items": { "$ref": "#/definitions/GetRoleResourceActionResponse2" } }, "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" } } }, "BatchCreateRoleResourceActionRequest2": { "title": "BatchCreateRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRoleResourceActionRequest2" } }, "BatchUpdateRoleResourceActionRequest2": { "title": "BatchUpdateRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRoleResourceActionRequest2" } }, "BatchDeleteRoleResourceActionRequest2": { "title": "BatchDeleteRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRoleResourceActionRequest2" } }, "GetUserTermsAndConditionVersionResourceActionResponse": { "title": "GetUserTermsAndConditionVersionResourceActionResponse", "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": "GetUserTermsAndConditionVersionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserTermsAndConditionVersion->CreatedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->PermissionTree_Description" }, "accepted": { "title": "accepted", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Accepted" }, "acceptedDate": { "title": "acceptedDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "UserTermsAndConditionVersion->AcceptedDate" }, "deprecated": { "title": "deprecated", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Deprecated" }, "termsAndConditionVersionId": { "title": "termsAndConditionVersionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Id" }, "termsAndConditionVersionContentVersion": { "title": "termsAndConditionVersionContentVersion", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_ContentVersion" }, "termsAndConditionVersionLanguageId": { "title": "termsAndConditionVersionLanguageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Id" }, "termsAndConditionVersionLanguageCode": { "title": "termsAndConditionVersionLanguageCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Code" }, "termsAndConditionVersionTermsAndConditionId": { "title": "termsAndConditionVersionTermsAndConditionId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Id" }, "termsAndConditionVersionTermsAndConditionName": { "title": "termsAndConditionVersionTermsAndConditionName", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Name" }, "termsAndConditionVersionContent": { "title": "termsAndConditionVersionContent", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Content" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->User_Id" }, "userCode": { "title": "userCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->User_Code" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserTermsAndConditionVersion->User_FullName" } } }, "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" } } }, "GetUserTermsAndConditionVersionCollectionResourceActionResponse": { "title": "GetUserTermsAndConditionVersionCollectionResourceActionResponse", "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": "GetUserTermsAndConditionVersionCollectionResourceActionResponseItem", "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": "GetUserTermsAndConditionVersionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "userCode": { "title": "userCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->User_Code" }, "termsAndConditionVersionTermsAndConditionCode": { "title": "termsAndConditionVersionTermsAndConditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Code" }, "termsAndConditionVersionTermsAndConditionName": { "title": "termsAndConditionVersionTermsAndConditionName", "type": "string", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Name" }, "termsAndConditionVersionLanguageCode": { "title": "termsAndConditionVersionLanguageCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Code" }, "termsAndConditionVersionPublished": { "title": "termsAndConditionVersionPublished", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Published" }, "termsAndConditionVersionContentVersion": { "title": "termsAndConditionVersionContentVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_ContentVersion" }, "deprecated": { "title": "deprecated", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Deprecated" }, "accepted": { "title": "accepted", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Accepted" }, "acceptedDate": { "title": "acceptedDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "UserTermsAndConditionVersion->AcceptedDate" } } }, "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" } } } }, "GetUserTermsAndConditionVersionForUserCollectionResourceActionResponse": { "title": "GetUserTermsAndConditionVersionForUserCollectionResourceActionResponse", "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": "GetUserTermsAndConditionVersionForUserCollectionResourceActionResponseItem", "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": "GetUserTermsAndConditionVersionForUserCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "termsAndConditionVersionTermsAndConditionCode": { "title": "termsAndConditionVersionTermsAndConditionCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Code" }, "termsAndConditionVersionTermsAndConditionName": { "title": "termsAndConditionVersionTermsAndConditionName", "type": "string", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_TermsAndCondition_Name" }, "termsAndConditionVersionLanguageCode": { "title": "termsAndConditionVersionLanguageCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Language_Code" }, "termsAndConditionVersionPublished": { "title": "termsAndConditionVersionPublished", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_Published" }, "termsAndConditionVersionContentVersion": { "title": "termsAndConditionVersionContentVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->TermsAndConditionVersion_ContentVersion" }, "deprecated": { "title": "deprecated", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Deprecated" }, "accepted": { "title": "accepted", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserTermsAndConditionVersion->Accepted" }, "acceptedDate": { "title": "acceptedDate", "type": "string", "format": "date", "x-nullable": true, "example": "2005-04-20", "x-propertyPath": "UserTermsAndConditionVersion->AcceptedDate" } } }, "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" } } } }, "BatchGetUserTermsAndConditionVersionResourceAction": { "title": "BatchGetUserTermsAndConditionVersionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Terms And Conditions Version entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Terms And Conditions Version entities", "items": { "$ref": "#/definitions/GetUserTermsAndConditionVersionResourceActionResponse" } }, "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" } } } }, "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": "Operational Role" }, { "name": "Operational Role Resource" }, { "name": "Operational Role Template" }, { "name": "Permission" }, { "name": "Permission Tree" }, { "name": "Permission Tree Tree" }, { "name": "Security Role" }, { "name": "Security Role Permission" }, { "name": "Terms And Conditions" }, { "name": "Terms And Conditions Operational Role" }, { "name": "Terms And Conditions Version" }, { "name": "User" }, { "name": "User Attribute" }, { "name": "User Authentication" }, { "name": "User Custom Permission" }, { "name": "User Document" }, { "name": "User Operational Role" }, { "name": "User Operational Role Resource" }, { "name": "User Operational Role Template" }, { "name": "User Option" }, { "name": "User Security Role" }, { "name": "User Terms And Conditions Version" } ], "x-tagGroups": [ { "name": "UAM", "tags": [ "Operational Role", "Operational Role Resource", "Operational Role Template", "Permission", "Permission Tree", "Permission Tree Tree", "Security Role", "Security Role Permission", "Terms And Conditions", "Terms And Conditions Operational Role", "Terms And Conditions Version", "User", "User Attribute", "User Authentication", "User Custom Permission", "User Document", "User Operational Role", "User Operational Role Resource", "User Operational Role Template", "User Option", "User Security Role", "User Terms And Conditions Version" ] } ] }