{ "x-generator": "On Key REST API Docs Generator", "swagger": "2.0", "info": { "title": "On Key GEN 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", "multipart/form-data" ], "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/GEN/AddressTypes/{id}": { "get": { "tags": [ "Address Type" ], "summary": "Get a Address Type 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 | AddressType->Code | string | |\r\n| createdByUserId | AddressType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AddressType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AddressType->CreatedByUser_FullName | string | |\r\n| createdOn | AddressType->CreatedOn | string | date-time |\r\n| isActive | AddressType->IsActive | boolean | |\r\n| modifiedByUserId | AddressType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AddressType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AddressType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AddressType->ModifiedOn | string | date-time |\r\n| permissionTreeId | AddressType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AddressType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AddressType->PermissionTree_Description | string | |\r\n| version | AddressType->Version | integer | int32 |\r\n| id | AddressType->Id | integer | int64 |\r\n| description | AddressType->Description | string | |\r\n| notes | AddressType->Notes | string | |\r\n| sequenceNumber | AddressType->SequenceNumber | integer | int32 |\r\n", "operationId": "GetAddressType", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Address Type Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Address Type", "schema": { "$ref": "#/definitions/GetAddressTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Address Type" ], "summary": "Update an existing Address Type 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 | AddressType->Version | integer | int32 |\r\n| sequenceNumber | AddressType->SequenceNumber | integer | int32 |\r\n| code | AddressType->Code | string | |\r\n| description | AddressType->Description | string | |\r\n| notes | AddressType->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": "UpdateAddressType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Address Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAddressTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Address Type 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": [ "Address Type" ], "summary": "Delete an existing Address Type 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 | AddressType->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": "DeleteAddressType", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Address Type Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteAddressTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Address Type 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/GEN/AddressTypes": { "get": { "tags": [ "Address Type" ], "summary": "Get a collection of Address Type 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 | AddressType->Version | integer | int32 |\r\n| id | AddressType->Id | integer | int64 |\r\n| code | AddressType->Code | string | |\r\n| description | AddressType->Description | string | |\r\n| sequenceNumber | AddressType->SequenceNumber | integer | int32 |\r\n| notes | AddressType->Notes | string | |\r\n| createdOn | AddressType->CreatedOn | string | date-time |\r\n| modifiedOn | AddressType->ModifiedOn | string | date-time |\r\n", "operationId": "GetAddressTypeCollection", "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 Address Type collection", "schema": { "$ref": "#/definitions/GetAddressTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Address Type" ], "summary": "Create a new Address Type 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 | AddressType->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AddressType->SequenceNumber | integer | int32 |\r\n| code | AddressType->Code | string | |\r\n| description | AddressType->Description | string | |\r\n| notes | AddressType->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": "CreateAddressType", "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/CreateAddressTypeResourceActionRequest" } }, { "$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/GEN/AddressTypes/Lookups/LookupAddressTypeChangePermissionTree": { "get": { "tags": [ "Address Type" ], "summary": "Lookup the permission set for changing the Address Type.", "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": "LookupAddressTypeChangePermissionTree", "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/AddressTypeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/AddressTypes/Lookups/LookupAddressTypeInsertPermissionTree": { "get": { "tags": [ "Address Type" ], "summary": "Lookup the permission set for creating the Address Type.", "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": "LookupAddressTypeInsertPermissionTree", "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/AddressTypeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/AddressTypes/Batch/{ids}": { "get": { "tags": [ "Address Type" ], "summary": "Get a collection of Address Type 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 | AddressType->Code | string | |\r\n| createdByUserId | AddressType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AddressType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AddressType->CreatedByUser_FullName | string | |\r\n| createdOn | AddressType->CreatedOn | string | date-time |\r\n| isActive | AddressType->IsActive | boolean | |\r\n| modifiedByUserId | AddressType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AddressType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AddressType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AddressType->ModifiedOn | string | date-time |\r\n| permissionTreeId | AddressType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AddressType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AddressType->PermissionTree_Description | string | |\r\n| version | AddressType->Version | integer | int32 |\r\n| id | AddressType->Id | integer | int64 |\r\n| description | AddressType->Description | string | |\r\n| notes | AddressType->Notes | string | |\r\n| sequenceNumber | AddressType->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetAddressType", "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 Address Type 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 Address Type collection", "schema": { "$ref": "#/definitions/BatchGetAddressTypeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/AddressTypes/Batch": { "post": { "tags": [ "Address Type" ], "summary": "Create a new collection of Address Type 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 | AddressType->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AddressType->SequenceNumber | integer | int32 |\r\n| code | AddressType->Code | string | |\r\n| description | AddressType->Description | string | |\r\n| notes | AddressType->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": "BatchCreateAddressType", "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/BatchCreateAddressTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Address Type 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": [ "Address Type" ], "summary": "Update a collection of existing Address Type 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 | AddressType->Id | integer | int64 |\r\n| version | AddressType->Version | integer | int32 |\r\n| sequenceNumber | AddressType->SequenceNumber | integer | int32 |\r\n| code | AddressType->Code | string | |\r\n| description | AddressType->Description | string | |\r\n| notes | AddressType->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": "BatchUpdateAddressType", "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/BatchUpdateAddressTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Address Type 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": [ "Address Type" ], "summary": "Delete a collection of existing Address Type 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 | AddressType->Id | integer | int64 |\r\n| version | AddressType->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": "BatchDeleteAddressType", "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/BatchDeleteAddressTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Address Type 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/GEN/AddressTypes/{id}/Active": { "patch": { "tags": [ "Address Type" ], "summary": "Change the IsActive status for an existing Address Type 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 | AddressType->Version | integer | int32 |\r\n| isActive | AddressType->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": "ChangeAddressTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Address Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAddressTypeIsActiveResourceActionRequest" } }, { "$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/GEN/AddressTypes/{id}/PermissionTree": { "patch": { "tags": [ "Address Type" ], "summary": "Change the PermissionTree for an existing Address Type 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 | AddressType->Version | integer | int32 |\r\n| permissionTreeId | AddressType->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": "ChangeAddressTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Address Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAddressTypePermissionTreeResourceActionRequest" } }, { "$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/GEN/AddressTypes/Batch/Active": { "patch": { "tags": [ "Address Type" ], "summary": "Change the IsActive status for a collection of existing Address Type 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 | AddressType->Id | integer | int64 |\r\n| version | AddressType->Version | integer | int32 |\r\n| isActive | AddressType->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": "BatchChangeAddressTypeIsActive", "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/BatchChangeAddressTypeIsActiveResourceActionRequest" } }, { "$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/GEN/AddressTypes/Batch/PermissionTree": { "patch": { "tags": [ "Address Type" ], "summary": "Change the PermissionTree status for a collection of existing Address Type 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 | AddressType->Id | integer | int64 |\r\n| version | AddressType->Version | integer | int32 |\r\n| permissionTreeId | AddressType->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": "BatchChangeAddressTypePermissionTree", "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/BatchChangeAddressTypePermissionTreeResourceActionRequest" } }, { "$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/GEN/Approvals/{id}": { "get": { "tags": [ "Approval" ], "summary": "Get a Approval 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 | Approval->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Approval->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Approval->CreatedByUser_FullName | string | |\r\n| createdOn | Approval->CreatedOn | string | date-time |\r\n| modifiedByUserId | Approval->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Approval->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Approval->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Approval->ModifiedOn | string | date-time |\r\n| version | Approval->Version | integer | int32 |\r\n| entitySiteId | Approval->EntitySite_Id | integer | int64 |\r\n| entitySiteCode | Approval->EntitySite_Code | string | |\r\n| entitySiteDescription | Approval->EntitySite_Description | string | |\r\n| id | Approval->Id | integer | int64 |\r\n| entityId | Approval->EntityId | integer | int64 |\r\n| entityType | Approval->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| entityVersion | Approval->EntityVersion | integer | int32 |\r\n| expressionId | Approval->Expression_Id | integer | int64 |\r\n| expressionDescription | Approval->Expression_Description | string | |\r\n| expressionVersion | Approval->ExpressionVersion | integer | int32 |\r\n| reviewedByUserId | Approval->ReviewedByUser_Id | integer | int64 |\r\n| reviewedByUserCode | Approval->ReviewedByUser_Code | string | |\r\n| reviewedByUserFullName | Approval->ReviewedByUser_FullName | string | |\r\n| reviewedOn | Approval->ReviewedOn | string | date-time |\r\n| isHistoric | Approval->IsHistoric | boolean | |\r\n| isLocked | Approval->IsLocked | boolean | |\r\n| notes | Approval->Notes | string | |\r\n| remark | Approval->Remark | string | |\r\n| roleId | Approval->Role_Id | integer | int64 |\r\n| roleCode | Approval->Role_Code | string | |\r\n| roleDescription | Approval->Role_Description | string | |\r\n| sequenceNumber | Approval->SequenceNumber | integer | int32 |\r\n| status | Approval->Status | string (Allowed values: [AwaitingApproval, Approved, Rejected, RoleCountReached]) | enum |\r\n", "operationId": "GetApproval", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Approval", "schema": { "$ref": "#/definitions/GetApprovalResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Approvals": { "get": { "tags": [ "Approval" ], "summary": "Get a collection of Approval 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 | Approval->Id | integer | int64 |\r\n| version | Approval->Version | integer | int32 |\r\n| entityId | Approval->EntityId | integer | int64 |\r\n| entityType | Approval->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| isLocked | Approval->IsLocked | boolean | |\r\n| roleCode | Approval->Role_Code | string | |\r\n| reviewedByUserCode | Approval->ReviewedByUser_Code | string | |\r\n| reviewedOn | Approval->ReviewedOn | string | date-time |\r\n| remark | Approval->Remark | string | |\r\n| isHistoric | Approval->IsHistoric | boolean | |\r\n| status | Approval->Status | string (Allowed values: [AwaitingApproval, Approved, Rejected, RoleCountReached]) | enum |\r\n", "operationId": "GetApprovalCollection", "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 Approval collection", "schema": { "$ref": "#/definitions/GetApprovalCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Approvals/Batch/{ids}": { "get": { "tags": [ "Approval" ], "summary": "Get a collection of Approval 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 | Approval->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Approval->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Approval->CreatedByUser_FullName | string | |\r\n| createdOn | Approval->CreatedOn | string | date-time |\r\n| modifiedByUserId | Approval->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Approval->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Approval->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Approval->ModifiedOn | string | date-time |\r\n| version | Approval->Version | integer | int32 |\r\n| entitySiteId | Approval->EntitySite_Id | integer | int64 |\r\n| entitySiteCode | Approval->EntitySite_Code | string | |\r\n| entitySiteDescription | Approval->EntitySite_Description | string | |\r\n| id | Approval->Id | integer | int64 |\r\n| entityId | Approval->EntityId | integer | int64 |\r\n| entityType | Approval->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| entityVersion | Approval->EntityVersion | integer | int32 |\r\n| expressionId | Approval->Expression_Id | integer | int64 |\r\n| expressionDescription | Approval->Expression_Description | string | |\r\n| expressionVersion | Approval->ExpressionVersion | integer | int32 |\r\n| reviewedByUserId | Approval->ReviewedByUser_Id | integer | int64 |\r\n| reviewedByUserCode | Approval->ReviewedByUser_Code | string | |\r\n| reviewedByUserFullName | Approval->ReviewedByUser_FullName | string | |\r\n| reviewedOn | Approval->ReviewedOn | string | date-time |\r\n| isHistoric | Approval->IsHistoric | boolean | |\r\n| isLocked | Approval->IsLocked | boolean | |\r\n| notes | Approval->Notes | string | |\r\n| remark | Approval->Remark | string | |\r\n| roleId | Approval->Role_Id | integer | int64 |\r\n| roleCode | Approval->Role_Code | string | |\r\n| roleDescription | Approval->Role_Description | string | |\r\n| sequenceNumber | Approval->SequenceNumber | integer | int32 |\r\n| status | Approval->Status | string (Allowed values: [AwaitingApproval, Approved, Rejected, RoleCountReached]) | enum |\r\n", "operationId": "BatchGetApproval", "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 Approval 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 Approval collection", "schema": { "$ref": "#/definitions/BatchGetApprovalResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalRoles/{id}": { "get": { "tags": [ "Approval Role" ], "summary": "Get a Approval 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 | ApprovalRole->Code | string | |\r\n| isActive | ApprovalRole->IsActive | boolean | |\r\n| createdByUserId | ApprovalRole->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ApprovalRole->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ApprovalRole->CreatedByUser_FullName | string | |\r\n| createdOn | ApprovalRole->CreatedOn | string | date-time |\r\n| modifiedByUserId | ApprovalRole->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ApprovalRole->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ApprovalRole->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ApprovalRole->ModifiedOn | string | date-time |\r\n| version | ApprovalRole->Version | integer | int32 |\r\n| permissionTreeId | ApprovalRole->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ApprovalRole->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ApprovalRole->PermissionTree_Description | string | |\r\n| id | ApprovalRole->Id | integer | int64 |\r\n| description | ApprovalRole->Description | string | |\r\n| notes | ApprovalRole->Notes | string | |\r\n| sequenceNumber | ApprovalRole->SequenceNumber | integer | int32 |\r\n", "operationId": "GetApprovalRole", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Role Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Approval Role", "schema": { "$ref": "#/definitions/GetApprovalRoleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Approval Role" ], "summary": "Update an existing Approval 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 | ApprovalRole->Version | integer | int32 |\r\n| code | ApprovalRole->Code | string | |\r\n| description | ApprovalRole->Description | string | |\r\n| sequenceNumber | ApprovalRole->SequenceNumber | integer | int32 |\r\n| notes | ApprovalRole->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": "UpdateApprovalRole", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateApprovalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Approval 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": [ "Approval Role" ], "summary": "Delete an existing Approval 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 | ApprovalRole->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": "DeleteApprovalRole", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Role Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteApprovalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Approval 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/GEN/ApprovalRoles": { "get": { "tags": [ "Approval Role" ], "summary": "Get a collection of Approval 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 | ApprovalRole->Version | integer | int32 |\r\n| id | ApprovalRole->Id | integer | int64 |\r\n| code | ApprovalRole->Code | string | |\r\n| description | ApprovalRole->Description | string | |\r\n| permissionTreeCode | ApprovalRole->PermissionTree_Code | string | |\r\n| sequenceNumber | ApprovalRole->SequenceNumber | integer | int32 |\r\n| notes | ApprovalRole->Notes | string | |\r\n| createdOn | ApprovalRole->CreatedOn | string | date-time |\r\n| modifiedOn | ApprovalRole->ModifiedOn | string | date-time |\r\n", "operationId": "GetApprovalRoleCollection", "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 Approval Role collection", "schema": { "$ref": "#/definitions/GetApprovalRoleCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Approval Role" ], "summary": "Create a new Approval 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 | ApprovalRole->PermissionTree_Id | integer | int64 |\r\n| code | ApprovalRole->Code | string | |\r\n| description | ApprovalRole->Description | string | |\r\n| sequenceNumber | ApprovalRole->SequenceNumber | integer | int32 |\r\n| notes | ApprovalRole->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": "CreateApprovalRole", "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/CreateApprovalRoleResourceActionRequest" } }, { "$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/GEN/ApprovalRoles/Lookups/LookupApprovalRoleChangePermissionTree": { "get": { "tags": [ "Approval Role" ], "summary": "Lookup the permission set for changing the Approval 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": "LookupApprovalRoleChangePermissionTree", "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/ApprovalRoleChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalRoles/Lookups/LookupApprovalRoleInsertPermissionTree": { "get": { "tags": [ "Approval Role" ], "summary": "Lookup the permission set for creating the Approval 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": "LookupApprovalRoleInsertPermissionTree", "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/ApprovalRoleInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalRoles/Batch/{ids}": { "get": { "tags": [ "Approval Role" ], "summary": "Get a collection of Approval 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 | ApprovalRole->Code | string | |\r\n| isActive | ApprovalRole->IsActive | boolean | |\r\n| createdByUserId | ApprovalRole->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ApprovalRole->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ApprovalRole->CreatedByUser_FullName | string | |\r\n| createdOn | ApprovalRole->CreatedOn | string | date-time |\r\n| modifiedByUserId | ApprovalRole->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ApprovalRole->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ApprovalRole->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ApprovalRole->ModifiedOn | string | date-time |\r\n| version | ApprovalRole->Version | integer | int32 |\r\n| permissionTreeId | ApprovalRole->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ApprovalRole->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ApprovalRole->PermissionTree_Description | string | |\r\n| id | ApprovalRole->Id | integer | int64 |\r\n| description | ApprovalRole->Description | string | |\r\n| notes | ApprovalRole->Notes | string | |\r\n| sequenceNumber | ApprovalRole->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetApprovalRole", "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 Approval 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 Approval Role collection", "schema": { "$ref": "#/definitions/BatchGetApprovalRoleResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalRoles/Batch": { "post": { "tags": [ "Approval Role" ], "summary": "Create a new collection of Approval 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 | ApprovalRole->PermissionTree_Id | integer | int64 |\r\n| code | ApprovalRole->Code | string | |\r\n| description | ApprovalRole->Description | string | |\r\n| sequenceNumber | ApprovalRole->SequenceNumber | integer | int32 |\r\n| notes | ApprovalRole->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": "BatchCreateApprovalRole", "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/BatchCreateApprovalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Approval 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": [ "Approval Role" ], "summary": "Update a collection of existing Approval 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 | ApprovalRole->Id | integer | int64 |\r\n| version | ApprovalRole->Version | integer | int32 |\r\n| code | ApprovalRole->Code | string | |\r\n| description | ApprovalRole->Description | string | |\r\n| sequenceNumber | ApprovalRole->SequenceNumber | integer | int32 |\r\n| notes | ApprovalRole->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": "BatchUpdateApprovalRole", "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/BatchUpdateApprovalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Approval 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": [ "Approval Role" ], "summary": "Delete a collection of existing Approval 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 | ApprovalRole->Id | integer | int64 |\r\n| version | ApprovalRole->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": "BatchDeleteApprovalRole", "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/BatchDeleteApprovalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Approval 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/GEN/ApprovalRoles/{id}/Active": { "patch": { "tags": [ "Approval Role" ], "summary": "Change the IsActive status for an existing Approval 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 | ApprovalRole->Version | integer | int32 |\r\n| isActive | ApprovalRole->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": "ChangeApprovalRoleIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeApprovalRoleIsActiveResourceActionRequest" } }, { "$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/GEN/ApprovalRoles/{id}/PermissionTree": { "patch": { "tags": [ "Approval Role" ], "summary": "Change the PermissionTree for an existing Approval 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 | ApprovalRole->Version | integer | int32 |\r\n| permissionTreeId | ApprovalRole->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": "ChangeApprovalRolePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeApprovalRolePermissionTreeResourceActionRequest" } }, { "$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/GEN/ApprovalRoles/Batch/Active": { "patch": { "tags": [ "Approval Role" ], "summary": "Change the IsActive status for a collection of existing Approval 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 | ApprovalRole->Id | integer | int64 |\r\n| version | ApprovalRole->Version | integer | int32 |\r\n| isActive | ApprovalRole->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": "BatchChangeApprovalRoleIsActive", "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/BatchChangeApprovalRoleIsActiveResourceActionRequest" } }, { "$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/GEN/ApprovalRoles/Batch/PermissionTree": { "patch": { "tags": [ "Approval Role" ], "summary": "Change the PermissionTree status for a collection of existing Approval 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 | ApprovalRole->Id | integer | int64 |\r\n| version | ApprovalRole->Version | integer | int32 |\r\n| permissionTreeId | ApprovalRole->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": "BatchChangeApprovalRolePermissionTree", "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/BatchChangeApprovalRolePermissionTreeResourceActionRequest" } }, { "$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/GEN/ApprovalWorkflows/{id}": { "get": { "tags": [ "Approval Workflow" ], "summary": "Get a Approval Workflow 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 | ApprovalWorkflow->Code | string | |\r\n| isActive | ApprovalWorkflow->IsActive | boolean | |\r\n| createdByUserId | ApprovalWorkflow->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ApprovalWorkflow->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ApprovalWorkflow->CreatedByUser_FullName | string | |\r\n| createdOn | ApprovalWorkflow->CreatedOn | string | date-time |\r\n| modifiedByUserId | ApprovalWorkflow->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ApprovalWorkflow->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ApprovalWorkflow->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ApprovalWorkflow->ModifiedOn | string | date-time |\r\n| version | ApprovalWorkflow->Version | integer | int32 |\r\n| permissionTreeId | ApprovalWorkflow->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ApprovalWorkflow->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ApprovalWorkflow->PermissionTree_Description | string | |\r\n| siteId | ApprovalWorkflow->Site_Id | integer | int64 |\r\n| siteCode | ApprovalWorkflow->Site_Code | string | |\r\n| siteDescription | ApprovalWorkflow->Site_Description | string | |\r\n| id | ApprovalWorkflow->Id | integer | int64 |\r\n| approvalEntity | ApprovalWorkflow->ApprovalEntity | string (Allowed values: [Requisition, RequisitionItem]) | enum |\r\n| defaultApprovalRoleStrategy | ApprovalWorkflow->DefaultApprovalRoleStrategy | string (Allowed values: [Sequential, CountBased]) | enum |\r\n| description | ApprovalWorkflow->Description | string | |\r\n| expressionMatchType | ApprovalWorkflow->ExpressionMatchType | string (Allowed values: [Highest, Lowest, All]) | enum |\r\n| notes | ApprovalWorkflow->Notes | string | |\r\n| sequenceNumber | ApprovalWorkflow->SequenceNumber | integer | int32 |\r\n", "operationId": "GetApprovalWorkflow", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Workflow Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Approval Workflow", "schema": { "$ref": "#/definitions/GetApprovalWorkflowResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Approval Workflow" ], "summary": "Update an existing Approval Workflow 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 | ApprovalWorkflow->Version | integer | int32 |\r\n| code | ApprovalWorkflow->Code | string | |\r\n| description | ApprovalWorkflow->Description | string | |\r\n| defaultApprovalRoleStrategy | ApprovalWorkflow->DefaultApprovalRoleStrategy | string (Allowed values: [Sequential, CountBased]) | enum |\r\n| expressionMatchType | ApprovalWorkflow->ExpressionMatchType | string (Allowed values: [Highest, Lowest, All]) | enum |\r\n| siteId | ApprovalWorkflow->Site_Id | integer | int64 |\r\n| sequenceNumber | ApprovalWorkflow->SequenceNumber | integer | int32 |\r\n| notes | ApprovalWorkflow->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| expressionMatchType | Nullable | False | |\r\n\r\n", "operationId": "UpdateApprovalWorkflow", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Workflow Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateApprovalWorkflowResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Approval Workflow 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": [ "Approval Workflow" ], "summary": "Delete an existing Approval Workflow 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 | ApprovalWorkflow->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": "DeleteApprovalWorkflow", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Workflow Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteApprovalWorkflowResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Approval Workflow 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/GEN/ApprovalWorkflows": { "get": { "tags": [ "Approval Workflow" ], "summary": "Get a collection of Approval Workflow 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 | ApprovalWorkflow->Version | integer | int32 |\r\n| id | ApprovalWorkflow->Id | integer | int64 |\r\n| code | ApprovalWorkflow->Code | string | |\r\n| description | ApprovalWorkflow->Description | string | |\r\n| approvalEntity | ApprovalWorkflow->ApprovalEntity | string (Allowed values: [Requisition, RequisitionItem]) | enum |\r\n| siteId | ApprovalWorkflow->Site_Id | integer | int64 |\r\n| siteCode | ApprovalWorkflow->Site_Code | string | |\r\n| siteDescription | ApprovalWorkflow->Site_Description | string | |\r\n| expressionMatchType | ApprovalWorkflow->ExpressionMatchType | string (Allowed values: [Highest, Lowest, All]) | enum |\r\n| defaultApprovalRoleStrategy | ApprovalWorkflow->DefaultApprovalRoleStrategy | string (Allowed values: [Sequential, CountBased]) | enum |\r\n| sequenceNumber | ApprovalWorkflow->SequenceNumber | integer | int32 |\r\n| notes | ApprovalWorkflow->Notes | string | |\r\n| createdOn | ApprovalWorkflow->CreatedOn | string | date-time |\r\n| modifiedOn | ApprovalWorkflow->ModifiedOn | string | date-time |\r\n", "operationId": "GetApprovalWorkflowCollection", "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 Approval Workflow collection", "schema": { "$ref": "#/definitions/GetApprovalWorkflowCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Approval Workflow" ], "summary": "Create a new Approval Workflow 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 | ApprovalWorkflow->PermissionTree_Id | integer | int64 |\r\n| code | ApprovalWorkflow->Code | string | |\r\n| description | ApprovalWorkflow->Description | string | |\r\n| defaultApprovalRoleStrategy | ApprovalWorkflow->DefaultApprovalRoleStrategy | string (Allowed values: [Sequential, CountBased]) | enum |\r\n| expressionMatchType | ApprovalWorkflow->ExpressionMatchType | string (Allowed values: [Highest, Lowest, All]) | enum |\r\n| approvalEntity | ApprovalWorkflow->ApprovalEntity | string (Allowed values: [Requisition, RequisitionItem]) | enum |\r\n| siteId | ApprovalWorkflow->Site_Id | integer | int64 |\r\n| sequenceNumber | ApprovalWorkflow->SequenceNumber | integer | int32 |\r\n| notes | ApprovalWorkflow->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| expressionMatchType | Required | True | |\r\n| expressionMatchType | Nullable | False | |\r\n| approvalEntity | Required | True | |\r\n| approvalEntity | Nullable | False | |\r\n\r\n", "operationId": "CreateApprovalWorkflow", "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/CreateApprovalWorkflowResourceActionRequest" } }, { "$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/GEN/ApprovalWorkflows/Lookups/LookupApprovalWorkflowChangePermissionTree": { "get": { "tags": [ "Approval Workflow" ], "summary": "Lookup the permission set for changing the Approval Workflow.", "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": "LookupApprovalWorkflowChangePermissionTree", "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/ApprovalWorkflowChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalWorkflows/Lookups/LookupApprovalWorkflowInsertPermissionTree": { "get": { "tags": [ "Approval Workflow" ], "summary": "Lookup the permission set for creating the Approval Workflow.", "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": "LookupApprovalWorkflowInsertPermissionTree", "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/ApprovalWorkflowInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalWorkflows/Lookups/LookupApprovalWorkflowSite": { "get": { "tags": [ "Approval Workflow" ], "summary": "Lookup the Site for the Approval Workflow.", "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": "LookupApprovalWorkflowSite", "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/ApprovalWorkflowSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalWorkflows/Batch/{ids}": { "get": { "tags": [ "Approval Workflow" ], "summary": "Get a collection of Approval Workflow 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 | ApprovalWorkflow->Code | string | |\r\n| isActive | ApprovalWorkflow->IsActive | boolean | |\r\n| createdByUserId | ApprovalWorkflow->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ApprovalWorkflow->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ApprovalWorkflow->CreatedByUser_FullName | string | |\r\n| createdOn | ApprovalWorkflow->CreatedOn | string | date-time |\r\n| modifiedByUserId | ApprovalWorkflow->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ApprovalWorkflow->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ApprovalWorkflow->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ApprovalWorkflow->ModifiedOn | string | date-time |\r\n| version | ApprovalWorkflow->Version | integer | int32 |\r\n| permissionTreeId | ApprovalWorkflow->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ApprovalWorkflow->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ApprovalWorkflow->PermissionTree_Description | string | |\r\n| siteId | ApprovalWorkflow->Site_Id | integer | int64 |\r\n| siteCode | ApprovalWorkflow->Site_Code | string | |\r\n| siteDescription | ApprovalWorkflow->Site_Description | string | |\r\n| id | ApprovalWorkflow->Id | integer | int64 |\r\n| approvalEntity | ApprovalWorkflow->ApprovalEntity | string (Allowed values: [Requisition, RequisitionItem]) | enum |\r\n| defaultApprovalRoleStrategy | ApprovalWorkflow->DefaultApprovalRoleStrategy | string (Allowed values: [Sequential, CountBased]) | enum |\r\n| description | ApprovalWorkflow->Description | string | |\r\n| expressionMatchType | ApprovalWorkflow->ExpressionMatchType | string (Allowed values: [Highest, Lowest, All]) | enum |\r\n| notes | ApprovalWorkflow->Notes | string | |\r\n| sequenceNumber | ApprovalWorkflow->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetApprovalWorkflow", "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 Approval Workflow 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 Approval Workflow collection", "schema": { "$ref": "#/definitions/BatchGetApprovalWorkflowResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalWorkflows/Batch": { "post": { "tags": [ "Approval Workflow" ], "summary": "Create a new collection of Approval Workflow 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 | ApprovalWorkflow->PermissionTree_Id | integer | int64 |\r\n| code | ApprovalWorkflow->Code | string | |\r\n| description | ApprovalWorkflow->Description | string | |\r\n| defaultApprovalRoleStrategy | ApprovalWorkflow->DefaultApprovalRoleStrategy | string (Allowed values: [Sequential, CountBased]) | enum |\r\n| expressionMatchType | ApprovalWorkflow->ExpressionMatchType | string (Allowed values: [Highest, Lowest, All]) | enum |\r\n| approvalEntity | ApprovalWorkflow->ApprovalEntity | string (Allowed values: [Requisition, RequisitionItem]) | enum |\r\n| siteId | ApprovalWorkflow->Site_Id | integer | int64 |\r\n| sequenceNumber | ApprovalWorkflow->SequenceNumber | integer | int32 |\r\n| notes | ApprovalWorkflow->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| expressionMatchType | Required | True | |\r\n| expressionMatchType | Nullable | False | |\r\n| approvalEntity | Required | True | |\r\n| approvalEntity | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateApprovalWorkflow", "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/BatchCreateApprovalWorkflowResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Approval Workflow 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": [ "Approval Workflow" ], "summary": "Update a collection of existing Approval Workflow 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 | ApprovalWorkflow->Id | integer | int64 |\r\n| version | ApprovalWorkflow->Version | integer | int32 |\r\n| code | ApprovalWorkflow->Code | string | |\r\n| description | ApprovalWorkflow->Description | string | |\r\n| defaultApprovalRoleStrategy | ApprovalWorkflow->DefaultApprovalRoleStrategy | string (Allowed values: [Sequential, CountBased]) | enum |\r\n| expressionMatchType | ApprovalWorkflow->ExpressionMatchType | string (Allowed values: [Highest, Lowest, All]) | enum |\r\n| siteId | ApprovalWorkflow->Site_Id | integer | int64 |\r\n| sequenceNumber | ApprovalWorkflow->SequenceNumber | integer | int32 |\r\n| notes | ApprovalWorkflow->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| expressionMatchType | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateApprovalWorkflow", "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/BatchUpdateApprovalWorkflowResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Approval Workflow 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": [ "Approval Workflow" ], "summary": "Delete a collection of existing Approval Workflow 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 | ApprovalWorkflow->Id | integer | int64 |\r\n| version | ApprovalWorkflow->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": "BatchDeleteApprovalWorkflow", "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/BatchDeleteApprovalWorkflowResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Approval Workflow 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/GEN/ApprovalWorkflows/{id}/Active": { "patch": { "tags": [ "Approval Workflow" ], "summary": "Change the IsActive status for an existing Approval Workflow 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 | ApprovalWorkflow->Version | integer | int32 |\r\n| isActive | ApprovalWorkflow->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": "ChangeApprovalWorkflowIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Workflow Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeApprovalWorkflowIsActiveResourceActionRequest" } }, { "$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/GEN/ApprovalWorkflows/{id}/PermissionTree": { "patch": { "tags": [ "Approval Workflow" ], "summary": "Change the PermissionTree for an existing Approval Workflow 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 | ApprovalWorkflow->Version | integer | int32 |\r\n| permissionTreeId | ApprovalWorkflow->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": "ChangeApprovalWorkflowPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Workflow Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeApprovalWorkflowPermissionTreeResourceActionRequest" } }, { "$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/GEN/ApprovalWorkflows/{id}/Site": { "patch": { "tags": [ "Approval Workflow" ], "summary": "Change the Site status for an existing Approval Workflow 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 | ApprovalWorkflow->Version | integer | int32 |\r\n| siteId | ApprovalWorkflow->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": "ChangeApprovalWorkflowSite", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Workflow Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeApprovalWorkflowSiteResourceActionRequest" } }, { "$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/GEN/ApprovalWorkflows/Batch/Active": { "patch": { "tags": [ "Approval Workflow" ], "summary": "Change the IsActive status for a collection of existing Approval Workflow 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 | ApprovalWorkflow->Id | integer | int64 |\r\n| version | ApprovalWorkflow->Version | integer | int32 |\r\n| isActive | ApprovalWorkflow->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": "BatchChangeApprovalWorkflowIsActive", "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/BatchChangeApprovalWorkflowIsActiveResourceActionRequest" } }, { "$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/GEN/ApprovalWorkflows/Batch/PermissionTree": { "patch": { "tags": [ "Approval Workflow" ], "summary": "Change the PermissionTree status for a collection of existing Approval Workflow 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 | ApprovalWorkflow->Id | integer | int64 |\r\n| version | ApprovalWorkflow->Version | integer | int32 |\r\n| permissionTreeId | ApprovalWorkflow->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": "BatchChangeApprovalWorkflowPermissionTree", "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/BatchChangeApprovalWorkflowPermissionTreeResourceActionRequest" } }, { "$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/GEN/ApprovalWorkflows/Batch/Site": { "patch": { "tags": [ "Approval Workflow" ], "summary": "Change the Site status for a collection of existing Approval Workflow 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 | ApprovalWorkflow->Id | integer | int64 |\r\n| version | ApprovalWorkflow->Version | integer | int32 |\r\n| siteId | ApprovalWorkflow->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": "BatchChangeApprovalWorkflowSite", "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/BatchChangeApprovalWorkflowSiteResourceActionRequest" } }, { "$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/GEN/ApprovalWorkflows/Expressions/{id}": { "get": { "tags": [ "Approval Workflow Expression" ], "summary": "Get a Approval Workflow Expression 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 | ApprovalWorkflowExpression->IsActive | boolean | |\r\n| createdByUserId | ApprovalWorkflowExpression->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ApprovalWorkflowExpression->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ApprovalWorkflowExpression->CreatedByUser_FullName | string | |\r\n| createdOn | ApprovalWorkflowExpression->CreatedOn | string | date-time |\r\n| modifiedByUserId | ApprovalWorkflowExpression->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ApprovalWorkflowExpression->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ApprovalWorkflowExpression->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ApprovalWorkflowExpression->ModifiedOn | string | date-time |\r\n| version | ApprovalWorkflowExpression->Version | integer | int32 |\r\n| permissionTreeId | ApprovalWorkflowExpression->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ApprovalWorkflowExpression->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ApprovalWorkflowExpression->PermissionTree_Description | string | |\r\n| id | ApprovalWorkflowExpression->Id | integer | int64 |\r\n| approvalWorkflowId | ApprovalWorkflowExpression->ApprovalWorkflow_Id | integer | int64 |\r\n| approvalWorkflowCode | ApprovalWorkflowExpression->ApprovalWorkflow_Code | string | |\r\n| approvalWorkflowDescription | ApprovalWorkflowExpression->ApprovalWorkflow_Description | string | |\r\n| approvalRoleStrategy | ApprovalWorkflowExpression->ApprovalRoleStrategy | string (Allowed values: [Sequential, CountBased]) | enum |\r\n| description | ApprovalWorkflowExpression->Description | string | |\r\n| expression | ApprovalWorkflowExpression->Expression | string | |\r\n| requiredApprovalCount | ApprovalWorkflowExpression->RequiredApprovalCount | integer | int32 |\r\n| notes | ApprovalWorkflowExpression->Notes | string | |\r\n| matchSequenceNumber | ApprovalWorkflowExpression->MatchSequenceNumber | integer | int32 |\r\n| status | ApprovalWorkflowExpression->Status | string (Allowed values: [UnderDevelopment, Open, Closed]) | enum |\r\n", "operationId": "GetApprovalWorkflowExpression", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Workflow Expression Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Approval Workflow Expression", "schema": { "$ref": "#/definitions/GetApprovalWorkflowExpressionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Approval Workflow Expression" ], "summary": "Update an existing Approval Workflow Expression 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 | ApprovalWorkflowExpression->Version | integer | int32 |\r\n| approvalWorkflowId | ApprovalWorkflowExpression->ApprovalWorkflow_Id | integer | int64 |\r\n| expression | ApprovalWorkflowExpression->Expression | string | |\r\n| description | ApprovalWorkflowExpression->Description | string | |\r\n| matchSequenceNumber | ApprovalWorkflowExpression->MatchSequenceNumber | integer | int32 |\r\n| approvalRoleStrategy | ApprovalWorkflowExpression->ApprovalRoleStrategy | string (Allowed values: [Sequential, CountBased]) | enum |\r\n| requiredApprovalCount | ApprovalWorkflowExpression->RequiredApprovalCount | integer | int32 |\r\n| status | ApprovalWorkflowExpression->Status | string (Allowed values: [UnderDevelopment, Open, Closed]) | enum |\r\n| notes | ApprovalWorkflowExpression->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| approvalWorkflowId | Nullable | False | |\r\n| expression | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| matchSequenceNumber | Nullable | False | |\r\n| matchSequenceNumber | Min Value | >= 0| |\r\n| approvalRoleStrategy | Nullable | False | |\r\n| requiredApprovalCount | Nullable | False | ApprovalWorkflowExpression->ApprovalRoleStrategy eq 'CountBased' |\r\n| requiredApprovalCount | Nullable | True | ApprovalWorkflowExpression->ApprovalRoleStrategy eq 'Sequential' |\r\n| requiredApprovalCount | Min Value | >= 1| |\r\n| status | Nullable | False | |\r\n\r\n", "operationId": "UpdateApprovalWorkflowExpression", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Workflow Expression Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateApprovalWorkflowExpressionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Approval Workflow Expression 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": [ "Approval Workflow Expression" ], "summary": "Delete an existing Approval Workflow Expression 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 | ApprovalWorkflowExpression->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": "DeleteApprovalWorkflowExpression", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Workflow Expression Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteApprovalWorkflowExpressionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Approval Workflow Expression 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/GEN/ApprovalWorkflows/Expressions": { "get": { "tags": [ "Approval Workflow Expression" ], "summary": "Get a collection of Approval Workflow Expression 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 | ApprovalWorkflowExpression->Version | integer | int32 |\r\n| id | ApprovalWorkflowExpression->Id | integer | int64 |\r\n| expression | ApprovalWorkflowExpression->Expression | string | |\r\n| approvalWorkflowCode | ApprovalWorkflowExpression->ApprovalWorkflow_Code | string | |\r\n| approvalWorkflowDescription | ApprovalWorkflowExpression->ApprovalWorkflow_Description | string | |\r\n| description | ApprovalWorkflowExpression->Description | string | |\r\n| matchSequenceNumber | ApprovalWorkflowExpression->MatchSequenceNumber | integer | int32 |\r\n| notes | ApprovalWorkflowExpression->Notes | string | |\r\n| createdOn | ApprovalWorkflowExpression->CreatedOn | string | date-time |\r\n| approvalRoleStrategy | ApprovalWorkflowExpression->ApprovalRoleStrategy | string (Allowed values: [Sequential, CountBased]) | enum |\r\n| requiredApprovalCount | ApprovalWorkflowExpression->RequiredApprovalCount | integer | int32 |\r\n| status | ApprovalWorkflowExpression->Status | string (Allowed values: [UnderDevelopment, Open, Closed]) | enum |\r\n| modifiedOn | ApprovalWorkflowExpression->ModifiedOn | string | date-time |\r\n", "operationId": "GetApprovalWorkflowExpressionCollection", "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 Approval Workflow Expression collection", "schema": { "$ref": "#/definitions/GetApprovalWorkflowExpressionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Approval Workflow Expression" ], "summary": "Create a new Approval Workflow Expression 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 | ApprovalWorkflowExpression->PermissionTree_Id | integer | int64 |\r\n| approvalWorkflowId | ApprovalWorkflowExpression->ApprovalWorkflow_Id | integer | int64 |\r\n| expression | ApprovalWorkflowExpression->Expression | string | |\r\n| description | ApprovalWorkflowExpression->Description | string | |\r\n| matchSequenceNumber | ApprovalWorkflowExpression->MatchSequenceNumber | integer | int32 |\r\n| approvalRoleStrategy | ApprovalWorkflowExpression->ApprovalRoleStrategy | string (Allowed values: [Sequential, CountBased]) | enum |\r\n| requiredApprovalCount | ApprovalWorkflowExpression->RequiredApprovalCount | integer | int32 |\r\n| notes | ApprovalWorkflowExpression->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| approvalWorkflowId | Required | True | |\r\n| approvalWorkflowId | Nullable | False | |\r\n| expression | Required | True | |\r\n| expression | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| matchSequenceNumber | Required | True | |\r\n| matchSequenceNumber | Nullable | False | |\r\n| matchSequenceNumber | Min Value | >= 0| |\r\n| approvalRoleStrategy | Nullable | False | |\r\n| requiredApprovalCount | Nullable | False | ApprovalWorkflowExpression->ApprovalRoleStrategy eq 'CountBased' |\r\n| requiredApprovalCount | Nullable | True | ApprovalWorkflowExpression->ApprovalRoleStrategy eq 'Sequential' |\r\n| requiredApprovalCount | Min Value | >= 1| |\r\n\r\n", "operationId": "CreateApprovalWorkflowExpression", "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/CreateApprovalWorkflowExpressionResourceActionRequest" } }, { "$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/GEN/ApprovalWorkflows/{approvalWorkflowId}/ApprovalWorkflowExpressionForApprovalWorkflow": { "get": { "tags": [ "Approval Workflow Expression" ], "summary": "Get a collection of Approval Workflow Expression resources for the Approval Workflow.", "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 | ApprovalWorkflowExpression->Version | integer | int32 |\r\n| id | ApprovalWorkflowExpression->Id | integer | int64 |\r\n| requiredApprovalCount | ApprovalWorkflowExpression->RequiredApprovalCount | integer | int32 |\r\n| description | ApprovalWorkflowExpression->Description | string | |\r\n| approvalRoleStrategy | ApprovalWorkflowExpression->ApprovalRoleStrategy | string (Allowed values: [Sequential, CountBased]) | enum |\r\n| status | ApprovalWorkflowExpression->Status | string (Allowed values: [UnderDevelopment, Open, Closed]) | enum |\r\n", "operationId": "GetApprovalWorkflowExpressionForApprovalWorkflowCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "approvalWorkflowId", "in": "path", "required": true, "description": "Approval Workflow 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 Approval Workflow Expression collection", "schema": { "$ref": "#/definitions/GetApprovalWorkflowExpressionForApprovalWorkflowCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalWorkflows/Expressions/Lookups/LookupApprovalWorkflowExpressionApprovalWorkflow": { "get": { "tags": [ "Approval Workflow Expression" ], "summary": "Lookup the Approval Workflow Expression for the Approval Workflow Expression.", "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 | ApprovalWorkflow->Id | integer | int64 |\r\n| code | ApprovalWorkflow->Code | string | |\r\n| description | ApprovalWorkflow->Description | string | |\r\n| defaultApprovalRoleStrategy | ApprovalWorkflow->DefaultApprovalRoleStrategy | string (Allowed values: [Sequential, CountBased]) | enum |\r\n", "operationId": "LookupApprovalWorkflowExpressionApprovalWorkflow", "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 Approval Workflow collection", "schema": { "$ref": "#/definitions/ApprovalWorkflowExpressionApprovalWorkflowLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalWorkflows/Expressions/Lookups/LookupApprovalWorkflowExpressionChangePermissionTree": { "get": { "tags": [ "Approval Workflow Expression" ], "summary": "Lookup the permission set for changing the Approval Workflow Expression.", "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": "LookupApprovalWorkflowExpressionChangePermissionTree", "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/ApprovalWorkflowExpressionChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalWorkflows/Expressions/Lookups/LookupApprovalWorkflowExpressionInsertPermissionTree": { "get": { "tags": [ "Approval Workflow Expression" ], "summary": "Lookup the permission set for creating the Approval Workflow Expression.", "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": "LookupApprovalWorkflowExpressionInsertPermissionTree", "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/ApprovalWorkflowExpressionInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalWorkflows/Expressions/Batch/{ids}": { "get": { "tags": [ "Approval Workflow Expression" ], "summary": "Get a collection of Approval Workflow Expression 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 | ApprovalWorkflowExpression->IsActive | boolean | |\r\n| createdByUserId | ApprovalWorkflowExpression->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ApprovalWorkflowExpression->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ApprovalWorkflowExpression->CreatedByUser_FullName | string | |\r\n| createdOn | ApprovalWorkflowExpression->CreatedOn | string | date-time |\r\n| modifiedByUserId | ApprovalWorkflowExpression->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ApprovalWorkflowExpression->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ApprovalWorkflowExpression->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ApprovalWorkflowExpression->ModifiedOn | string | date-time |\r\n| version | ApprovalWorkflowExpression->Version | integer | int32 |\r\n| permissionTreeId | ApprovalWorkflowExpression->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ApprovalWorkflowExpression->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ApprovalWorkflowExpression->PermissionTree_Description | string | |\r\n| id | ApprovalWorkflowExpression->Id | integer | int64 |\r\n| approvalWorkflowId | ApprovalWorkflowExpression->ApprovalWorkflow_Id | integer | int64 |\r\n| approvalWorkflowCode | ApprovalWorkflowExpression->ApprovalWorkflow_Code | string | |\r\n| approvalWorkflowDescription | ApprovalWorkflowExpression->ApprovalWorkflow_Description | string | |\r\n| approvalRoleStrategy | ApprovalWorkflowExpression->ApprovalRoleStrategy | string (Allowed values: [Sequential, CountBased]) | enum |\r\n| description | ApprovalWorkflowExpression->Description | string | |\r\n| expression | ApprovalWorkflowExpression->Expression | string | |\r\n| requiredApprovalCount | ApprovalWorkflowExpression->RequiredApprovalCount | integer | int32 |\r\n| notes | ApprovalWorkflowExpression->Notes | string | |\r\n| matchSequenceNumber | ApprovalWorkflowExpression->MatchSequenceNumber | integer | int32 |\r\n| status | ApprovalWorkflowExpression->Status | string (Allowed values: [UnderDevelopment, Open, Closed]) | enum |\r\n", "operationId": "BatchGetApprovalWorkflowExpression", "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 Approval Workflow Expression 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 Approval Workflow Expression collection", "schema": { "$ref": "#/definitions/BatchGetApprovalWorkflowExpressionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalWorkflows/Expressions/Batch": { "post": { "tags": [ "Approval Workflow Expression" ], "summary": "Create a new collection of Approval Workflow Expression 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 | ApprovalWorkflowExpression->PermissionTree_Id | integer | int64 |\r\n| approvalWorkflowId | ApprovalWorkflowExpression->ApprovalWorkflow_Id | integer | int64 |\r\n| expression | ApprovalWorkflowExpression->Expression | string | |\r\n| description | ApprovalWorkflowExpression->Description | string | |\r\n| matchSequenceNumber | ApprovalWorkflowExpression->MatchSequenceNumber | integer | int32 |\r\n| approvalRoleStrategy | ApprovalWorkflowExpression->ApprovalRoleStrategy | string (Allowed values: [Sequential, CountBased]) | enum |\r\n| requiredApprovalCount | ApprovalWorkflowExpression->RequiredApprovalCount | integer | int32 |\r\n| notes | ApprovalWorkflowExpression->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| approvalWorkflowId | Required | True | |\r\n| approvalWorkflowId | Nullable | False | |\r\n| expression | Required | True | |\r\n| expression | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| matchSequenceNumber | Required | True | |\r\n| matchSequenceNumber | Nullable | False | |\r\n| matchSequenceNumber | Min Value | >= 0| |\r\n| approvalRoleStrategy | Nullable | False | |\r\n| requiredApprovalCount | Nullable | False | ApprovalWorkflowExpression->ApprovalRoleStrategy eq 'CountBased' |\r\n| requiredApprovalCount | Nullable | True | ApprovalWorkflowExpression->ApprovalRoleStrategy eq 'Sequential' |\r\n| requiredApprovalCount | Min Value | >= 1| |\r\n\r\n", "operationId": "BatchCreateApprovalWorkflowExpression", "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/BatchCreateApprovalWorkflowExpressionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Approval Workflow Expression 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": [ "Approval Workflow Expression" ], "summary": "Update a collection of existing Approval Workflow Expression 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 | ApprovalWorkflowExpression->Id | integer | int64 |\r\n| version | ApprovalWorkflowExpression->Version | integer | int32 |\r\n| approvalWorkflowId | ApprovalWorkflowExpression->ApprovalWorkflow_Id | integer | int64 |\r\n| expression | ApprovalWorkflowExpression->Expression | string | |\r\n| description | ApprovalWorkflowExpression->Description | string | |\r\n| matchSequenceNumber | ApprovalWorkflowExpression->MatchSequenceNumber | integer | int32 |\r\n| approvalRoleStrategy | ApprovalWorkflowExpression->ApprovalRoleStrategy | string (Allowed values: [Sequential, CountBased]) | enum |\r\n| requiredApprovalCount | ApprovalWorkflowExpression->RequiredApprovalCount | integer | int32 |\r\n| status | ApprovalWorkflowExpression->Status | string (Allowed values: [UnderDevelopment, Open, Closed]) | enum |\r\n| notes | ApprovalWorkflowExpression->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| approvalWorkflowId | Nullable | False | |\r\n| expression | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| matchSequenceNumber | Nullable | False | |\r\n| matchSequenceNumber | Min Value | >= 0| |\r\n| approvalRoleStrategy | Nullable | False | |\r\n| requiredApprovalCount | Nullable | False | ApprovalWorkflowExpression->ApprovalRoleStrategy eq 'CountBased' |\r\n| requiredApprovalCount | Nullable | True | ApprovalWorkflowExpression->ApprovalRoleStrategy eq 'Sequential' |\r\n| requiredApprovalCount | Min Value | >= 1| |\r\n| status | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateApprovalWorkflowExpression", "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/BatchUpdateApprovalWorkflowExpressionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Approval Workflow Expression 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": [ "Approval Workflow Expression" ], "summary": "Delete a collection of existing Approval Workflow Expression 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 | ApprovalWorkflowExpression->Id | integer | int64 |\r\n| version | ApprovalWorkflowExpression->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": "BatchDeleteApprovalWorkflowExpression", "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/BatchDeleteApprovalWorkflowExpressionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Approval Workflow Expression 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/GEN/ApprovalWorkflows/Expressions/{id}/Active": { "patch": { "tags": [ "Approval Workflow Expression" ], "summary": "Change the IsActive status for an existing Approval Workflow Expression 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 | ApprovalWorkflowExpression->Version | integer | int32 |\r\n| isActive | ApprovalWorkflowExpression->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": "ChangeApprovalWorkflowExpressionIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Workflow Expression Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeApprovalWorkflowExpressionIsActiveResourceActionRequest" } }, { "$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/GEN/ApprovalWorkflows/Expressions/{id}/PermissionTree": { "patch": { "tags": [ "Approval Workflow Expression" ], "summary": "Change the PermissionTree for an existing Approval Workflow Expression 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 | ApprovalWorkflowExpression->Version | integer | int32 |\r\n| permissionTreeId | ApprovalWorkflowExpression->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": "ChangeApprovalWorkflowExpressionPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Workflow Expression Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeApprovalWorkflowExpressionPermissionTreeResourceActionRequest" } }, { "$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/GEN/ApprovalWorkflows/Expressions/Batch/Active": { "patch": { "tags": [ "Approval Workflow Expression" ], "summary": "Change the IsActive status for a collection of existing Approval Workflow Expression 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 | ApprovalWorkflowExpression->Id | integer | int64 |\r\n| version | ApprovalWorkflowExpression->Version | integer | int32 |\r\n| isActive | ApprovalWorkflowExpression->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": "BatchChangeApprovalWorkflowExpressionIsActive", "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/BatchChangeApprovalWorkflowExpressionIsActiveResourceActionRequest" } }, { "$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/GEN/ApprovalWorkflows/Expressions/Batch/PermissionTree": { "patch": { "tags": [ "Approval Workflow Expression" ], "summary": "Change the PermissionTree status for a collection of existing Approval Workflow Expression 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 | ApprovalWorkflowExpression->Id | integer | int64 |\r\n| version | ApprovalWorkflowExpression->Version | integer | int32 |\r\n| permissionTreeId | ApprovalWorkflowExpression->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": "BatchChangeApprovalWorkflowExpressionPermissionTree", "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/BatchChangeApprovalWorkflowExpressionPermissionTreeResourceActionRequest" } }, { "$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/GEN/ApprovalWorkflows/Expressions/ApprovalRoles/{id}": { "get": { "tags": [ "Approval Workflow Expression Approval Role" ], "summary": "Get a Approval Workflow Expression Approval 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 | ApprovalWorkflowExpressionApprovalRole->IsActive | boolean | |\r\n| createdByUserId | ApprovalWorkflowExpressionApprovalRole->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ApprovalWorkflowExpressionApprovalRole->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ApprovalWorkflowExpressionApprovalRole->CreatedByUser_FullName | string | |\r\n| createdOn | ApprovalWorkflowExpressionApprovalRole->CreatedOn | string | date-time |\r\n| modifiedByUserId | ApprovalWorkflowExpressionApprovalRole->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ApprovalWorkflowExpressionApprovalRole->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ApprovalWorkflowExpressionApprovalRole->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ApprovalWorkflowExpressionApprovalRole->ModifiedOn | string | date-time |\r\n| version | ApprovalWorkflowExpressionApprovalRole->Version | integer | int32 |\r\n| permissionTreeId | ApprovalWorkflowExpressionApprovalRole->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ApprovalWorkflowExpressionApprovalRole->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ApprovalWorkflowExpressionApprovalRole->PermissionTree_Description | string | |\r\n| id | ApprovalWorkflowExpressionApprovalRole->Id | integer | int64 |\r\n| approvalRoleId | ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Id | integer | int64 |\r\n| approvalRoleCode | ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Code | string | |\r\n| approvalRoleDescription | ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Description | string | |\r\n| approvalWorkflowExpressionId | ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_Id | integer | int64 |\r\n| approvalWorkflowExpressionDescription | ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_Description | string | |\r\n| notes | ApprovalWorkflowExpressionApprovalRole->Notes | string | |\r\n| approvalSequenceNumber | ApprovalWorkflowExpressionApprovalRole->ApprovalSequenceNumber | integer | int32 |\r\n", "operationId": "GetApprovalWorkflowExpressionApprovalRole", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Workflow Expression Approval Role Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Approval Workflow Expression Approval Role", "schema": { "$ref": "#/definitions/GetApprovalWorkflowExpressionApprovalRoleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Approval Workflow Expression Approval Role" ], "summary": "Update an existing Approval Workflow Expression Approval 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 | ApprovalWorkflowExpressionApprovalRole->Version | integer | int32 |\r\n| approvalSequenceNumber | ApprovalWorkflowExpressionApprovalRole->ApprovalSequenceNumber | integer | int32 |\r\n| notes | ApprovalWorkflowExpressionApprovalRole->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| approvalSequenceNumber | Min Value | >= 0| |\r\n\r\n", "operationId": "UpdateApprovalWorkflowExpressionApprovalRole", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Workflow Expression Approval Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateApprovalWorkflowExpressionApprovalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Approval Workflow Expression Approval 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": [ "Approval Workflow Expression Approval Role" ], "summary": "Delete an existing Approval Workflow Expression Approval 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 | ApprovalWorkflowExpressionApprovalRole->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": "DeleteApprovalWorkflowExpressionApprovalRole", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Workflow Expression Approval Role Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteApprovalWorkflowExpressionApprovalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Approval Workflow Expression Approval 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/GEN/ApprovalWorkflows/Expressions/ApprovalRoles": { "get": { "tags": [ "Approval Workflow Expression Approval Role" ], "summary": "Get a collection of Approval Workflow Expression Approval 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 | ApprovalWorkflowExpressionApprovalRole->Version | integer | int32 |\r\n| id | ApprovalWorkflowExpressionApprovalRole->Id | integer | int64 |\r\n| approvalWorkflowExpressionApprovalWorkflowSiteId | ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_ApprovalWorkflow_Site_Id | integer | int64 |\r\n| approvalWorkflowExpressionApprovalWorkflowSiteCode | ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_ApprovalWorkflow_Site_Code | string | |\r\n| approvalWorkflowExpressionApprovalWorkflowSiteDescription | ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_ApprovalWorkflow_Site_Description | string | |\r\n| approvalWorkflowExpressionDescription | ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_Description | string | |\r\n| approvalRoleCode | ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Code | string | |\r\n| approvalRoleDescription | ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Description | string | |\r\n| approvalSequenceNumber | ApprovalWorkflowExpressionApprovalRole->ApprovalSequenceNumber | integer | int32 |\r\n| notes | ApprovalWorkflowExpressionApprovalRole->Notes | string | |\r\n| createdOn | ApprovalWorkflowExpressionApprovalRole->CreatedOn | string | date-time |\r\n| modifiedOn | ApprovalWorkflowExpressionApprovalRole->ModifiedOn | string | date-time |\r\n", "operationId": "GetApprovalWorkflowExpressionApprovalRoleCollection", "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 Approval Workflow Expression Approval Role collection", "schema": { "$ref": "#/definitions/GetApprovalWorkflowExpressionApprovalRoleCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Approval Workflow Expression Approval Role" ], "summary": "Create a new Approval Workflow Expression Approval 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 | ApprovalWorkflowExpressionApprovalRole->PermissionTree_Id | integer | int64 |\r\n| approvalWorkflowExpressionId | ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_Id | integer | int64 |\r\n| approvalRoleId | ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Id | integer | int64 |\r\n| approvalSequenceNumber | ApprovalWorkflowExpressionApprovalRole->ApprovalSequenceNumber | integer | int32 |\r\n| notes | ApprovalWorkflowExpressionApprovalRole->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| approvalWorkflowExpressionId | Required | True | |\r\n| approvalWorkflowExpressionId | Nullable | False | |\r\n| approvalRoleId | Required | True | |\r\n| approvalRoleId | Nullable | False | |\r\n| approvalSequenceNumber | Min Value | >= 0| |\r\n\r\n", "operationId": "CreateApprovalWorkflowExpressionApprovalRole", "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/CreateApprovalWorkflowExpressionApprovalRoleResourceActionRequest" } }, { "$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/GEN/ApprovalWorkflows/Expressions/{approvalWorkflowExpressionId}/ApprovalWorkflowExpressionApprovalRoleForApprovalWorkflowExpression": { "get": { "tags": [ "Approval Workflow Expression Approval Role" ], "summary": "Get a collection of Approval Workflow Expression Approval Role resources for the Approval Workflow Expression.", "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 | ApprovalWorkflowExpressionApprovalRole->Version | integer | int32 |\r\n| id | ApprovalWorkflowExpressionApprovalRole->Id | integer | int64 |\r\n| approvalWorkflowExpressionDescription | ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_Description | string | |\r\n| approvalRoleCode | ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Code | string | |\r\n| approvalRoleDescription | ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Description | string | |\r\n| approvalSequenceNumber | ApprovalWorkflowExpressionApprovalRole->ApprovalSequenceNumber | integer | int32 |\r\n", "operationId": "GetApprovalWorkflowExpressionApprovalRoleForApprovalWorkflowExpressionCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "approvalWorkflowExpressionId", "in": "path", "required": true, "description": "Approval Workflow Expression 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 Approval Workflow Expression Approval Role collection", "schema": { "$ref": "#/definitions/GetApprovalWorkflowExpressionApprovalRoleForApprovalWorkflowExpressionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalWorkflows/Expressions/ApprovalRoles/Lookups/LookupApprovalWorkflowExpressionApprovalRoleApprovalRole": { "get": { "tags": [ "Approval Workflow Expression Approval Role" ], "summary": "Lookup the Approval Workflow Expression Approval Role for the Approval Workflow Expression Approval 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 | ApprovalRole->Id | integer | int64 |\r\n| code | ApprovalRole->Code | string | |\r\n| description | ApprovalRole->Description | string | |\r\n", "operationId": "LookupApprovalWorkflowExpressionApprovalRoleApprovalRole", "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 Approval Role collection", "schema": { "$ref": "#/definitions/ApprovalWorkflowExpressionApprovalRoleApprovalRoleLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalWorkflows/Expressions/ApprovalRoles/Lookups/LookupApprovalWorkflowExpressionApprovalRoleApprovalWorkflowExpression": { "get": { "tags": [ "Approval Workflow Expression Approval Role" ], "summary": "Lookup the Approval Workflow Expression Approval Role for the Approval Workflow Expression Approval 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 | ApprovalWorkflowExpression->Id | integer | int64 |\r\n| description | ApprovalWorkflowExpression->Description | string | |\r\n", "operationId": "LookupApprovalWorkflowExpressionApprovalRoleApprovalWorkflowExpression", "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 Approval Workflow Expression collection", "schema": { "$ref": "#/definitions/ApprovalWorkflowExpressionApprovalRoleApprovalWorkflowExpressionLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalWorkflows/Expressions/ApprovalRoles/Lookups/LookupApprovalWorkflowExpressionApprovalRoleChangePermissionTree": { "get": { "tags": [ "Approval Workflow Expression Approval Role" ], "summary": "Lookup the permission set for changing the Approval Workflow Expression Approval 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": "LookupApprovalWorkflowExpressionApprovalRoleChangePermissionTree", "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/ApprovalWorkflowExpressionApprovalRoleChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalWorkflows/Expressions/ApprovalRoles/Lookups/LookupApprovalWorkflowExpressionApprovalRoleInsertPermissionTree": { "get": { "tags": [ "Approval Workflow Expression Approval Role" ], "summary": "Lookup the permission set for creating the Approval Workflow Expression Approval 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": "LookupApprovalWorkflowExpressionApprovalRoleInsertPermissionTree", "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/ApprovalWorkflowExpressionApprovalRoleInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalWorkflows/Expressions/ApprovalRoles/Batch/{ids}": { "get": { "tags": [ "Approval Workflow Expression Approval Role" ], "summary": "Get a collection of Approval Workflow Expression Approval 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 | ApprovalWorkflowExpressionApprovalRole->IsActive | boolean | |\r\n| createdByUserId | ApprovalWorkflowExpressionApprovalRole->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ApprovalWorkflowExpressionApprovalRole->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ApprovalWorkflowExpressionApprovalRole->CreatedByUser_FullName | string | |\r\n| createdOn | ApprovalWorkflowExpressionApprovalRole->CreatedOn | string | date-time |\r\n| modifiedByUserId | ApprovalWorkflowExpressionApprovalRole->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ApprovalWorkflowExpressionApprovalRole->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ApprovalWorkflowExpressionApprovalRole->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ApprovalWorkflowExpressionApprovalRole->ModifiedOn | string | date-time |\r\n| version | ApprovalWorkflowExpressionApprovalRole->Version | integer | int32 |\r\n| permissionTreeId | ApprovalWorkflowExpressionApprovalRole->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ApprovalWorkflowExpressionApprovalRole->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ApprovalWorkflowExpressionApprovalRole->PermissionTree_Description | string | |\r\n| id | ApprovalWorkflowExpressionApprovalRole->Id | integer | int64 |\r\n| approvalRoleId | ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Id | integer | int64 |\r\n| approvalRoleCode | ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Code | string | |\r\n| approvalRoleDescription | ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Description | string | |\r\n| approvalWorkflowExpressionId | ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_Id | integer | int64 |\r\n| approvalWorkflowExpressionDescription | ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_Description | string | |\r\n| notes | ApprovalWorkflowExpressionApprovalRole->Notes | string | |\r\n| approvalSequenceNumber | ApprovalWorkflowExpressionApprovalRole->ApprovalSequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetApprovalWorkflowExpressionApprovalRole", "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 Approval Workflow Expression Approval 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 Approval Workflow Expression Approval Role collection", "schema": { "$ref": "#/definitions/BatchGetApprovalWorkflowExpressionApprovalRoleResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ApprovalWorkflows/Expressions/ApprovalRoles/Batch": { "post": { "tags": [ "Approval Workflow Expression Approval Role" ], "summary": "Create a new collection of Approval Workflow Expression Approval 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 | ApprovalWorkflowExpressionApprovalRole->PermissionTree_Id | integer | int64 |\r\n| approvalWorkflowExpressionId | ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_Id | integer | int64 |\r\n| approvalRoleId | ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Id | integer | int64 |\r\n| approvalSequenceNumber | ApprovalWorkflowExpressionApprovalRole->ApprovalSequenceNumber | integer | int32 |\r\n| notes | ApprovalWorkflowExpressionApprovalRole->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| approvalWorkflowExpressionId | Required | True | |\r\n| approvalWorkflowExpressionId | Nullable | False | |\r\n| approvalRoleId | Required | True | |\r\n| approvalRoleId | Nullable | False | |\r\n| approvalSequenceNumber | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchCreateApprovalWorkflowExpressionApprovalRole", "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/BatchCreateApprovalWorkflowExpressionApprovalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Approval Workflow Expression Approval 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": [ "Approval Workflow Expression Approval Role" ], "summary": "Update a collection of existing Approval Workflow Expression Approval 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 | ApprovalWorkflowExpressionApprovalRole->Id | integer | int64 |\r\n| version | ApprovalWorkflowExpressionApprovalRole->Version | integer | int32 |\r\n| approvalSequenceNumber | ApprovalWorkflowExpressionApprovalRole->ApprovalSequenceNumber | integer | int32 |\r\n| notes | ApprovalWorkflowExpressionApprovalRole->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| approvalSequenceNumber | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchUpdateApprovalWorkflowExpressionApprovalRole", "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/BatchUpdateApprovalWorkflowExpressionApprovalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Approval Workflow Expression Approval 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": [ "Approval Workflow Expression Approval Role" ], "summary": "Delete a collection of existing Approval Workflow Expression Approval 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 | ApprovalWorkflowExpressionApprovalRole->Id | integer | int64 |\r\n| version | ApprovalWorkflowExpressionApprovalRole->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": "BatchDeleteApprovalWorkflowExpressionApprovalRole", "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/BatchDeleteApprovalWorkflowExpressionApprovalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Approval Workflow Expression Approval 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/GEN/ApprovalWorkflows/Expressions/ApprovalRoles/{id}/Active": { "patch": { "tags": [ "Approval Workflow Expression Approval Role" ], "summary": "Change the IsActive status for an existing Approval Workflow Expression Approval 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 | ApprovalWorkflowExpressionApprovalRole->Version | integer | int32 |\r\n| isActive | ApprovalWorkflowExpressionApprovalRole->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": "ChangeApprovalWorkflowExpressionApprovalRoleIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Workflow Expression Approval Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeApprovalWorkflowExpressionApprovalRoleIsActiveResourceActionRequest" } }, { "$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/GEN/ApprovalWorkflows/Expressions/ApprovalRoles/{id}/PermissionTree": { "patch": { "tags": [ "Approval Workflow Expression Approval Role" ], "summary": "Change the PermissionTree for an existing Approval Workflow Expression Approval 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 | ApprovalWorkflowExpressionApprovalRole->Version | integer | int32 |\r\n| permissionTreeId | ApprovalWorkflowExpressionApprovalRole->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": "ChangeApprovalWorkflowExpressionApprovalRolePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Approval Workflow Expression Approval Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeApprovalWorkflowExpressionApprovalRolePermissionTreeResourceActionRequest" } }, { "$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/GEN/ApprovalWorkflows/Expressions/ApprovalRoles/Batch/Active": { "patch": { "tags": [ "Approval Workflow Expression Approval Role" ], "summary": "Change the IsActive status for a collection of existing Approval Workflow Expression Approval 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 | ApprovalWorkflowExpressionApprovalRole->Id | integer | int64 |\r\n| version | ApprovalWorkflowExpressionApprovalRole->Version | integer | int32 |\r\n| isActive | ApprovalWorkflowExpressionApprovalRole->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": "BatchChangeApprovalWorkflowExpressionApprovalRoleIsActive", "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/BatchChangeApprovalWorkflowExpressionApprovalRoleIsActiveResourceActionRequest" } }, { "$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/GEN/ApprovalWorkflows/Expressions/ApprovalRoles/Batch/PermissionTree": { "patch": { "tags": [ "Approval Workflow Expression Approval Role" ], "summary": "Change the PermissionTree status for a collection of existing Approval Workflow Expression Approval 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 | ApprovalWorkflowExpressionApprovalRole->Id | integer | int64 |\r\n| version | ApprovalWorkflowExpressionApprovalRole->Version | integer | int32 |\r\n| permissionTreeId | ApprovalWorkflowExpressionApprovalRole->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": "BatchChangeApprovalWorkflowExpressionApprovalRolePermissionTree", "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/BatchChangeApprovalWorkflowExpressionApprovalRolePermissionTreeResourceActionRequest" } }, { "$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/GEN/Attributes/{id}": { "get": { "tags": [ "Attribute" ], "summary": "Get a 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| code | Attribute->Code | string | |\r\n| createdByUserId | Attribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Attribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Attribute->CreatedByUser_FullName | string | |\r\n| createdOn | Attribute->CreatedOn | string | date-time |\r\n| isActive | Attribute->IsActive | boolean | |\r\n| modifiedByUserId | Attribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Attribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Attribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Attribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | Attribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Attribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Attribute->PermissionTree_Description | string | |\r\n| version | Attribute->Version | integer | int32 |\r\n| id | Attribute->Id | integer | int64 |\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| defaultAllowedValueId | Attribute->DefaultAllowedValue_Id | integer | int64 |\r\n| defaultAllowedValueDescription | Attribute->DefaultAllowedValue_Description | string | |\r\n| defaultAllowedValueValue | Attribute->DefaultAllowedValue_Value | object | composite |\r\n| defaultValue | Attribute->DefaultValue | object | composite |\r\n| description | Attribute->Description | string | |\r\n| explanation | Attribute->Explanation | string | |\r\n| notes | Attribute->Notes | string | |\r\n| sequenceNumber | Attribute->SequenceNumber | integer | int32 |\r\n", "operationId": "GetAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Attribute", "schema": { "$ref": "#/definitions/GetAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Attribute" ], "summary": "Update an existing 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 | Attribute->Version | integer | int32 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| sequenceNumber | Attribute->SequenceNumber | integer | int32 |\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| explanation | Attribute->Explanation | string | |\r\n| notes | Attribute->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| allowAnyValue | Nullable | False | |\r\n| dataType | Nullable | False | |\r\n| defaultValue | Nullable | True | Attribute->AllowAnyValue eq false |\r\n| defaultAllowedValueId | Nullable | True | Attribute->AllowAnyValue eq true |\r\n| defaultAllowedValueId | Min Value | > 0| |\r\n\r\n", "operationId": "UpdateAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - 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": [ "Attribute" ], "summary": "Delete an existing 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 | Attribute->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": "DeleteAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - 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/GEN/Attributes": { "get": { "tags": [ "Attribute" ], "summary": "Get a collection of 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| version | Attribute->Version | integer | int32 |\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| sequenceNumber | Attribute->SequenceNumber | integer | int32 |\r\n| notes | Attribute->Notes | string | |\r\n| createdOn | Attribute->CreatedOn | string | date-time |\r\n| modifiedOn | Attribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetAttributeCollection", "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/GetAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Attribute" ], "summary": "Create a new 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| permissionTreeId | Attribute->PermissionTree_Id | integer | int64 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| sequenceNumber | Attribute->SequenceNumber | integer | int32 |\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| explanation | Attribute->Explanation | string | |\r\n| notes | Attribute->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| allowAnyValue | Required | True | |\r\n| allowAnyValue | Nullable | False | |\r\n| dataType | Required | True | |\r\n| dataType | Nullable | False | |\r\n| defaultValue | Nullable | True | Attribute->AllowAnyValue eq false |\r\n| defaultAllowedValueId | Nullable | True | Attribute->AllowAnyValue eq true |\r\n| defaultAllowedValueId | Min Value | > 0| |\r\n\r\n", "operationId": "CreateAttribute", "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/CreateAttributeResourceActionRequest" } }, { "$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/GEN/Attributes/Lookups/LookupAttributeAttributeAllowedValue": { "get": { "tags": [ "Attribute" ], "summary": "Lookup the Attribute Allowed Value for the 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| value | AttributeAllowedValue->Value | object | composite |\r\n| description | AttributeAllowedValue->Description | string | |\r\n", "operationId": "LookupAttributeAttributeAllowedValue", "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/AttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Attributes/Lookups/LookupAttributeChangePermissionTree": { "get": { "tags": [ "Attribute" ], "summary": "Lookup the permission set for changing the 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": "LookupAttributeChangePermissionTree", "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/AttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Attributes/Lookups/LookupAttributeInsertPermissionTree": { "get": { "tags": [ "Attribute" ], "summary": "Lookup the permission set for creating the 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": "LookupAttributeInsertPermissionTree", "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/AttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Attributes/Batch/{ids}": { "get": { "tags": [ "Attribute" ], "summary": "Get a collection of 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| code | Attribute->Code | string | |\r\n| createdByUserId | Attribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Attribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Attribute->CreatedByUser_FullName | string | |\r\n| createdOn | Attribute->CreatedOn | string | date-time |\r\n| isActive | Attribute->IsActive | boolean | |\r\n| modifiedByUserId | Attribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Attribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Attribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Attribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | Attribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Attribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Attribute->PermissionTree_Description | string | |\r\n| version | Attribute->Version | integer | int32 |\r\n| id | Attribute->Id | integer | int64 |\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| defaultAllowedValueId | Attribute->DefaultAllowedValue_Id | integer | int64 |\r\n| defaultAllowedValueDescription | Attribute->DefaultAllowedValue_Description | string | |\r\n| defaultAllowedValueValue | Attribute->DefaultAllowedValue_Value | object | composite |\r\n| defaultValue | Attribute->DefaultValue | object | composite |\r\n| description | Attribute->Description | string | |\r\n| explanation | Attribute->Explanation | string | |\r\n| notes | Attribute->Notes | string | |\r\n| sequenceNumber | Attribute->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetAttribute", "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 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 Attribute collection", "schema": { "$ref": "#/definitions/BatchGetAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Attributes/Batch": { "post": { "tags": [ "Attribute" ], "summary": "Create a new collection of 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| permissionTreeId | Attribute->PermissionTree_Id | integer | int64 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| sequenceNumber | Attribute->SequenceNumber | integer | int32 |\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| explanation | Attribute->Explanation | string | |\r\n| notes | Attribute->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| allowAnyValue | Required | True | |\r\n| allowAnyValue | Nullable | False | |\r\n| dataType | Required | True | |\r\n| dataType | Nullable | False | |\r\n| defaultValue | Nullable | True | Attribute->AllowAnyValue eq false |\r\n| defaultAllowedValueId | Nullable | True | Attribute->AllowAnyValue eq true |\r\n| defaultAllowedValueId | Min Value | > 0| |\r\n\r\n", "operationId": "BatchCreateAttribute", "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/BatchCreateAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - 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": [ "Attribute" ], "summary": "Update a collection of existing 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 | Attribute->Id | integer | int64 |\r\n| version | Attribute->Version | integer | int32 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| sequenceNumber | Attribute->SequenceNumber | integer | int32 |\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| explanation | Attribute->Explanation | string | |\r\n| notes | Attribute->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| allowAnyValue | Nullable | False | |\r\n| dataType | Nullable | False | |\r\n| defaultValue | Nullable | True | Attribute->AllowAnyValue eq false |\r\n| defaultAllowedValueId | Nullable | True | Attribute->AllowAnyValue eq true |\r\n| defaultAllowedValueId | Min Value | > 0| |\r\n\r\n", "operationId": "BatchUpdateAttribute", "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/BatchUpdateAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - 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": [ "Attribute" ], "summary": "Delete a collection of existing 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 | Attribute->Id | integer | int64 |\r\n| version | Attribute->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": "BatchDeleteAttribute", "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/BatchDeleteAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - 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/GEN/Attributes/{id}/Active": { "patch": { "tags": [ "Attribute" ], "summary": "Change the IsActive status for an existing 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 | Attribute->Version | integer | int32 |\r\n| isActive | Attribute->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": "ChangeAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAttributeIsActiveResourceActionRequest" } }, { "$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/GEN/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Attribute" ], "summary": "Change the PermissionTree for an existing 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 | Attribute->Version | integer | int32 |\r\n| permissionTreeId | Attribute->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": "ChangeAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAttributePermissionTreeResourceActionRequest" } }, { "$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/GEN/Attributes/Batch/Active": { "patch": { "tags": [ "Attribute" ], "summary": "Change the IsActive status for a collection of existing 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 | Attribute->Id | integer | int64 |\r\n| version | Attribute->Version | integer | int32 |\r\n| isActive | Attribute->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": "BatchChangeAttributeIsActive", "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/BatchChangeAttributeIsActiveResourceActionRequest" } }, { "$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/GEN/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Attribute" ], "summary": "Change the PermissionTree status for a collection of existing 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 | Attribute->Id | integer | int64 |\r\n| version | Attribute->Version | integer | int32 |\r\n| permissionTreeId | Attribute->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": "BatchChangeAttributePermissionTree", "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/BatchChangeAttributePermissionTreeResourceActionRequest" } }, { "$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/GEN/Attributes/AllowedValues/{id}": { "get": { "tags": [ "Attribute Allowed Value" ], "summary": "Get a Attribute Allowed Value 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 | AttributeAllowedValue->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AttributeAllowedValue->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AttributeAllowedValue->CreatedByUser_FullName | string | |\r\n| createdOn | AttributeAllowedValue->CreatedOn | string | date-time |\r\n| isActive | AttributeAllowedValue->IsActive | boolean | |\r\n| modifiedByUserId | AttributeAllowedValue->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AttributeAllowedValue->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AttributeAllowedValue->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AttributeAllowedValue->ModifiedOn | string | date-time |\r\n| permissionTreeId | AttributeAllowedValue->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AttributeAllowedValue->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AttributeAllowedValue->PermissionTree_Description | string | |\r\n| version | AttributeAllowedValue->Version | integer | int32 |\r\n| id | AttributeAllowedValue->Id | integer | int64 |\r\n| attributeId | AttributeAllowedValue->Attribute_Id | integer | int64 |\r\n| attributeCode | AttributeAllowedValue->Attribute_Code | string | |\r\n| attributeDescription | AttributeAllowedValue->Attribute_Description | string | |\r\n| attributeAllowAnyValue | AttributeAllowedValue->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | AttributeAllowedValue->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | AttributeAllowedValue->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | AttributeAllowedValue->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | AttributeAllowedValue->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | AttributeAllowedValue->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| notes | AttributeAllowedValue->Notes | string | |\r\n| sequenceNumber | AttributeAllowedValue->SequenceNumber | integer | int32 |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n", "operationId": "GetAttributeAllowedValue", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Attribute Allowed Value Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Attribute Allowed Value", "schema": { "$ref": "#/definitions/GetAttributeAllowedValueResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Attribute Allowed Value" ], "summary": "Update an existing Attribute Allowed Value 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 | AttributeAllowedValue->Version | integer | int32 |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| sequenceNumber | AttributeAllowedValue->SequenceNumber | integer | int32 |\r\n| notes | AttributeAllowedValue->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 | False | |\r\n\r\n", "operationId": "UpdateAttributeAllowedValue", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Attribute Allowed Value Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateAttributeAllowedValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Attribute Allowed Value 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": [ "Attribute Allowed Value" ], "summary": "Delete an existing Attribute Allowed Value 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 | AttributeAllowedValue->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": "DeleteAttributeAllowedValue", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Attribute Allowed Value Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteAttributeAllowedValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Attribute Allowed Value 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/GEN/Attributes/{id}/allowedValues": { "get": { "tags": [ "Attribute Allowed Value" ], "summary": "Get a collection of Attribute Allowed Value resources for the 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| version | AttributeAllowedValue->Version | integer | int32 |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n| description | AttributeAllowedValue->Description | string | |\r\n", "operationId": "GetAttributeAllowedValueForAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Attribute 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 Attribute Allowed Value collection", "schema": { "$ref": "#/definitions/GetAllowedValueForAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Attributes/AllowedValues": { "get": { "tags": [ "Attribute Allowed Value" ], "summary": "Get a collection of Attribute Allowed Value 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 | AttributeAllowedValue->Version | integer | int32 |\r\n| id | AttributeAllowedValue->Id | integer | int64 |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| sequenceNumber | AttributeAllowedValue->SequenceNumber | integer | int32 |\r\n| notes | AttributeAllowedValue->Notes | string | |\r\n| createdOn | AttributeAllowedValue->CreatedOn | string | date-time |\r\n| modifiedOn | AttributeAllowedValue->ModifiedOn | string | date-time |\r\n", "operationId": "GetAttributeAllowedValueCollection", "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/GetAttributeAllowedValueCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Attribute Allowed Value" ], "summary": "Create a new Attribute Allowed Value 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 | AttributeAllowedValue->PermissionTree_Id | integer | int64 |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| sequenceNumber | AttributeAllowedValue->SequenceNumber | integer | int32 |\r\n| attributeId | AttributeAllowedValue->Attribute_Id | integer | int64 |\r\n| notes | AttributeAllowedValue->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n\r\n", "operationId": "CreateAttributeAllowedValue", "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/CreateAttributeAllowedValueResourceActionRequest" } }, { "$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/GEN/Attributes/AllowedValues/Lookups/LookupAttributeAllowedValueAttribute": { "get": { "tags": [ "Attribute Allowed Value" ], "summary": "Lookup the Attribute for the Attribute Allowed Value.", "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", "operationId": "LookupAttributeAllowedValueAttribute", "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/AttributeAllowedValueAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Attributes/AllowedValues/Lookups/LookupAttributeAllowedValueChangePermissionTree": { "get": { "tags": [ "Attribute Allowed Value" ], "summary": "Lookup the permission set for changing the Attribute Allowed Value.", "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": "LookupAttributeAllowedValueChangePermissionTree", "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/AttributeAllowedValueChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Attributes/AllowedValues/Lookups/LookupAttributeAllowedValueInsertPermissionTree": { "get": { "tags": [ "Attribute Allowed Value" ], "summary": "Lookup the permission set for creating the Attribute Allowed Value.", "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": "LookupAttributeAllowedValueInsertPermissionTree", "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/AttributeAllowedValueInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Attributes/AllowedValues/Batch/{ids}": { "get": { "tags": [ "Attribute Allowed Value" ], "summary": "Get a collection of Attribute Allowed Value 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 | AttributeAllowedValue->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AttributeAllowedValue->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AttributeAllowedValue->CreatedByUser_FullName | string | |\r\n| createdOn | AttributeAllowedValue->CreatedOn | string | date-time |\r\n| isActive | AttributeAllowedValue->IsActive | boolean | |\r\n| modifiedByUserId | AttributeAllowedValue->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AttributeAllowedValue->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AttributeAllowedValue->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AttributeAllowedValue->ModifiedOn | string | date-time |\r\n| permissionTreeId | AttributeAllowedValue->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AttributeAllowedValue->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AttributeAllowedValue->PermissionTree_Description | string | |\r\n| version | AttributeAllowedValue->Version | integer | int32 |\r\n| id | AttributeAllowedValue->Id | integer | int64 |\r\n| attributeId | AttributeAllowedValue->Attribute_Id | integer | int64 |\r\n| attributeCode | AttributeAllowedValue->Attribute_Code | string | |\r\n| attributeDescription | AttributeAllowedValue->Attribute_Description | string | |\r\n| attributeAllowAnyValue | AttributeAllowedValue->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | AttributeAllowedValue->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | AttributeAllowedValue->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | AttributeAllowedValue->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | AttributeAllowedValue->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | AttributeAllowedValue->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| notes | AttributeAllowedValue->Notes | string | |\r\n| sequenceNumber | AttributeAllowedValue->SequenceNumber | integer | int32 |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n", "operationId": "BatchGetAttributeAllowedValue", "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 Attribute Allowed Value 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 Attribute Allowed Value collection", "schema": { "$ref": "#/definitions/BatchGetAttributeAllowedValueResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Attributes/AllowedValues/Batch": { "post": { "tags": [ "Attribute Allowed Value" ], "summary": "Create a new collection of Attribute Allowed Value 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 | AttributeAllowedValue->PermissionTree_Id | integer | int64 |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| sequenceNumber | AttributeAllowedValue->SequenceNumber | integer | int32 |\r\n| attributeId | AttributeAllowedValue->Attribute_Id | integer | int64 |\r\n| notes | AttributeAllowedValue->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateAttributeAllowedValue", "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/BatchCreateAttributeAllowedValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Attribute Allowed Value 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": [ "Attribute Allowed Value" ], "summary": "Update a collection of existing Attribute Allowed Value 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 | AttributeAllowedValue->Id | integer | int64 |\r\n| version | AttributeAllowedValue->Version | integer | int32 |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| sequenceNumber | AttributeAllowedValue->SequenceNumber | integer | int32 |\r\n| notes | AttributeAllowedValue->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 | False | |\r\n\r\n", "operationId": "BatchUpdateAttributeAllowedValue", "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/BatchUpdateAttributeAllowedValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Attribute Allowed Value 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": [ "Attribute Allowed Value" ], "summary": "Delete a collection of existing Attribute Allowed Value 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 | AttributeAllowedValue->Id | integer | int64 |\r\n| version | AttributeAllowedValue->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": "BatchDeleteAttributeAllowedValue", "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/BatchDeleteAttributeAllowedValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Attribute Allowed Value 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/GEN/Attributes/AllowedValues/{id}/Active": { "patch": { "tags": [ "Attribute Allowed Value" ], "summary": "Change the IsActive status for an existing Attribute Allowed Value 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 | AttributeAllowedValue->Version | integer | int32 |\r\n| isActive | AttributeAllowedValue->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": "ChangeAttributeAllowedValueIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Attribute Allowed Value Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAttributeAllowedValueIsActiveResourceActionRequest" } }, { "$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/GEN/Attributes/AllowedValues/{id}/PermissionTree": { "patch": { "tags": [ "Attribute Allowed Value" ], "summary": "Change the PermissionTree for an existing Attribute Allowed Value 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 | AttributeAllowedValue->Version | integer | int32 |\r\n| permissionTreeId | AttributeAllowedValue->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": "ChangeAttributeAllowedValuePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Attribute Allowed Value Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeAttributeAllowedValuePermissionTreeResourceActionRequest" } }, { "$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/GEN/Attributes/AllowedValues/Batch/Active": { "patch": { "tags": [ "Attribute Allowed Value" ], "summary": "Change the IsActive status for a collection of existing Attribute Allowed Value 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 | AttributeAllowedValue->Id | integer | int64 |\r\n| version | AttributeAllowedValue->Version | integer | int32 |\r\n| isActive | AttributeAllowedValue->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": "BatchChangeAttributeAllowedValueIsActive", "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/BatchChangeAttributeAllowedValueIsActiveResourceActionRequest" } }, { "$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/GEN/Attributes/AllowedValues/Batch/PermissionTree": { "patch": { "tags": [ "Attribute Allowed Value" ], "summary": "Change the PermissionTree status for a collection of existing Attribute Allowed Value 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 | AttributeAllowedValue->Id | integer | int64 |\r\n| version | AttributeAllowedValue->Version | integer | int32 |\r\n| permissionTreeId | AttributeAllowedValue->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": "BatchChangeAttributeAllowedValuePermissionTree", "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/BatchChangeAttributeAllowedValuePermissionTreeResourceActionRequest" } }, { "$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/GEN/Calendars/{id}": { "get": { "tags": [ "Calendar" ], "summary": "Get a Calendar 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 | Calendar->Code | string | |\r\n| createdByUserId | Calendar->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Calendar->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Calendar->CreatedByUser_FullName | string | |\r\n| createdOn | Calendar->CreatedOn | string | date-time |\r\n| isActive | Calendar->IsActive | boolean | |\r\n| modifiedByUserId | Calendar->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Calendar->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Calendar->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Calendar->ModifiedOn | string | date-time |\r\n| permissionTreeId | Calendar->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Calendar->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Calendar->PermissionTree_Description | string | |\r\n| siteId | Calendar->Site_Id | integer | int64 |\r\n| siteCode | Calendar->Site_Code | string | |\r\n| siteDescription | Calendar->Site_Description | string | |\r\n| version | Calendar->Version | integer | int32 |\r\n| id | Calendar->Id | integer | int64 |\r\n| calendarType | Calendar->CalendarType | string (Allowed values: [Asset, Resource]) | enum |\r\n| description | Calendar->Description | string | |\r\n| notes | Calendar->Notes | string | |\r\n| sequenceNumber | Calendar->SequenceNumber | integer | int32 |\r\n", "operationId": "GetCalendar", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Calendar Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Calendar", "schema": { "$ref": "#/definitions/GetCalendarResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Calendar" ], "summary": "Update an existing Calendar 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 | Calendar->Version | integer | int32 |\r\n| code | Calendar->Code | string | |\r\n| calendarType | Calendar->CalendarType | string (Allowed values: [Asset, Resource]) | enum |\r\n| description | Calendar->Description | string | |\r\n| sequenceNumber | Calendar->SequenceNumber | integer | int32 |\r\n| notes | Calendar->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| calendarType | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateCalendar", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Calendar Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateCalendarResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Calendar 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": [ "Calendar" ], "summary": "Delete an existing Calendar 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 | Calendar->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": "DeleteCalendar", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Calendar Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteCalendarResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Calendar 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/GEN/Calendars": { "get": { "tags": [ "Calendar" ], "summary": "Get a collection of Calendar 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 | Calendar->Id | integer | int64 |\r\n| version | Calendar->Version | integer | int32 |\r\n| code | Calendar->Code | string | |\r\n| description | Calendar->Description | string | |\r\n| calendarType | Calendar->CalendarType | string (Allowed values: [Asset, Resource]) | enum |\r\n| siteCode | Calendar->Site_Code | string | |\r\n| siteDescription | Calendar->Site_Description | string | |\r\n", "operationId": "GetCalendarCollection", "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 Calendar collection", "schema": { "$ref": "#/definitions/GetCalendarCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Calendar" ], "summary": "Create a new Calendar 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 | Calendar->PermissionTree_Id | integer | int64 |\r\n| siteId | Calendar->Site_Id | integer | int64 |\r\n| code | Calendar->Code | string | |\r\n| description | Calendar->Description | string | |\r\n| sequenceNumber | Calendar->SequenceNumber | integer | int32 |\r\n| calendarType | Calendar->CalendarType | string (Allowed values: [Asset, Resource]) | enum |\r\n| notes | Calendar->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| 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| calendarType | Required | True | |\r\n| calendarType | Nullable | False | |\r\n\r\n", "operationId": "CreateCalendar", "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/CreateCalendarResourceActionRequest" } }, { "$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/GEN/Calendars/Lookups/LookupCalendarChangePermissionTree": { "get": { "tags": [ "Calendar" ], "summary": "Lookup the permission set for changing the Calendar.", "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": "LookupCalendarChangePermissionTree", "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/CalendarChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Calendars/Lookups/LookupCalendarInsertPermissionTree": { "get": { "tags": [ "Calendar" ], "summary": "Lookup the permission set for creating the Calendar.", "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": "LookupCalendarInsertPermissionTree", "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/CalendarInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Calendars/Lookups/LookupCalendarSite": { "get": { "tags": [ "Calendar" ], "summary": "Lookup the Site for the Calendar.", "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": "LookupCalendarSite", "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/CalendarSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Calendars/Batch/{ids}": { "get": { "tags": [ "Calendar" ], "summary": "Get a collection of Calendar 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 | Calendar->Code | string | |\r\n| createdByUserId | Calendar->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Calendar->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Calendar->CreatedByUser_FullName | string | |\r\n| createdOn | Calendar->CreatedOn | string | date-time |\r\n| isActive | Calendar->IsActive | boolean | |\r\n| modifiedByUserId | Calendar->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Calendar->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Calendar->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Calendar->ModifiedOn | string | date-time |\r\n| permissionTreeId | Calendar->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Calendar->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Calendar->PermissionTree_Description | string | |\r\n| siteId | Calendar->Site_Id | integer | int64 |\r\n| siteCode | Calendar->Site_Code | string | |\r\n| siteDescription | Calendar->Site_Description | string | |\r\n| version | Calendar->Version | integer | int32 |\r\n| id | Calendar->Id | integer | int64 |\r\n| calendarType | Calendar->CalendarType | string (Allowed values: [Asset, Resource]) | enum |\r\n| description | Calendar->Description | string | |\r\n| notes | Calendar->Notes | string | |\r\n| sequenceNumber | Calendar->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetCalendar", "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 Calendar 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 Calendar collection", "schema": { "$ref": "#/definitions/BatchGetCalendarResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Calendars/Batch": { "post": { "tags": [ "Calendar" ], "summary": "Create a new collection of Calendar 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 | Calendar->PermissionTree_Id | integer | int64 |\r\n| siteId | Calendar->Site_Id | integer | int64 |\r\n| code | Calendar->Code | string | |\r\n| description | Calendar->Description | string | |\r\n| sequenceNumber | Calendar->SequenceNumber | integer | int32 |\r\n| calendarType | Calendar->CalendarType | string (Allowed values: [Asset, Resource]) | enum |\r\n| notes | Calendar->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| 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| calendarType | Required | True | |\r\n| calendarType | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateCalendar", "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/BatchCreateCalendarResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Calendar 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": [ "Calendar" ], "summary": "Update a collection of existing Calendar 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 | Calendar->Id | integer | int64 |\r\n| version | Calendar->Version | integer | int32 |\r\n| code | Calendar->Code | string | |\r\n| calendarType | Calendar->CalendarType | string (Allowed values: [Asset, Resource]) | enum |\r\n| description | Calendar->Description | string | |\r\n| sequenceNumber | Calendar->SequenceNumber | integer | int32 |\r\n| notes | Calendar->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| calendarType | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateCalendar", "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/BatchUpdateCalendarResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Calendar 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": [ "Calendar" ], "summary": "Delete a collection of existing Calendar 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 | Calendar->Id | integer | int64 |\r\n| version | Calendar->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": "BatchDeleteCalendar", "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/BatchDeleteCalendarResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Calendar 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/GEN/Calendars/{id}/Active": { "patch": { "tags": [ "Calendar" ], "summary": "Change the IsActive status for an existing Calendar 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 | Calendar->Version | integer | int32 |\r\n| isActive | Calendar->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": "ChangeCalendarIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Calendar Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeCalendarIsActiveResourceActionRequest" } }, { "$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/GEN/Calendars/{id}/PermissionTree": { "patch": { "tags": [ "Calendar" ], "summary": "Change the PermissionTree for an existing Calendar 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 | Calendar->Version | integer | int32 |\r\n| permissionTreeId | Calendar->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": "ChangeCalendarPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Calendar Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeCalendarPermissionTreeResourceActionRequest" } }, { "$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/GEN/Calendars/{id}/Site": { "patch": { "tags": [ "Calendar" ], "summary": "Change the Site status for an existing Calendar 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 | Calendar->Version | integer | int32 |\r\n| siteId | Calendar->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": "ChangeCalendarSite", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Calendar Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeCalendarSiteResourceActionRequest" } }, { "$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/GEN/Calendars/Batch/Active": { "patch": { "tags": [ "Calendar" ], "summary": "Change the IsActive status for a collection of existing Calendar 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 | Calendar->Id | integer | int64 |\r\n| version | Calendar->Version | integer | int32 |\r\n| isActive | Calendar->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": "BatchChangeCalendarIsActive", "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/BatchChangeCalendarIsActiveResourceActionRequest" } }, { "$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/GEN/Calendars/Batch/PermissionTree": { "patch": { "tags": [ "Calendar" ], "summary": "Change the PermissionTree status for a collection of existing Calendar 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 | Calendar->Id | integer | int64 |\r\n| version | Calendar->Version | integer | int32 |\r\n| permissionTreeId | Calendar->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": "BatchChangeCalendarPermissionTree", "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/BatchChangeCalendarPermissionTreeResourceActionRequest" } }, { "$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/GEN/Calendars/Batch/Site": { "patch": { "tags": [ "Calendar" ], "summary": "Change the Site status for a collection of existing Calendar 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 | Calendar->Id | integer | int64 |\r\n| version | Calendar->Version | integer | int32 |\r\n| siteId | Calendar->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": "BatchChangeCalendarSite", "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/BatchChangeCalendarSiteResourceActionRequest" } }, { "$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/GEN/Calendars/Days/{id}": { "get": { "tags": [ "Calendar Day" ], "summary": "Get a Calendar Day 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 | CalendarDay->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CalendarDay->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CalendarDay->CreatedByUser_FullName | string | |\r\n| createdOn | CalendarDay->CreatedOn | string | date-time |\r\n| modifiedByUserId | CalendarDay->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CalendarDay->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CalendarDay->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CalendarDay->ModifiedOn | string | date-time |\r\n| version | CalendarDay->Version | integer | int32 |\r\n| id | CalendarDay->Id | integer | int64 |\r\n| calendarId | CalendarDay->Calendar_Id | integer | int64 |\r\n| calendarCode | CalendarDay->Calendar_Code | string | |\r\n| calendarDescription | CalendarDay->Calendar_Description | string | |\r\n| dayOfWeek | CalendarDay->DayOfWeek | string (Allowed values: [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday]) | enum |\r\n| isWorkingDay | CalendarDay->IsWorkingDay | boolean | |\r\n| notes | CalendarDay->Notes | string | |\r\n", "operationId": "GetCalendarDay", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Calendar Day Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Calendar Day", "schema": { "$ref": "#/definitions/GetCalendarDayResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Calendar Day" ], "summary": "Update an existing Calendar Day 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 | CalendarDay->Version | integer | int32 |\r\n| isWorkingDay | CalendarDay->IsWorkingDay | boolean | |\r\n| notes | CalendarDay->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| isWorkingDay | Nullable | False | |\r\n\r\n", "operationId": "UpdateCalendarDay", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Calendar Day Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateCalendarDayResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Calendar Day 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/GEN/Calendars/Days": { "get": { "tags": [ "Calendar Day" ], "summary": "Get a collection of Calendar Day 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 | CalendarDay->Id | integer | int64 |\r\n| calendarCode | CalendarDay->Calendar_Code | string | |\r\n| dayOfWeek | CalendarDay->DayOfWeek | string (Allowed values: [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday]) | enum |\r\n| isWorkingDay | CalendarDay->IsWorkingDay | boolean | |\r\n", "operationId": "GetCalendarDayCollection", "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 Calendar Day collection", "schema": { "$ref": "#/definitions/GetCalendarDayCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Calendars/{id}/Days": { "get": { "tags": [ "Calendar Day" ], "summary": "Get a collection of Calendar Day 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 | CalendarDay->Id | integer | int64 |\r\n| version | CalendarDay->Version | integer | int32 |\r\n| dayOfWeek | CalendarDay->DayOfWeek | string (Allowed values: [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday]) | enum |\r\n| isWorkingDay | CalendarDay->IsWorkingDay | boolean | |\r\n", "operationId": "GetCalendarDayForCalendarCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Calendar 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 Calendar Day collection", "schema": { "$ref": "#/definitions/GetCalendarDayForCalendarCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Calendars/Days/Batch/{ids}": { "get": { "tags": [ "Calendar Day" ], "summary": "Get a collection of Calendar Day 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 | CalendarDay->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CalendarDay->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CalendarDay->CreatedByUser_FullName | string | |\r\n| createdOn | CalendarDay->CreatedOn | string | date-time |\r\n| modifiedByUserId | CalendarDay->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CalendarDay->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CalendarDay->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CalendarDay->ModifiedOn | string | date-time |\r\n| version | CalendarDay->Version | integer | int32 |\r\n| id | CalendarDay->Id | integer | int64 |\r\n| calendarId | CalendarDay->Calendar_Id | integer | int64 |\r\n| calendarCode | CalendarDay->Calendar_Code | string | |\r\n| calendarDescription | CalendarDay->Calendar_Description | string | |\r\n| dayOfWeek | CalendarDay->DayOfWeek | string (Allowed values: [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday]) | enum |\r\n| isWorkingDay | CalendarDay->IsWorkingDay | boolean | |\r\n| notes | CalendarDay->Notes | string | |\r\n", "operationId": "BatchGetCalendarDay", "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 Calendar Day 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 Calendar Day collection", "schema": { "$ref": "#/definitions/BatchGetCalendarDayResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Calendars/Days/Batch": { "patch": { "tags": [ "Calendar Day" ], "summary": "Update a collection of existing Calendar Day 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 | CalendarDay->Id | integer | int64 |\r\n| version | CalendarDay->Version | integer | int32 |\r\n| isWorkingDay | CalendarDay->IsWorkingDay | boolean | |\r\n| notes | CalendarDay->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| isWorkingDay | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateCalendarDay", "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/BatchUpdateCalendarDayResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Calendar Day 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/GEN/Calendars/Days/Hours/{id}": { "get": { "tags": [ "Calendar Day Hour" ], "summary": "Get a Calendar Day Hour 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 | CalendarDayHour->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CalendarDayHour->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CalendarDayHour->CreatedByUser_FullName | string | |\r\n| createdOn | CalendarDayHour->CreatedOn | string | date-time |\r\n| modifiedByUserId | CalendarDayHour->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CalendarDayHour->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CalendarDayHour->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CalendarDayHour->ModifiedOn | string | date-time |\r\n| version | CalendarDayHour->Version | integer | int32 |\r\n| id | CalendarDayHour->Id | integer | int64 |\r\n| calendarDayId | CalendarDayHour->CalendarDay_Id | integer | int64 |\r\n| calendarDayDayOfWeek | CalendarDayHour->CalendarDay_DayOfWeek | string (Allowed values: [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday]) | enum |\r\n| calendarDayIsWorkingDay | CalendarDayHour->CalendarDay_IsWorkingDay | boolean | |\r\n| calendarDayCalendarId | CalendarDayHour->CalendarDay_Calendar_Id | integer | int64 |\r\n| calendarDayCalendarCode | CalendarDayHour->CalendarDay_Calendar_Code | string | |\r\n| calendarDayCalendarDescription | CalendarDayHour->CalendarDay_Calendar_Description | string | |\r\n| notes | CalendarDayHour->Notes | string | |\r\n| timeFrom | CalendarDayHour->TimeFrom | string | time |\r\n| timeTo | CalendarDayHour->TimeTo | string | time |\r\n", "operationId": "GetCalendarDayHour", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Calendar Day Hour Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Calendar Day Hour", "schema": { "$ref": "#/definitions/GetCalendarDayHourResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Calendar Day Hour" ], "summary": "Update an existing Calendar Day Hour 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 | CalendarDayHour->Version | integer | int32 |\r\n| timeTo | CalendarDayHour->TimeTo | string | time |\r\n| timeFrom | CalendarDayHour->TimeFrom | string | time |\r\n| notes | CalendarDayHour->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| timeTo | Max Value | < 1.00:00:00| |\r\n| timeFrom | Max Value | < 1.00:00:00| |\r\n\r\n", "operationId": "UpdateCalendarDayHour", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Calendar Day Hour Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateCalendarDayHourResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Calendar Day Hour 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": [ "Calendar Day Hour" ], "summary": "Delete an existing Calendar Day Hour 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 | CalendarDayHour->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": "DeleteCalendarDayHour", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Calendar Day Hour Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteCalendarDayHourResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Calendar Day Hour 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/GEN/Calendars/Days/Hours": { "get": { "tags": [ "Calendar Day Hour" ], "summary": "Get a collection of Calendar Day Hour 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 | CalendarDayHour->Id | integer | int64 |\r\n| version | CalendarDayHour->Version | integer | int32 |\r\n| calendarDayId | CalendarDayHour->CalendarDay_Id | integer | int64 |\r\n| calendarDayDayOfWeek | CalendarDayHour->CalendarDay_DayOfWeek | string (Allowed values: [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday]) | enum |\r\n| calendarDayIsWorkingDay | CalendarDayHour->CalendarDay_IsWorkingDay | boolean | |\r\n| calendarDayCalendarCode | CalendarDayHour->CalendarDay_Calendar_Code | string | |\r\n| calendarDayCalendarDescription | CalendarDayHour->CalendarDay_Calendar_Description | string | |\r\n| timeFrom | CalendarDayHour->TimeFrom | string | time |\r\n| timeTo | CalendarDayHour->TimeTo | string | time |\r\n", "operationId": "GetCalendarDayHourCollection", "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 Calendar Day Hour collection", "schema": { "$ref": "#/definitions/GetCalendarDayHourCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Calendar Day Hour" ], "summary": "Create a new Calendar Day Hour 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| calendarDayId | CalendarDayHour->CalendarDay_Id | integer | int64 |\r\n| timeFrom | CalendarDayHour->TimeFrom | string | time |\r\n| timeTo | CalendarDayHour->TimeTo | string | time |\r\n| notes | CalendarDayHour->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| calendarDayId | Required | True | |\r\n| calendarDayId | Nullable | False | |\r\n| timeFrom | Required | True | |\r\n| timeFrom | Nullable | False | |\r\n| timeFrom | Max Value | < 1.00:00:00| |\r\n| timeTo | Required | True | |\r\n| timeTo | Nullable | False | |\r\n| timeTo | Max Value | < 1.00:00:00| |\r\n\r\n", "operationId": "CreateCalendarDayHour", "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/CreateCalendarDayHourResourceActionRequest" } }, { "$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/GEN/Calendars/Days/{id}/Days": { "get": { "tags": [ "Calendar Day Hour" ], "summary": "Get a collection of Calendar Day Hour resources for the Calendar Day.", "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 | CalendarDayHour->Id | integer | int64 |\r\n| version | CalendarDayHour->Version | integer | int32 |\r\n| timeFrom | CalendarDayHour->TimeFrom | string | time |\r\n| timeTo | CalendarDayHour->TimeTo | string | time |\r\n", "operationId": "GetCalendarDayHourForCalendarDayCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Calendar Day 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 Calendar Day Hour collection", "schema": { "$ref": "#/definitions/GetCalendarDayHourForCalendarDayCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Calendars/Days/Hours/Lookups/LookupCalendarDayHourCalendarDay": { "get": { "tags": [ "Calendar Day Hour" ], "summary": "Lookup the permission set for creating the Calendar Day Hour.", "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 | CalendarDay->Id | integer | int64 |\r\n| dayOfWeek | CalendarDay->DayOfWeek | string (Allowed values: [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday]) | enum |\r\n| calendarCode | CalendarDay->Calendar_Code | string | |\r\n| calendarDescription | CalendarDay->Calendar_Description | string | |\r\n", "operationId": "LookupCalendarDayHourCalendarDay", "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 Calendar Day collection", "schema": { "$ref": "#/definitions/CalendarDayHourCalendarDayLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Calendars/Days/Hours/Batch/{ids}": { "get": { "tags": [ "Calendar Day Hour" ], "summary": "Get a collection of Calendar Day Hour 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 | CalendarDayHour->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CalendarDayHour->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CalendarDayHour->CreatedByUser_FullName | string | |\r\n| createdOn | CalendarDayHour->CreatedOn | string | date-time |\r\n| modifiedByUserId | CalendarDayHour->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CalendarDayHour->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CalendarDayHour->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CalendarDayHour->ModifiedOn | string | date-time |\r\n| version | CalendarDayHour->Version | integer | int32 |\r\n| id | CalendarDayHour->Id | integer | int64 |\r\n| calendarDayId | CalendarDayHour->CalendarDay_Id | integer | int64 |\r\n| calendarDayDayOfWeek | CalendarDayHour->CalendarDay_DayOfWeek | string (Allowed values: [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday]) | enum |\r\n| calendarDayIsWorkingDay | CalendarDayHour->CalendarDay_IsWorkingDay | boolean | |\r\n| calendarDayCalendarId | CalendarDayHour->CalendarDay_Calendar_Id | integer | int64 |\r\n| calendarDayCalendarCode | CalendarDayHour->CalendarDay_Calendar_Code | string | |\r\n| calendarDayCalendarDescription | CalendarDayHour->CalendarDay_Calendar_Description | string | |\r\n| notes | CalendarDayHour->Notes | string | |\r\n| timeFrom | CalendarDayHour->TimeFrom | string | time |\r\n| timeTo | CalendarDayHour->TimeTo | string | time |\r\n", "operationId": "BatchGetCalendarDayHour", "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 Calendar Day Hour 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 Calendar Day Hour collection", "schema": { "$ref": "#/definitions/BatchGetCalendarDayHourResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Calendars/Days/Hours/Batch": { "post": { "tags": [ "Calendar Day Hour" ], "summary": "Create a new collection of Calendar Day Hour 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| calendarDayId | CalendarDayHour->CalendarDay_Id | integer | int64 |\r\n| timeTo | CalendarDayHour->TimeTo | string | time |\r\n| timeFrom | CalendarDayHour->TimeFrom | string | time |\r\n| notes | CalendarDayHour->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| calendarDayId | Required | True | |\r\n| calendarDayId | Nullable | False | |\r\n| timeTo | Required | True | |\r\n| timeTo | Nullable | False | |\r\n| timeTo | Max Value | < 1.00:00:00| |\r\n| timeFrom | Required | True | |\r\n| timeFrom | Nullable | False | |\r\n| timeFrom | Max Value | < 1.00:00:00| |\r\n\r\n", "operationId": "BatchCreateCalendarDayHour", "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/BatchCreateCalendarDayHourResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Calendar Day Hour 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": [ "Calendar Day Hour" ], "summary": "Update a collection of existing Calendar Day Hour 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 | CalendarDayHour->Id | integer | int64 |\r\n| version | CalendarDayHour->Version | integer | int32 |\r\n| timeTo | CalendarDayHour->TimeTo | string | time |\r\n| timeFrom | CalendarDayHour->TimeFrom | string | time |\r\n| notes | CalendarDayHour->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| timeTo | Max Value | < 1.00:00:00| |\r\n| timeFrom | Max Value | < 1.00:00:00| |\r\n\r\n", "operationId": "BatchUpdateCalendarDayHour", "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/BatchUpdateCalendarDayHourResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Calendar Day Hour 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": [ "Calendar Day Hour" ], "summary": "Delete a collection of existing Calendar Day Hour 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 | CalendarDayHour->Id | integer | int64 |\r\n| version | CalendarDayHour->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": "BatchDeleteCalendarDayHour", "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/BatchDeleteCalendarDayHourResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Calendar Day Hour 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/GEN/Calendars/Exceptions/{id}": { "get": { "tags": [ "Calendar Exception" ], "summary": "Get a Calendar Exception 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 | CalendarException->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CalendarException->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CalendarException->CreatedByUser_FullName | string | |\r\n| createdOn | CalendarException->CreatedOn | string | date-time |\r\n| modifiedByUserId | CalendarException->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CalendarException->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CalendarException->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CalendarException->ModifiedOn | string | date-time |\r\n| version | CalendarException->Version | integer | int32 |\r\n| id | CalendarException->Id | integer | int64 |\r\n| calendarId | CalendarException->Calendar_Id | integer | int64 |\r\n| calendarCode | CalendarException->Calendar_Code | string | |\r\n| calendarDescription | CalendarException->Calendar_Description | string | |\r\n| description | CalendarException->Description | string | |\r\n| exceptionOn | CalendarException->ExceptionOn | string | date |\r\n| isWorkingDay | CalendarException->IsWorkingDay | boolean | |\r\n| notes | CalendarException->Notes | string | |\r\n| timeFrom | CalendarException->TimeFrom | string | time |\r\n| timeTo | CalendarException->TimeTo | string | time |\r\n", "operationId": "GetCalendarException", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Calendar Exception Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Calendar Exception", "schema": { "$ref": "#/definitions/GetCalendarExceptionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Calendar Exception" ], "summary": "Update an existing Calendar Exception 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 | CalendarException->Version | integer | int32 |\r\n| description | CalendarException->Description | string | |\r\n| isWorkingDay | CalendarException->IsWorkingDay | boolean | |\r\n| exceptionOn | CalendarException->ExceptionOn | string | date |\r\n| timeFrom | CalendarException->TimeFrom | string | time |\r\n| timeTo | CalendarException->TimeTo | string | time |\r\n| notes | CalendarException->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| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| isWorkingDay | Nullable | False | |\r\n| exceptionOn | Nullable | False | |\r\n| timeFrom | Max Value | < 1.00:00:00| |\r\n| timeTo | Max Value | < 1.00:00:00| |\r\n\r\n", "operationId": "UpdateCalendarException", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Calendar Exception Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateCalendarExceptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Calendar Exception 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": [ "Calendar Exception" ], "summary": "Delete an existing Calendar Exception 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 | CalendarException->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": "DeleteCalendarException", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Calendar Exception Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteCalendarExceptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Calendar Exception 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/GEN/Calendars/Exceptions": { "get": { "tags": [ "Calendar Exception" ], "summary": "Get a collection of Calendar Exception 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 | CalendarException->Id | integer | int64 |\r\n| version | CalendarException->Version | integer | int32 |\r\n| calendarId | CalendarException->Calendar_Id | integer | int64 |\r\n| calendarCode | CalendarException->Calendar_Code | string | |\r\n| calendarDescription | CalendarException->Calendar_Description | string | |\r\n| description | CalendarException->Description | string | |\r\n| isWorkingDay | CalendarException->IsWorkingDay | boolean | |\r\n| exceptionOn | CalendarException->ExceptionOn | string | date |\r\n| timeFrom | CalendarException->TimeFrom | string | time |\r\n| timeTo | CalendarException->TimeTo | string | time |\r\n", "operationId": "GetCalendarExceptionCollection", "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 Calendar Exception collection", "schema": { "$ref": "#/definitions/GetCalendarExceptionCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Calendar Exception" ], "summary": "Create a new Calendar Exception 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| calendarId | CalendarException->Calendar_Id | integer | int64 |\r\n| description | CalendarException->Description | string | |\r\n| isWorkingDay | CalendarException->IsWorkingDay | boolean | |\r\n| exceptionOn | CalendarException->ExceptionOn | string | date |\r\n| timeFrom | CalendarException->TimeFrom | string | time |\r\n| timeTo | CalendarException->TimeTo | string | time |\r\n| notes | CalendarException->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| calendarId | Required | True | |\r\n| calendarId | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| isWorkingDay | Required | True | |\r\n| isWorkingDay | Nullable | False | |\r\n| exceptionOn | Required | True | |\r\n| exceptionOn | Nullable | False | |\r\n| timeFrom | Max Value | < 1.00:00:00| |\r\n| timeTo | Max Value | < 1.00:00:00| |\r\n\r\n", "operationId": "CreateCalendarException", "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/CreateCalendarExceptionResourceActionRequest" } }, { "$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/GEN/Calendars/{id}/Exceptions": { "get": { "tags": [ "Calendar Exception" ], "summary": "Get a collection of Calendar Exception resources for the Calendar.", "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 | CalendarException->Id | integer | int64 |\r\n| version | CalendarException->Version | integer | int32 |\r\n| description | CalendarException->Description | string | |\r\n| exceptionOn | CalendarException->ExceptionOn | string | date |\r\n| timeFrom | CalendarException->TimeFrom | string | time |\r\n| timeTo | CalendarException->TimeTo | string | time |\r\n| isWorkingDay | CalendarException->IsWorkingDay | boolean | |\r\n", "operationId": "GetCalendarExceptionForCalendarCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Calendar 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 Calendar Exception collection", "schema": { "$ref": "#/definitions/GetCalendarExceptionForCalendarCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Calendars/Exceptions/Lookups/LookupCalendarExceptionCalendar": { "get": { "tags": [ "Calendar Exception" ], "summary": "Lookup the Calendar for the Calendar Exception.", "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 | Calendar->Id | integer | int64 |\r\n| code | Calendar->Code | string | |\r\n| description | Calendar->Description | string | |\r\n", "operationId": "LookupCalendarExceptionCalendar", "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 Calendar collection", "schema": { "$ref": "#/definitions/CalendarExceptionCalendarLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Calendars/Exceptions/Batch/{ids}": { "get": { "tags": [ "Calendar Exception" ], "summary": "Get a collection of Calendar Exception 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 | CalendarException->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | CalendarException->CreatedByUser_Code | string | |\r\n| createdByUserFullName | CalendarException->CreatedByUser_FullName | string | |\r\n| createdOn | CalendarException->CreatedOn | string | date-time |\r\n| modifiedByUserId | CalendarException->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | CalendarException->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | CalendarException->ModifiedByUser_FullName | string | |\r\n| modifiedOn | CalendarException->ModifiedOn | string | date-time |\r\n| version | CalendarException->Version | integer | int32 |\r\n| id | CalendarException->Id | integer | int64 |\r\n| calendarId | CalendarException->Calendar_Id | integer | int64 |\r\n| calendarCode | CalendarException->Calendar_Code | string | |\r\n| calendarDescription | CalendarException->Calendar_Description | string | |\r\n| description | CalendarException->Description | string | |\r\n| exceptionOn | CalendarException->ExceptionOn | string | date |\r\n| isWorkingDay | CalendarException->IsWorkingDay | boolean | |\r\n| notes | CalendarException->Notes | string | |\r\n| timeFrom | CalendarException->TimeFrom | string | time |\r\n| timeTo | CalendarException->TimeTo | string | time |\r\n", "operationId": "BatchGetCalendarException", "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 Calendar Exception 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 Calendar Exception collection", "schema": { "$ref": "#/definitions/BatchGetCalendarExceptionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Calendars/Exceptions/Batch": { "post": { "tags": [ "Calendar Exception" ], "summary": "Create a new collection of Calendar Exception 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| calendarId | CalendarException->Calendar_Id | integer | int64 |\r\n| description | CalendarException->Description | string | |\r\n| isWorkingDay | CalendarException->IsWorkingDay | boolean | |\r\n| exceptionOn | CalendarException->ExceptionOn | string | date |\r\n| timeFrom | CalendarException->TimeFrom | string | time |\r\n| timeTo | CalendarException->TimeTo | string | time |\r\n| notes | CalendarException->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| calendarId | Required | True | |\r\n| calendarId | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| isWorkingDay | Required | True | |\r\n| isWorkingDay | Nullable | False | |\r\n| exceptionOn | Required | True | |\r\n| exceptionOn | Nullable | False | |\r\n| timeFrom | Max Value | < 1.00:00:00| |\r\n| timeTo | Max Value | < 1.00:00:00| |\r\n\r\n", "operationId": "BatchCreateCalendarException", "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/BatchCreateCalendarExceptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Calendar Exception 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": [ "Calendar Exception" ], "summary": "Update a collection of existing Calendar Exception 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 | CalendarException->Id | integer | int64 |\r\n| version | CalendarException->Version | integer | int32 |\r\n| description | CalendarException->Description | string | |\r\n| isWorkingDay | CalendarException->IsWorkingDay | boolean | |\r\n| exceptionOn | CalendarException->ExceptionOn | string | date |\r\n| timeFrom | CalendarException->TimeFrom | string | time |\r\n| timeTo | CalendarException->TimeTo | string | time |\r\n| notes | CalendarException->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| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| isWorkingDay | Nullable | False | |\r\n| exceptionOn | Nullable | False | |\r\n| timeFrom | Max Value | < 1.00:00:00| |\r\n| timeTo | Max Value | < 1.00:00:00| |\r\n\r\n", "operationId": "BatchUpdateCalendarException", "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/BatchUpdateCalendarExceptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Calendar Exception 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": [ "Calendar Exception" ], "summary": "Delete a collection of existing Calendar Exception 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 | CalendarException->Id | integer | int64 |\r\n| version | CalendarException->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": "BatchDeleteCalendarException", "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/BatchDeleteCalendarExceptionResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Calendar Exception 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/GEN/ChangeDataTriggers/{id}": { "get": { "tags": [ "Change Data Trigger" ], "summary": "Get a Change Data Trigger 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 | ChangeDataTrigger->Code | string | |\r\n| isActive | ChangeDataTrigger->IsActive | boolean | |\r\n| createdByUserId | ChangeDataTrigger->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ChangeDataTrigger->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ChangeDataTrigger->CreatedByUser_FullName | string | |\r\n| createdOn | ChangeDataTrigger->CreatedOn | string | date-time |\r\n| modifiedByUserId | ChangeDataTrigger->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ChangeDataTrigger->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ChangeDataTrigger->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ChangeDataTrigger->ModifiedOn | string | date-time |\r\n| version | ChangeDataTrigger->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTrigger->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ChangeDataTrigger->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ChangeDataTrigger->PermissionTree_Description | string | |\r\n| id | ChangeDataTrigger->Id | integer | int64 |\r\n| description | ChangeDataTrigger->Description | string | |\r\n| entityType | ChangeDataTrigger->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| isSystem | ChangeDataTrigger->IsSystem | boolean | |\r\n| triggerOnce | ChangeDataTrigger->TriggerOnce | boolean | |\r\n| notes | ChangeDataTrigger->Notes | string | |\r\n| sequenceNumber | ChangeDataTrigger->SequenceNumber | integer | int32 |\r\n", "operationId": "GetChangeDataTrigger", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Change Data Trigger", "schema": { "$ref": "#/definitions/GetChangeDataTriggerResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Change Data Trigger" ], "summary": "Update an existing Change Data Trigger 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 | ChangeDataTrigger->Version | integer | int32 |\r\n| code | ChangeDataTrigger->Code | string | |\r\n| description | ChangeDataTrigger->Description | string | |\r\n| sequenceNumber | ChangeDataTrigger->SequenceNumber | integer | int32 |\r\n| triggerOnce | ChangeDataTrigger->TriggerOnce | boolean | |\r\n| notes | ChangeDataTrigger->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| triggerOnce | Nullable | False | |\r\n\r\n", "operationId": "UpdateChangeDataTrigger", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateChangeDataTriggerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger 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": [ "Change Data Trigger" ], "summary": "Delete an existing Change Data Trigger 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 | ChangeDataTrigger->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": "DeleteChangeDataTrigger", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteChangeDataTriggerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger 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/GEN/ChangeDataTriggers": { "get": { "tags": [ "Change Data Trigger" ], "summary": "Get a collection of Change Data Trigger 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 | ChangeDataTrigger->Version | integer | int32 |\r\n| id | ChangeDataTrigger->Id | integer | int64 |\r\n| code | ChangeDataTrigger->Code | string | |\r\n| description | ChangeDataTrigger->Description | string | |\r\n| isActive | ChangeDataTrigger->IsActive | boolean | |\r\n| sequenceNumber | ChangeDataTrigger->SequenceNumber | integer | int32 |\r\n| entityType | ChangeDataTrigger->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| triggerOnce | ChangeDataTrigger->TriggerOnce | boolean | |\r\n", "operationId": "GetChangeDataTriggerCollection", "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 Change Data Trigger collection", "schema": { "$ref": "#/definitions/GetChangeDataTriggerCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Change Data Trigger" ], "summary": "Create a new Change Data Trigger 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 | ChangeDataTrigger->Code | string | |\r\n| description | ChangeDataTrigger->Description | string | |\r\n| permissionTreeId | ChangeDataTrigger->PermissionTree_Id | integer | int64 |\r\n| entityType | ChangeDataTrigger->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| sequenceNumber | ChangeDataTrigger->SequenceNumber | integer | int32 |\r\n| triggerOnce | ChangeDataTrigger->TriggerOnce | boolean | |\r\n| notes | ChangeDataTrigger->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| permissionTreeId | Nullable | False | |\r\n| entityType | Nullable | False | |\r\n| triggerOnce | Nullable | False | |\r\n\r\n", "operationId": "CreateChangeDataTrigger", "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/CreateChangeDataTriggerResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/Lookups/LookupChangeDataTriggerChangePermissionTree": { "get": { "tags": [ "Change Data Trigger" ], "summary": "Lookup the permission set for changing the Change Data Trigger.", "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": "LookupChangeDataTriggerChangePermissionTree", "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/ChangeDataTriggerChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/Lookups/LookupChangeDataTriggerInsertPermissionTree": { "get": { "tags": [ "Change Data Trigger" ], "summary": "Lookup the permission set for creating the Change Data Trigger.", "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": "LookupChangeDataTriggerInsertPermissionTree", "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/ChangeDataTriggerInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/Batch/{ids}": { "get": { "tags": [ "Change Data Trigger" ], "summary": "Get a collection of Change Data Trigger 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 | ChangeDataTrigger->Code | string | |\r\n| isActive | ChangeDataTrigger->IsActive | boolean | |\r\n| createdByUserId | ChangeDataTrigger->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ChangeDataTrigger->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ChangeDataTrigger->CreatedByUser_FullName | string | |\r\n| createdOn | ChangeDataTrigger->CreatedOn | string | date-time |\r\n| modifiedByUserId | ChangeDataTrigger->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ChangeDataTrigger->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ChangeDataTrigger->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ChangeDataTrigger->ModifiedOn | string | date-time |\r\n| version | ChangeDataTrigger->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTrigger->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ChangeDataTrigger->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ChangeDataTrigger->PermissionTree_Description | string | |\r\n| id | ChangeDataTrigger->Id | integer | int64 |\r\n| description | ChangeDataTrigger->Description | string | |\r\n| entityType | ChangeDataTrigger->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| isSystem | ChangeDataTrigger->IsSystem | boolean | |\r\n| triggerOnce | ChangeDataTrigger->TriggerOnce | boolean | |\r\n| notes | ChangeDataTrigger->Notes | string | |\r\n| sequenceNumber | ChangeDataTrigger->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetChangeDataTrigger", "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 Change Data Trigger 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 Change Data Trigger collection", "schema": { "$ref": "#/definitions/BatchGetChangeDataTriggerResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/Batch": { "post": { "tags": [ "Change Data Trigger" ], "summary": "Create a new collection of Change Data Trigger 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 | ChangeDataTrigger->Code | string | |\r\n| description | ChangeDataTrigger->Description | string | |\r\n| permissionTreeId | ChangeDataTrigger->PermissionTree_Id | integer | int64 |\r\n| entityType | ChangeDataTrigger->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| sequenceNumber | ChangeDataTrigger->SequenceNumber | integer | int32 |\r\n| triggerOnce | ChangeDataTrigger->TriggerOnce | boolean | |\r\n| notes | ChangeDataTrigger->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| permissionTreeId | Nullable | False | |\r\n| entityType | Nullable | False | |\r\n| triggerOnce | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateChangeDataTrigger", "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/BatchCreateChangeDataTriggerRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Change Data Trigger 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": [ "Change Data Trigger" ], "summary": "Update a collection of existing Change Data Trigger 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 | ChangeDataTrigger->Id | integer | int64 |\r\n| version | ChangeDataTrigger->Version | integer | int32 |\r\n| code | ChangeDataTrigger->Code | string | |\r\n| description | ChangeDataTrigger->Description | string | |\r\n| sequenceNumber | ChangeDataTrigger->SequenceNumber | integer | int32 |\r\n| triggerOnce | ChangeDataTrigger->TriggerOnce | boolean | |\r\n| notes | ChangeDataTrigger->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| triggerOnce | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateChangeDataTrigger", "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/BatchUpdateChangeDataTriggerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger 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": [ "Change Data Trigger" ], "summary": "Delete a collection of existing Change Data Trigger 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 | ChangeDataTrigger->Id | integer | int64 |\r\n| version | ChangeDataTrigger->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": "BatchDeleteChangeDataTrigger", "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/BatchDeleteChangeDataTriggerResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger 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/GEN/ChangeDataTriggers/{id}/Active": { "patch": { "tags": [ "Change Data Trigger" ], "summary": "Change the IsActive status for an existing Change Data Trigger 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 | ChangeDataTrigger->Version | integer | int32 |\r\n| isActive | ChangeDataTrigger->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": "ChangeChangeDataTriggerIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeChangeDataTriggerIsActiveResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/{id}/PermissionTree": { "patch": { "tags": [ "Change Data Trigger" ], "summary": "Change the PermissionTree for an existing Change Data Trigger 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 | ChangeDataTrigger->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTrigger->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": "ChangeChangeDataTriggerPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeChangeDataTriggerPermissionTreeResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/Batch/Active": { "patch": { "tags": [ "Change Data Trigger" ], "summary": "Change the IsActive status for a collection of existing Change Data Trigger 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 | ChangeDataTrigger->Id | integer | int64 |\r\n| version | ChangeDataTrigger->Version | integer | int32 |\r\n| isActive | ChangeDataTrigger->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": "BatchChangeChangeDataTriggerIsActive", "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/BatchChangeChangeDataTriggerIsActiveResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/Batch/PermissionTree": { "patch": { "tags": [ "Change Data Trigger" ], "summary": "Change the PermissionTree status for a collection of existing Change Data Trigger 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 | ChangeDataTrigger->Id | integer | int64 |\r\n| version | ChangeDataTrigger->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTrigger->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": "BatchChangeChangeDataTriggerPermissionTree", "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/BatchChangeChangeDataTriggerPermissionTreeResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/Criteria/{id}": { "get": { "tags": [ "Change Data Trigger Criteria" ], "summary": "Get a Change Data Trigger Criteria 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 | ChangeDataTriggerCriteria->IsActive | boolean | |\r\n| createdByUserId | ChangeDataTriggerCriteria->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ChangeDataTriggerCriteria->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ChangeDataTriggerCriteria->CreatedByUser_FullName | string | |\r\n| createdOn | ChangeDataTriggerCriteria->CreatedOn | string | date-time |\r\n| modifiedByUserId | ChangeDataTriggerCriteria->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ChangeDataTriggerCriteria->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ChangeDataTriggerCriteria->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ChangeDataTriggerCriteria->ModifiedOn | string | date-time |\r\n| version | ChangeDataTriggerCriteria->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerCriteria->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ChangeDataTriggerCriteria->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ChangeDataTriggerCriteria->PermissionTree_Description | string | |\r\n| id | ChangeDataTriggerCriteria->Id | integer | int64 |\r\n| changeDataTriggerId | ChangeDataTriggerCriteria->ChangeDataTrigger_Id | integer | int64 |\r\n| changeDataTriggerCode | ChangeDataTriggerCriteria->ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerDescription | ChangeDataTriggerCriteria->ChangeDataTrigger_Description | string | |\r\n| changeDataTriggerEntityType | ChangeDataTriggerCriteria->ChangeDataTrigger_EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| changeDataTriggerIsSystem | ChangeDataTriggerCriteria->ChangeDataTrigger_IsSystem | boolean | |\r\n| changeType | ChangeDataTriggerCriteria->ChangeType | string (Allowed values: [Unchanged, Created, Updated, Deleted]) | enum |\r\n| description | ChangeDataTriggerCriteria->Description | string | |\r\n| filterExpression | ChangeDataTriggerCriteria->FilterExpression | string | |\r\n| newValueExpression | ChangeDataTriggerCriteria->NewValueExpression | string | |\r\n| notes | ChangeDataTriggerCriteria->Notes | string | |\r\n| oldValueExpression | ChangeDataTriggerCriteria->OldValueExpression | string | |\r\n| repeatNotification | ChangeDataTriggerCriteria->RepeatNotification | string | duration |\r\n| repeatNotificationLimit | ChangeDataTriggerCriteria->RepeatNotificationLimit | integer | int32 |\r\n| sequenceNumber | ChangeDataTriggerCriteria->SequenceNumber | integer | int32 |\r\n| triggerProperties | ChangeDataTriggerCriteria->TriggerProperties | array | array |\r\n", "operationId": "GetChangeDataTriggerCriteria", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Criteria Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Change Data Trigger Criteria", "schema": { "$ref": "#/definitions/GetChangeDataTriggerCriteriaResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Change Data Trigger Criteria" ], "summary": "Update an existing Change Data Trigger Criteria 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 | ChangeDataTriggerCriteria->Version | integer | int32 |\r\n| changeDataTriggerId | ChangeDataTriggerCriteria->ChangeDataTrigger_Id | integer | int64 |\r\n| triggerProperties | ChangeDataTriggerCriteria->TriggerProperties | array | array |\r\n| description | ChangeDataTriggerCriteria->Description | string | |\r\n| changeType | ChangeDataTriggerCriteria->ChangeType | string (Allowed values: [Unchanged, Created, Updated, Deleted]) | enum |\r\n| filterExpression | ChangeDataTriggerCriteria->FilterExpression | string | |\r\n| newValueExpression | ChangeDataTriggerCriteria->NewValueExpression | string | |\r\n| oldValueExpression | ChangeDataTriggerCriteria->OldValueExpression | string | |\r\n| repeatNotification | ChangeDataTriggerCriteria->RepeatNotification | string | duration |\r\n| repeatNotificationLimit | ChangeDataTriggerCriteria->RepeatNotificationLimit | integer | int32 |\r\n| sequenceNumber | ChangeDataTriggerCriteria->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerCriteria->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| changeDataTriggerId | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| changeType | Nullable | False | |\r\n| repeatNotification | Nullable | True | ChangeDataTriggerCriteria->FilterExpression eq null |\r\n| repeatNotificationLimit | Min Value | > 0| ChangeDataTriggerCriteria->RepeatNotificationLimit ne null |\r\n\r\n", "operationId": "UpdateChangeDataTriggerCriteria", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Criteria Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateChangeDataTriggerCriteriaResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Criteria 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": [ "Change Data Trigger Criteria" ], "summary": "Delete an existing Change Data Trigger Criteria 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 | ChangeDataTriggerCriteria->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": "DeleteChangeDataTriggerCriteria", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Criteria Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteChangeDataTriggerCriteriaResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Criteria 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/GEN/ChangeDataTriggers/Criteria": { "get": { "tags": [ "Change Data Trigger Criteria" ], "summary": "Get a collection of Change Data Trigger Criteria 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 | ChangeDataTriggerCriteria->Id | integer | int64 |\r\n| changeDataTriggerId | ChangeDataTriggerCriteria->ChangeDataTrigger_Id | integer | int64 |\r\n| changeDataTriggerCode | ChangeDataTriggerCriteria->ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerDescription | ChangeDataTriggerCriteria->ChangeDataTrigger_Description | string | |\r\n| changeType | ChangeDataTriggerCriteria->ChangeType | string (Allowed values: [Unchanged, Created, Updated, Deleted]) | enum |\r\n| description | ChangeDataTriggerCriteria->Description | string | |\r\n| isActive | ChangeDataTriggerCriteria->IsActive | boolean | |\r\n| version | ChangeDataTriggerCriteria->Version | integer | int32 |\r\n", "operationId": "GetChangeDataTriggerCriteriaCollection", "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 Change Data Trigger Criteria collection", "schema": { "$ref": "#/definitions/GetChangeDataTriggerCriteriaCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Change Data Trigger Criteria" ], "summary": "Create a new Change Data Trigger Criteria 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 | ChangeDataTriggerCriteria->PermissionTree_Id | integer | int64 |\r\n| changeDataTriggerId | ChangeDataTriggerCriteria->ChangeDataTrigger_Id | integer | int64 |\r\n| description | ChangeDataTriggerCriteria->Description | string | |\r\n| changeType | ChangeDataTriggerCriteria->ChangeType | string (Allowed values: [Unchanged, Created, Updated, Deleted]) | enum |\r\n| triggerProperties | ChangeDataTriggerCriteria->TriggerProperties | array | array |\r\n| filterExpression | ChangeDataTriggerCriteria->FilterExpression | string | |\r\n| isActive | ChangeDataTriggerCriteria->IsActive | boolean | |\r\n| newValueExpression | ChangeDataTriggerCriteria->NewValueExpression | string | |\r\n| oldValueExpression | ChangeDataTriggerCriteria->OldValueExpression | string | |\r\n| repeatNotification | ChangeDataTriggerCriteria->RepeatNotification | string | duration |\r\n| repeatNotificationLimit | ChangeDataTriggerCriteria->RepeatNotificationLimit | integer | int32 |\r\n| sequenceNumber | ChangeDataTriggerCriteria->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerCriteria->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| changeDataTriggerId | Required | True | |\r\n| changeDataTriggerId | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| changeType | Required | True | |\r\n| changeType | Nullable | False | |\r\n| isActive | Nullable | False | |\r\n| repeatNotification | Nullable | True | ChangeDataTriggerCriteria->FilterExpression eq null |\r\n| repeatNotificationLimit | Min Value | > 0| ChangeDataTriggerCriteria->RepeatNotificationLimit ne null |\r\n\r\n", "operationId": "CreateChangeDataTriggerCriteria", "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/CreateChangeDataTriggerCriteriaResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/{changeDataTriggerId}/Criteria": { "get": { "tags": [ "Change Data Trigger Criteria" ], "summary": "Get a collection of Change Data Trigger Criteria resources for the Change Data Trigger.", "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 | ChangeDataTriggerCriteria->Id | integer | int64 |\r\n| changeDataTriggerId | ChangeDataTriggerCriteria->ChangeDataTrigger_Id | integer | int64 |\r\n| changeDataTriggerCode | ChangeDataTriggerCriteria->ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerDescription | ChangeDataTriggerCriteria->ChangeDataTrigger_Description | string | |\r\n| changeType | ChangeDataTriggerCriteria->ChangeType | string (Allowed values: [Unchanged, Created, Updated, Deleted]) | enum |\r\n| description | ChangeDataTriggerCriteria->Description | string | |\r\n| repeatNotification | ChangeDataTriggerCriteria->RepeatNotification | string | duration |\r\n| repeatNotificationLimit | ChangeDataTriggerCriteria->RepeatNotificationLimit | integer | int32 |\r\n| isActive | ChangeDataTriggerCriteria->IsActive | boolean | |\r\n| version | ChangeDataTriggerCriteria->Version | integer | int32 |\r\n", "operationId": "GetChangeDataTriggerCriteriaForChangeDataTriggerCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "changeDataTriggerId", "in": "path", "required": true, "description": "Change Data Trigger 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 Change Data Trigger Criteria collection", "schema": { "$ref": "#/definitions/GetChangeDataTriggerCriteriaForChangeDataTriggerCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/Criteria/Lookups/LookupChangeDataTriggerCriteriaChangeDataTrigger": { "get": { "tags": [ "Change Data Trigger Criteria" ], "summary": "Lookup the Change Data Trigger for the Change Data Trigger Criteria.", "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 | ChangeDataTrigger->Id | integer | int64 |\r\n| code | ChangeDataTrigger->Code | string | |\r\n| description | ChangeDataTrigger->Description | string | |\r\n| entityType | ChangeDataTrigger->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n", "operationId": "LookupChangeDataTriggerCriteriaChangeDataTrigger", "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 Change Data Trigger collection", "schema": { "$ref": "#/definitions/ChangeDataTriggerCriteriaChangeDataTriggerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/Criteria/Lookups/LookupChangeDataTriggerCriteriaChangePermissionTree": { "get": { "tags": [ "Change Data Trigger Criteria" ], "summary": "Lookup the permission set for changing the Change Data Trigger Criteria.", "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": "LookupChangeDataTriggerCriteriaChangePermissionTree", "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/ChangeDataTriggerCriteriaChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/Criteria/Lookups/LookupChangeDataTriggerCriteriaEntityProperty": { "get": { "tags": [ "Change Data Trigger Criteria" ], "summary": "Change Data Trigger Criteria", "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": "LookupChangeDataTriggerCriteriaEntityProperty", "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/ChangeDataTriggerCriteriaEntityPropertyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/Criteria/Lookups/LookupChangeDataTriggerCriteriaInsertPermissionTree": { "get": { "tags": [ "Change Data Trigger Criteria" ], "summary": "Lookup the permission set for creating the Change Data Trigger Criteria.", "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": "LookupChangeDataTriggerCriteriaInsertPermissionTree", "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/ChangeDataTriggerCriteriaInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/Criteria/Batch/{ids}": { "get": { "tags": [ "Change Data Trigger Criteria" ], "summary": "Get a collection of Change Data Trigger Criteria 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 | ChangeDataTriggerCriteria->IsActive | boolean | |\r\n| createdByUserId | ChangeDataTriggerCriteria->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ChangeDataTriggerCriteria->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ChangeDataTriggerCriteria->CreatedByUser_FullName | string | |\r\n| createdOn | ChangeDataTriggerCriteria->CreatedOn | string | date-time |\r\n| modifiedByUserId | ChangeDataTriggerCriteria->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ChangeDataTriggerCriteria->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ChangeDataTriggerCriteria->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ChangeDataTriggerCriteria->ModifiedOn | string | date-time |\r\n| version | ChangeDataTriggerCriteria->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerCriteria->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ChangeDataTriggerCriteria->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ChangeDataTriggerCriteria->PermissionTree_Description | string | |\r\n| id | ChangeDataTriggerCriteria->Id | integer | int64 |\r\n| changeDataTriggerId | ChangeDataTriggerCriteria->ChangeDataTrigger_Id | integer | int64 |\r\n| changeDataTriggerCode | ChangeDataTriggerCriteria->ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerDescription | ChangeDataTriggerCriteria->ChangeDataTrigger_Description | string | |\r\n| changeDataTriggerEntityType | ChangeDataTriggerCriteria->ChangeDataTrigger_EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| changeDataTriggerIsSystem | ChangeDataTriggerCriteria->ChangeDataTrigger_IsSystem | boolean | |\r\n| changeType | ChangeDataTriggerCriteria->ChangeType | string (Allowed values: [Unchanged, Created, Updated, Deleted]) | enum |\r\n| description | ChangeDataTriggerCriteria->Description | string | |\r\n| filterExpression | ChangeDataTriggerCriteria->FilterExpression | string | |\r\n| newValueExpression | ChangeDataTriggerCriteria->NewValueExpression | string | |\r\n| notes | ChangeDataTriggerCriteria->Notes | string | |\r\n| oldValueExpression | ChangeDataTriggerCriteria->OldValueExpression | string | |\r\n| repeatNotification | ChangeDataTriggerCriteria->RepeatNotification | string | duration |\r\n| repeatNotificationLimit | ChangeDataTriggerCriteria->RepeatNotificationLimit | integer | int32 |\r\n| sequenceNumber | ChangeDataTriggerCriteria->SequenceNumber | integer | int32 |\r\n| triggerProperties | ChangeDataTriggerCriteria->TriggerProperties | array | array |\r\n", "operationId": "BatchGetChangeDataTriggerCriteria", "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 Change Data Trigger Criteria 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 Change Data Trigger Criteria collection", "schema": { "$ref": "#/definitions/BatchGetChangeDataTriggerCriteriaResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/Criteria/Batch": { "post": { "tags": [ "Change Data Trigger Criteria" ], "summary": "Create a new collection of Change Data Trigger Criteria 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 | ChangeDataTriggerCriteria->PermissionTree_Id | integer | int64 |\r\n| changeDataTriggerId | ChangeDataTriggerCriteria->ChangeDataTrigger_Id | integer | int64 |\r\n| description | ChangeDataTriggerCriteria->Description | string | |\r\n| changeType | ChangeDataTriggerCriteria->ChangeType | string (Allowed values: [Unchanged, Created, Updated, Deleted]) | enum |\r\n| triggerProperties | ChangeDataTriggerCriteria->TriggerProperties | array | array |\r\n| filterExpression | ChangeDataTriggerCriteria->FilterExpression | string | |\r\n| isActive | ChangeDataTriggerCriteria->IsActive | boolean | |\r\n| newValueExpression | ChangeDataTriggerCriteria->NewValueExpression | string | |\r\n| oldValueExpression | ChangeDataTriggerCriteria->OldValueExpression | string | |\r\n| repeatNotification | ChangeDataTriggerCriteria->RepeatNotification | string | duration |\r\n| repeatNotificationLimit | ChangeDataTriggerCriteria->RepeatNotificationLimit | integer | int32 |\r\n| sequenceNumber | ChangeDataTriggerCriteria->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerCriteria->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| changeDataTriggerId | Required | True | |\r\n| changeDataTriggerId | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| changeType | Required | True | |\r\n| changeType | Nullable | False | |\r\n| isActive | Nullable | False | |\r\n| repeatNotification | Nullable | True | ChangeDataTriggerCriteria->FilterExpression eq null |\r\n| repeatNotificationLimit | Min Value | > 0| ChangeDataTriggerCriteria->RepeatNotificationLimit ne null |\r\n\r\n", "operationId": "BatchCreateChangeDataTriggerCriteria", "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/BatchCreateChangeDataTriggerCriteriaResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Change Data Trigger Criteria 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": [ "Change Data Trigger Criteria" ], "summary": "Update a collection of existing Change Data Trigger Criteria 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 | ChangeDataTriggerCriteria->Id | integer | int64 |\r\n| version | ChangeDataTriggerCriteria->Version | integer | int32 |\r\n| changeDataTriggerId | ChangeDataTriggerCriteria->ChangeDataTrigger_Id | integer | int64 |\r\n| triggerProperties | ChangeDataTriggerCriteria->TriggerProperties | array | array |\r\n| description | ChangeDataTriggerCriteria->Description | string | |\r\n| changeType | ChangeDataTriggerCriteria->ChangeType | string (Allowed values: [Unchanged, Created, Updated, Deleted]) | enum |\r\n| filterExpression | ChangeDataTriggerCriteria->FilterExpression | string | |\r\n| newValueExpression | ChangeDataTriggerCriteria->NewValueExpression | string | |\r\n| oldValueExpression | ChangeDataTriggerCriteria->OldValueExpression | string | |\r\n| repeatNotification | ChangeDataTriggerCriteria->RepeatNotification | string | duration |\r\n| repeatNotificationLimit | ChangeDataTriggerCriteria->RepeatNotificationLimit | integer | int32 |\r\n| sequenceNumber | ChangeDataTriggerCriteria->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerCriteria->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| changeDataTriggerId | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 255 chars| |\r\n| changeType | Nullable | False | |\r\n| repeatNotification | Nullable | True | ChangeDataTriggerCriteria->FilterExpression eq null |\r\n| repeatNotificationLimit | Min Value | > 0| ChangeDataTriggerCriteria->RepeatNotificationLimit ne null |\r\n\r\n", "operationId": "BatchUpdateChangeDataTriggerCriteria", "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/BatchUpdateChangeDataTriggerCriteriaResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Criteria 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": [ "Change Data Trigger Criteria" ], "summary": "Delete a collection of existing Change Data Trigger Criteria 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 | ChangeDataTriggerCriteria->Id | integer | int64 |\r\n| version | ChangeDataTriggerCriteria->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": "BatchDeleteChangeDataTriggerCriteria", "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/BatchDeleteChangeDataTriggerCriteriaResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Criteria 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/GEN/ChangeDataTriggers/Criteria/{id}/Active": { "patch": { "tags": [ "Change Data Trigger Criteria" ], "summary": "Change the IsActive status for an existing Change Data Trigger Criteria 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 | ChangeDataTriggerCriteria->Version | integer | int32 |\r\n| isActive | ChangeDataTriggerCriteria->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": "ChangeChangeDataTriggerCriteriaIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Criteria Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeChangeDataTriggerCriteriaIsActiveResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/Criteria/{id}/PermissionTree": { "patch": { "tags": [ "Change Data Trigger Criteria" ], "summary": "Change the PermissionTree for an existing Change Data Trigger Criteria 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 | ChangeDataTriggerCriteria->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerCriteria->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": "ChangeChangeDataTriggerCriteriaPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Criteria Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeChangeDataTriggerCriteriaPermissionTreeResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/Criteria/Batch/Active": { "patch": { "tags": [ "Change Data Trigger Criteria" ], "summary": "Change the IsActive status for a collection of existing Change Data Trigger Criteria 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 | ChangeDataTriggerCriteria->Id | integer | int64 |\r\n| version | ChangeDataTriggerCriteria->Version | integer | int32 |\r\n| isActive | ChangeDataTriggerCriteria->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": "BatchChangeChangeDataTriggerCriteriaIsActive", "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/BatchChangeChangeDataTriggerCriteriaIsActiveResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/Criteria/Batch/PermissionTree": { "patch": { "tags": [ "Change Data Trigger Criteria" ], "summary": "Change the PermissionTree status for a collection of existing Change Data Trigger Criteria 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 | ChangeDataTriggerCriteria->Id | integer | int64 |\r\n| version | ChangeDataTriggerCriteria->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerCriteria->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": "BatchChangeChangeDataTriggerCriteriaPermissionTree", "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/BatchChangeChangeDataTriggerCriteriaPermissionTreeResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/Criteria/Evaluation": { "get": { "tags": [ "Change Data Trigger Criteria Evaluation" ], "summary": "Get a collection of Change Data Trigger Criteria Evaluation records", "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 | ChangeDataTriggerCriteriaEvaluation->Id | integer | int64 |\r\n| entityType | ChangeDataTriggerCriteriaEvaluation->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| entityId | ChangeDataTriggerCriteriaEvaluation->EntityId | integer | int64 |\r\n| changeDataTriggerCode | ChangeDataTriggerCriteriaEvaluation->ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerCriteriaDescription | ChangeDataTriggerCriteriaEvaluation->ChangeDataTriggerCriteria_Description | string | |\r\n| evaluationAborted | ChangeDataTriggerCriteriaEvaluation->EvaluationAborted | boolean | |\r\n| criteriaPropertiesMatched | ChangeDataTriggerCriteriaEvaluation->CriteriaPropertiesMatched | boolean | |\r\n| filterExpressionMatched | ChangeDataTriggerCriteriaEvaluation->FilterExpressionMatched | boolean | |\r\n| oldValueExpressionMatched | ChangeDataTriggerCriteriaEvaluation->OldValueExpressionMatched | boolean | |\r\n| newValueExpressionMatched | ChangeDataTriggerCriteriaEvaluation->NewValueExpressionMatched | boolean | |\r\n| triggerCriteriaEvalMatched | ChangeDataTriggerCriteriaEvaluation->TriggerCriteriaEvalMatched | boolean | |\r\n| evaluatedOn | ChangeDataTriggerCriteriaEvaluation->EvaluatedOn | string | date-time |\r\n", "operationId": "GetChangeDataTriggerCriteriaEvaluationCollection", "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 Change Data Trigger Criteria Evaluation collection", "schema": { "$ref": "#/definitions/GetChangeDataTriggerCriteriaEvaluationCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/Criteria/Parameters/{id}": { "get": { "tags": [ "Change Data Trigger Criteria Parameter" ], "summary": "Get a Change Data Trigger Criteria Parameter 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 | ChangeDataTriggerCriteriaParameter->IsActive | boolean | |\r\n| createdByUserId | ChangeDataTriggerCriteriaParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ChangeDataTriggerCriteriaParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ChangeDataTriggerCriteriaParameter->CreatedByUser_FullName | string | |\r\n| createdOn | ChangeDataTriggerCriteriaParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | ChangeDataTriggerCriteriaParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ChangeDataTriggerCriteriaParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ChangeDataTriggerCriteriaParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ChangeDataTriggerCriteriaParameter->ModifiedOn | string | date-time |\r\n| version | ChangeDataTriggerCriteriaParameter->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerCriteriaParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ChangeDataTriggerCriteriaParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ChangeDataTriggerCriteriaParameter->PermissionTree_Description | string | |\r\n| id | ChangeDataTriggerCriteriaParameter->Id | integer | int64 |\r\n| changeDataTriggerCriteriaId | ChangeDataTriggerCriteriaParameter->ChangeDataTriggerCriteria_Id | integer | int64 |\r\n| changeDataTriggerCriteriaDescription | ChangeDataTriggerCriteriaParameter->ChangeDataTriggerCriteria_Description | string | |\r\n| expressionType | ChangeDataTriggerCriteriaParameter->ExpressionType | string (Allowed values: [FilterExpression, OldValueExpression, NewValueExpression]) | enum |\r\n| notes | ChangeDataTriggerCriteriaParameter->Notes | string | |\r\n| parameterName | ChangeDataTriggerCriteriaParameter->ParameterName | string | |\r\n| sequenceNumber | ChangeDataTriggerCriteriaParameter->SequenceNumber | integer | int32 |\r\n| value | ChangeDataTriggerCriteriaParameter->Value | object | composite |\r\n", "operationId": "GetChangeDataTriggerCriteriaParameter", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Criteria Parameter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Change Data Trigger Criteria Parameter", "schema": { "$ref": "#/definitions/GetChangeDataTriggerCriteriaParameterResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Change Data Trigger Criteria Parameter" ], "summary": "Update an existing Change Data Trigger Criteria Parameter 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 | ChangeDataTriggerCriteriaParameter->Version | integer | int32 |\r\n| parameterName | ChangeDataTriggerCriteriaParameter->ParameterName | string | |\r\n| expressionType | ChangeDataTriggerCriteriaParameter->ExpressionType | string (Allowed values: [FilterExpression, OldValueExpression, NewValueExpression]) | enum |\r\n| value | ChangeDataTriggerCriteriaParameter->Value | object | composite |\r\n| sequenceNumber | ChangeDataTriggerCriteriaParameter->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerCriteriaParameter->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| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| expressionType | Nullable | False | |\r\n| value | Nullable | False | |\r\n\r\n", "operationId": "UpdateChangeDataTriggerCriteriaParameter", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Criteria Parameter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateChangeDataTriggerCriteriaParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Criteria Parameter 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": [ "Change Data Trigger Criteria Parameter" ], "summary": "Delete an existing Change Data Trigger Criteria Parameter 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 | ChangeDataTriggerCriteriaParameter->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": "DeleteChangeDataTriggerCriteriaParameter", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Criteria Parameter Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteChangeDataTriggerCriteriaParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Criteria Parameter 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/GEN/ChangeDataTriggers/Criteria/Parameters": { "get": { "tags": [ "Change Data Trigger Criteria Parameter" ], "summary": "Get a collection of Change Data Trigger Criteria Parameter 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 | ChangeDataTriggerCriteriaParameter->Version | integer | int32 |\r\n| id | ChangeDataTriggerCriteriaParameter->Id | integer | int64 |\r\n| parameterName | ChangeDataTriggerCriteriaParameter->ParameterName | string | |\r\n| expressionType | ChangeDataTriggerCriteriaParameter->ExpressionType | string (Allowed values: [FilterExpression, OldValueExpression, NewValueExpression]) | enum |\r\n| isActive | ChangeDataTriggerCriteriaParameter->IsActive | boolean | |\r\n| sequenceNumber | ChangeDataTriggerCriteriaParameter->SequenceNumber | integer | int32 |\r\n| value | ChangeDataTriggerCriteriaParameter->Value | object | composite |\r\n| changeDataTriggerCriteriaId | ChangeDataTriggerCriteriaParameter->ChangeDataTriggerCriteria_Id | integer | int64 |\r\n| changeDataTriggerCriteriaDescription | ChangeDataTriggerCriteriaParameter->ChangeDataTriggerCriteria_Description | string | |\r\n", "operationId": "GetChangeDataTriggerCriteriaParameterCollection", "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 Change Data Trigger Criteria Parameter collection", "schema": { "$ref": "#/definitions/GetChangeDataTriggerCriteriaParameterCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Change Data Trigger Criteria Parameter" ], "summary": "Create a new Change Data Trigger Criteria Parameter 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| parameterName | ChangeDataTriggerCriteriaParameter->ParameterName | string | |\r\n| expressionType | ChangeDataTriggerCriteriaParameter->ExpressionType | string (Allowed values: [FilterExpression, OldValueExpression, NewValueExpression]) | enum |\r\n| permissionTreeId | ChangeDataTriggerCriteriaParameter->PermissionTree_Id | integer | int64 |\r\n| value | ChangeDataTriggerCriteriaParameter->Value | object | composite |\r\n| changeDataTriggerCriteriaId | ChangeDataTriggerCriteriaParameter->ChangeDataTriggerCriteria_Id | integer | int64 |\r\n| sequenceNumber | ChangeDataTriggerCriteriaParameter->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerCriteriaParameter->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| parameterName | Required | True | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| expressionType | Required | True | |\r\n| expressionType | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | Nullable | False | |\r\n| changeDataTriggerCriteriaId | Required | True | |\r\n| changeDataTriggerCriteriaId | Nullable | False | |\r\n\r\n", "operationId": "CreateChangeDataTriggerCriteriaParameter", "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/CreateChangeDataTriggerCriteriaParameterResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/Criteria/{changeDataTriggerCriteriaId}/Parameters": { "get": { "tags": [ "Change Data Trigger Criteria Parameter" ], "summary": "Get a collection of Change Data Trigger Criteria Parameter resources for the Change Data Trigger Criteria.", "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 | ChangeDataTriggerCriteriaParameter->Id | integer | int64 |\r\n| changeDataTriggerCriteriaId | ChangeDataTriggerCriteriaParameter->ChangeDataTriggerCriteria_Id | integer | int64 |\r\n| changeDataTriggerCriteriaDescription | ChangeDataTriggerCriteriaParameter->ChangeDataTriggerCriteria_Description | string | |\r\n| expressionType | ChangeDataTriggerCriteriaParameter->ExpressionType | string (Allowed values: [FilterExpression, OldValueExpression, NewValueExpression]) | enum |\r\n| parameterName | ChangeDataTriggerCriteriaParameter->ParameterName | string | |\r\n| value | ChangeDataTriggerCriteriaParameter->Value | object | composite |\r\n| isActive | ChangeDataTriggerCriteriaParameter->IsActive | boolean | |\r\n| version | ChangeDataTriggerCriteriaParameter->Version | integer | int32 |\r\n", "operationId": "GetChangeDataTriggerCriteriaParameterForChangeDataTriggerCriteriaCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "changeDataTriggerCriteriaId", "in": "path", "required": true, "description": "Change Data Trigger Criteria 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 Change Data Trigger Criteria Parameter collection", "schema": { "$ref": "#/definitions/GetChangeDataTriggerCriteriaParameterForChangeDataTriggerCriteriaCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/Criteria/Parameters/Lookups/LookupChangeDataTriggerCriteriaParameterChangeDataTriggerCriteria": { "get": { "tags": [ "Change Data Trigger Criteria Parameter" ], "summary": "Lookup the Change Data Trigger Criteria for the Change Data Trigger Criteria Parameter.", "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 | ChangeDataTriggerCriteria->Id | integer | int64 |\r\n| description | ChangeDataTriggerCriteria->Description | string | |\r\n", "operationId": "LookupChangeDataTriggerCriteriaParameterChangeDataTriggerCriteria", "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 Change Data Trigger Criteria collection", "schema": { "$ref": "#/definitions/ChangeDataTriggerCriteriaParametersChangeDataTriggerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/Criteria/Parameters/Lookups/LookupChangeDataTriggerCriteriaParameterChangePermissionTree": { "get": { "tags": [ "Change Data Trigger Criteria Parameter" ], "summary": "Lookup the permission set for changing the Change Data Trigger Criteria Parameter.", "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": "LookupChangeDataTriggerCriteriaParameterChangePermissionTree", "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/ChangeDataTriggerCriteriaParameterChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/Criteria/Parameters/Lookups/LookupChangeDataTriggerCriteriaParameterInsertPermissionTree": { "get": { "tags": [ "Change Data Trigger Criteria Parameter" ], "summary": "Lookup the permission set for creating the Change Data Trigger Criteria Parameter.", "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": "LookupChangeDataTriggerCriteriaParameterInsertPermissionTree", "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/ChangeDataTriggerCriteriaParameterInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/Criteria/Parameters/Batch/{ids}": { "get": { "tags": [ "Change Data Trigger Criteria Parameter" ], "summary": "Get a collection of Change Data Trigger Criteria Parameter 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 | ChangeDataTriggerCriteriaParameter->IsActive | boolean | |\r\n| createdByUserId | ChangeDataTriggerCriteriaParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ChangeDataTriggerCriteriaParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ChangeDataTriggerCriteriaParameter->CreatedByUser_FullName | string | |\r\n| createdOn | ChangeDataTriggerCriteriaParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | ChangeDataTriggerCriteriaParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ChangeDataTriggerCriteriaParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ChangeDataTriggerCriteriaParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ChangeDataTriggerCriteriaParameter->ModifiedOn | string | date-time |\r\n| version | ChangeDataTriggerCriteriaParameter->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerCriteriaParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ChangeDataTriggerCriteriaParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ChangeDataTriggerCriteriaParameter->PermissionTree_Description | string | |\r\n| id | ChangeDataTriggerCriteriaParameter->Id | integer | int64 |\r\n| changeDataTriggerCriteriaId | ChangeDataTriggerCriteriaParameter->ChangeDataTriggerCriteria_Id | integer | int64 |\r\n| changeDataTriggerCriteriaDescription | ChangeDataTriggerCriteriaParameter->ChangeDataTriggerCriteria_Description | string | |\r\n| expressionType | ChangeDataTriggerCriteriaParameter->ExpressionType | string (Allowed values: [FilterExpression, OldValueExpression, NewValueExpression]) | enum |\r\n| notes | ChangeDataTriggerCriteriaParameter->Notes | string | |\r\n| parameterName | ChangeDataTriggerCriteriaParameter->ParameterName | string | |\r\n| sequenceNumber | ChangeDataTriggerCriteriaParameter->SequenceNumber | integer | int32 |\r\n| value | ChangeDataTriggerCriteriaParameter->Value | object | composite |\r\n", "operationId": "BatchGetChangeDataTriggerCriteriaParameter", "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 Change Data Trigger Criteria Parameter 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 Change Data Trigger Criteria Parameter collection", "schema": { "$ref": "#/definitions/BatchGetChangeDataTriggerCriteriaParameterResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/Criteria/Parameters/Batch": { "post": { "tags": [ "Change Data Trigger Criteria Parameter" ], "summary": "Create a new collection of Change Data Trigger Criteria Parameter 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| parameterName | ChangeDataTriggerCriteriaParameter->ParameterName | string | |\r\n| expressionType | ChangeDataTriggerCriteriaParameter->ExpressionType | string (Allowed values: [FilterExpression, OldValueExpression, NewValueExpression]) | enum |\r\n| permissionTreeId | ChangeDataTriggerCriteriaParameter->PermissionTree_Id | integer | int64 |\r\n| value | ChangeDataTriggerCriteriaParameter->Value | object | composite |\r\n| changeDataTriggerCriteriaId | ChangeDataTriggerCriteriaParameter->ChangeDataTriggerCriteria_Id | integer | int64 |\r\n| sequenceNumber | ChangeDataTriggerCriteriaParameter->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerCriteriaParameter->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| parameterName | Required | True | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| expressionType | Required | True | |\r\n| expressionType | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | Nullable | False | |\r\n| changeDataTriggerCriteriaId | Required | True | |\r\n| changeDataTriggerCriteriaId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateChangeDataTriggerCriteriaParameter", "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/BatchCreateChangeDataTriggerCriteriaParameterRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Change Data Trigger Criteria Parameter 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": [ "Change Data Trigger Criteria Parameter" ], "summary": "Update a collection of existing Change Data Trigger Criteria Parameter 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 | ChangeDataTriggerCriteriaParameter->Id | integer | int64 |\r\n| version | ChangeDataTriggerCriteriaParameter->Version | integer | int32 |\r\n| parameterName | ChangeDataTriggerCriteriaParameter->ParameterName | string | |\r\n| expressionType | ChangeDataTriggerCriteriaParameter->ExpressionType | string (Allowed values: [FilterExpression, OldValueExpression, NewValueExpression]) | enum |\r\n| value | ChangeDataTriggerCriteriaParameter->Value | object | composite |\r\n| sequenceNumber | ChangeDataTriggerCriteriaParameter->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerCriteriaParameter->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| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| expressionType | Nullable | False | |\r\n| value | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateChangeDataTriggerCriteriaParameter", "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/BatchUpdateChangeDataTriggerCriteriaParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Criteria Parameter 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": [ "Change Data Trigger Criteria Parameter" ], "summary": "Delete a collection of existing Change Data Trigger Criteria Parameter 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 | ChangeDataTriggerCriteriaParameter->Id | integer | int64 |\r\n| version | ChangeDataTriggerCriteriaParameter->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": "BatchDeleteChangeDataTriggerCriteriaParameter", "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/BatchDeleteChangeDataTriggerCriteriaParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Criteria Parameter 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/GEN/ChangeDataTriggers/Criteria/Parameters/{id}/Active": { "patch": { "tags": [ "Change Data Trigger Criteria Parameter" ], "summary": "Change the IsActive status for an existing Change Data Trigger Criteria Parameter 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 | ChangeDataTriggerCriteriaParameter->Version | integer | int32 |\r\n| isActive | ChangeDataTriggerCriteriaParameter->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": "ChangeChangeDataTriggerCriteriaParameterIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Criteria Parameter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeChangeDataTriggerCriteriaParameterIsActiveResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/Criteria/Parameters/{id}/PermissionTree": { "patch": { "tags": [ "Change Data Trigger Criteria Parameter" ], "summary": "Change the PermissionTree for an existing Change Data Trigger Criteria Parameter 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 | ChangeDataTriggerCriteriaParameter->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerCriteriaParameter->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": "ChangeChangeDataTriggerCriteriaParameterPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Criteria Parameter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeChangeDataTriggerCriteriaParameterPermissionTreeResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/Criteria/Parameters/Batch/Active": { "patch": { "tags": [ "Change Data Trigger Criteria Parameter" ], "summary": "Change the IsActive status for a collection of existing Change Data Trigger Criteria Parameter 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 | ChangeDataTriggerCriteriaParameter->Id | integer | int64 |\r\n| version | ChangeDataTriggerCriteriaParameter->Version | integer | int32 |\r\n| isActive | ChangeDataTriggerCriteriaParameter->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": "BatchChangeChangeDataTriggerCriteriaParameterIsActive", "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/BatchChangeChangeDataTriggerCriteriaParameterIsActiveResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/Criteria/Parameters/Batch/PermissionTree": { "patch": { "tags": [ "Change Data Trigger Criteria Parameter" ], "summary": "Change the PermissionTree status for a collection of existing Change Data Trigger Criteria Parameter 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 | ChangeDataTriggerCriteriaParameter->Id | integer | int64 |\r\n| version | ChangeDataTriggerCriteriaParameter->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerCriteriaParameter->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": "BatchChangeChangeDataTriggerCriteriaParameterPermissionTree", "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/BatchChangeChangeDataTriggerCriteriaParameterPermissionTreeResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/NotificationEvents/{id}": { "get": { "tags": [ "Change Data Trigger Notification Event" ], "summary": "Get a Change Data Trigger Notification Event 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 | ChangeDataTriggerNotificationEvent->IsActive | boolean | |\r\n| createdByUserId | ChangeDataTriggerNotificationEvent->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ChangeDataTriggerNotificationEvent->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ChangeDataTriggerNotificationEvent->CreatedByUser_FullName | string | |\r\n| createdOn | ChangeDataTriggerNotificationEvent->CreatedOn | string | date-time |\r\n| modifiedByUserId | ChangeDataTriggerNotificationEvent->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ChangeDataTriggerNotificationEvent->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ChangeDataTriggerNotificationEvent->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ChangeDataTriggerNotificationEvent->ModifiedOn | string | date-time |\r\n| version | ChangeDataTriggerNotificationEvent->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerNotificationEvent->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ChangeDataTriggerNotificationEvent->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ChangeDataTriggerNotificationEvent->PermissionTree_Description | string | |\r\n| id | ChangeDataTriggerNotificationEvent->Id | integer | int64 |\r\n| audience | ChangeDataTriggerNotificationEvent->Audience | array | array |\r\n| changeDataTriggerId | ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Id | integer | int64 |\r\n| changeDataTriggerCode | ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerDescription | ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Description | string | |\r\n| ignoreTemplateAudience | ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience | boolean | |\r\n| notes | ChangeDataTriggerNotificationEvent->Notes | string | |\r\n| notificationTemplateId | ChangeDataTriggerNotificationEvent->NotificationTemplate_Id | integer | int64 |\r\n| notificationTemplateCode | ChangeDataTriggerNotificationEvent->NotificationTemplate_Code | string | |\r\n| notificationTemplateDescription | ChangeDataTriggerNotificationEvent->NotificationTemplate_Description | string | |\r\n| sequenceNumber | ChangeDataTriggerNotificationEvent->SequenceNumber | integer | int32 |\r\n", "operationId": "GetChangeDataTriggerNotificationEvent", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Notification Event Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Change Data Trigger Notification Event", "schema": { "$ref": "#/definitions/GetChangeDataTriggerNotificationEventResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Change Data Trigger Notification Event" ], "summary": "Update an existing Change Data Trigger Notification Event 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 | ChangeDataTriggerNotificationEvent->Version | integer | int32 |\r\n| ignoreTemplateAudience | ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience | boolean | |\r\n| audience | ChangeDataTriggerNotificationEvent->Audience | array | array |\r\n| sequenceNumber | ChangeDataTriggerNotificationEvent->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerNotificationEvent->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| audience | Nullable | False | ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience eq TRUE |\r\n\r\n", "operationId": "UpdateChangeDataTriggerNotificationEvent", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Notification Event Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateChangeDataTriggerNotificationEventResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Notification Event 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": [ "Change Data Trigger Notification Event" ], "summary": "Delete an existing Change Data Trigger Notification Event 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 | ChangeDataTriggerNotificationEvent->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": "DeleteChangeDataTriggerNotificationEvent", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Notification Event Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteChangeDataTriggerNotificationEventResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Notification Event 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/GEN/ChangeDataTriggers/NotificationEvents": { "get": { "tags": [ "Change Data Trigger Notification Event" ], "summary": "Get a collection of Change Data Trigger Notification Event 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 | ChangeDataTriggerNotificationEvent->Id | integer | int64 |\r\n| changeDataTriggerId | ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Id | integer | int64 |\r\n| changeDataTriggerCode | ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerDescription | ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Description | string | |\r\n| notificationTemplateId | ChangeDataTriggerNotificationEvent->NotificationTemplate_Id | integer | int64 |\r\n| notificationTemplateCode | ChangeDataTriggerNotificationEvent->NotificationTemplate_Code | string | |\r\n| notificationTemplateDescription | ChangeDataTriggerNotificationEvent->NotificationTemplate_Description | string | |\r\n| ignoreTemplateAudience | ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience | boolean | |\r\n| audience | ChangeDataTriggerNotificationEvent->Audience | array | array |\r\n| isActive | ChangeDataTriggerNotificationEvent->IsActive | boolean | |\r\n| version | ChangeDataTriggerNotificationEvent->Version | integer | int32 |\r\n", "operationId": "GetChangeDataTriggerNotificationEventCollection", "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 Change Data Trigger Notification Event collection", "schema": { "$ref": "#/definitions/GetChangeDataTriggerNotificationEventCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Change Data Trigger Notification Event" ], "summary": "Create a new Change Data Trigger Notification Event 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 | ChangeDataTriggerNotificationEvent->PermissionTree_Id | integer | int64 |\r\n| changeDataTriggerId | ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Id | integer | int64 |\r\n| notificationTemplateId | ChangeDataTriggerNotificationEvent->NotificationTemplate_Id | integer | int64 |\r\n| ignoreTemplateAudience | ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience | boolean | |\r\n| audience | ChangeDataTriggerNotificationEvent->Audience | array | array |\r\n| sequenceNumber | ChangeDataTriggerNotificationEvent->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerNotificationEvent->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| changeDataTriggerId | Required | True | |\r\n| changeDataTriggerId | Nullable | False | |\r\n| notificationTemplateId | Required | True | |\r\n| notificationTemplateId | Nullable | False | |\r\n| audience | Nullable | False | ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience eq TRUE |\r\n\r\n", "operationId": "CreateChangeDataTriggerNotificationEvent", "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/CreateChangeDataTriggerNotificationEventResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/{changeDataTriggerId}/NotificationEvents": { "get": { "tags": [ "Change Data Trigger Notification Event" ], "summary": "Get a collection of Change Data Trigger Notification Event resources for the Change Data Trigger.", "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 | ChangeDataTriggerNotificationEvent->Id | integer | int64 |\r\n| changeDataTriggerId | ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Id | integer | int64 |\r\n| changeDataTriggerCode | ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerDescription | ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Description | string | |\r\n| notificationTemplateId | ChangeDataTriggerNotificationEvent->NotificationTemplate_Id | integer | int64 |\r\n| notificationTemplateCode | ChangeDataTriggerNotificationEvent->NotificationTemplate_Code | string | |\r\n| notificationTemplateDescription | ChangeDataTriggerNotificationEvent->NotificationTemplate_Description | string | |\r\n| ignoreTemplateAudience | ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience | boolean | |\r\n| audience | ChangeDataTriggerNotificationEvent->Audience | array | array |\r\n| isActive | ChangeDataTriggerNotificationEvent->IsActive | boolean | |\r\n| version | ChangeDataTriggerNotificationEvent->Version | integer | int32 |\r\n", "operationId": "GetChangeDataTriggerNotificationEventForChangeDataTriggerCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "changeDataTriggerId", "in": "path", "required": true, "description": "Change Data Trigger 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 Change Data Trigger Notification Event collection", "schema": { "$ref": "#/definitions/GetChangeDataTriggerNotificationEventForChangeDataTriggerCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Lookups/LookupChangeDataTriggerNotificationEventChangeDataTrigger": { "get": { "tags": [ "Change Data Trigger Notification Event" ], "summary": "Lookup the Change Data Trigger for the Change Data Trigger Notification Event.", "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 | ChangeDataTrigger->Id | integer | int64 |\r\n| code | ChangeDataTrigger->Code | string | |\r\n| description | ChangeDataTrigger->Description | string | |\r\n| entityType | ChangeDataTrigger->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n", "operationId": "LookupChangeDataTriggerNotificationEventChangeDataTrigger", "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 Change Data Trigger collection", "schema": { "$ref": "#/definitions/ChangeDataTriggerNotificationEventChangeDataTriggerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Lookups/LookupChangeDataTriggerNotificationEventChangePermissionTree": { "get": { "tags": [ "Change Data Trigger Notification Event" ], "summary": "Lookup the permission set for changing the Change Data Trigger Notification Event.", "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": "LookupChangeDataTriggerNotificationEventChangePermissionTree", "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/ChangeDataTriggerNotificationEventChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Lookups/LookupChangeDataTriggerNotificationEventInsertPermissionTree": { "get": { "tags": [ "Change Data Trigger Notification Event" ], "summary": "Lookup the permission set for creating the Change Data Trigger Notification Event.", "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": "LookupChangeDataTriggerNotificationEventInsertPermissionTree", "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/ChangeDataTriggerNotificationEventInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Lookups/LookupChangeDataTriggerNotificationNotificationTemplateTemplate": { "get": { "tags": [ "Change Data Trigger Notification Event" ], "summary": "Lookup the Change Data Trigger for the Change Data Trigger Notification Event.", "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 | NotificationTemplate->Id | integer | int64 |\r\n| code | NotificationTemplate->Code | string | |\r\n| description | NotificationTemplate->Description | string | |\r\n| entityType | NotificationTemplate->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n", "operationId": "LookupChangeDataTriggerNotificationNotificationTemplateTemplate", "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 Notification Template collection", "schema": { "$ref": "#/definitions/ChangeDataTriggerNotificationNotificationTemplateTemplateLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Batch/{ids}": { "get": { "tags": [ "Change Data Trigger Notification Event" ], "summary": "Get a collection of Change Data Trigger Notification Event 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 | ChangeDataTriggerNotificationEvent->IsActive | boolean | |\r\n| createdByUserId | ChangeDataTriggerNotificationEvent->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ChangeDataTriggerNotificationEvent->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ChangeDataTriggerNotificationEvent->CreatedByUser_FullName | string | |\r\n| createdOn | ChangeDataTriggerNotificationEvent->CreatedOn | string | date-time |\r\n| modifiedByUserId | ChangeDataTriggerNotificationEvent->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ChangeDataTriggerNotificationEvent->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ChangeDataTriggerNotificationEvent->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ChangeDataTriggerNotificationEvent->ModifiedOn | string | date-time |\r\n| version | ChangeDataTriggerNotificationEvent->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerNotificationEvent->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ChangeDataTriggerNotificationEvent->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ChangeDataTriggerNotificationEvent->PermissionTree_Description | string | |\r\n| id | ChangeDataTriggerNotificationEvent->Id | integer | int64 |\r\n| audience | ChangeDataTriggerNotificationEvent->Audience | array | array |\r\n| changeDataTriggerId | ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Id | integer | int64 |\r\n| changeDataTriggerCode | ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerDescription | ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Description | string | |\r\n| ignoreTemplateAudience | ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience | boolean | |\r\n| notes | ChangeDataTriggerNotificationEvent->Notes | string | |\r\n| notificationTemplateId | ChangeDataTriggerNotificationEvent->NotificationTemplate_Id | integer | int64 |\r\n| notificationTemplateCode | ChangeDataTriggerNotificationEvent->NotificationTemplate_Code | string | |\r\n| notificationTemplateDescription | ChangeDataTriggerNotificationEvent->NotificationTemplate_Description | string | |\r\n| sequenceNumber | ChangeDataTriggerNotificationEvent->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetChangeDataTriggerNotificationEvent", "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 Change Data Trigger Notification Event 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 Change Data Trigger Notification Event collection", "schema": { "$ref": "#/definitions/BatchGetChangeDataTriggerNotificationEventResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Batch": { "post": { "tags": [ "Change Data Trigger Notification Event" ], "summary": "Create a new collection of Change Data Trigger Notification Event 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 | ChangeDataTriggerNotificationEvent->PermissionTree_Id | integer | int64 |\r\n| changeDataTriggerId | ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Id | integer | int64 |\r\n| notificationTemplateId | ChangeDataTriggerNotificationEvent->NotificationTemplate_Id | integer | int64 |\r\n| ignoreTemplateAudience | ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience | boolean | |\r\n| audience | ChangeDataTriggerNotificationEvent->Audience | array | array |\r\n| sequenceNumber | ChangeDataTriggerNotificationEvent->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerNotificationEvent->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| changeDataTriggerId | Required | True | |\r\n| changeDataTriggerId | Nullable | False | |\r\n| notificationTemplateId | Required | True | |\r\n| notificationTemplateId | Nullable | False | |\r\n| audience | Nullable | False | ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience eq TRUE |\r\n\r\n", "operationId": "BatchCreateChangeDataTriggerNotificationEvent", "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/BatchCreateChangeDataTriggerNotificationEventResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Change Data Trigger Notification Event 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": [ "Change Data Trigger Notification Event" ], "summary": "Update a collection of existing Change Data Trigger Notification Event 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 | ChangeDataTriggerNotificationEvent->Id | integer | int64 |\r\n| version | ChangeDataTriggerNotificationEvent->Version | integer | int32 |\r\n| ignoreTemplateAudience | ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience | boolean | |\r\n| audience | ChangeDataTriggerNotificationEvent->Audience | array | array |\r\n| sequenceNumber | ChangeDataTriggerNotificationEvent->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerNotificationEvent->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| audience | Nullable | False | ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience eq TRUE |\r\n\r\n", "operationId": "BatchUpdateChangeDataTriggerNotificationEvent", "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/BatchUpdateChangeDataTriggerNotificationEventResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Notification Event 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": [ "Change Data Trigger Notification Event" ], "summary": "Delete a collection of existing Change Data Trigger Notification Event 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 | ChangeDataTriggerNotificationEvent->Id | integer | int64 |\r\n| version | ChangeDataTriggerNotificationEvent->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": "BatchDeleteChangeDataTriggerNotificationEvent", "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/BatchDeleteChangeDataTriggerNotificationEventResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Notification Event 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/GEN/ChangeDataTriggers/NotificationEvents/{id}/Active": { "patch": { "tags": [ "Change Data Trigger Notification Event" ], "summary": "Change the IsActive status for an existing Change Data Trigger Notification Event 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 | ChangeDataTriggerNotificationEvent->Version | integer | int32 |\r\n| isActive | ChangeDataTriggerNotificationEvent->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": "ChangeChangeDataTriggerNotificationEventIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Notification Event Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeChangeDataTriggerNotificationEventIsActiveResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/NotificationEvents/{id}/PermissionTree": { "patch": { "tags": [ "Change Data Trigger Notification Event" ], "summary": "Change the PermissionTree for an existing Change Data Trigger Notification Event 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 | ChangeDataTriggerNotificationEvent->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerNotificationEvent->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": "ChangeChangeDataTriggerNotificationEventPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Notification Event Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeChangeDataTriggerNotificationEventPermissionTreeResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/NotificationEvents/Batch/PermissionTree": { "patch": { "tags": [ "Change Data Trigger Notification Event" ], "summary": "Change the PermissionTree status for a collection of existing Change Data Trigger Notification Event 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 | ChangeDataTriggerNotificationEvent->Id | integer | int64 |\r\n| version | ChangeDataTriggerNotificationEvent->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerNotificationEvent->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": "BatchChangeChangeDataTriggerNotificationEventPermissionTree", "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/BatchChangeChangeDataTriggerNotificationEventPermissionTreeResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/NotificationEvents/Batch/Active": { "patch": { "tags": [ "Change Data Trigger Notification Event" ], "summary": "Change the IsActive status for a collection of existing Change Data Trigger Notification Event 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 | ChangeDataTriggerNotificationEvent->Id | integer | int64 |\r\n| version | ChangeDataTriggerNotificationEvent->Version | integer | int32 |\r\n| isActive | ChangeDataTriggerNotificationEvent->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": "BatchChangeChangeDataTriggerNotificationEventIsActive", "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/BatchChangeChangeDataTriggerNotificationEventIsActiveResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/NotificationEvents/Attachments/{id}": { "get": { "tags": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Get a Change Data Trigger Notification Event Attachment 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 | ChangeDataTriggerNotificationEventAttachment->Code | string | |\r\n| isActive | ChangeDataTriggerNotificationEventAttachment->IsActive | boolean | |\r\n| createdByUserId | ChangeDataTriggerNotificationEventAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ChangeDataTriggerNotificationEventAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ChangeDataTriggerNotificationEventAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | ChangeDataTriggerNotificationEventAttachment->CreatedOn | string | date-time |\r\n| modifiedByUserId | ChangeDataTriggerNotificationEventAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ChangeDataTriggerNotificationEventAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ChangeDataTriggerNotificationEventAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ChangeDataTriggerNotificationEventAttachment->ModifiedOn | string | date-time |\r\n| version | ChangeDataTriggerNotificationEventAttachment->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerNotificationEventAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ChangeDataTriggerNotificationEventAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ChangeDataTriggerNotificationEventAttachment->PermissionTree_Description | string | |\r\n| id | ChangeDataTriggerNotificationEventAttachment->Id | integer | int64 |\r\n| attachmentType | ChangeDataTriggerNotificationEventAttachment->AttachmentType | string (Allowed values: [Report]) | enum |\r\n| changeDataTriggerNotificationEventId | ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_Id | integer | int64 |\r\n| changeDataTriggerNotificationEventChangeDataTriggerId | ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_ChangeDataTrigger_Id | integer | int64 |\r\n| changeDataTriggerNotificationEventChangeDataTriggerCode | ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerNotificationEventChangeDataTriggerDescription | ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_ChangeDataTrigger_Description | string | |\r\n| notes | ChangeDataTriggerNotificationEventAttachment->Notes | string | |\r\n| reportFormat | ChangeDataTriggerNotificationEventAttachment->ReportFormat | string (Allowed values: [Pdf, Csv, Excel, Docx, Html, Image, Json]) | enum |\r\n| reportName | ChangeDataTriggerNotificationEventAttachment->ReportName | string | |\r\n| reportUserFullName | ChangeDataTriggerNotificationEventAttachment->ReportUserFullName | string | |\r\n| reportUserId | ChangeDataTriggerNotificationEventAttachment->ReportUserId | string | |\r\n| reportUserName | ChangeDataTriggerNotificationEventAttachment->ReportUserName | string | |\r\n| runAsAdminUser | ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser | boolean | |\r\n| sequenceNumber | ChangeDataTriggerNotificationEventAttachment->SequenceNumber | integer | int32 |\r\n", "operationId": "GetChangeDataTriggerNotificationEventAttachment", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Notification Event Attachment Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Change Data Trigger Notification Event Attachment", "schema": { "$ref": "#/definitions/GetChangeDataTriggerNotificationEventAttachmentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Update an existing Change Data Trigger Notification Event Attachment 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 | ChangeDataTriggerNotificationEventAttachment->Version | integer | int32 |\r\n| code | ChangeDataTriggerNotificationEventAttachment->Code | string | |\r\n| reportName | ChangeDataTriggerNotificationEventAttachment->ReportName | string | |\r\n| reportFormat | ChangeDataTriggerNotificationEventAttachment->ReportFormat | string (Allowed values: [Pdf, Csv, Excel, Docx, Html, Image, Json]) | enum |\r\n| runAsAdminUser | ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser | boolean | |\r\n| reportPassword | ChangeDataTriggerNotificationEventAttachment->ReportPassword | string | password |\r\n| reportUserId | ChangeDataTriggerNotificationEventAttachment->ReportUserId | string | |\r\n| sequenceNumber | ChangeDataTriggerNotificationEventAttachment->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerNotificationEventAttachment->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| reportName | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' |\r\n| reportName | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' |\r\n| reportFormat | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' |\r\n| reportPassword | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false |\r\n| reportPassword | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false |\r\n| reportUserId | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false |\r\n| reportUserId | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false |\r\n\r\n", "operationId": "UpdateChangeDataTriggerNotificationEventAttachment", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Notification Event Attachment Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateChangeDataTriggerNotificationEventAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Notification Event Attachment 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": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Delete an existing Change Data Trigger Notification Event Attachment 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 | ChangeDataTriggerNotificationEventAttachment->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": "DeleteChangeDataTriggerNotificationEventAttachment", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Notification Event Attachment Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteChangeDataTriggerNotificationEventAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Notification Event Attachment 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/GEN/ChangeDataTriggers/NotificationEvents/Attachments": { "get": { "tags": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Get a collection of Change Data Trigger Notification Event Attachment 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 | ChangeDataTriggerNotificationEventAttachment->Id | integer | int64 |\r\n| code | ChangeDataTriggerNotificationEventAttachment->Code | string | |\r\n| reportName | ChangeDataTriggerNotificationEventAttachment->ReportName | string | |\r\n| attachmentType | ChangeDataTriggerNotificationEventAttachment->AttachmentType | string (Allowed values: [Report]) | enum |\r\n| runAsAdminUser | ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser | boolean | |\r\n| isActive | ChangeDataTriggerNotificationEventAttachment->IsActive | boolean | |\r\n| version | ChangeDataTriggerNotificationEventAttachment->Version | integer | int32 |\r\n| changeDataTriggerNotificationEventChangeDataTriggerId | ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_ChangeDataTrigger_Id | integer | int64 |\r\n| changeDataTriggerNotificationEventChangeDataTriggerCode | ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerNotificationEventChangeDataTriggerDescription | ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_ChangeDataTrigger_Description | string | |\r\n| changeDataTriggerNotificationEventNotificationTemplateId | ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_NotificationTemplate_Id | integer | int64 |\r\n| changeDataTriggerNotificationEventNotificationTemplateCode | ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_NotificationTemplate_Code | string | |\r\n| changeDataTriggerNotificationEventNotificationTemplateDescription | ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_NotificationTemplate_Description | string | |\r\n", "operationId": "GetChangeDataTriggerNotificationEventAttachmentCollection", "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 Change Data Trigger Notification Event Attachment collection", "schema": { "$ref": "#/definitions/GetChangeDataTriggerNotificationEventAttachmentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Create a new Change Data Trigger Notification Event Attachment 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| changeDataTriggerNotificationEventId | ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_Id | integer | int64 |\r\n| permissionTreeId | ChangeDataTriggerNotificationEventAttachment->PermissionTree_Id | integer | int64 |\r\n| code | ChangeDataTriggerNotificationEventAttachment->Code | string | |\r\n| attachmentType | ChangeDataTriggerNotificationEventAttachment->AttachmentType | string (Allowed values: [Report]) | enum |\r\n| reportName | ChangeDataTriggerNotificationEventAttachment->ReportName | string | |\r\n| reportFormat | ChangeDataTriggerNotificationEventAttachment->ReportFormat | string (Allowed values: [Pdf, Csv, Excel, Docx, Html, Image, Json]) | enum |\r\n| runAsAdminUser | ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser | boolean | |\r\n| reportPassword | ChangeDataTriggerNotificationEventAttachment->ReportPassword | string | password |\r\n| reportUserId | ChangeDataTriggerNotificationEventAttachment->ReportUserId | string | |\r\n| sequenceNumber | ChangeDataTriggerNotificationEventAttachment->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerNotificationEventAttachment->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| changeDataTriggerNotificationEventId | Required | True | |\r\n| changeDataTriggerNotificationEventId | Nullable | False | |\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| attachmentType | Required | True | |\r\n| attachmentType | Nullable | False | |\r\n| reportName | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' |\r\n| reportName | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' |\r\n| reportFormat | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' |\r\n| reportPassword | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false |\r\n| reportPassword | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false |\r\n| reportUserId | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false |\r\n| reportUserId | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false |\r\n\r\n", "operationId": "CreateChangeDataTriggerNotificationEventAttachment", "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/CreateChangeDataTriggerNotificationEventAttachmentResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/NotificationEvents/{changeDataTriggerNotificationEventId}/Attachments": { "get": { "tags": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Get a collection of Change Data Trigger Notification Event Attachment resources for the Change Data Trigger.", "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 | ChangeDataTriggerNotificationEventAttachment->Id | integer | int64 |\r\n| reportName | ChangeDataTriggerNotificationEventAttachment->ReportName | string | |\r\n| code | ChangeDataTriggerNotificationEventAttachment->Code | string | |\r\n| attachmentType | ChangeDataTriggerNotificationEventAttachment->AttachmentType | string (Allowed values: [Report]) | enum |\r\n| runAsAdminUser | ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser | boolean | |\r\n| isActive | ChangeDataTriggerNotificationEventAttachment->IsActive | boolean | |\r\n| version | ChangeDataTriggerNotificationEventAttachment->Version | integer | int32 |\r\n", "operationId": "GetChangeDataTriggerNotificationEventAttachmentForChangeDataTriggerNotificationEventCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "changeDataTriggerNotificationEventId", "in": "path", "required": true, "description": "Change Data Trigger Notification Event 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 Change Data Trigger Notification Event Attachment collection", "schema": { "$ref": "#/definitions/GetChangeDataTriggerNotificationEventAttachmentForChangeDataTriggerNotificationEventCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Lookups/LookupChangeDataTriggerNotificationEventAttachmentInsertPermissionTree": { "get": { "tags": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Lookup the permission set for creating the Change Data Trigger Notification Event Attachment.", "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": "LookupChangeDataTriggerNotificationEventAttachmentInsertPermissionTree", "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/ChangeDataTriggerNotificationEventAttachmentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Lookups/LookupChangeDataTriggerNotificationEventAttachmentChangeDataTriggerNotificationEvent": { "get": { "tags": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Lookup the Change Data Trigger for the Change Data Trigger Notification Event Attachment.", "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 | ChangeDataTriggerNotificationEvent->Id | integer | int64 |\r\n| changeDataTriggerId | ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Id | integer | int64 |\r\n| changeDataTriggerCode | ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerDescription | ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Description | string | |\r\n| notificationTemplateId | ChangeDataTriggerNotificationEvent->NotificationTemplate_Id | integer | int64 |\r\n| notificationTemplateCode | ChangeDataTriggerNotificationEvent->NotificationTemplate_Code | string | |\r\n| notificationTemplateDescription | ChangeDataTriggerNotificationEvent->NotificationTemplate_Description | string | |\r\n", "operationId": "LookupChangeDataTriggerNotificationEventAttachmentChangeDataTriggerNotificationEvent", "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 Change Data Trigger Notification Event collection", "schema": { "$ref": "#/definitions/ChangeDataTriggerNotificationEventAttachmentChangeDataTriggerNotificationEventLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Lookups/LookupChangeDataTriggerNotificationEventAttachmentChangePermissionTree": { "get": { "tags": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Lookup the permission set for changing the Change Data Trigger Notification Event Attachment.", "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": "LookupChangeDataTriggerNotificationEventAttachmentChangePermissionTree", "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/ChangeDataTriggerNotificationEventAttachmentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Lookups/LookupChangeDataTriggerNotificationEventAttachmentReport": { "get": { "tags": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Change Data Trigger Notification Event Attachment", "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 | ReportServerReport->Id | string | |\r\n| title | ReportServerReport->Title | string | |\r\n| description | ReportServerReport->Description | string | |\r\n| category | ReportServerReport->Category | string | |\r\n", "operationId": "LookupChangeDataTriggerNotificationEventAttachmentReport", "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/ChangeDataTriggerNotificationEventAttachmentReportLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Lookups/LookupChangeDataTriggerNotificationEventAttachmentReportUser": { "get": { "tags": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Change Data Trigger Notification Event Attachment", "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 | ReportServerUser->Id | string | |\r\n| email | ReportServerUser->Email | string | |\r\n| firstName | ReportServerUser->FirstName | string | |\r\n| lastName | ReportServerUser->LastName | string | |\r\n| fullName | ReportServerUser->FullName | string | |\r\n| userName | ReportServerUser->UserName | string | |\r\n", "operationId": "LookupChangeDataTriggerNotificationEventAttachmentReportUser", "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/ChangeDataTriggerNotificationEventAttachmentReportUserLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Batch/{ids}": { "get": { "tags": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Get a collection of Change Data Trigger Notification Event Attachment 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 | ChangeDataTriggerNotificationEventAttachment->Code | string | |\r\n| isActive | ChangeDataTriggerNotificationEventAttachment->IsActive | boolean | |\r\n| createdByUserId | ChangeDataTriggerNotificationEventAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ChangeDataTriggerNotificationEventAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ChangeDataTriggerNotificationEventAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | ChangeDataTriggerNotificationEventAttachment->CreatedOn | string | date-time |\r\n| modifiedByUserId | ChangeDataTriggerNotificationEventAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ChangeDataTriggerNotificationEventAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ChangeDataTriggerNotificationEventAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ChangeDataTriggerNotificationEventAttachment->ModifiedOn | string | date-time |\r\n| version | ChangeDataTriggerNotificationEventAttachment->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerNotificationEventAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ChangeDataTriggerNotificationEventAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ChangeDataTriggerNotificationEventAttachment->PermissionTree_Description | string | |\r\n| id | ChangeDataTriggerNotificationEventAttachment->Id | integer | int64 |\r\n| attachmentType | ChangeDataTriggerNotificationEventAttachment->AttachmentType | string (Allowed values: [Report]) | enum |\r\n| changeDataTriggerNotificationEventId | ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_Id | integer | int64 |\r\n| changeDataTriggerNotificationEventChangeDataTriggerId | ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_ChangeDataTrigger_Id | integer | int64 |\r\n| changeDataTriggerNotificationEventChangeDataTriggerCode | ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerNotificationEventChangeDataTriggerDescription | ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_ChangeDataTrigger_Description | string | |\r\n| notes | ChangeDataTriggerNotificationEventAttachment->Notes | string | |\r\n| reportFormat | ChangeDataTriggerNotificationEventAttachment->ReportFormat | string (Allowed values: [Pdf, Csv, Excel, Docx, Html, Image, Json]) | enum |\r\n| reportName | ChangeDataTriggerNotificationEventAttachment->ReportName | string | |\r\n| reportUserFullName | ChangeDataTriggerNotificationEventAttachment->ReportUserFullName | string | |\r\n| reportUserId | ChangeDataTriggerNotificationEventAttachment->ReportUserId | string | |\r\n| reportUserName | ChangeDataTriggerNotificationEventAttachment->ReportUserName | string | |\r\n| runAsAdminUser | ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser | boolean | |\r\n| sequenceNumber | ChangeDataTriggerNotificationEventAttachment->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetChangeDataTriggerNotificationEventAttachment", "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 Change Data Trigger Notification Event Attachment 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 Change Data Trigger Notification Event Attachment collection", "schema": { "$ref": "#/definitions/BatchGetChangeDataTriggerNotificationEventAttachmentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Batch": { "post": { "tags": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Create a new collection of Change Data Trigger Notification Event Attachment 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| changeDataTriggerNotificationEventId | ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_Id | integer | int64 |\r\n| permissionTreeId | ChangeDataTriggerNotificationEventAttachment->PermissionTree_Id | integer | int64 |\r\n| code | ChangeDataTriggerNotificationEventAttachment->Code | string | |\r\n| attachmentType | ChangeDataTriggerNotificationEventAttachment->AttachmentType | string (Allowed values: [Report]) | enum |\r\n| reportFormat | ChangeDataTriggerNotificationEventAttachment->ReportFormat | string (Allowed values: [Pdf, Csv, Excel, Docx, Html, Image, Json]) | enum |\r\n| reportName | ChangeDataTriggerNotificationEventAttachment->ReportName | string | |\r\n| runAsAdminUser | ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser | boolean | |\r\n| reportPassword | ChangeDataTriggerNotificationEventAttachment->ReportPassword | string | password |\r\n| reportUserId | ChangeDataTriggerNotificationEventAttachment->ReportUserId | string | |\r\n| sequenceNumber | ChangeDataTriggerNotificationEventAttachment->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerNotificationEventAttachment->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| changeDataTriggerNotificationEventId | Required | True | |\r\n| changeDataTriggerNotificationEventId | Nullable | False | |\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| attachmentType | Required | True | |\r\n| attachmentType | Nullable | False | |\r\n| reportFormat | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' |\r\n| reportName | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' |\r\n| reportName | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' |\r\n| reportPassword | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false |\r\n| reportPassword | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false |\r\n| reportUserId | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false |\r\n| reportUserId | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false |\r\n\r\n", "operationId": "BatchCreateChangeDataTriggerNotificationEventAttachment", "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/BatchCreateChangeDataTriggerNotificationEventAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Change Data Trigger Notification Event Attachment 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": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Update a collection of existing Change Data Trigger Notification Event Attachment 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 | ChangeDataTriggerNotificationEventAttachment->Id | integer | int64 |\r\n| version | ChangeDataTriggerNotificationEventAttachment->Version | integer | int32 |\r\n| code | ChangeDataTriggerNotificationEventAttachment->Code | string | |\r\n| reportFormat | ChangeDataTriggerNotificationEventAttachment->ReportFormat | string (Allowed values: [Pdf, Csv, Excel, Docx, Html, Image, Json]) | enum |\r\n| reportName | ChangeDataTriggerNotificationEventAttachment->ReportName | string | |\r\n| runAsAdminUser | ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser | boolean | |\r\n| reportPassword | ChangeDataTriggerNotificationEventAttachment->ReportPassword | string | password |\r\n| reportUserId | ChangeDataTriggerNotificationEventAttachment->ReportUserId | string | |\r\n| sequenceNumber | ChangeDataTriggerNotificationEventAttachment->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerNotificationEventAttachment->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| reportFormat | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' |\r\n| reportName | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' |\r\n| reportName | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' |\r\n| reportPassword | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false |\r\n| reportPassword | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false |\r\n| reportUserId | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false |\r\n| reportUserId | Nullable | False | ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false |\r\n\r\n", "operationId": "BatchUpdateChangeDataTriggerNotificationEventAttachment", "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/BatchUpdateChangeDataTriggerNotificationEventAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Notification Event Attachment 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": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Delete a collection of existing Change Data Trigger Notification Event Attachment 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 | ChangeDataTriggerNotificationEventAttachment->Id | integer | int64 |\r\n| version | ChangeDataTriggerNotificationEventAttachment->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": "BatchDeleteChangeDataTriggerNotificationEventAttachment", "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/BatchDeleteChangeDataTriggerNotificationEventAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Notification Event Attachment 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/GEN/ChangeDataTriggers/NotificationEvents/Attachments/{id}/Active": { "patch": { "tags": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Change the IsActive status for an existing Change Data Trigger Notification Event Attachment 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 | ChangeDataTriggerNotificationEventAttachment->Version | integer | int32 |\r\n| isActive | ChangeDataTriggerNotificationEventAttachment->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": "ChangeChangeDataTriggerNotificationEventAttachmentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Notification Event Attachment Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeChangeDataTriggerNotificationEventAttachmentIsActiveResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/NotificationEvents/Attachments/{id}/PermissionTree": { "patch": { "tags": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Change the PermissionTree for an existing Change Data Trigger Notification Event Attachment 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 | ChangeDataTriggerNotificationEventAttachment->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerNotificationEventAttachment->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": "ChangeChangeDataTriggerNotificationEventAttachmentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Notification Event Attachment Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeChangeDataTriggerNotificationEventAttachmentPermissionTreeResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Batch/Active": { "patch": { "tags": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Change the IsActive status for a collection of existing Change Data Trigger Notification Event Attachment 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 | ChangeDataTriggerNotificationEventAttachment->Id | integer | int64 |\r\n| version | ChangeDataTriggerNotificationEventAttachment->Version | integer | int32 |\r\n| isActive | ChangeDataTriggerNotificationEventAttachment->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": "BatchChangeChangeDataTriggerNotificationEventAttachmentIsActive", "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/BatchChangeChangeDataTriggerNotificationEventAttachmentIsActiveResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Batch/PermissionTree": { "patch": { "tags": [ "Change Data Trigger Notification Event Attachment" ], "summary": "Change the PermissionTree status for a collection of existing Change Data Trigger Notification Event Attachment 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 | ChangeDataTriggerNotificationEventAttachment->Id | integer | int64 |\r\n| version | ChangeDataTriggerNotificationEventAttachment->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerNotificationEventAttachment->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": "BatchChangeChangeDataTriggerNotificationEventAttachmentPermissionTree", "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/BatchChangeChangeDataTriggerNotificationEventAttachmentPermissionTreeResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Parameters/{id}": { "get": { "tags": [ "Change Data Trigger Notification Event Attachment Parameter" ], "summary": "Get a Change Data Trigger Notification Event Attachment Parameter 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 | ChangeDataTriggerNotificationEventAttachmentParameter->IsActive | boolean | |\r\n| createdByUserId | ChangeDataTriggerNotificationEventAttachmentParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ChangeDataTriggerNotificationEventAttachmentParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ChangeDataTriggerNotificationEventAttachmentParameter->CreatedByUser_FullName | string | |\r\n| createdOn | ChangeDataTriggerNotificationEventAttachmentParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | ChangeDataTriggerNotificationEventAttachmentParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ChangeDataTriggerNotificationEventAttachmentParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ChangeDataTriggerNotificationEventAttachmentParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ChangeDataTriggerNotificationEventAttachmentParameter->ModifiedOn | string | date-time |\r\n| version | ChangeDataTriggerNotificationEventAttachmentParameter->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerNotificationEventAttachmentParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ChangeDataTriggerNotificationEventAttachmentParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ChangeDataTriggerNotificationEventAttachmentParameter->PermissionTree_Description | string | |\r\n| id | ChangeDataTriggerNotificationEventAttachmentParameter->Id | integer | int64 |\r\n| changeDataTriggerNotificationEventAttachmentId | ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_Id | integer | int64 |\r\n| changeDataTriggerNotificationEventAttachmentCode | ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_Code | string | |\r\n| changeDataTriggerNotificationEventAttachmentReportName | ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_ReportName | string | |\r\n| notes | ChangeDataTriggerNotificationEventAttachmentParameter->Notes | string | |\r\n| parameterName | ChangeDataTriggerNotificationEventAttachmentParameter->ParameterName | string | |\r\n| sequenceNumber | ChangeDataTriggerNotificationEventAttachmentParameter->SequenceNumber | integer | int32 |\r\n| value | ChangeDataTriggerNotificationEventAttachmentParameter->Value | object | composite |\r\n", "operationId": "GetChangeDataTriggerNotificationEventAttachmentParameter", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Notification Event Attachment Parameter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Change Data Trigger Notification Event Attachment Parameter", "schema": { "$ref": "#/definitions/GetChangeDataTriggerNotificationEventAttachmentParameterResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Change Data Trigger Notification Event Attachment Parameter" ], "summary": "Update an existing Change Data Trigger Notification Event Attachment Parameter 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 | ChangeDataTriggerNotificationEventAttachmentParameter->Version | integer | int32 |\r\n| parameterName | ChangeDataTriggerNotificationEventAttachmentParameter->ParameterName | string | |\r\n| value | ChangeDataTriggerNotificationEventAttachmentParameter->Value | object | composite |\r\n| sequenceNumber | ChangeDataTriggerNotificationEventAttachmentParameter->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerNotificationEventAttachmentParameter->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| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| value | Nullable | False | |\r\n\r\n", "operationId": "UpdateChangeDataTriggerNotificationEventAttachmentParameter", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Notification Event Attachment Parameter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Notification Event Attachment Parameter 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": [ "Change Data Trigger Notification Event Attachment Parameter" ], "summary": "Delete an existing Change Data Trigger Notification Event Attachment Parameter 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 | ChangeDataTriggerNotificationEventAttachmentParameter->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": "DeleteChangeDataTriggerNotificationEventAttachmentParameter", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Notification Event Attachment Parameter Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Notification Event Attachment Parameter 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/GEN/ChangeDataTriggers/NotificationEvents/Attachments/{changeDataTriggerNotificationEventAttachmentId}/Parameters": { "get": { "tags": [ "Change Data Trigger Notification Event Attachment Parameter" ], "summary": "Get a collection of Change Data Trigger Notification Event Attachment Parameter resources for the Change Data Trigger Notification Event Attachment.", "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 | ChangeDataTriggerNotificationEventAttachmentParameter->Id | integer | int64 |\r\n| changeDataTriggerNotificationEventAttachmentId | ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_Id | integer | int64 |\r\n| changeDataTriggerNotificationEventAttachmentCode | ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_Code | string | |\r\n| parameterName | ChangeDataTriggerNotificationEventAttachmentParameter->ParameterName | string | |\r\n| value | ChangeDataTriggerNotificationEventAttachmentParameter->Value | object | composite |\r\n| isActive | ChangeDataTriggerNotificationEventAttachmentParameter->IsActive | boolean | |\r\n| version | ChangeDataTriggerNotificationEventAttachmentParameter->Version | integer | int32 |\r\n", "operationId": "GetChangeDataTriggerNotificationEventAttachmentParameterForChangeDataTriggerNotificationEventAttachmentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "changeDataTriggerNotificationEventAttachmentId", "in": "path", "required": true, "description": "Change Data Trigger Notification Event Attachment 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 Change Data Trigger Notification Event Attachment Parameter collection", "schema": { "$ref": "#/definitions/GetChangeDataTriggerNotificationEventAttachmentParameterForChangeDataTriggerNotificationEventAttachmentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Parameters": { "get": { "tags": [ "Change Data Trigger Notification Event Attachment Parameter" ], "summary": "Get a collection of Change Data Trigger Notification Event Attachment Parameter 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 | ChangeDataTriggerNotificationEventAttachmentParameter->Version | integer | int32 |\r\n| id | ChangeDataTriggerNotificationEventAttachmentParameter->Id | integer | int64 |\r\n| parameterName | ChangeDataTriggerNotificationEventAttachmentParameter->ParameterName | string | |\r\n| isActive | ChangeDataTriggerNotificationEventAttachmentParameter->IsActive | boolean | |\r\n| sequenceNumber | ChangeDataTriggerNotificationEventAttachmentParameter->SequenceNumber | integer | int32 |\r\n| value | ChangeDataTriggerNotificationEventAttachmentParameter->Value | object | composite |\r\n| changeDataTriggerNotificationEventAttachmentId | ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_Id | integer | int64 |\r\n| changeDataTriggerNotificationEventAttachmentCode | ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_Code | string | |\r\n", "operationId": "GetChangeDataTriggerNotificationEventAttachmentParameterCollection", "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 Change Data Trigger Notification Event Attachment Parameter collection", "schema": { "$ref": "#/definitions/GetChangeDataTriggerNotificationEventAttachmentParameterCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Change Data Trigger Notification Event Attachment Parameter" ], "summary": "Create a new Change Data Trigger Notification Event Attachment Parameter 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| parameterName | ChangeDataTriggerNotificationEventAttachmentParameter->ParameterName | string | |\r\n| permissionTreeId | ChangeDataTriggerNotificationEventAttachmentParameter->PermissionTree_Id | integer | int64 |\r\n| value | ChangeDataTriggerNotificationEventAttachmentParameter->Value | object | composite |\r\n| changeDataTriggerNotificationEventAttachmentId | ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_Id | integer | int64 |\r\n| sequenceNumber | ChangeDataTriggerNotificationEventAttachmentParameter->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerNotificationEventAttachmentParameter->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| parameterName | Required | True | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | Nullable | False | |\r\n| changeDataTriggerNotificationEventAttachmentId | Required | True | |\r\n| changeDataTriggerNotificationEventAttachmentId | Nullable | False | |\r\n\r\n", "operationId": "CreateChangeDataTriggerNotificationEventAttachmentParameter", "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/CreateChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Parameters/Lookups/LookupChangeDataTriggerNotificationEventAttachmentParameterChangePermissionTree": { "get": { "tags": [ "Change Data Trigger Notification Event Attachment Parameter" ], "summary": "Lookup the permission set for changing the Change Data Trigger Notification Event Attachment Parameter.", "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": "LookupChangeDataTriggerNotificationEventAttachmentParameterChangePermissionTree", "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/ChangeDataTriggerNotificationEventAttachmentParameterChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Parameters/Lookups/LookupChangeDataTriggerNotificationEventAttachmentParameterInsertPermissionTree": { "get": { "tags": [ "Change Data Trigger Notification Event Attachment Parameter" ], "summary": "Lookup the permission set for creating the Change Data Trigger Notification Event Attachment Parameter.", "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": "LookupChangeDataTriggerNotificationEventAttachmentParameterInsertPermissionTree", "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/ChangeDataTriggerNotificationEventAttachmentParameterInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Parameters/Lookups/LookupChangeDataTriggerNotificationEventAttachmentParameterChangeDataTriggerNotificationEventAttachment": { "get": { "tags": [ "Change Data Trigger Notification Event Attachment Parameter" ], "summary": "Lookup the Change Data Trigger Criteria for the Change Data Trigger Notification Event Attachment Parameter.", "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 | ChangeDataTriggerNotificationEventAttachment->Id | integer | int64 |\r\n| code | ChangeDataTriggerNotificationEventAttachment->Code | string | |\r\n| reportName | ChangeDataTriggerNotificationEventAttachment->ReportName | string | |\r\n", "operationId": "LookupChangeDataTriggerNotificationEventAttachmentParameterChangeDataTriggerNotificationEventAttachment", "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 Change Data Trigger Notification Event Attachment collection", "schema": { "$ref": "#/definitions/ChangeDataTriggerNotificationEventAttachmentParameterChangeDataTriggerNotificationEventAttachmentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Parameters/Batch/{ids}": { "get": { "tags": [ "Change Data Trigger Notification Event Attachment Parameter" ], "summary": "Get a collection of Change Data Trigger Notification Event Attachment Parameter 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 | ChangeDataTriggerNotificationEventAttachmentParameter->IsActive | boolean | |\r\n| createdByUserId | ChangeDataTriggerNotificationEventAttachmentParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ChangeDataTriggerNotificationEventAttachmentParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ChangeDataTriggerNotificationEventAttachmentParameter->CreatedByUser_FullName | string | |\r\n| createdOn | ChangeDataTriggerNotificationEventAttachmentParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | ChangeDataTriggerNotificationEventAttachmentParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ChangeDataTriggerNotificationEventAttachmentParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ChangeDataTriggerNotificationEventAttachmentParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ChangeDataTriggerNotificationEventAttachmentParameter->ModifiedOn | string | date-time |\r\n| version | ChangeDataTriggerNotificationEventAttachmentParameter->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerNotificationEventAttachmentParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ChangeDataTriggerNotificationEventAttachmentParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ChangeDataTriggerNotificationEventAttachmentParameter->PermissionTree_Description | string | |\r\n| id | ChangeDataTriggerNotificationEventAttachmentParameter->Id | integer | int64 |\r\n| changeDataTriggerNotificationEventAttachmentId | ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_Id | integer | int64 |\r\n| changeDataTriggerNotificationEventAttachmentCode | ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_Code | string | |\r\n| changeDataTriggerNotificationEventAttachmentReportName | ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_ReportName | string | |\r\n| notes | ChangeDataTriggerNotificationEventAttachmentParameter->Notes | string | |\r\n| parameterName | ChangeDataTriggerNotificationEventAttachmentParameter->ParameterName | string | |\r\n| sequenceNumber | ChangeDataTriggerNotificationEventAttachmentParameter->SequenceNumber | integer | int32 |\r\n| value | ChangeDataTriggerNotificationEventAttachmentParameter->Value | object | composite |\r\n", "operationId": "BatchGetChangeDataTriggerNotificationEventAttachmentParameter", "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 Change Data Trigger Notification Event Attachment Parameter 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 Change Data Trigger Notification Event Attachment Parameter collection", "schema": { "$ref": "#/definitions/BatchGetChangeDataTriggerNotificationEventAttachmentParameterResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Parameters/Batch": { "post": { "tags": [ "Change Data Trigger Notification Event Attachment Parameter" ], "summary": "Create a new collection of Change Data Trigger Notification Event Attachment Parameter 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| parameterName | ChangeDataTriggerNotificationEventAttachmentParameter->ParameterName | string | |\r\n| permissionTreeId | ChangeDataTriggerNotificationEventAttachmentParameter->PermissionTree_Id | integer | int64 |\r\n| value | ChangeDataTriggerNotificationEventAttachmentParameter->Value | object | composite |\r\n| changeDataTriggerNotificationEventAttachmentId | ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_Id | integer | int64 |\r\n| sequenceNumber | ChangeDataTriggerNotificationEventAttachmentParameter->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerNotificationEventAttachmentParameter->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| parameterName | Required | True | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | Nullable | False | |\r\n| changeDataTriggerNotificationEventAttachmentId | Required | True | |\r\n| changeDataTriggerNotificationEventAttachmentId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateChangeDataTriggerNotificationEventAttachmentParameter", "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/BatchCreateChangeDataTriggerNotificationEventAttachmentParameterRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Change Data Trigger Notification Event Attachment Parameter 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": [ "Change Data Trigger Notification Event Attachment Parameter" ], "summary": "Update a collection of existing Change Data Trigger Notification Event Attachment Parameter 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 | ChangeDataTriggerNotificationEventAttachmentParameter->Id | integer | int64 |\r\n| version | ChangeDataTriggerNotificationEventAttachmentParameter->Version | integer | int32 |\r\n| parameterName | ChangeDataTriggerNotificationEventAttachmentParameter->ParameterName | string | |\r\n| value | ChangeDataTriggerNotificationEventAttachmentParameter->Value | object | composite |\r\n| sequenceNumber | ChangeDataTriggerNotificationEventAttachmentParameter->SequenceNumber | integer | int32 |\r\n| notes | ChangeDataTriggerNotificationEventAttachmentParameter->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| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| value | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateChangeDataTriggerNotificationEventAttachmentParameter", "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/BatchUpdateChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Notification Event Attachment Parameter 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": [ "Change Data Trigger Notification Event Attachment Parameter" ], "summary": "Delete a collection of existing Change Data Trigger Notification Event Attachment Parameter 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 | ChangeDataTriggerNotificationEventAttachmentParameter->Id | integer | int64 |\r\n| version | ChangeDataTriggerNotificationEventAttachmentParameter->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": "BatchDeleteChangeDataTriggerNotificationEventAttachmentParameter", "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/BatchDeleteChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Change Data Trigger Notification Event Attachment Parameter 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/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Parameters/{id}/Active": { "patch": { "tags": [ "Change Data Trigger Notification Event Attachment Parameter" ], "summary": "Change the IsActive status for an existing Change Data Trigger Notification Event Attachment Parameter 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 | ChangeDataTriggerNotificationEventAttachmentParameter->Version | integer | int32 |\r\n| isActive | ChangeDataTriggerNotificationEventAttachmentParameter->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": "ChangeChangeDataTriggerNotificationEventAttachmentParameterIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Notification Event Attachment Parameter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeChangeDataTriggerNotificationEventAttachmentParameterIsActiveResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Parameters/{id}/PermissionTree": { "patch": { "tags": [ "Change Data Trigger Notification Event Attachment Parameter" ], "summary": "Change the PermissionTree for an existing Change Data Trigger Notification Event Attachment Parameter 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 | ChangeDataTriggerNotificationEventAttachmentParameter->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerNotificationEventAttachmentParameter->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": "ChangeChangeDataTriggerNotificationEventAttachmentParameterPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Notification Event Attachment Parameter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeChangeDataTriggerNotificationEventAttachmentParameterPermissionTreeResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Parameters/Batch/Active": { "patch": { "tags": [ "Change Data Trigger Notification Event Attachment Parameter" ], "summary": "Change the IsActive status for a collection of existing Change Data Trigger Notification Event Attachment Parameter 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 | ChangeDataTriggerNotificationEventAttachmentParameter->Id | integer | int64 |\r\n| version | ChangeDataTriggerNotificationEventAttachmentParameter->Version | integer | int32 |\r\n| isActive | ChangeDataTriggerNotificationEventAttachmentParameter->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": "BatchChangeChangeDataTriggerNotificationEventAttachmentParameterIsActive", "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/BatchChangeChangeDataTriggerNotificationEventAttachmentParameterIsActiveResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/NotificationEvents/Attachments/Parameters/Batch/PermissionTree": { "patch": { "tags": [ "Change Data Trigger Notification Event Attachment Parameter" ], "summary": "Change the PermissionTree status for a collection of existing Change Data Trigger Notification Event Attachment Parameter 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 | ChangeDataTriggerNotificationEventAttachmentParameter->Id | integer | int64 |\r\n| version | ChangeDataTriggerNotificationEventAttachmentParameter->Version | integer | int32 |\r\n| permissionTreeId | ChangeDataTriggerNotificationEventAttachmentParameter->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": "BatchChangeChangeDataTriggerNotificationEventAttachmentParameterPermissionTree", "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/BatchChangeChangeDataTriggerNotificationEventAttachmentParameterPermissionTreeResourceActionRequest" } }, { "$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/GEN/ChangeDataTriggers/ExecutionLogs/{id}": { "get": { "tags": [ "Change Data Trigger Occurrence Log" ], "summary": "Get a Change Data Trigger Occurrence Log 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 | ChangeDataTriggerOccurrenceLog->Id | integer | int64 |\r\n| version | ChangeDataTriggerOccurrenceLog->Version | integer | int32 |\r\n| changeDataTriggerId | ChangeDataTriggerOccurrenceLog->ChangeDataTrigger_Id | integer | int64 |\r\n| changeDataTriggerCode | ChangeDataTriggerOccurrenceLog->ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerCriteriaId | ChangeDataTriggerOccurrenceLog->ChangeDataTriggerCriteria_Id | integer | int64 |\r\n| changeDataTriggerCriteriaDescription | ChangeDataTriggerOccurrenceLog->ChangeDataTriggerCriteria_Description | string | |\r\n| entityId | ChangeDataTriggerOccurrenceLog->EntityId | integer | int64 |\r\n| entityType | ChangeDataTriggerOccurrenceLog->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| nextOccurrenceDate | ChangeDataTriggerOccurrenceLog->NextOccurrenceDate | string | date-time |\r\n| occurrenceDate | ChangeDataTriggerOccurrenceLog->OccurrenceDate | string | date-time |\r\n| recurrenceActive | ChangeDataTriggerOccurrenceLog->RecurrenceActive | boolean | |\r\n| recurrenceCount | ChangeDataTriggerOccurrenceLog->RecurrenceCount | integer | int32 |\r\n", "operationId": "GetChangeDataTriggerOccurrenceLog", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Change Data Trigger Occurrence Log Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Change Data Trigger Occurrence Log", "schema": { "$ref": "#/definitions/GetChangeDataTriggerOccurrenceLogResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/ExecutionLogs": { "get": { "tags": [ "Change Data Trigger Occurrence Log" ], "summary": "Get a collection of Change Data Trigger Occurrence Log 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 | ChangeDataTriggerOccurrenceLog->Id | integer | int64 |\r\n| version | ChangeDataTriggerOccurrenceLog->Version | integer | int32 |\r\n| entityType | ChangeDataTriggerOccurrenceLog->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| entityId | ChangeDataTriggerOccurrenceLog->EntityId | integer | int64 |\r\n| changeDataTriggerCode | ChangeDataTriggerOccurrenceLog->ChangeDataTrigger_Code | string | |\r\n| occurrenceDate | ChangeDataTriggerOccurrenceLog->OccurrenceDate | string | date-time |\r\n| nextOccurrenceDate | ChangeDataTriggerOccurrenceLog->NextOccurrenceDate | string | date-time |\r\n", "operationId": "GetChangeDataTriggerOccurrenceLogCollection", "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 Change Data Trigger Occurrence Log collection", "schema": { "$ref": "#/definitions/GetChangeDataTriggerOccurrenceLogCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/ChangeDataTriggers/ExecutionLogs/Batch/{ids}": { "get": { "tags": [ "Change Data Trigger Occurrence Log" ], "summary": "Get a collection of Change Data Trigger Occurrence Log 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| id | ChangeDataTriggerOccurrenceLog->Id | integer | int64 |\r\n| version | ChangeDataTriggerOccurrenceLog->Version | integer | int32 |\r\n| changeDataTriggerId | ChangeDataTriggerOccurrenceLog->ChangeDataTrigger_Id | integer | int64 |\r\n| changeDataTriggerCode | ChangeDataTriggerOccurrenceLog->ChangeDataTrigger_Code | string | |\r\n| changeDataTriggerCriteriaId | ChangeDataTriggerOccurrenceLog->ChangeDataTriggerCriteria_Id | integer | int64 |\r\n| changeDataTriggerCriteriaDescription | ChangeDataTriggerOccurrenceLog->ChangeDataTriggerCriteria_Description | string | |\r\n| entityId | ChangeDataTriggerOccurrenceLog->EntityId | integer | int64 |\r\n| entityType | ChangeDataTriggerOccurrenceLog->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| nextOccurrenceDate | ChangeDataTriggerOccurrenceLog->NextOccurrenceDate | string | date-time |\r\n| occurrenceDate | ChangeDataTriggerOccurrenceLog->OccurrenceDate | string | date-time |\r\n| recurrenceActive | ChangeDataTriggerOccurrenceLog->RecurrenceActive | boolean | |\r\n| recurrenceCount | ChangeDataTriggerOccurrenceLog->RecurrenceCount | integer | int32 |\r\n", "operationId": "BatchGetChangeDataTriggerOccurrenceLog", "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 Change Data Trigger Occurrence Log 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 Change Data Trigger Occurrence Log collection", "schema": { "$ref": "#/definitions/BatchGetChangeDataTriggerOccurrenceLogResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Classifications/{id}": { "get": { "tags": [ "Classification" ], "summary": "Get a Classification 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 | Classification->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Classification->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Classification->CreatedByUser_FullName | string | |\r\n| createdOn | Classification->CreatedOn | string | date-time |\r\n| modifiedByUserId | Classification->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Classification->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Classification->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Classification->ModifiedOn | string | date-time |\r\n| permissionTreeId | Classification->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Classification->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Classification->PermissionTree_Description | string | |\r\n| version | Classification->Version | integer | int32 |\r\n| id | Classification->Id | integer | int64 |\r\n| classificationNumber | Classification->ClassificationNumber | integer | int32 |\r\n| classificationType | Classification->ClassificationType | string (Allowed values: [WorkOrder, Task, TaskFeedback, CalendarHour, PurchaseOrder, WorkOrderStatus]) | enum |\r\n| description | Classification->Description | string | |\r\n| notes | Classification->Notes | string | |\r\n", "operationId": "GetClassification", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Classification Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Classification", "schema": { "$ref": "#/definitions/GetClassificationResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Classification" ], "summary": "Update an existing Classification 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 | Classification->Version | integer | int32 |\r\n| description | Classification->Description | string | |\r\n| permissionTreeId | Classification->PermissionTree_Id | integer | int64 |\r\n| notes | Classification->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| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "UpdateClassification", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Classification Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateClassificationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Classification 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/GEN/Classifications": { "get": { "tags": [ "Classification" ], "summary": "Get a collection of Classification 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 | Classification->Version | integer | int32 |\r\n| id | Classification->Id | integer | int64 |\r\n| permissionTreeId | Classification->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Classification->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Classification->PermissionTree_Description | string | |\r\n| classificationType | Classification->ClassificationType | string (Allowed values: [WorkOrder, Task, TaskFeedback, CalendarHour, PurchaseOrder, WorkOrderStatus]) | enum |\r\n| description | Classification->Description | string | |\r\n| classificationNumber | Classification->ClassificationNumber | integer | int32 |\r\n| notes | Classification->Notes | string | |\r\n", "operationId": "GetClassificationCollection", "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 collection", "schema": { "$ref": "#/definitions/GetClassificationCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Classifications/Lookups/LookupClassificationChangePermissionTree": { "get": { "tags": [ "Classification" ], "summary": "Lookup the permission set for changing the Classification.", "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": "LookupClassificationChangePermissionTree", "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/ClassificationChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Classifications/Batch/{ids}": { "get": { "tags": [ "Classification" ], "summary": "Get a collection of Classification 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 | Classification->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Classification->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Classification->CreatedByUser_FullName | string | |\r\n| createdOn | Classification->CreatedOn | string | date-time |\r\n| modifiedByUserId | Classification->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Classification->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Classification->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Classification->ModifiedOn | string | date-time |\r\n| permissionTreeId | Classification->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Classification->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Classification->PermissionTree_Description | string | |\r\n| version | Classification->Version | integer | int32 |\r\n| id | Classification->Id | integer | int64 |\r\n| classificationNumber | Classification->ClassificationNumber | integer | int32 |\r\n| classificationType | Classification->ClassificationType | string (Allowed values: [WorkOrder, Task, TaskFeedback, CalendarHour, PurchaseOrder, WorkOrderStatus]) | enum |\r\n| description | Classification->Description | string | |\r\n| notes | Classification->Notes | string | |\r\n", "operationId": "BatchGetClassification", "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 Classification 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 Classification collection", "schema": { "$ref": "#/definitions/BatchGetClassificationResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Classifications/Batch": { "patch": { "tags": [ "Classification" ], "summary": "Update a collection of existing Classification 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 | Classification->Id | integer | int64 |\r\n| version | Classification->Version | integer | int32 |\r\n| permissionTreeId | Classification->PermissionTree_Id | integer | int64 |\r\n| description | Classification->Description | string | |\r\n| notes | Classification->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| permissionTreeId | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateClassification", "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/BatchUpdateClassificationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Classification 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/GEN/Classifications/{id}/PermissionTree": { "patch": { "tags": [ "Classification" ], "summary": "Change the PermissionTree for an existing Classification 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 | Classification->Version | integer | int32 |\r\n| permissionTreeId | Classification->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": "ChangeClassificationPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Classification Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeClassificationPermissionTreeResourceActionRequest" } }, { "$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/GEN/Classifications/Batch/PermissionTree": { "patch": { "tags": [ "Classification" ], "summary": "Change the PermissionTree status for a collection of existing Classification 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 | Classification->Id | integer | int64 |\r\n| version | Classification->Version | integer | int32 |\r\n| permissionTreeId | Classification->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": "BatchChangeClassificationPermissionTree", "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/BatchChangeClassificationPermissionTreeResourceActionRequest" } }, { "$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/GEN/Classifications/AllowedValues/{id}": { "get": { "tags": [ "Classification Allowed Value" ], "summary": "Get a Classification Allowed Value 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 | ClassificationAllowedValue->IsActive | boolean | |\r\n| createdByUserId | ClassificationAllowedValue->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ClassificationAllowedValue->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ClassificationAllowedValue->CreatedByUser_FullName | string | |\r\n| createdOn | ClassificationAllowedValue->CreatedOn | string | date-time |\r\n| modifiedByUserId | ClassificationAllowedValue->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ClassificationAllowedValue->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ClassificationAllowedValue->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ClassificationAllowedValue->ModifiedOn | string | date-time |\r\n| version | ClassificationAllowedValue->Version | integer | int32 |\r\n| permissionTreeId | ClassificationAllowedValue->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ClassificationAllowedValue->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ClassificationAllowedValue->PermissionTree_Description | string | |\r\n| id | ClassificationAllowedValue->Id | integer | int64 |\r\n| classificationId | ClassificationAllowedValue->Classification_Id | integer | int64 |\r\n| classificationDescription | ClassificationAllowedValue->Classification_Description | string | |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n| notes | ClassificationAllowedValue->Notes | string | |\r\n| sequenceNumber | ClassificationAllowedValue->SequenceNumber | integer | int32 |\r\n", "operationId": "GetClassificationAllowedValue", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Classification Allowed Value Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Classification Allowed Value", "schema": { "$ref": "#/definitions/GetClassificationAllowedValueResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Classification Allowed Value" ], "summary": "Update an existing Classification Allowed Value 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 | ClassificationAllowedValue->Version | integer | int32 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n| notes | ClassificationAllowedValue->Notes | string | |\r\n| sequenceNumber | ClassificationAllowedValue->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| description | Nullable | False | |\r\n\r\n", "operationId": "UpdateClassificationAllowedValue", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Classification Allowed Value Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateClassificationAllowedValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Classification Allowed Value 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": [ "Classification Allowed Value" ], "summary": "Delete an existing Classification Allowed Value 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 | ClassificationAllowedValue->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": "DeleteClassificationAllowedValue", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Classification Allowed Value Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteClassificationAllowedValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Classification Allowed Value 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/GEN/Classifications/AllowedValues": { "get": { "tags": [ "Classification Allowed Value" ], "summary": "Get a collection of Classification Allowed Value 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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| version | ClassificationAllowedValue->Version | integer | int32 |\r\n| isActive | ClassificationAllowedValue->IsActive | boolean | |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n| sequenceNumber | ClassificationAllowedValue->SequenceNumber | integer | int32 |\r\n| classificationId | ClassificationAllowedValue->Classification_Id | integer | int64 |\r\n| classificationClassificationType | ClassificationAllowedValue->Classification_ClassificationType | string (Allowed values: [WorkOrder, Task, TaskFeedback, CalendarHour, PurchaseOrder, WorkOrderStatus]) | enum |\r\n| classificationDescription | ClassificationAllowedValue->Classification_Description | string | |\r\n", "operationId": "GetClassificationAllowedValueCollection", "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/GetClassificationAllowedValueCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Classification Allowed Value" ], "summary": "Create a new Classification Allowed Value 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 | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n| classificationId | ClassificationAllowedValue->Classification_Id | integer | int64 |\r\n| permissionTreeId | ClassificationAllowedValue->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | ClassificationAllowedValue->SequenceNumber | integer | int32 |\r\n| notes | ClassificationAllowedValue->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| description | Required | True | |\r\n| description | Nullable | False | |\r\n| classificationId | Required | True | |\r\n| classificationId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateClassificationAllowedValue", "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/CreateClassificationAllowedValueResourceActionRequest" } }, { "$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/GEN/Classifications/{id}/AllowedValues": { "get": { "tags": [ "Classification Allowed Value" ], "summary": "Get a list of Classification Allowed Value resources for the Classification.", "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| version | ClassificationAllowedValue->Version | integer | int32 |\r\n| isActive | ClassificationAllowedValue->IsActive | boolean | |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n| classificationId | ClassificationAllowedValue->Classification_Id | integer | int64 |\r\n| classificationClassificationType | ClassificationAllowedValue->Classification_ClassificationType | string (Allowed values: [WorkOrder, Task, TaskFeedback, CalendarHour, PurchaseOrder, WorkOrderStatus]) | enum |\r\n| classificationDescription | ClassificationAllowedValue->Classification_Description | string | |\r\n| sequenceNumber | ClassificationAllowedValue->SequenceNumber | integer | int32 |\r\n", "operationId": "GetClassificationAllowedValueForClassificationCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Classification 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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/GetClassificationAllowedValueForClassificationCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Classifications/AllowedValues/Lookups/LookupClassificationAllowedValueChangePermissionTree": { "get": { "tags": [ "Classification Allowed Value" ], "summary": "Lookup the permission set for changing the Classification Allowed Value.", "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": "LookupClassificationAllowedValueChangePermissionTree", "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/ClassificationAllowedValueChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Classifications/AllowedValues/Lookups/LookupClassificationAllowedValueClassification": { "get": { "tags": [ "Classification Allowed Value" ], "summary": "Lookup the Classification for the Classification Allowed Value.", "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 | Classification->Id | integer | int64 |\r\n| classificationType | Classification->ClassificationType | string (Allowed values: [WorkOrder, Task, TaskFeedback, CalendarHour, PurchaseOrder, WorkOrderStatus]) | enum |\r\n| description | Classification->Description | string | |\r\n", "operationId": "LookupClassificationAllowedValueClassification", "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 collection", "schema": { "$ref": "#/definitions/ClassificationAllowedValueClassificationLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Classifications/AllowedValues/Lookups/LookupClassificationAllowedValueInsertPermissionTree": { "get": { "tags": [ "Classification Allowed Value" ], "summary": "Lookup the permission set for creating the Classification Allowed Value.", "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": "LookupClassificationAllowedValueInsertPermissionTree", "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/ClassificationAllowedValueInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Classifications/AllowedValues/Batch/{ids}": { "get": { "tags": [ "Classification Allowed Value" ], "summary": "Get a collection of Classification Allowed Value 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 | ClassificationAllowedValue->IsActive | boolean | |\r\n| createdByUserId | ClassificationAllowedValue->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | ClassificationAllowedValue->CreatedByUser_Code | string | |\r\n| createdByUserFullName | ClassificationAllowedValue->CreatedByUser_FullName | string | |\r\n| createdOn | ClassificationAllowedValue->CreatedOn | string | date-time |\r\n| modifiedByUserId | ClassificationAllowedValue->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | ClassificationAllowedValue->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | ClassificationAllowedValue->ModifiedByUser_FullName | string | |\r\n| modifiedOn | ClassificationAllowedValue->ModifiedOn | string | date-time |\r\n| version | ClassificationAllowedValue->Version | integer | int32 |\r\n| permissionTreeId | ClassificationAllowedValue->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | ClassificationAllowedValue->PermissionTree_Code | string | |\r\n| permissionTreeDescription | ClassificationAllowedValue->PermissionTree_Description | string | |\r\n| id | ClassificationAllowedValue->Id | integer | int64 |\r\n| classificationId | ClassificationAllowedValue->Classification_Id | integer | int64 |\r\n| classificationDescription | ClassificationAllowedValue->Classification_Description | string | |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n| notes | ClassificationAllowedValue->Notes | string | |\r\n| sequenceNumber | ClassificationAllowedValue->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetClassificationAllowedValue", "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 Classification Allowed Value 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 Classification Allowed Value collection", "schema": { "$ref": "#/definitions/BatchGetClassificationAllowedValueResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Classifications/AllowedValues/Batch": { "post": { "tags": [ "Classification Allowed Value" ], "summary": "Create a new collection of Classification Allowed Value 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 | ClassificationAllowedValue->Notes | string | |\r\n| classificationId | ClassificationAllowedValue->Classification_Id | integer | int64 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n| permissionTreeId | ClassificationAllowedValue->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | ClassificationAllowedValue->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| classificationId | Required | True | |\r\n| classificationId | Nullable | False | |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateClassificationAllowedValue", "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/BatchCreateClassificationAllowedValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Classification Allowed Value 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": [ "Classification Allowed Value" ], "summary": "Update a collection of existing Classification Allowed Value 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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| version | ClassificationAllowedValue->Version | integer | int32 |\r\n| code | ClassificationAllowedValue->Code | string | |\r\n| description | ClassificationAllowedValue->Description | string | |\r\n| notes | ClassificationAllowedValue->Notes | string | |\r\n| sequenceNumber | ClassificationAllowedValue->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| description | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateClassificationAllowedValue", "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/BatchUpdateClassificationAllowedValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Classification Allowed Value 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": [ "Classification Allowed Value" ], "summary": "Delete a collection of existing Classification Allowed Value 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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| version | ClassificationAllowedValue->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": "BatchDeleteClassificationAllowedValue", "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/BatchDeleteClassificationAllowedValueResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Classification Allowed Value 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/GEN/Classifications/AllowedValues/{id}/Active": { "patch": { "tags": [ "Classification Allowed Value" ], "summary": "Change the IsActive status for an existing Classification Allowed Value 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 | ClassificationAllowedValue->Version | integer | int32 |\r\n| isActive | ClassificationAllowedValue->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": "ChangeClassificationAllowedValueIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Classification Allowed Value Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeClassificationAllowedValueIsActiveResourceActionRequest" } }, { "$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/GEN/Classifications/AllowedValues/{id}/PermissionTree": { "patch": { "tags": [ "Classification Allowed Value" ], "summary": "Change the PermissionTree for an existing Classification Allowed Value 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 | ClassificationAllowedValue->Version | integer | int32 |\r\n| permissionTreeId | ClassificationAllowedValue->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": "ChangeClassificationAllowedValuePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Classification Allowed Value Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeClassificationAllowedValuePermissionTreeResourceActionRequest" } }, { "$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/GEN/Classifications/AllowedValues/Batch/Active": { "patch": { "tags": [ "Classification Allowed Value" ], "summary": "Change the IsActive status for a collection of existing Classification Allowed Value 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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| version | ClassificationAllowedValue->Version | integer | int32 |\r\n| isActive | ClassificationAllowedValue->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": "BatchChangeClassificationAllowedValueIsActive", "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/BatchChangeClassificationAllowedValueIsActiveResourceActionRequest" } }, { "$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/GEN/Classifications/AllowedValues/Batch/PermissionTree": { "patch": { "tags": [ "Classification Allowed Value" ], "summary": "Change the PermissionTree status for a collection of existing Classification Allowed Value 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 | ClassificationAllowedValue->Id | integer | int64 |\r\n| version | ClassificationAllowedValue->Version | integer | int32 |\r\n| permissionTreeId | ClassificationAllowedValue->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": "BatchChangeClassificationAllowedValuePermissionTree", "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/BatchChangeClassificationAllowedValuePermissionTreeResourceActionRequest" } }, { "$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/GEN/EmailTypes/{id}": { "get": { "tags": [ "Email Type" ], "summary": "Get a Email Type 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 | EmailType->Code | string | |\r\n| createdByUserId | EmailType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | EmailType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | EmailType->CreatedByUser_FullName | string | |\r\n| createdOn | EmailType->CreatedOn | string | date-time |\r\n| isActive | EmailType->IsActive | boolean | |\r\n| modifiedByUserId | EmailType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | EmailType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | EmailType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | EmailType->ModifiedOn | string | date-time |\r\n| permissionTreeId | EmailType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | EmailType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | EmailType->PermissionTree_Description | string | |\r\n| version | EmailType->Version | integer | int32 |\r\n| id | EmailType->Id | integer | int64 |\r\n| description | EmailType->Description | string | |\r\n| notes | EmailType->Notes | string | |\r\n| sequenceNumber | EmailType->SequenceNumber | integer | int32 |\r\n", "operationId": "GetEmailType", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Email Type Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Email Type", "schema": { "$ref": "#/definitions/GetEmailTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Email Type" ], "summary": "Update an existing Email Type 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 | EmailType->Version | integer | int32 |\r\n| code | EmailType->Code | string | |\r\n| description | EmailType->Description | string | |\r\n| sequenceNumber | EmailType->SequenceNumber | integer | int32 |\r\n| notes | EmailType->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": "UpdateEmailType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Email Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateEmailTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Email Type 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": [ "Email Type" ], "summary": "Delete an existing Email Type 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 | EmailType->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": "DeleteEmailType", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Email Type Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteEmailTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Email Type 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/GEN/EmailTypes": { "get": { "tags": [ "Email Type" ], "summary": "Get a collection of Email Type 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 | EmailType->Version | integer | int32 |\r\n| id | EmailType->Id | integer | int64 |\r\n| code | EmailType->Code | string | |\r\n| description | EmailType->Description | string | |\r\n| notes | EmailType->Notes | string | |\r\n| sequenceNumber | EmailType->SequenceNumber | integer | int32 |\r\n| isActive | EmailType->IsActive | boolean | |\r\n| createdOn | EmailType->CreatedOn | string | date-time |\r\n| modifiedOn | EmailType->ModifiedOn | string | date-time |\r\n", "operationId": "GetEmailTypeCollection", "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 Email Type collection", "schema": { "$ref": "#/definitions/GetEmailTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Email Type" ], "summary": "Create a new Email Type 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 | EmailType->Code | string | |\r\n| description | EmailType->Description | string | |\r\n| permissionTreeId | EmailType->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | EmailType->SequenceNumber | integer | int32 |\r\n| notes | EmailType->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 | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateEmailType", "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/CreateEmailTypeResourceActionRequest" } }, { "$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/GEN/EmailTypes/Lookups/LookupEmailTypeChangePermissionTree": { "get": { "tags": [ "Email Type" ], "summary": "Lookup the permission set for changing the Email Type.", "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": "LookupEmailTypeChangePermissionTree", "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/EmailTypeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/EmailTypes/Lookups/LookupEmailTypeInsertPermissionTree": { "get": { "tags": [ "Email Type" ], "summary": "Lookup the permission set for creating the Email Type.", "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": "LookupEmailTypeInsertPermissionTree", "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/EmailTypeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/EmailTypes/Batch/{ids}": { "get": { "tags": [ "Email Type" ], "summary": "Get a collection of Email Type 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 | EmailType->Code | string | |\r\n| createdByUserId | EmailType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | EmailType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | EmailType->CreatedByUser_FullName | string | |\r\n| createdOn | EmailType->CreatedOn | string | date-time |\r\n| isActive | EmailType->IsActive | boolean | |\r\n| modifiedByUserId | EmailType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | EmailType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | EmailType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | EmailType->ModifiedOn | string | date-time |\r\n| permissionTreeId | EmailType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | EmailType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | EmailType->PermissionTree_Description | string | |\r\n| version | EmailType->Version | integer | int32 |\r\n| id | EmailType->Id | integer | int64 |\r\n| description | EmailType->Description | string | |\r\n| notes | EmailType->Notes | string | |\r\n| sequenceNumber | EmailType->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetEmailType", "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 Email Type 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 Email Type collection", "schema": { "$ref": "#/definitions/BatchGetEmailTypeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/EmailTypes/Batch": { "post": { "tags": [ "Email Type" ], "summary": "Create a new collection of Email Type 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 | EmailType->Code | string | |\r\n| description | EmailType->Description | string | |\r\n| sequenceNumber | EmailType->SequenceNumber | integer | int32 |\r\n| permissionTreeId | EmailType->PermissionTree_Id | integer | int64 |\r\n| notes | EmailType->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 | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateEmailType", "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/BatchCreateEmailTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Email Type 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": [ "Email Type" ], "summary": "Update a collection of existing Email Type 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 | EmailType->Id | integer | int64 |\r\n| version | EmailType->Version | integer | int32 |\r\n| code | EmailType->Code | string | |\r\n| description | EmailType->Description | string | |\r\n| notes | EmailType->Notes | string | |\r\n| sequenceNumber | EmailType->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateEmailType", "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/BatchUpdateEmailTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Email Type 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": [ "Email Type" ], "summary": "Delete a collection of existing Email Type 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 | EmailType->Id | integer | int64 |\r\n| version | EmailType->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": "BatchDeleteEmailType", "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/BatchDeleteEmailTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Email Type 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/GEN/EmailTypes/{id}/Active": { "patch": { "tags": [ "Email Type" ], "summary": "Change the IsActive status for an existing Email Type 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 | EmailType->Version | integer | int32 |\r\n| isActive | EmailType->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": "ChangeEmailTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Email Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeEmailTypeIsActiveResourceActionRequest" } }, { "$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/GEN/EmailTypes/{id}/PermissionTree": { "patch": { "tags": [ "Email Type" ], "summary": "Change the PermissionTree for an existing Email Type 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 | EmailType->Version | integer | int32 |\r\n| permissionTreeId | EmailType->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": "ChangeEmailTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Email Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeEmailTypePermissionTreeResourceActionRequest" } }, { "$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/GEN/EmailTypes/Batch/Active": { "patch": { "tags": [ "Email Type" ], "summary": "Change the IsActive status for a collection of existing Email Type 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 | EmailType->Id | integer | int64 |\r\n| version | EmailType->Version | integer | int32 |\r\n| isActive | EmailType->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": "BatchChangeEmailTypeIsActive", "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/BatchChangeEmailTypeIsActiveResourceActionRequest" } }, { "$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/GEN/EmailTypes/Batch/PermissionTree": { "patch": { "tags": [ "Email Type" ], "summary": "Change the PermissionTree status for a collection of existing Email Type 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 | EmailType->Id | integer | int64 |\r\n| version | EmailType->Version | integer | int32 |\r\n| permissionTreeId | EmailType->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": "BatchChangeEmailTypePermissionTree", "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/BatchChangeEmailTypePermissionTreeResourceActionRequest" } }, { "$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/GEN/Languages/{id}": { "get": { "tags": [ "Language" ], "summary": "Get a Language 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 | Language->Code | string | |\r\n| createdByUserId | Language->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Language->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Language->CreatedByUser_FullName | string | |\r\n| createdOn | Language->CreatedOn | string | date-time |\r\n| isActive | Language->IsActive | boolean | |\r\n| modifiedByUserId | Language->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Language->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Language->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Language->ModifiedOn | string | date-time |\r\n| permissionTreeId | Language->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Language->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Language->PermissionTree_Description | string | |\r\n| version | Language->Version | integer | int32 |\r\n| id | Language->Id | integer | int64 |\r\n| description | Language->Description | string | |\r\n| notes | Language->Notes | string | |\r\n| sequenceNumber | Language->SequenceNumber | integer | int32 |\r\n| languageCode | Language->LanguageCode | string | |\r\n", "operationId": "GetLanguage", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Language Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Language", "schema": { "$ref": "#/definitions/GetLanguageResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Language" ], "summary": "Update an existing Language 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 | Language->Version | integer | int32 |\r\n| code | Language->Code | string | |\r\n| description | Language->Description | string | |\r\n| languageCode | Language->LanguageCode | string | |\r\n| sequenceNumber | Language->SequenceNumber | integer | int32 |\r\n| notes | Language->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| languageCode | Nullable | False | |\r\n| languageCode | Min Length | >= 2 chars| |\r\n| languageCode | Max Length | <= 8 chars| |\r\n\r\n", "operationId": "UpdateLanguage", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Language Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateLanguageResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Language 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": [ "Language" ], "summary": "Delete an existing Language 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 | Language->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": "DeleteLanguage", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Language Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteLanguageResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Language 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/GEN/Languages": { "get": { "tags": [ "Language" ], "summary": "Get a collection of Language 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 | Language->Version | integer | int32 |\r\n| id | Language->Id | integer | int64 |\r\n| code | Language->Code | string | |\r\n| description | Language->Description | string | |\r\n| languageCode | Language->LanguageCode | string | |\r\n| sequenceNumber | Language->SequenceNumber | integer | int32 |\r\n| isActive | Language->IsActive | boolean | |\r\n", "operationId": "GetLanguageCollection", "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/GetLanguageCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Language" ], "summary": "Create a new Language 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 | Language->PermissionTree_Id | integer | int64 |\r\n| code | Language->Code | string | |\r\n| description | Language->Description | string | |\r\n| languageCode | Language->LanguageCode | string | |\r\n| sequenceNumber | Language->SequenceNumber | integer | int32 |\r\n| notes | Language->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| languageCode | Required | True | |\r\n| languageCode | Nullable | False | |\r\n| languageCode | Min Length | >= 2 chars| |\r\n| languageCode | Max Length | <= 8 chars| |\r\n\r\n", "operationId": "CreateLanguage", "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/CreateLanguageResourceActionRequest" } }, { "$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/GEN/Languages/Lookups/LookupLanguageChangePermissionTree": { "get": { "tags": [ "Language" ], "summary": "Lookup the permission set for changing the Language.", "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": "LookupLanguageChangePermissionTree", "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/LanguageChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Languages/Lookups/LookupLanguageInsertPermissionTree": { "get": { "tags": [ "Language" ], "summary": "Lookup the permission set for creating the Language.", "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": "LookupLanguageInsertPermissionTree", "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/LanguageInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Languages/Batch/{ids}": { "get": { "tags": [ "Language" ], "summary": "Get a collection of Language 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 | Language->Code | string | |\r\n| createdByUserId | Language->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Language->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Language->CreatedByUser_FullName | string | |\r\n| createdOn | Language->CreatedOn | string | date-time |\r\n| isActive | Language->IsActive | boolean | |\r\n| modifiedByUserId | Language->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Language->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Language->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Language->ModifiedOn | string | date-time |\r\n| permissionTreeId | Language->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Language->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Language->PermissionTree_Description | string | |\r\n| version | Language->Version | integer | int32 |\r\n| id | Language->Id | integer | int64 |\r\n| description | Language->Description | string | |\r\n| notes | Language->Notes | string | |\r\n| sequenceNumber | Language->SequenceNumber | integer | int32 |\r\n| languageCode | Language->LanguageCode | string | |\r\n", "operationId": "BatchGetLanguage", "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 Language 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 Language collection", "schema": { "$ref": "#/definitions/BatchGetLanguageResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Languages/Batch": { "post": { "tags": [ "Language" ], "summary": "Create a new collection of Language 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 | Language->PermissionTree_Id | integer | int64 |\r\n| code | Language->Code | string | |\r\n| description | Language->Description | string | |\r\n| languageCode | Language->LanguageCode | string | |\r\n| sequenceNumber | Language->SequenceNumber | integer | int32 |\r\n| notes | Language->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| languageCode | Required | True | |\r\n| languageCode | Nullable | False | |\r\n| languageCode | Min Length | >= 2 chars| |\r\n| languageCode | Max Length | <= 8 chars| |\r\n\r\n", "operationId": "BatchCreateLanguage", "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/BatchCreateLanguageResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Language 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": [ "Language" ], "summary": "Update a collection of existing Language 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 | Language->Id | integer | int64 |\r\n| version | Language->Version | integer | int32 |\r\n| code | Language->Code | string | |\r\n| description | Language->Description | string | |\r\n| languageCode | Language->LanguageCode | string | |\r\n| sequenceNumber | Language->SequenceNumber | integer | int32 |\r\n| notes | Language->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| languageCode | Nullable | False | |\r\n| languageCode | Min Length | >= 2 chars| |\r\n| languageCode | Max Length | <= 8 chars| |\r\n\r\n", "operationId": "BatchUpdateLanguage", "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/BatchUpdateLanguageResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Language 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": [ "Language" ], "summary": "Delete a collection of existing Language 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 | Language->Id | integer | int64 |\r\n| version | Language->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": "BatchDeleteLanguage", "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/BatchDeleteLanguageResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Language 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/GEN/Languages/{id}/PermissionTree": { "patch": { "tags": [ "Language" ], "summary": "Change the PermissionTree for an existing Language 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 | Language->Version | integer | int32 |\r\n| permissionTreeId | Language->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": "ChangeLanguagePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Language Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeLanguagePermissionTreeResourceActionRequest" } }, { "$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/GEN/Languages/{id}/Active": { "patch": { "tags": [ "Language" ], "summary": "Change the IsActive status for an existing Language 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 | Language->Version | integer | int32 |\r\n| isActive | Language->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": "ChangeLanguageIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Language Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeLanguageIsActiveResourceActionRequest" } }, { "$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/GEN/Languages/Batch/Active": { "patch": { "tags": [ "Language" ], "summary": "Change the IsActive status for a collection of existing Language 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 | Language->Id | integer | int64 |\r\n| version | Language->Version | integer | int32 |\r\n| isActive | Language->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": "BatchChangeLanguageIsActive", "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/BatchChangeLanguageIsActiveResourceActionRequest" } }, { "$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/GEN/Languages/Batch/PermissionTree": { "patch": { "tags": [ "Language" ], "summary": "Change the PermissionTree status for a collection of existing Language 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 | Language->Id | integer | int64 |\r\n| version | Language->Version | integer | int32 |\r\n| permissionTreeId | Language->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": "BatchChangeLanguagePermissionTree", "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/BatchChangeLanguagePermissionTreeResourceActionRequest" } }, { "$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/GEN/Localisations/Sets/Keys/{id}": { "get": { "tags": [ "Localisation Key" ], "summary": "Get a Localisation Key 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 | LocalisationKey->IsActive | boolean | |\r\n| createdByUserId | LocalisationKey->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | LocalisationKey->CreatedByUser_Code | string | |\r\n| createdByUserFullName | LocalisationKey->CreatedByUser_FullName | string | |\r\n| createdOn | LocalisationKey->CreatedOn | string | date-time |\r\n| modifiedByUserId | LocalisationKey->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | LocalisationKey->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | LocalisationKey->ModifiedByUser_FullName | string | |\r\n| modifiedOn | LocalisationKey->ModifiedOn | string | date-time |\r\n| version | LocalisationKey->Version | integer | int32 |\r\n| permissionTreeId | LocalisationKey->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | LocalisationKey->PermissionTree_Code | string | |\r\n| permissionTreeDescription | LocalisationKey->PermissionTree_Description | string | |\r\n| id | LocalisationKey->Id | integer | int64 |\r\n| localisationSetId | LocalisationKey->LocalisationSet_Id | integer | int64 |\r\n| localisationSetName | LocalisationKey->LocalisationSet_Name | string | |\r\n| localisationSetDescription | LocalisationKey->LocalisationSet_Description | string | |\r\n| localisationSetType | LocalisationKey->LocalisationSet_Type | string (Allowed values: [Phrases, UI, ValueLists, Messages]) | enum |\r\n| notes | LocalisationKey->Notes | string | |\r\n| sequenceNumber | LocalisationKey->SequenceNumber | integer | int32 |\r\n| text | LocalisationKey->Text | string | |\r\n", "operationId": "GetLocalisationKey", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Localisation Key Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Localisation Key", "schema": { "$ref": "#/definitions/GetLocalisationKeyResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Localisation Key" ], "summary": "Update an existing Localisation Key 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 | LocalisationKey->Version | integer | int32 |\r\n| text | LocalisationKey->Text | string | |\r\n| notes | LocalisationKey->Notes | string | |\r\n| sequenceNumber | LocalisationKey->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| text | Nullable | False | |\r\n| text | Min Length | >= 2 chars| |\r\n| text | Max Length | <= 512 chars| |\r\n\r\n", "operationId": "UpdateLocalisationKey", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Localisation Key Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateLocalisationKeyResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Localisation Key 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": [ "Localisation Key" ], "summary": "Delete an existing Localisation Key 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 | LocalisationKey->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": "DeleteLocalisationKey", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Localisation Key Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteLocalisationKeyResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Localisation Key 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/GEN/Localisations/Sets/Keys": { "get": { "tags": [ "Localisation Key" ], "summary": "Get a collection of Localisation Key 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 | LocalisationKey->Version | integer | int32 |\r\n| id | LocalisationKey->Id | integer | int64 |\r\n| text | LocalisationKey->Text | string | |\r\n| localisationSetId | LocalisationKey->LocalisationSet_Id | integer | int64 |\r\n| localisationSetName | LocalisationKey->LocalisationSet_Name | string | |\r\n| localisationSetDescription | LocalisationKey->LocalisationSet_Description | string | |\r\n| localisationSetType | LocalisationKey->LocalisationSet_Type | string (Allowed values: [Phrases, UI, ValueLists, Messages]) | enum |\r\n| permissionTreeId | LocalisationKey->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | LocalisationKey->PermissionTree_Code | string | |\r\n| permissionTreeDescription | LocalisationKey->PermissionTree_Description | string | |\r\n| sequenceNumber | LocalisationKey->SequenceNumber | integer | int32 |\r\n| isActive | LocalisationKey->IsActive | boolean | |\r\n| notes | LocalisationKey->Notes | string | |\r\n", "operationId": "GetLocalisationKeyCollection", "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 Localisation Key collection", "schema": { "$ref": "#/definitions/GetLocalisationKeyCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Localisation Key" ], "summary": "Create a new Localisation Key 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| text | LocalisationKey->Text | string | |\r\n| permissionTreeId | LocalisationKey->PermissionTree_Id | integer | int64 |\r\n| localisationSetId | LocalisationKey->LocalisationSet_Id | integer | int64 |\r\n| notes | LocalisationKey->Notes | string | |\r\n| sequenceNumber | LocalisationKey->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| text | Required | True | |\r\n| text | Nullable | False | |\r\n| text | Min Length | >= 2 chars| |\r\n| text | Max Length | <= 512 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| localisationSetId | Required | True | |\r\n| localisationSetId | Nullable | False | |\r\n\r\n", "operationId": "CreateLocalisationKey", "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/CreateLocalisationKeyResourceActionRequest" } }, { "$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/GEN/Localisations/Sets/{localisationSetId}/Keys": { "get": { "tags": [ "Localisation Key" ], "summary": "Get a collection of Localisation Key resources for the Localisation Set", "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 | LocalisationKey->Id | integer | int64 |\r\n| version | LocalisationKey->Version | integer | int32 |\r\n| isActive | LocalisationKey->IsActive | boolean | |\r\n| text | LocalisationKey->Text | string | |\r\n| localisationSetId | LocalisationKey->LocalisationSet_Id | integer | int64 |\r\n| localisationSetName | LocalisationKey->LocalisationSet_Name | string | |\r\n| localisationSetDescription | LocalisationKey->LocalisationSet_Description | string | |\r\n| localisationSetType | LocalisationKey->LocalisationSet_Type | string (Allowed values: [Phrases, UI, ValueLists, Messages]) | enum |\r\n| sequenceNumber | LocalisationKey->SequenceNumber | integer | int32 |\r\n| notes | LocalisationKey->Notes | string | |\r\n", "operationId": "GetLocalisationKeyForLocalisationSetCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "localisationSetId", "in": "path", "required": true, "description": "Localisation Set 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 Localisation Key collection", "schema": { "$ref": "#/definitions/GetLocalisationKeyForLocalisationSetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Localisations/Sets/Keys/Lookups/LookupLocalisationKeyChangePermissionTree": { "get": { "tags": [ "Localisation Key" ], "summary": "Lookup the permission set for changing the Localisation Key.", "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": "LookupLocalisationKeyChangePermissionTree", "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/LocalisationKeyChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Localisations/Sets/Keys/Lookups/LookupLocalisationKeyInsertPermissionTree": { "get": { "tags": [ "Localisation Key" ], "summary": "Lookup the permission set for creating the Localisation Key.", "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": "LookupLocalisationKeyInsertPermissionTree", "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/LocalisationKeyInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Localisations/Sets/Keys/Lookups/LookupLocalisationKeyLocalisationSet": { "get": { "tags": [ "Localisation Key" ], "summary": "Lookup the Localisation Key for the Localisation Key.", "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 | LocalisationSet->Id | integer | int64 |\r\n| name | LocalisationSet->Name | string | |\r\n| description | LocalisationSet->Description | string | |\r\n| type | LocalisationSet->Type | string (Allowed values: [Phrases, UI, ValueLists, Messages]) | enum |\r\n| isSystem | LocalisationSet->IsSystem | boolean | |\r\n", "operationId": "LookupLocalisationKeyLocalisationSet", "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 Localisation Set collection", "schema": { "$ref": "#/definitions/LocalisationKeyLocalisationSetResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Localisations/Sets/Keys/Batch/{ids}": { "get": { "tags": [ "Localisation Key" ], "summary": "Get a collection of Localisation Key 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 | LocalisationKey->IsActive | boolean | |\r\n| createdByUserId | LocalisationKey->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | LocalisationKey->CreatedByUser_Code | string | |\r\n| createdByUserFullName | LocalisationKey->CreatedByUser_FullName | string | |\r\n| createdOn | LocalisationKey->CreatedOn | string | date-time |\r\n| modifiedByUserId | LocalisationKey->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | LocalisationKey->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | LocalisationKey->ModifiedByUser_FullName | string | |\r\n| modifiedOn | LocalisationKey->ModifiedOn | string | date-time |\r\n| version | LocalisationKey->Version | integer | int32 |\r\n| permissionTreeId | LocalisationKey->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | LocalisationKey->PermissionTree_Code | string | |\r\n| permissionTreeDescription | LocalisationKey->PermissionTree_Description | string | |\r\n| id | LocalisationKey->Id | integer | int64 |\r\n| localisationSetId | LocalisationKey->LocalisationSet_Id | integer | int64 |\r\n| localisationSetName | LocalisationKey->LocalisationSet_Name | string | |\r\n| localisationSetDescription | LocalisationKey->LocalisationSet_Description | string | |\r\n| localisationSetType | LocalisationKey->LocalisationSet_Type | string (Allowed values: [Phrases, UI, ValueLists, Messages]) | enum |\r\n| notes | LocalisationKey->Notes | string | |\r\n| sequenceNumber | LocalisationKey->SequenceNumber | integer | int32 |\r\n| text | LocalisationKey->Text | string | |\r\n", "operationId": "BatchGetLocalisationKey", "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 Localisation Key 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 Localisation Key collection", "schema": { "$ref": "#/definitions/BatchGetLocalisationKeyResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Localisations/Sets/Keys/Batch": { "post": { "tags": [ "Localisation Key" ], "summary": "Create a new collection of Localisation Key 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| text | LocalisationKey->Text | string | |\r\n| permissionTreeId | LocalisationKey->PermissionTree_Id | integer | int64 |\r\n| localisationSetId | LocalisationKey->LocalisationSet_Id | integer | int64 |\r\n| notes | LocalisationKey->Notes | string | |\r\n| sequenceNumber | LocalisationKey->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| text | Required | True | |\r\n| text | Nullable | False | |\r\n| text | Min Length | >= 2 chars| |\r\n| text | Max Length | <= 512 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| localisationSetId | Required | True | |\r\n| localisationSetId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateLocalisationKey", "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/BatchCreateLocalisationKeyResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Localisation Key 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": [ "Localisation Key" ], "summary": "Update a collection of existing Localisation Key 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 | LocalisationKey->Id | integer | int64 |\r\n| version | LocalisationKey->Version | integer | int32 |\r\n| text | LocalisationKey->Text | string | |\r\n| notes | LocalisationKey->Notes | string | |\r\n| sequenceNumber | LocalisationKey->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| text | Nullable | False | |\r\n| text | Min Length | >= 2 chars| |\r\n| text | Max Length | <= 512 chars| |\r\n\r\n", "operationId": "BatchUpdateLocalisationKey", "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/BatchUpdateLocalisationKeyResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Localisation Key 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": [ "Localisation Key" ], "summary": "Delete a collection of existing Localisation Key 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 | LocalisationKey->Id | integer | int64 |\r\n| version | LocalisationKey->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": "BatchDeleteLocalisationKey", "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/BatchDeleteLocalisationKeyResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Localisation Key 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/GEN/Localisations/Sets/Keys/{id}/Active": { "patch": { "tags": [ "Localisation Key" ], "summary": "Change the IsActive status for an existing Localisation Key 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 | LocalisationKey->Version | integer | int32 |\r\n| isActive | LocalisationKey->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": "ChangeLocalisationKeyIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Localisation Key Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeLocalisationKeyIsActiveResourceActionRequest" } }, { "$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/GEN/Localisations/Sets/Keys/{id}/PermissionTree": { "patch": { "tags": [ "Localisation Key" ], "summary": "Change the PermissionTree for an existing Localisation Key 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 | LocalisationKey->Version | integer | int32 |\r\n| permissionTreeId | LocalisationKey->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": "ChangeLocalisationKeyPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Localisation Key Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeLocalisationKeyPermissionTreeResourceActionRequest" } }, { "$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/GEN/Localisations/Sets/Keys/Batch/Active": { "patch": { "tags": [ "Localisation Key" ], "summary": "Change the IsActive status for a collection of existing Localisation Key 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 | LocalisationKey->Id | integer | int64 |\r\n| version | LocalisationKey->Version | integer | int32 |\r\n| isActive | LocalisationKey->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": "BatchChangeLocalisationKeyIsActive", "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/BatchChangeLocalisationKeyIsActiveResourceActionRequest" } }, { "$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/GEN/Localisations/Sets/Keys/Batch/PermissionTree": { "patch": { "tags": [ "Localisation Key" ], "summary": "Change the PermissionTree status for a collection of existing Localisation Key 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 | LocalisationKey->Id | integer | int64 |\r\n| version | LocalisationKey->Version | integer | int32 |\r\n| permissionTreeId | LocalisationKey->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": "BatchChangeLocalisationKeyPermissionTree", "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/BatchChangeLocalisationKeyPermissionTreeResourceActionRequest" } }, { "$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/GEN/Localisations/Sets/{id}": { "get": { "tags": [ "Localisation Set" ], "summary": "Get a Localisation Set 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 | LocalisationSet->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | LocalisationSet->CreatedByUser_Code | string | |\r\n| createdByUserFullName | LocalisationSet->CreatedByUser_FullName | string | |\r\n| createdOn | LocalisationSet->CreatedOn | string | date-time |\r\n| modifiedByUserId | LocalisationSet->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | LocalisationSet->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | LocalisationSet->ModifiedByUser_FullName | string | |\r\n| modifiedOn | LocalisationSet->ModifiedOn | string | date-time |\r\n| version | LocalisationSet->Version | integer | int32 |\r\n| id | LocalisationSet->Id | integer | int64 |\r\n| description | LocalisationSet->Description | string | |\r\n| isSystem | LocalisationSet->IsSystem | boolean | |\r\n| name | LocalisationSet->Name | string | |\r\n| notes | LocalisationSet->Notes | string | |\r\n| type | LocalisationSet->Type | string (Allowed values: [Phrases, UI, ValueLists, Messages]) | enum |\r\n", "operationId": "GetLocalisationSet", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Localisation Set Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Localisation Set", "schema": { "$ref": "#/definitions/GetLocalisationSetResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Localisations/Sets": { "get": { "tags": [ "Localisation Set" ], "summary": "Get a collection of Localisation Set 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 | LocalisationSet->Version | integer | int32 |\r\n| id | LocalisationSet->Id | integer | int64 |\r\n| name | LocalisationSet->Name | string | |\r\n| description | LocalisationSet->Description | string | |\r\n| type | LocalisationSet->Type | string (Allowed values: [Phrases, UI, ValueLists, Messages]) | enum |\r\n| isSystem | LocalisationSet->IsSystem | boolean | |\r\n| notes | LocalisationSet->Notes | string | |\r\n", "operationId": "GetLocalisationSetCollection", "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 Localisation Set collection", "schema": { "$ref": "#/definitions/GetLocalisationSetCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Localisations/Sets/Keys/Languages/Translations/{id}": { "get": { "tags": [ "Localisation Translation" ], "summary": "Get a Localisation Translation 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 | LocalisationTranslation->IsActive | boolean | |\r\n| createdByUserId | LocalisationTranslation->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | LocalisationTranslation->CreatedByUser_Code | string | |\r\n| createdByUserFullName | LocalisationTranslation->CreatedByUser_FullName | string | |\r\n| createdOn | LocalisationTranslation->CreatedOn | string | date-time |\r\n| modifiedByUserId | LocalisationTranslation->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | LocalisationTranslation->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | LocalisationTranslation->ModifiedByUser_FullName | string | |\r\n| modifiedOn | LocalisationTranslation->ModifiedOn | string | date-time |\r\n| version | LocalisationTranslation->Version | integer | int32 |\r\n| permissionTreeId | LocalisationTranslation->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | LocalisationTranslation->PermissionTree_Code | string | |\r\n| permissionTreeDescription | LocalisationTranslation->PermissionTree_Description | string | |\r\n| id | LocalisationTranslation->Id | integer | int64 |\r\n| languageId | LocalisationTranslation->Language_Id | integer | int64 |\r\n| languageCode | LocalisationTranslation->Language_Code | string | |\r\n| languageDescription | LocalisationTranslation->Language_Description | string | |\r\n| localisationKeyId | LocalisationTranslation->LocalisationKey_Id | integer | int64 |\r\n| localisationKeyText | LocalisationTranslation->LocalisationKey_Text | string | |\r\n| localisationKeyLocalisationSetId | LocalisationTranslation->LocalisationKey_LocalisationSet_Id | integer | int64 |\r\n| localisationKeyLocalisationSetName | LocalisationTranslation->LocalisationKey_LocalisationSet_Name | string | |\r\n| notes | LocalisationTranslation->Notes | string | |\r\n| sequenceNumber | LocalisationTranslation->SequenceNumber | integer | int32 |\r\n| translatedText | LocalisationTranslation->TranslatedText | string | |\r\n", "operationId": "GetLocalisationTranslation", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Localisation Translation Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Localisation Translation", "schema": { "$ref": "#/definitions/GetLocalisationTranslationResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Localisation Translation" ], "summary": "Update an existing Localisation Translation 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 | LocalisationTranslation->Version | integer | int32 |\r\n| translatedText | LocalisationTranslation->TranslatedText | string | |\r\n| sequenceNumber | LocalisationTranslation->SequenceNumber | integer | int32 |\r\n| languageId | LocalisationTranslation->Language_Id | integer | int64 |\r\n| notes | LocalisationTranslation->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| translatedText | Nullable | False | |\r\n| translatedText | Min Length | >= 1 chars| |\r\n| translatedText | Max Length | <= 512 chars| |\r\n| languageId | Nullable | False | |\r\n\r\n", "operationId": "UpdateLocalisationTranslation", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Localisation Translation Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateLocalisationTranslationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Localisation Translation 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": [ "Localisation Translation" ], "summary": "Delete an existing Localisation Translation 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 | LocalisationTranslation->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": "DeleteLocalisationTranslation", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Localisation Translation Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteLocalisationTranslationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Localisation Translation 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/GEN/Localisations/Sets/Keys/Languages/Translations": { "get": { "tags": [ "Localisation Translation" ], "summary": "Get a collection of Localisation Translation 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 | LocalisationTranslation->Version | integer | int32 |\r\n| id | LocalisationTranslation->Id | integer | int64 |\r\n| translatedText | LocalisationTranslation->TranslatedText | string | |\r\n| sequenceNumber | LocalisationTranslation->SequenceNumber | integer | int32 |\r\n| languageId | LocalisationTranslation->Language_Id | integer | int64 |\r\n| languageCode | LocalisationTranslation->Language_Code | string | |\r\n| languageDescription | LocalisationTranslation->Language_Description | string | |\r\n| languageLanguageCode | LocalisationTranslation->Language_LanguageCode | string | |\r\n| localisationKeyId | LocalisationTranslation->LocalisationKey_Id | integer | int64 |\r\n| localisationKeyText | LocalisationTranslation->LocalisationKey_Text | string | |\r\n| localisationKeyLocalisationSetId | LocalisationTranslation->LocalisationKey_LocalisationSet_Id | integer | int64 |\r\n| localisationKeyLocalisationSetType | LocalisationTranslation->LocalisationKey_LocalisationSet_Type | string (Allowed values: [Phrases, UI, ValueLists, Messages]) | enum |\r\n| localisationKeyLocalisationSetName | LocalisationTranslation->LocalisationKey_LocalisationSet_Name | string | |\r\n| permissionTreeId | LocalisationTranslation->PermissionTree_Id | integer | int64 |\r\n| permissionTreeDescription | LocalisationTranslation->PermissionTree_Description | string | |\r\n| permissionTreeCode | LocalisationTranslation->PermissionTree_Code | string | |\r\n| notes | LocalisationTranslation->Notes | string | |\r\n| createdOn | LocalisationTranslation->CreatedOn | string | date-time |\r\n| modifiedOn | LocalisationTranslation->ModifiedOn | string | date-time |\r\n", "operationId": "GetLocalisationTranslationCollection", "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 Localisation Translation collection", "schema": { "$ref": "#/definitions/GetLocalisationTranslationCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Localisation Translation" ], "summary": "Create a new Localisation Translation 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 | LocalisationTranslation->PermissionTree_Id | integer | int64 |\r\n| translatedText | LocalisationTranslation->TranslatedText | string | |\r\n| sequenceNumber | LocalisationTranslation->SequenceNumber | integer | int32 |\r\n| languageId | LocalisationTranslation->Language_Id | integer | int64 |\r\n| localisationKeyId | LocalisationTranslation->LocalisationKey_Id | integer | int64 |\r\n| notes | LocalisationTranslation->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| translatedText | Required | True | |\r\n| translatedText | Nullable | False | |\r\n| translatedText | Min Length | >= 1 chars| |\r\n| translatedText | Max Length | <= 512 chars| |\r\n| languageId | Required | True | |\r\n| languageId | Nullable | False | |\r\n| localisationKeyId | Required | True | |\r\n| localisationKeyId | Nullable | False | |\r\n\r\n", "operationId": "CreateLocalisationTranslation", "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/CreateLocalisationTranslationResourceActionRequest" } }, { "$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/GEN/Localisations/Sets/Keys/Languages/{languageId}/Translations": { "get": { "tags": [ "Localisation Translation" ], "summary": "Get a collection of Localisation Translation resources for the Language", "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 | LocalisationTranslation->Id | integer | int64 |\r\n| version | LocalisationTranslation->Version | integer | int32 |\r\n| isActive | LocalisationTranslation->IsActive | boolean | |\r\n| translatedText | LocalisationTranslation->TranslatedText | string | |\r\n| localisationKeyId | LocalisationTranslation->LocalisationKey_Id | integer | int64 |\r\n| localisationKeyText | LocalisationTranslation->LocalisationKey_Text | string | |\r\n| sequenceNumber | LocalisationTranslation->SequenceNumber | integer | int32 |\r\n| languageId | LocalisationTranslation->Language_Id | integer | int64 |\r\n| languageCode | LocalisationTranslation->Language_Code | string | |\r\n| languageDescription | LocalisationTranslation->Language_Description | string | |\r\n| languageLanguageCode | LocalisationTranslation->Language_LanguageCode | string | |\r\n| notes | LocalisationTranslation->Notes | string | |\r\n", "operationId": "GetLocalisationTranslationForLanguageCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "languageId", "in": "path", "required": true, "description": "Language 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 Localisation Translation collection", "schema": { "$ref": "#/definitions/GetLocalisationTranslationForLanguageCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Localisations/Sets/Keys/{localisationKeyId}/Translations": { "get": { "tags": [ "Localisation Translation" ], "summary": "Get a collection of Localisation Translation resources for the Localisation Key", "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 | LocalisationTranslation->Id | integer | int64 |\r\n| version | LocalisationTranslation->Version | integer | int32 |\r\n| isActive | LocalisationTranslation->IsActive | boolean | |\r\n| translatedText | LocalisationTranslation->TranslatedText | string | |\r\n| localisationKeyId | LocalisationTranslation->LocalisationKey_Id | integer | int64 |\r\n| localisationKeyText | LocalisationTranslation->LocalisationKey_Text | string | |\r\n| sequenceNumber | LocalisationTranslation->SequenceNumber | integer | int32 |\r\n| languageId | LocalisationTranslation->Language_Id | integer | int64 |\r\n| languageCode | LocalisationTranslation->Language_Code | string | |\r\n| languageDescription | LocalisationTranslation->Language_Description | string | |\r\n| languageLanguageCode | LocalisationTranslation->Language_LanguageCode | string | |\r\n| notes | LocalisationTranslation->Notes | string | |\r\n", "operationId": "GetLocalisationTranslationForLocalisationKeyCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "localisationKeyId", "in": "path", "required": true, "description": "Localisation Key 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 Localisation Translation collection", "schema": { "$ref": "#/definitions/GetLocalisationTranslationForLocalisationKeyCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Localisations/Sets/Keys/Languages/Translations/Lookups/LookupLocalisationTranslationChangePermissionTree": { "get": { "tags": [ "Localisation Translation" ], "summary": "Lookup the permission set for changing the Localisation Translation.", "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": "LookupLocalisationTranslationChangePermissionTree", "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/LocalisationTranslationChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Localisations/Sets/Keys/Languages/Translations/Lookups/LookupLocalisationTranslationInsertPermissionTree": { "get": { "tags": [ "Localisation Translation" ], "summary": "Lookup the permission set for creating the Localisation Translation.", "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": "LookupLocalisationTranslationInsertPermissionTree", "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/LocalisationTranslationInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Localisations/Sets/Keys/Languages/Translations/Lookups/LookupLocalisationTranslationLanguage": { "get": { "tags": [ "Localisation Translation" ], "summary": "Lookup the Language for the Localisation Translation.", "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": "LookupLocalisationTranslationLanguage", "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/LocalisationTranslationLanguageLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Localisations/Sets/Keys/Languages/Translations/Lookups/LookupLocalisationTranslationLocalisationKey": { "get": { "tags": [ "Localisation Translation" ], "summary": "Lookup the Localisation Key for the Localisation Translation.", "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 | LocalisationKey->Id | integer | int64 |\r\n| text | LocalisationKey->Text | string | |\r\n| localisationSetName | LocalisationKey->LocalisationSet_Name | string | |\r\n", "operationId": "LookupLocalisationTranslationLocalisationKey", "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 Localisation Key collection", "schema": { "$ref": "#/definitions/LocalisationTranslationLocalisationLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Localisations/Sets/Keys/Languages/Translations/Batch/{ids}": { "get": { "tags": [ "Localisation Translation" ], "summary": "Get a collection of Localisation Translation 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 | LocalisationTranslation->IsActive | boolean | |\r\n| createdByUserId | LocalisationTranslation->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | LocalisationTranslation->CreatedByUser_Code | string | |\r\n| createdByUserFullName | LocalisationTranslation->CreatedByUser_FullName | string | |\r\n| createdOn | LocalisationTranslation->CreatedOn | string | date-time |\r\n| modifiedByUserId | LocalisationTranslation->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | LocalisationTranslation->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | LocalisationTranslation->ModifiedByUser_FullName | string | |\r\n| modifiedOn | LocalisationTranslation->ModifiedOn | string | date-time |\r\n| version | LocalisationTranslation->Version | integer | int32 |\r\n| permissionTreeId | LocalisationTranslation->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | LocalisationTranslation->PermissionTree_Code | string | |\r\n| permissionTreeDescription | LocalisationTranslation->PermissionTree_Description | string | |\r\n| id | LocalisationTranslation->Id | integer | int64 |\r\n| languageId | LocalisationTranslation->Language_Id | integer | int64 |\r\n| languageCode | LocalisationTranslation->Language_Code | string | |\r\n| languageDescription | LocalisationTranslation->Language_Description | string | |\r\n| localisationKeyId | LocalisationTranslation->LocalisationKey_Id | integer | int64 |\r\n| localisationKeyText | LocalisationTranslation->LocalisationKey_Text | string | |\r\n| localisationKeyLocalisationSetId | LocalisationTranslation->LocalisationKey_LocalisationSet_Id | integer | int64 |\r\n| localisationKeyLocalisationSetName | LocalisationTranslation->LocalisationKey_LocalisationSet_Name | string | |\r\n| notes | LocalisationTranslation->Notes | string | |\r\n| sequenceNumber | LocalisationTranslation->SequenceNumber | integer | int32 |\r\n| translatedText | LocalisationTranslation->TranslatedText | string | |\r\n", "operationId": "BatchGetLocalisationTranslation", "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 Localisation Translation 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 Localisation Translation collection", "schema": { "$ref": "#/definitions/BatchGetLocalisationTranslationResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Localisations/Sets/Keys/Languages/Translations/Batch": { "post": { "tags": [ "Localisation Translation" ], "summary": "Create a new collection of Localisation Translation 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 | LocalisationTranslation->PermissionTree_Id | integer | int64 |\r\n| translatedText | LocalisationTranslation->TranslatedText | string | |\r\n| sequenceNumber | LocalisationTranslation->SequenceNumber | integer | int32 |\r\n| languageId | LocalisationTranslation->Language_Id | integer | int64 |\r\n| localisationKeyId | LocalisationTranslation->LocalisationKey_Id | integer | int64 |\r\n| notes | LocalisationTranslation->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| translatedText | Required | True | |\r\n| translatedText | Nullable | False | |\r\n| translatedText | Min Length | >= 1 chars| |\r\n| translatedText | Max Length | <= 512 chars| |\r\n| languageId | Required | True | |\r\n| languageId | Nullable | False | |\r\n| localisationKeyId | Required | True | |\r\n| localisationKeyId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateLocalisationTranslation", "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/BatchCreateLocalisationTranslationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Localisation Translation 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": [ "Localisation Translation" ], "summary": "Update a collection of existing Localisation Translation 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 | LocalisationTranslation->Id | integer | int64 |\r\n| version | LocalisationTranslation->Version | integer | int32 |\r\n| translatedText | LocalisationTranslation->TranslatedText | string | |\r\n| sequenceNumber | LocalisationTranslation->SequenceNumber | integer | int32 |\r\n| languageId | LocalisationTranslation->Language_Id | integer | int64 |\r\n| notes | LocalisationTranslation->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| translatedText | Nullable | False | |\r\n| translatedText | Min Length | >= 1 chars| |\r\n| translatedText | Max Length | <= 512 chars| |\r\n| languageId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateLocalisationTranslation", "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/BatchUpdateLocalisationTranslationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Localisation Translation 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": [ "Localisation Translation" ], "summary": "Delete a collection of existing Localisation Translation 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 | LocalisationTranslation->Id | integer | int64 |\r\n| version | LocalisationTranslation->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": "BatchDeleteLocalisationTranslation", "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/BatchDeleteLocalisationTranslationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Localisation Translation 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/GEN/Localisations/Sets/Keys/Languages/Translations/{id}/Active": { "patch": { "tags": [ "Localisation Translation" ], "summary": "Change the IsActive status for an existing Localisation Translation 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 | LocalisationTranslation->Version | integer | int32 |\r\n| isActive | LocalisationTranslation->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": "ChangeLocalisationTranslationIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Localisation Translation Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeLocalisationTranslationIsActiveResourceActionRequest" } }, { "$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/GEN/Localisations/Sets/Keys/Languages/Translations/{id}/PermissionTree": { "patch": { "tags": [ "Localisation Translation" ], "summary": "Change the PermissionTree for an existing Localisation Translation 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 | LocalisationTranslation->Version | integer | int32 |\r\n| permissionTreeId | LocalisationTranslation->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": "ChangeLocalisationTranslationPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Localisation Translation Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeLocalisationTranslationPermissionTreeResourceActionRequest" } }, { "$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/GEN/Localisations/Sets/Keys/Languages/Translations/Batch/Active": { "patch": { "tags": [ "Localisation Translation" ], "summary": "Change the IsActive status for a collection of existing Localisation Translation 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 | LocalisationTranslation->Id | integer | int64 |\r\n| version | LocalisationTranslation->Version | integer | int32 |\r\n| isActive | LocalisationTranslation->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": "BatchChangeLocalisationTranslationIsActive", "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/BatchChangeLocalisationTranslationIsActiveResourceActionRequest" } }, { "$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/GEN/Localisations/Sets/Keys/Languages/Translations/Batch/PermissionTree": { "patch": { "tags": [ "Localisation Translation" ], "summary": "Change the PermissionTree status for a collection of existing Localisation Translation 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 | LocalisationTranslation->Id | integer | int64 |\r\n| version | LocalisationTranslation->Version | integer | int32 |\r\n| permissionTreeId | LocalisationTranslation->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": "BatchChangeLocalisationTranslationPermissionTree", "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/BatchChangeLocalisationTranslationPermissionTreeResourceActionRequest" } }, { "$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/GEN/Locations/{id}": { "get": { "tags": [ "Location" ], "summary": "Get a Location 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 | Location->Code | string | |\r\n| isActive | Location->IsActive | boolean | |\r\n| createdByUserId | Location->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Location->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Location->CreatedByUser_FullName | string | |\r\n| createdOn | Location->CreatedOn | string | date-time |\r\n| modifiedByUserId | Location->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Location->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Location->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Location->ModifiedOn | string | date-time |\r\n| version | Location->Version | integer | int32 |\r\n| permissionTreeId | Location->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Location->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Location->PermissionTree_Description | string | |\r\n| geographicId | Location->GeographicId | integer | int64 |\r\n| geographicEndPosition | Location->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | Location->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | Location->GeographicLength | number | decimal |\r\n| geographicLocation | Location->GeographicLocation | object | |\r\n| geographicNotes | Location->GeographicNotes | string | |\r\n| geographicReferenceEntityId | Location->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | Location->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | Location->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | Location->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | Location->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | Location->GeographicUnitOfMeasurement_Code | string | |\r\n| siteId | Location->Site_Id | integer | int64 |\r\n| siteCode | Location->Site_Code | string | |\r\n| siteDescription | Location->Site_Description | string | |\r\n| id | Location->Id | integer | int64 |\r\n| description | Location->Description | string | |\r\n| notes | Location->Notes | string | |\r\n| parentLocationId | Location->ParentLocation_Id | integer | int64 |\r\n| parentLocationCode | Location->ParentLocation_Code | string | |\r\n| parentLocationDescription | Location->ParentLocation_Description | string | |\r\n| sequenceNumber | Location->SequenceNumber | integer | int32 |\r\n", "operationId": "GetLocation", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Location Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Location", "schema": { "$ref": "#/definitions/GetLocationResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Location" ], "summary": "Update an existing Location 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 | Location->Version | integer | int32 |\r\n| code | Location->Code | string | |\r\n| description | Location->Description | string | |\r\n| parentLocationId | Location->ParentLocation_Id | integer | int64 |\r\n| sequenceNumber | Location->SequenceNumber | integer | int32 |\r\n| notes | Location->Notes | string | |\r\n| geographicLocation | Location->GeographicLocation | object | |\r\n| geographicStartPosition | Location->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | Location->GeographicEndPosition | number | decimal |\r\n| geographicLength | Location->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | Location->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | Location->GeographicNotes | string | |\r\n| geographicReferenceEntityType | Location->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | Location->GeographicReferenceEntityId | 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| 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| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "UpdateLocation", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Location Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateLocationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Location 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": [ "Location" ], "summary": "Delete an existing Location 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 | Location->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": "DeleteLocation", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Location Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteLocationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Location 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/GEN/Locations": { "get": { "tags": [ "Location" ], "summary": "Get a collection of Location 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 | Location->Version | integer | int32 |\r\n| id | Location->Id | integer | int64 |\r\n| code | Location->Code | string | |\r\n| description | Location->Description | string | |\r\n| isActive | Location->IsActive | boolean | |\r\n| sequenceNumber | Location->SequenceNumber | integer | int32 |\r\n| siteId | Location->Site_Id | integer | int64 |\r\n| siteCode | Location->Site_Code | string | |\r\n| siteDescription | Location->Site_Description | string | |\r\n| parentLocationId | Location->ParentLocation_Id | integer | int64 |\r\n| parentLocationCode | Location->ParentLocation_Code | string | |\r\n| parentLocationDescription | Location->ParentLocation_Description | string | |\r\n", "operationId": "GetLocationCollection", "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 Location collection", "schema": { "$ref": "#/definitions/GetLocationCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Location" ], "summary": "Create a new Location 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 | Location->Code | string | |\r\n| description | Location->Description | string | |\r\n| permissionTreeId | Location->PermissionTree_Id | integer | int64 |\r\n| siteId | Location->Site_Id | integer | int64 |\r\n| parentLocationId | Location->ParentLocation_Id | integer | int64 |\r\n| sequenceNumber | Location->SequenceNumber | integer | int32 |\r\n| notes | Location->Notes | string | |\r\n| geographicLocation | Location->GeographicLocation | object | |\r\n| geographicStartPosition | Location->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | Location->GeographicEndPosition | number | decimal |\r\n| geographicLength | Location->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | Location->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | Location->GeographicNotes | string | |\r\n| geographicReferenceEntityType | Location->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | Location->GeographicReferenceEntityId | 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| 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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "CreateLocation", "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/CreateLocationResourceActionRequest" } }, { "$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/GEN/Locations/Lookups/LookupLocationChangePermissionTree": { "get": { "tags": [ "Location" ], "summary": "Lookup the permission set for changing the Location.", "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": "LookupLocationChangePermissionTree", "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/LocationChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Locations/Lookups/LookupLocationInsertPermissionTree": { "get": { "tags": [ "Location" ], "summary": "Lookup the permission set for creating the Location.", "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": "LookupLocationInsertPermissionTree", "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/LocationInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Locations/Lookups/LookupLocationParentLocation": { "get": { "tags": [ "Location" ], "summary": "Lookup the Location for the Location.", "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 | Location->Id | integer | int64 |\r\n| code | Location->Code | string | |\r\n| description | Location->Description | string | |\r\n", "operationId": "LookupLocationParentLocation", "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 Location collection", "schema": { "$ref": "#/definitions/LocationParentLocationLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Locations/Lookups/LookupLocationSite": { "get": { "tags": [ "Location" ], "summary": "Lookup the Site for the Location.", "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": "LookupLocationSite", "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/LocationSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Locations/Batch/{ids}": { "get": { "tags": [ "Location" ], "summary": "Get a collection of Location 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 | Location->Code | string | |\r\n| isActive | Location->IsActive | boolean | |\r\n| createdByUserId | Location->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Location->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Location->CreatedByUser_FullName | string | |\r\n| createdOn | Location->CreatedOn | string | date-time |\r\n| modifiedByUserId | Location->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Location->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Location->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Location->ModifiedOn | string | date-time |\r\n| version | Location->Version | integer | int32 |\r\n| permissionTreeId | Location->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Location->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Location->PermissionTree_Description | string | |\r\n| geographicId | Location->GeographicId | integer | int64 |\r\n| geographicEndPosition | Location->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | Location->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | Location->GeographicLength | number | decimal |\r\n| geographicLocation | Location->GeographicLocation | object | |\r\n| geographicNotes | Location->GeographicNotes | string | |\r\n| geographicReferenceEntityId | Location->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | Location->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | Location->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | Location->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | Location->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | Location->GeographicUnitOfMeasurement_Code | string | |\r\n| siteId | Location->Site_Id | integer | int64 |\r\n| siteCode | Location->Site_Code | string | |\r\n| siteDescription | Location->Site_Description | string | |\r\n| id | Location->Id | integer | int64 |\r\n| description | Location->Description | string | |\r\n| notes | Location->Notes | string | |\r\n| parentLocationId | Location->ParentLocation_Id | integer | int64 |\r\n| parentLocationCode | Location->ParentLocation_Code | string | |\r\n| parentLocationDescription | Location->ParentLocation_Description | string | |\r\n| sequenceNumber | Location->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetLocation", "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 Location 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 Location collection", "schema": { "$ref": "#/definitions/BatchGetLocationResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Locations/Batch": { "post": { "tags": [ "Location" ], "summary": "Create a new collection of Location 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 | Location->Code | string | |\r\n| description | Location->Description | string | |\r\n| permissionTreeId | Location->PermissionTree_Id | integer | int64 |\r\n| siteId | Location->Site_Id | integer | int64 |\r\n| parentLocationId | Location->ParentLocation_Id | integer | int64 |\r\n| sequenceNumber | Location->SequenceNumber | integer | int32 |\r\n| notes | Location->Notes | string | |\r\n| geographicLocation | Location->GeographicLocation | object | |\r\n| geographicStartPosition | Location->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | Location->GeographicEndPosition | number | decimal |\r\n| geographicLength | Location->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | Location->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | Location->GeographicNotes | string | |\r\n| geographicReferenceEntityType | Location->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | Location->GeographicReferenceEntityId | 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| 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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateLocation", "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/BatchCreateLocationRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Location 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": [ "Location" ], "summary": "Update a collection of existing Location 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 | Location->Id | integer | int64 |\r\n| version | Location->Version | integer | int32 |\r\n| code | Location->Code | string | |\r\n| description | Location->Description | string | |\r\n| siteId | Location->Site_Id | integer | int64 |\r\n| parentLocationId | Location->ParentLocation_Id | integer | int64 |\r\n| sequenceNumber | Location->SequenceNumber | integer | int32 |\r\n| notes | Location->Notes | string | |\r\n| geographicLocation | Location->GeographicLocation | object | |\r\n| geographicStartPosition | Location->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | Location->GeographicEndPosition | number | decimal |\r\n| geographicLength | Location->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | Location->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | Location->GeographicNotes | string | |\r\n| geographicReferenceEntityType | Location->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | Location->GeographicReferenceEntityId | 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| 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| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateLocation", "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/BatchUpdateLocationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Location 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": [ "Location" ], "summary": "Delete a collection of existing Location 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 | Location->Id | integer | int64 |\r\n| version | Location->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": "BatchDeleteLocation", "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/BatchDeleteLocationResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Location 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/GEN/Locations/{id}/Active": { "patch": { "tags": [ "Location" ], "summary": "Change the IsActive status for an existing Location 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 | Location->Version | integer | int32 |\r\n| isActive | Location->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": "ChangeLocationIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Location Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeLocationIsActiveResourceActionRequest" } }, { "$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/GEN/Locations/{id}/PermissionTree": { "patch": { "tags": [ "Location" ], "summary": "Change the PermissionTree for an existing Location 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 | Location->Version | integer | int32 |\r\n| permissionTreeId | Location->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": "ChangeLocationPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Location Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeLocationPermissionTreeResourceActionRequest" } }, { "$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/GEN/Locations/{id}/Site": { "patch": { "tags": [ "Location" ], "summary": "Change the Site status for an existing Location 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 | Location->Version | integer | int32 |\r\n| siteId | Location->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": "ChangeLocationSite", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Location Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeLocationSiteResourceActionRequest" } }, { "$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/GEN/Locations/Batch/Active": { "patch": { "tags": [ "Location" ], "summary": "Change the IsActive status for a collection of existing Location 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 | Location->Id | integer | int64 |\r\n| version | Location->Version | integer | int32 |\r\n| isActive | Location->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": "BatchChangeLocationIsActive", "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/BatchChangeLocationIsActiveResourceActionRequest" } }, { "$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/GEN/Locations/Batch/PermissionTree": { "patch": { "tags": [ "Location" ], "summary": "Change the PermissionTree status for a collection of existing Location 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 | Location->Id | integer | int64 |\r\n| version | Location->Version | integer | int32 |\r\n| permissionTreeId | Location->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": "BatchChangeLocationPermissionTree", "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/BatchChangeLocationPermissionTreeResourceActionRequest" } }, { "$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/GEN/Locations/Batch/Site": { "patch": { "tags": [ "Location" ], "summary": "Change the Site status for a collection of existing Location 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 | Location->Id | integer | int64 |\r\n| version | Location->Version | integer | int32 |\r\n| siteId | Location->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": "BatchChangeLocationSite", "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/BatchChangeLocationSiteResourceActionRequest" } }, { "$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/GEN/Locations/Attributes/{id}": { "get": { "tags": [ "Location Attribute" ], "summary": "Get a Location 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| locationId | LocationAttribute->Location_Id | integer | int64 |\r\n| locationCode | LocationAttribute->Location_Code | string | |\r\n| locationDescription | LocationAttribute->Location_Description | string | |\r\n| createdByUserId | LocationAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | LocationAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | LocationAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | LocationAttribute->CreatedOn | string | date-time |\r\n| isActive | LocationAttribute->IsActive | boolean | |\r\n| modifiedByUserId | LocationAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | LocationAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | LocationAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | LocationAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | LocationAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | LocationAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | LocationAttribute->PermissionTree_Description | string | |\r\n| version | LocationAttribute->Version | integer | int32 |\r\n| id | LocationAttribute->Id | integer | int64 |\r\n| attributeId | LocationAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | LocationAttribute->Attribute_Code | string | |\r\n| attributeDescription | LocationAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | LocationAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | LocationAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | LocationAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | LocationAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | LocationAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | LocationAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | LocationAttribute->Notes | string | |\r\n| predefinedValueId | LocationAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | LocationAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | LocationAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | LocationAttribute->SequenceNumber | integer | int32 |\r\n| value | LocationAttribute->Value | object | composite |\r\n", "operationId": "GetLocationAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Location Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Location Attribute", "schema": { "$ref": "#/definitions/GetLocationAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Location Attribute" ], "summary": "Update an existing Location 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 | LocationAttribute->Version | integer | int32 |\r\n| value | LocationAttribute->Value | object | composite |\r\n| predefinedValueId | LocationAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | LocationAttribute->SequenceNumber | integer | int32 |\r\n| notes | LocationAttribute->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": "UpdateLocationAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Location Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateLocationAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Location 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": [ "Location Attribute" ], "summary": "Delete an existing Location 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 | LocationAttribute->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": "DeleteLocationAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Location Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteLocationAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Location 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/GEN/Locations/{locationId}/Attributes": { "get": { "tags": [ "Location Attribute" ], "summary": "Get a collection of Location Attribute resources for the Location.", "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 | LocationAttribute->Id | integer | int64 |\r\n| version | LocationAttribute->Version | integer | int32 |\r\n| sequenceNumber | LocationAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | LocationAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | LocationAttribute->Attribute_Code | string | |\r\n| attributeDescription | LocationAttribute->Attribute_Description | string | |\r\n| attributeDataType | LocationAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | LocationAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | LocationAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | LocationAttribute->PredefinedValue_Value | object | composite |\r\n| value | LocationAttribute->Value | object | composite |\r\n| notes | LocationAttribute->Notes | string | |\r\n| createdOn | LocationAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | LocationAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetLocationAttributeCollectionForLocation", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "locationId", "in": "path", "required": true, "description": "Location 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 Location Attribute collection", "schema": { "$ref": "#/definitions/GetLocationAttributeCollectionForLocationResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Locations/Attributes": { "get": { "tags": [ "Location Attribute" ], "summary": "Get a collection of Location 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 | LocationAttribute->Id | integer | int64 |\r\n| version | LocationAttribute->Version | integer | int32 |\r\n| sequenceNumber | LocationAttribute->SequenceNumber | integer | int32 |\r\n| locationCode | LocationAttribute->Location_Code | string | |\r\n| locationDescription | LocationAttribute->Location_Description | string | |\r\n| attributeId | LocationAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | LocationAttribute->Attribute_Code | string | |\r\n| attributeDescription | LocationAttribute->Attribute_Description | string | |\r\n| attributeDataType | LocationAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | LocationAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | LocationAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | LocationAttribute->PredefinedValue_Value | object | composite |\r\n| value | LocationAttribute->Value | object | composite |\r\n| notes | LocationAttribute->Notes | string | |\r\n| createdOn | LocationAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | LocationAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetLocationAttributeCollection", "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 Location Attribute collection", "schema": { "$ref": "#/definitions/GetLocationAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Location Attribute" ], "summary": "Create a new Location 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| locationId | LocationAttribute->Location_Id | integer | int64 |\r\n| attributeId | LocationAttribute->Attribute_Id | integer | int64 |\r\n| value | LocationAttribute->Value | object | composite |\r\n| predefinedValueId | LocationAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | LocationAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | LocationAttribute->SequenceNumber | integer | int32 |\r\n| notes | LocationAttribute->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| locationId | Required | True | |\r\n| locationId | 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": "CreateLocationAttribute", "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/CreateLocationAttributeResourceActionRequest" } }, { "$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/GEN/Locations/Attributes/Lookups/LookupLocationAttributeAllowedValue": { "get": { "tags": [ "Location Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Location 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": "LookupLocationAttributeAllowedValue", "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/LocationAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Locations/Attributes/Lookups/LookupLocationAttribute": { "get": { "tags": [ "Location Attribute" ], "summary": "Lookup the Attribute for the Location 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": "LookupLocationAttribute", "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/LocationAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Locations/Attributes/Lookups/LookupLocationAttributeInsertPermissionTree": { "get": { "tags": [ "Location Attribute" ], "summary": "Lookup the permission set for creating the Location 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": "LookupLocationAttributeInsertPermissionTree", "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/LocationAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Locations/Attributes/Lookups/LookupLocationAttributeLocation": { "get": { "tags": [ "Location Attribute" ], "summary": "Lookup the Location Attribute for the Location 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 | Location->Id | integer | int64 |\r\n| code | Location->Code | string | |\r\n| description | Location->Description | string | |\r\n", "operationId": "LookupLocationAttributeLocation", "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 Location collection", "schema": { "$ref": "#/definitions/LocationAttributeLocationLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Locations/Attributes/Batch/{ids}": { "get": { "tags": [ "Location Attribute" ], "summary": "Get a collection of Location 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| locationId | LocationAttribute->Location_Id | integer | int64 |\r\n| locationCode | LocationAttribute->Location_Code | string | |\r\n| locationDescription | LocationAttribute->Location_Description | string | |\r\n| createdByUserId | LocationAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | LocationAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | LocationAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | LocationAttribute->CreatedOn | string | date-time |\r\n| isActive | LocationAttribute->IsActive | boolean | |\r\n| modifiedByUserId | LocationAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | LocationAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | LocationAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | LocationAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | LocationAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | LocationAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | LocationAttribute->PermissionTree_Description | string | |\r\n| version | LocationAttribute->Version | integer | int32 |\r\n| id | LocationAttribute->Id | integer | int64 |\r\n| attributeId | LocationAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | LocationAttribute->Attribute_Code | string | |\r\n| attributeDescription | LocationAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | LocationAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | LocationAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | LocationAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | LocationAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | LocationAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | LocationAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | LocationAttribute->Notes | string | |\r\n| predefinedValueId | LocationAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | LocationAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | LocationAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | LocationAttribute->SequenceNumber | integer | int32 |\r\n| value | LocationAttribute->Value | object | composite |\r\n", "operationId": "BatchGetLocationAttribute", "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 Location 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 Location Attribute collection", "schema": { "$ref": "#/definitions/BatchGetLocationAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Locations/Attributes/Batch": { "post": { "tags": [ "Location Attribute" ], "summary": "Create a new collection of Location 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| locationId | LocationAttribute->Location_Id | integer | int64 |\r\n| attributeId | LocationAttribute->Attribute_Id | integer | int64 |\r\n| value | LocationAttribute->Value | object | composite |\r\n| predefinedValueId | LocationAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | LocationAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | LocationAttribute->SequenceNumber | integer | int32 |\r\n| notes | LocationAttribute->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| locationId | Required | True | |\r\n| locationId | 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": "BatchCreateLocationAttribute", "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/BatchCreateLocationAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Location 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": [ "Location Attribute" ], "summary": "Update a collection of existing Location 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 | LocationAttribute->Id | integer | int64 |\r\n| version | LocationAttribute->Version | integer | int32 |\r\n| value | LocationAttribute->Value | object | composite |\r\n| predefinedValueId | LocationAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | LocationAttribute->SequenceNumber | integer | int32 |\r\n| notes | LocationAttribute->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": "BatchUpdateLocationAttribute", "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/BatchUpdateLocationAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Location 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": [ "Location Attribute" ], "summary": "Delete a collection of existing Location 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 | LocationAttribute->Id | integer | int64 |\r\n| version | LocationAttribute->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": "BatchDeleteLocationAttribute", "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/BatchDeleteLocationAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Location 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/GEN/Locations/Attributes/{id}/Active": { "patch": { "tags": [ "Location Attribute" ], "summary": "Change the IsActive status for an existing Location 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 | LocationAttribute->Version | integer | int32 |\r\n| isActive | LocationAttribute->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": "ChangeLocationAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Location Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeLocationAttributeIsActiveResourceActionRequest" } }, { "$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/GEN/Locations/Attributes/Batch/Active": { "patch": { "tags": [ "Location Attribute" ], "summary": "Change the IsActive status for a collection of existing Location 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 | LocationAttribute->Id | integer | int64 |\r\n| version | LocationAttribute->Version | integer | int32 |\r\n| isActive | LocationAttribute->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": "BatchChangeLocationAttributeIsActive", "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/BatchChangeLocationAttributeIsActiveResourceActionRequest" } }, { "$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/GEN/Locations/Documents/{id}": { "get": { "tags": [ "Location Document" ], "summary": "Get a Location 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| locationId | LocationDocument->Location_Id | integer | int64 |\r\n| locationCode | LocationDocument->Location_Code | string | |\r\n| locationDescription | LocationDocument->Location_Description | string | |\r\n| isActive | LocationDocument->IsActive | boolean | |\r\n| createdByUserId | LocationDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | LocationDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | LocationDocument->CreatedByUser_FullName | string | |\r\n| createdOn | LocationDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | LocationDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | LocationDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | LocationDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | LocationDocument->ModifiedOn | string | date-time |\r\n| version | LocationDocument->Version | integer | int32 |\r\n| permissionTreeId | LocationDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | LocationDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | LocationDocument->PermissionTree_Description | string | |\r\n| id | LocationDocument->Id | integer | int64 |\r\n| documentRecordId | LocationDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | LocationDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | LocationDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | LocationDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | LocationDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | LocationDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | LocationDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | LocationDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | LocationDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | LocationDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | LocationDocument->Notes | string | |\r\n| sequenceNumber | LocationDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetLocationDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Location Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Location Document", "schema": { "$ref": "#/definitions/GetLocationDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Location Document" ], "summary": "Update an existing Location 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 | LocationDocument->Version | integer | int32 |\r\n| sequenceNumber | LocationDocument->SequenceNumber | integer | int32 |\r\n| notes | LocationDocument->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": "UpdateLocationDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Location Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateLocationDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Location 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": [ "Location Document" ], "summary": "Delete an existing Location 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 | LocationDocument->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": "DeleteLocationDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Location Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteLocationDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Location 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/GEN/Locations/{id}/Documents": { "get": { "tags": [ "Location Document" ], "summary": "Get a collection of Location Document resources for the Location.", "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 | LocationDocument->Id | integer | int64 |\r\n| version | LocationDocument->Version | integer | int32 |\r\n| sequenceNumber | LocationDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | LocationDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | LocationDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | LocationDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | LocationDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | LocationDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | LocationDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | LocationDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetLocationDocumentCollectionForLocation", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Location 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 Location Document collection", "schema": { "$ref": "#/definitions/GetLocationDocumentCollectionForLocationResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Locations/Documents": { "get": { "tags": [ "Location Document" ], "summary": "Get a collection of Location 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 | LocationDocument->Id | integer | int64 |\r\n| version | LocationDocument->Version | integer | int32 |\r\n| locationId | LocationDocument->Location_Id | integer | int64 |\r\n| locationCode | LocationDocument->Location_Code | string | |\r\n| locationDescription | LocationDocument->Location_Description | string | |\r\n| sequenceNumber | LocationDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | LocationDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | LocationDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | LocationDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | LocationDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | LocationDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | LocationDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | LocationDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetLocationDocumentCollection", "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 Location Document collection", "schema": { "$ref": "#/definitions/GetLocationDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Location Document" ], "summary": "Create a new Location 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| locationId | LocationDocument->Location_Id | integer | int64 |\r\n| documentRecordId | LocationDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | LocationDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | LocationDocument->SequenceNumber | integer | int32 |\r\n| notes | LocationDocument->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| locationId | Required | True | |\r\n| locationId | 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": "CreateLocationDocument", "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/CreateLocationDocumentResourceActionRequest" } }, { "$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/GEN/Locations/Documents/Lookups/LookupLocationDocumentChangePermissionTree": { "get": { "tags": [ "Location Document" ], "summary": "Lookup the permission set for changing the Location 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": "LookupLocationDocumentChangePermissionTree", "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/LocationDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Locations/Documents/Lookups/LookupLocationDocument": { "get": { "tags": [ "Location Document" ], "summary": "Location 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": "LookupLocationDocument", "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/LocationDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Locations/Documents/Lookups/LookupLocationDocumentInsertPermissionTree": { "get": { "tags": [ "Location Document" ], "summary": "Lookup the permission set for creating the Location 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": "LookupLocationDocumentInsertPermissionTree", "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/LocationDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Locations/Documents/Lookups/LookupLocationDocumentLocation": { "get": { "tags": [ "Location Document" ], "summary": "Lookup the Location Document for the Location 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 | Location->Id | integer | int64 |\r\n| code | Location->Code | string | |\r\n| description | Location->Description | string | |\r\n", "operationId": "LookupLocationDocumentLocation", "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 Location collection", "schema": { "$ref": "#/definitions/LocationDocumentLocationLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Locations/Documents/Batch/{ids}": { "get": { "tags": [ "Location Document" ], "summary": "Get a collection of Location 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| locationId | LocationDocument->Location_Id | integer | int64 |\r\n| locationCode | LocationDocument->Location_Code | string | |\r\n| locationDescription | LocationDocument->Location_Description | string | |\r\n| isActive | LocationDocument->IsActive | boolean | |\r\n| createdByUserId | LocationDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | LocationDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | LocationDocument->CreatedByUser_FullName | string | |\r\n| createdOn | LocationDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | LocationDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | LocationDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | LocationDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | LocationDocument->ModifiedOn | string | date-time |\r\n| version | LocationDocument->Version | integer | int32 |\r\n| permissionTreeId | LocationDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | LocationDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | LocationDocument->PermissionTree_Description | string | |\r\n| id | LocationDocument->Id | integer | int64 |\r\n| documentRecordId | LocationDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | LocationDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | LocationDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | LocationDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | LocationDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | LocationDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | LocationDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | LocationDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | LocationDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | LocationDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | LocationDocument->Notes | string | |\r\n| sequenceNumber | LocationDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetLocationDocument", "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 Location 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 Location Document collection", "schema": { "$ref": "#/definitions/BatchGetLocationDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Locations/Documents/Batch": { "post": { "tags": [ "Location Document" ], "summary": "Create a new collection of Location 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| locationId | LocationDocument->Location_Id | integer | int64 |\r\n| documentRecordId | LocationDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | LocationDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | LocationDocument->SequenceNumber | integer | int32 |\r\n| notes | LocationDocument->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| locationId | Required | True | |\r\n| locationId | 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": "BatchCreateLocationDocument", "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/BatchCreateLocationDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Location 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": [ "Location Document" ], "summary": "Update a collection of existing Location 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 | LocationDocument->Id | integer | int64 |\r\n| version | LocationDocument->Version | integer | int32 |\r\n| sequenceNumber | LocationDocument->SequenceNumber | integer | int32 |\r\n| notes | LocationDocument->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": "BatchUpdateLocationDocument", "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/BatchUpdateLocationDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Location 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": [ "Location Document" ], "summary": "Delete a collection of existing Location 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 | LocationDocument->Id | integer | int64 |\r\n| version | LocationDocument->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": "BatchDeleteLocationDocument", "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/BatchDeleteLocationDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Location 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/GEN/Locations/Documents/{id}/Active": { "patch": { "tags": [ "Location Document" ], "summary": "Change the IsActive status for an existing Location 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 | LocationDocument->Version | integer | int32 |\r\n| isActive | LocationDocument->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": "ChangeLocationDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Location Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeLocationDocumentIsActiveResourceActionRequest" } }, { "$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/GEN/Locations/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Location Document" ], "summary": "Change the PermissionTree for an existing Location 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 | LocationDocument->Version | integer | int32 |\r\n| permissionTreeId | LocationDocument->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": "ChangeLocationDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Location Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeLocationDocumentPermissionTreeResourceActionRequest" } }, { "$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/GEN/Locations/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Location Document" ], "summary": "Change the PermissionTree status for a collection of existing Location 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 | LocationDocument->Id | integer | int64 |\r\n| version | LocationDocument->Version | integer | int32 |\r\n| permissionTreeId | LocationDocument->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": "BatchChangeLocationDocumentPermissionTree", "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/BatchChangeLocationDocumentPermissionTreeResourceActionRequest" } }, { "$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/GEN/Locations/Documents/Batch/Active": { "patch": { "tags": [ "Location Document" ], "summary": "Change the IsActive status for a collection of existing Location 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 | LocationDocument->Id | integer | int64 |\r\n| version | LocationDocument->Version | integer | int32 |\r\n| isActive | LocationDocument->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": "BatchChangeLocationDocumentIsActive", "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/BatchChangeLocationDocumentIsActiveResourceActionRequest" } }, { "$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/GEN/NotificationTemplates/{id}": { "get": { "tags": [ "Notification Template" ], "summary": "Get a Notification 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| code | NotificationTemplate->Code | string | |\r\n| isActive | NotificationTemplate->IsActive | boolean | |\r\n| createdByUserId | NotificationTemplate->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | NotificationTemplate->CreatedByUser_Code | string | |\r\n| createdByUserFullName | NotificationTemplate->CreatedByUser_FullName | string | |\r\n| createdOn | NotificationTemplate->CreatedOn | string | date-time |\r\n| modifiedByUserId | NotificationTemplate->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | NotificationTemplate->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | NotificationTemplate->ModifiedByUser_FullName | string | |\r\n| modifiedOn | NotificationTemplate->ModifiedOn | string | date-time |\r\n| version | NotificationTemplate->Version | integer | int32 |\r\n| permissionTreeId | NotificationTemplate->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | NotificationTemplate->PermissionTree_Code | string | |\r\n| permissionTreeDescription | NotificationTemplate->PermissionTree_Description | string | |\r\n| siteId | NotificationTemplate->Site_Id | integer | int64 |\r\n| siteCode | NotificationTemplate->Site_Code | string | |\r\n| siteDescription | NotificationTemplate->Site_Description | string | |\r\n| id | NotificationTemplate->Id | integer | int64 |\r\n| audience | NotificationTemplate->Audience | array | array |\r\n| audienceQuery | NotificationTemplate->AudienceQuery | string | |\r\n| audienceQueryFilter | NotificationTemplate->AudienceQueryFilter | string | |\r\n| bodyQuery | NotificationTemplate->BodyQuery | string | |\r\n| description | NotificationTemplate->Description | string | |\r\n| entityType | NotificationTemplate->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| languageId | NotificationTemplate->Language_Id | integer | int64 |\r\n| languageCode | NotificationTemplate->Language_Code | string | |\r\n| languageDescription | NotificationTemplate->Language_Description | string | |\r\n| languageQuery | NotificationTemplate->LanguageQuery | string | |\r\n| messageBody | NotificationTemplate->MessageBody | string | |\r\n| messageSubject | NotificationTemplate->MessageSubject | string | |\r\n| notes | NotificationTemplate->Notes | string | |\r\n| outputLanguage | NotificationTemplate->OutputLanguage | string (Allowed values: [None, SystemOption, Fixed, Dynamic]) | enum |\r\n| outputType | NotificationTemplate->OutputType | string (Allowed values: [Email]) | enum |\r\n| sequenceNumber | NotificationTemplate->SequenceNumber | integer | int32 |\r\n| useAudienceQuery | NotificationTemplate->UseAudienceQuery | boolean | |\r\n| useBodyQuery | NotificationTemplate->UseBodyQuery | boolean | |\r\n", "operationId": "GetNotificationTemplate", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Notification Template Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Notification Template", "schema": { "$ref": "#/definitions/GetNotificationTemplateResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Notification Template" ], "summary": "Update an existing Notification 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 | NotificationTemplate->Version | integer | int32 |\r\n| code | NotificationTemplate->Code | string | |\r\n| description | NotificationTemplate->Description | string | |\r\n| siteId | NotificationTemplate->Site_Id | integer | int64 |\r\n| sequenceNumber | NotificationTemplate->SequenceNumber | integer | int32 |\r\n| useAudienceQuery | NotificationTemplate->UseAudienceQuery | boolean | |\r\n| audienceQuery | NotificationTemplate->AudienceQuery | string | |\r\n| audienceQueryFilter | NotificationTemplate->AudienceQueryFilter | string | |\r\n| useBodyQuery | NotificationTemplate->UseBodyQuery | boolean | |\r\n| bodyQuery | NotificationTemplate->BodyQuery | string | |\r\n| outputLanguage | NotificationTemplate->OutputLanguage | string (Allowed values: [None, SystemOption, Fixed, Dynamic]) | enum |\r\n| languageQuery | NotificationTemplate->LanguageQuery | string | |\r\n| languageId | NotificationTemplate->Language_Id | integer | int64 |\r\n| audience | NotificationTemplate->Audience | array | array |\r\n| messageSubject | NotificationTemplate->MessageSubject | string | |\r\n| messageBody | NotificationTemplate->MessageBody | string | |\r\n| notes | NotificationTemplate->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| audienceQuery | Nullable | False | NotificationTemplate->UseAudienceQuery eq TRUE |\r\n| bodyQuery | Nullable | False | NotificationTemplate->UseBodyQuery eq TRUE |\r\n| languageQuery | Nullable | False | NotificationTemplate->OutputLanguage eq 'Dynamic' |\r\n| languageId | Nullable | False | NotificationTemplate->OutputLanguage eq 'Fixed' |\r\n| languageId | Nullable | True | NotificationTemplate->OutputLanguage ne 'Fixed' |\r\n| messageSubject | Nullable | False | |\r\n| messageBody | Nullable | False | |\r\n\r\n", "operationId": "UpdateNotificationTemplate", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Notification Template Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateNotificationTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Notification 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": [ "Notification Template" ], "summary": "Delete an existing Notification 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 | NotificationTemplate->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": "DeleteNotificationTemplate", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Notification Template Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteNotificationTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Notification 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/GEN/NotificationTemplates": { "get": { "tags": [ "Notification Template" ], "summary": "Get a collection of Notification 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| id | NotificationTemplate->Id | integer | int64 |\r\n| version | NotificationTemplate->Version | integer | int32 |\r\n| code | NotificationTemplate->Code | string | |\r\n| description | NotificationTemplate->Description | string | |\r\n| entityType | NotificationTemplate->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| outputType | NotificationTemplate->OutputType | string (Allowed values: [Email]) | enum |\r\n| isActive | NotificationTemplate->IsActive | boolean | |\r\n", "operationId": "GetNotificationTemplateCollection", "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 Notification Template collection", "schema": { "$ref": "#/definitions/GetNotificationTemplateCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Notification Template" ], "summary": "Create a new Notification 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| code | NotificationTemplate->Code | string | |\r\n| description | NotificationTemplate->Description | string | |\r\n| siteId | NotificationTemplate->Site_Id | integer | int64 |\r\n| permissionTreeId | NotificationTemplate->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | NotificationTemplate->SequenceNumber | integer | int32 |\r\n| entityType | NotificationTemplate->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| outputType | NotificationTemplate->OutputType | string (Allowed values: [Email]) | enum |\r\n| useAudienceQuery | NotificationTemplate->UseAudienceQuery | boolean | |\r\n| audienceQuery | NotificationTemplate->AudienceQuery | string | |\r\n| audienceQueryFilter | NotificationTemplate->AudienceQueryFilter | string | |\r\n| useBodyQuery | NotificationTemplate->UseBodyQuery | boolean | |\r\n| bodyQuery | NotificationTemplate->BodyQuery | string | |\r\n| outputLanguage | NotificationTemplate->OutputLanguage | string (Allowed values: [None, SystemOption, Fixed, Dynamic]) | enum |\r\n| languageQuery | NotificationTemplate->LanguageQuery | string | |\r\n| languageId | NotificationTemplate->Language_Id | integer | int64 |\r\n| audience | NotificationTemplate->Audience | array | array |\r\n| messageSubject | NotificationTemplate->MessageSubject | string | |\r\n| messageBody | NotificationTemplate->MessageBody | string | |\r\n| notes | NotificationTemplate->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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| entityType | Required | True | |\r\n| entityType | Nullable | False | |\r\n| outputType | Required | True | |\r\n| outputType | Nullable | False | |\r\n| audienceQuery | Nullable | False | NotificationTemplate->UseAudienceQuery eq TRUE |\r\n| bodyQuery | Nullable | False | NotificationTemplate->UseBodyQuery eq TRUE |\r\n| outputLanguage | Required | True | |\r\n| outputLanguage | Nullable | False | |\r\n| languageQuery | Nullable | False | NotificationTemplate->OutputLanguage eq 'Dynamic' |\r\n| languageId | Nullable | False | NotificationTemplate->OutputLanguage eq 'Fixed' |\r\n| languageId | Nullable | True | NotificationTemplate->OutputLanguage ne 'Fixed' |\r\n| messageSubject | Required | True | |\r\n| messageSubject | Nullable | False | |\r\n| messageBody | Required | True | |\r\n| messageBody | Nullable | False | |\r\n\r\n", "operationId": "CreateNotificationTemplate", "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/CreateNotificationTemplateResourceActionRequest" } }, { "$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/GEN/NotificationTemplates/Lookups/LookupNotificationTemplateChangePermissionTree": { "get": { "tags": [ "Notification Template" ], "summary": "Lookup the permission set for changing the Notification 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 | 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": "LookupNotificationTemplateChangePermissionTree", "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/NotificationTemplateChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/NotificationTemplates/Lookups/LookupNotificationTemplateInsertPermissionTree": { "get": { "tags": [ "Notification Template" ], "summary": "Lookup the permission set for creating the Notification 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 | 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": "LookupNotificationTemplateInsertPermissionTree", "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/NotificationTemplateInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/NotificationTemplates/Lookups/LookupNotificationTemplateLanguage": { "get": { "tags": [ "Notification Template" ], "summary": "Lookup the Language for the Notification 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 | Language->Id | integer | int64 |\r\n| code | Language->Code | string | |\r\n| description | Language->Description | string | |\r\n", "operationId": "LookupNotificationTemplateLanguage", "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/GEN/NotificationTemplates/Lookups/LookupNotificationTemplateSite": { "get": { "tags": [ "Notification Template" ], "summary": "Lookup the Site for the Notification 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 | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n", "operationId": "LookupNotificationTemplateSite", "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/GEN/NotificationTemplates/Batch/{ids}": { "get": { "tags": [ "Notification Template" ], "summary": "Get a collection of Notification 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| code | NotificationTemplate->Code | string | |\r\n| isActive | NotificationTemplate->IsActive | boolean | |\r\n| createdByUserId | NotificationTemplate->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | NotificationTemplate->CreatedByUser_Code | string | |\r\n| createdByUserFullName | NotificationTemplate->CreatedByUser_FullName | string | |\r\n| createdOn | NotificationTemplate->CreatedOn | string | date-time |\r\n| modifiedByUserId | NotificationTemplate->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | NotificationTemplate->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | NotificationTemplate->ModifiedByUser_FullName | string | |\r\n| modifiedOn | NotificationTemplate->ModifiedOn | string | date-time |\r\n| version | NotificationTemplate->Version | integer | int32 |\r\n| permissionTreeId | NotificationTemplate->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | NotificationTemplate->PermissionTree_Code | string | |\r\n| permissionTreeDescription | NotificationTemplate->PermissionTree_Description | string | |\r\n| siteId | NotificationTemplate->Site_Id | integer | int64 |\r\n| siteCode | NotificationTemplate->Site_Code | string | |\r\n| siteDescription | NotificationTemplate->Site_Description | string | |\r\n| id | NotificationTemplate->Id | integer | int64 |\r\n| audience | NotificationTemplate->Audience | array | array |\r\n| audienceQuery | NotificationTemplate->AudienceQuery | string | |\r\n| audienceQueryFilter | NotificationTemplate->AudienceQueryFilter | string | |\r\n| bodyQuery | NotificationTemplate->BodyQuery | string | |\r\n| description | NotificationTemplate->Description | string | |\r\n| entityType | NotificationTemplate->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| languageId | NotificationTemplate->Language_Id | integer | int64 |\r\n| languageCode | NotificationTemplate->Language_Code | string | |\r\n| languageDescription | NotificationTemplate->Language_Description | string | |\r\n| languageQuery | NotificationTemplate->LanguageQuery | string | |\r\n| messageBody | NotificationTemplate->MessageBody | string | |\r\n| messageSubject | NotificationTemplate->MessageSubject | string | |\r\n| notes | NotificationTemplate->Notes | string | |\r\n| outputLanguage | NotificationTemplate->OutputLanguage | string (Allowed values: [None, SystemOption, Fixed, Dynamic]) | enum |\r\n| outputType | NotificationTemplate->OutputType | string (Allowed values: [Email]) | enum |\r\n| sequenceNumber | NotificationTemplate->SequenceNumber | integer | int32 |\r\n| useAudienceQuery | NotificationTemplate->UseAudienceQuery | boolean | |\r\n| useBodyQuery | NotificationTemplate->UseBodyQuery | boolean | |\r\n", "operationId": "BatchGetNotificationTemplate", "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 Notification 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 Notification Template collection", "schema": { "$ref": "#/definitions/BatchGetNotificationTemplateResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/NotificationTemplates/Batch": { "post": { "tags": [ "Notification Template" ], "summary": "Create a new collection of Notification 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| code | NotificationTemplate->Code | string | |\r\n| description | NotificationTemplate->Description | string | |\r\n| siteId | NotificationTemplate->Site_Id | integer | int64 |\r\n| permissionTreeId | NotificationTemplate->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | NotificationTemplate->SequenceNumber | integer | int32 |\r\n| entityType | NotificationTemplate->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| outputType | NotificationTemplate->OutputType | string (Allowed values: [Email]) | enum |\r\n| useAudienceQuery | NotificationTemplate->UseAudienceQuery | boolean | |\r\n| audienceQuery | NotificationTemplate->AudienceQuery | string | |\r\n| audienceQueryFilter | NotificationTemplate->AudienceQueryFilter | string | |\r\n| useBodyQuery | NotificationTemplate->UseBodyQuery | boolean | |\r\n| bodyQuery | NotificationTemplate->BodyQuery | string | |\r\n| outputLanguage | NotificationTemplate->OutputLanguage | string (Allowed values: [None, SystemOption, Fixed, Dynamic]) | enum |\r\n| languageQuery | NotificationTemplate->LanguageQuery | string | |\r\n| languageId | NotificationTemplate->Language_Id | integer | int64 |\r\n| audience | NotificationTemplate->Audience | array | array |\r\n| messageSubject | NotificationTemplate->MessageSubject | string | |\r\n| messageBody | NotificationTemplate->MessageBody | string | |\r\n| notes | NotificationTemplate->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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| entityType | Required | True | |\r\n| entityType | Nullable | False | |\r\n| outputType | Required | True | |\r\n| outputType | Nullable | False | |\r\n| audienceQuery | Nullable | False | NotificationTemplate->UseAudienceQuery eq TRUE |\r\n| bodyQuery | Nullable | False | NotificationTemplate->UseBodyQuery eq TRUE |\r\n| outputLanguage | Required | True | |\r\n| outputLanguage | Nullable | False | |\r\n| languageQuery | Nullable | False | NotificationTemplate->OutputLanguage eq 'Dynamic' |\r\n| languageId | Nullable | False | NotificationTemplate->OutputLanguage eq 'Fixed' |\r\n| languageId | Nullable | True | NotificationTemplate->OutputLanguage ne 'Fixed' |\r\n| messageSubject | Required | True | |\r\n| messageSubject | Nullable | False | |\r\n| messageBody | Required | True | |\r\n| messageBody | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateNotificationTemplate", "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/BatchCreateNotificationTemplateRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Notification 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": [ "Notification Template" ], "summary": "Update a collection of existing Notification 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 | NotificationTemplate->Id | integer | int64 |\r\n| version | NotificationTemplate->Version | integer | int32 |\r\n| code | NotificationTemplate->Code | string | |\r\n| description | NotificationTemplate->Description | string | |\r\n| siteId | NotificationTemplate->Site_Id | integer | int64 |\r\n| sequenceNumber | NotificationTemplate->SequenceNumber | integer | int32 |\r\n| useAudienceQuery | NotificationTemplate->UseAudienceQuery | boolean | |\r\n| audienceQuery | NotificationTemplate->AudienceQuery | string | |\r\n| audienceQueryFilter | NotificationTemplate->AudienceQueryFilter | string | |\r\n| useBodyQuery | NotificationTemplate->UseBodyQuery | boolean | |\r\n| bodyQuery | NotificationTemplate->BodyQuery | string | |\r\n| outputLanguage | NotificationTemplate->OutputLanguage | string (Allowed values: [None, SystemOption, Fixed, Dynamic]) | enum |\r\n| languageQuery | NotificationTemplate->LanguageQuery | string | |\r\n| languageId | NotificationTemplate->Language_Id | integer | int64 |\r\n| audience | NotificationTemplate->Audience | array | array |\r\n| messageSubject | NotificationTemplate->MessageSubject | string | |\r\n| messageBody | NotificationTemplate->MessageBody | string | |\r\n| notes | NotificationTemplate->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| audienceQuery | Nullable | False | NotificationTemplate->UseAudienceQuery eq TRUE |\r\n| bodyQuery | Nullable | False | NotificationTemplate->UseBodyQuery eq TRUE |\r\n| languageQuery | Nullable | False | NotificationTemplate->OutputLanguage eq 'Dynamic' |\r\n| languageId | Nullable | False | NotificationTemplate->OutputLanguage eq 'Fixed' |\r\n| languageId | Nullable | True | NotificationTemplate->OutputLanguage ne 'Fixed' |\r\n| messageSubject | Nullable | False | |\r\n| messageBody | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateNotificationTemplate", "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/BatchUpdateNotificationTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Notification 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": [ "Notification Template" ], "summary": "Delete a collection of existing Notification 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 | NotificationTemplate->Id | integer | int64 |\r\n| version | NotificationTemplate->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": "BatchDeleteNotificationTemplate", "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/BatchDeleteNotificationTemplateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Notification 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/GEN/NotificationTemplates/{id}/PermissionTree": { "patch": { "tags": [ "Notification Template" ], "summary": "Change the PermissionTree for an existing Notification 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 | NotificationTemplate->Version | integer | int32 |\r\n| permissionTreeId | NotificationTemplate->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": "ChangeNotificationTemplatePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Notification Template Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeNotificationTemplatePermissionTreeResourceActionRequest" } }, { "$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/GEN/NotificationTemplates/{id}/Active": { "patch": { "tags": [ "Notification Template" ], "summary": "Change the IsActive status for an existing Notification 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 | NotificationTemplate->Version | integer | int32 |\r\n| isActive | NotificationTemplate->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": "ChangeNotificationTemplateIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Notification Template Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeNotificationTemplateIsActiveResourceActionRequest" } }, { "$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/GEN/NotificationTemplates/Batch/Active": { "patch": { "tags": [ "Notification Template" ], "summary": "Change the IsActive status for a collection of existing Notification 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 | NotificationTemplate->Id | integer | int64 |\r\n| version | NotificationTemplate->Version | integer | int32 |\r\n| isActive | NotificationTemplate->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": "BatchChangeNotificationTemplateIsActive", "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/BatchChangeNotificationTemplateIsActiveResourceActionRequest" } }, { "$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/GEN/NotificationTemplates/Batch/PermissionTree": { "patch": { "tags": [ "Notification Template" ], "summary": "Change the PermissionTree status for a collection of existing Notification 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 | NotificationTemplate->Id | integer | int64 |\r\n| version | NotificationTemplate->Version | integer | int32 |\r\n| permissionTreeId | NotificationTemplate->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": "BatchChangeNotificationTemplatePermissionTree", "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/BatchChangeNotificationTemplatePermissionTreeResourceActionRequest" } }, { "$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/GEN/NotificationTemplate/Parameters/{id}": { "get": { "tags": [ "Notification Template Parameter" ], "summary": "Get a Notification Template Parameter 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 | NotificationTemplateParameter->IsActive | boolean | |\r\n| createdByUserId | NotificationTemplateParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | NotificationTemplateParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | NotificationTemplateParameter->CreatedByUser_FullName | string | |\r\n| createdOn | NotificationTemplateParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | NotificationTemplateParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | NotificationTemplateParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | NotificationTemplateParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | NotificationTemplateParameter->ModifiedOn | string | date-time |\r\n| version | NotificationTemplateParameter->Version | integer | int32 |\r\n| permissionTreeId | NotificationTemplateParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | NotificationTemplateParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | NotificationTemplateParameter->PermissionTree_Description | string | |\r\n| id | NotificationTemplateParameter->Id | integer | int64 |\r\n| expressionType | NotificationTemplateParameter->ExpressionType | string (Allowed values: [Audience]) | enum |\r\n| notes | NotificationTemplateParameter->Notes | string | |\r\n| notificationTemplateId | NotificationTemplateParameter->NotificationTemplate_Id | integer | int64 |\r\n| notificationTemplateDescription | NotificationTemplateParameter->NotificationTemplate_Description | string | |\r\n| parameterName | NotificationTemplateParameter->ParameterName | string | |\r\n| sequenceNumber | NotificationTemplateParameter->SequenceNumber | integer | int32 |\r\n| value | NotificationTemplateParameter->Value | object | composite |\r\n", "operationId": "GetNotificationTemplateParameter", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Notification Template Parameter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Notification Template Parameter", "schema": { "$ref": "#/definitions/GetNotificationTemplateParameterResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Notification Template Parameter" ], "summary": "Update an existing Notification Template Parameter 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 | NotificationTemplateParameter->Version | integer | int32 |\r\n| parameterName | NotificationTemplateParameter->ParameterName | string | |\r\n| expressionType | NotificationTemplateParameter->ExpressionType | string (Allowed values: [Audience]) | enum |\r\n| value | NotificationTemplateParameter->Value | object | composite |\r\n| sequenceNumber | NotificationTemplateParameter->SequenceNumber | integer | int32 |\r\n| notes | NotificationTemplateParameter->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| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| expressionType | Nullable | False | |\r\n| value | Nullable | False | |\r\n\r\n", "operationId": "UpdateNotificationTemplateParameter", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Notification Template Parameter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateNotificationTemplateParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Notification Template Parameter 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": [ "Notification Template Parameter" ], "summary": "Delete an existing Notification Template Parameter 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 | NotificationTemplateParameter->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": "DeleteNotificationTemplateParameter", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Notification Template Parameter Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteNotificationTemplateParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Notification Template Parameter 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/GEN/NotificationTemplate/Parameters": { "get": { "tags": [ "Notification Template Parameter" ], "summary": "Get a collection of Notification Template Parameter 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 | NotificationTemplateParameter->Version | integer | int32 |\r\n| id | NotificationTemplateParameter->Id | integer | int64 |\r\n| parameterName | NotificationTemplateParameter->ParameterName | string | |\r\n| expressionType | NotificationTemplateParameter->ExpressionType | string (Allowed values: [Audience]) | enum |\r\n| isActive | NotificationTemplateParameter->IsActive | boolean | |\r\n| sequenceNumber | NotificationTemplateParameter->SequenceNumber | integer | int32 |\r\n| value | NotificationTemplateParameter->Value | object | composite |\r\n| notificationTemplateId | NotificationTemplateParameter->NotificationTemplate_Id | integer | int64 |\r\n| notificationTemplateDescription | NotificationTemplateParameter->NotificationTemplate_Description | string | |\r\n", "operationId": "GetNotificationTemplateParameterCollection", "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 Notification Template Parameter collection", "schema": { "$ref": "#/definitions/GetNotificationTemplateParameterCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Notification Template Parameter" ], "summary": "Create a new Notification Template Parameter 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| parameterName | NotificationTemplateParameter->ParameterName | string | |\r\n| expressionType | NotificationTemplateParameter->ExpressionType | string (Allowed values: [Audience]) | enum |\r\n| permissionTreeId | NotificationTemplateParameter->PermissionTree_Id | integer | int64 |\r\n| value | NotificationTemplateParameter->Value | object | composite |\r\n| notificationTemplateId | NotificationTemplateParameter->NotificationTemplate_Id | integer | int64 |\r\n| sequenceNumber | NotificationTemplateParameter->SequenceNumber | integer | int32 |\r\n| notes | NotificationTemplateParameter->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| parameterName | Required | True | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| expressionType | Required | True | |\r\n| expressionType | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | Nullable | False | |\r\n| notificationTemplateId | Required | True | |\r\n| notificationTemplateId | Nullable | False | |\r\n\r\n", "operationId": "CreateNotificationTemplateParameter", "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/CreateNotificationTemplateParameterResourceActionRequest" } }, { "$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/GEN/NotificationTemplates/{notificationTemplateId}/Parameters": { "get": { "tags": [ "Notification Template Parameter" ], "summary": "Get a collection of Notification Template Parameter resources for the Notification 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 | NotificationTemplateParameter->Id | integer | int64 |\r\n| notificationTemplateId | NotificationTemplateParameter->NotificationTemplate_Id | integer | int64 |\r\n| notificationTemplateDescription | NotificationTemplateParameter->NotificationTemplate_Description | string | |\r\n| expressionType | NotificationTemplateParameter->ExpressionType | string (Allowed values: [Audience]) | enum |\r\n| parameterName | NotificationTemplateParameter->ParameterName | string | |\r\n| value | NotificationTemplateParameter->Value | object | composite |\r\n| isActive | NotificationTemplateParameter->IsActive | boolean | |\r\n| version | NotificationTemplateParameter->Version | integer | int32 |\r\n", "operationId": "GetNotificationTemplateParameterForNotificationTemplateCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "notificationTemplateId", "in": "path", "required": true, "description": "Notification Template 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 Notification Template Parameter collection", "schema": { "$ref": "#/definitions/GetNotificationTemplateParameterForNotificationTemplateCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/NotificationTemplate/Parameters/Lookups/LookupNotificationTemplateParameterChangePermissionTree": { "get": { "tags": [ "Notification Template Parameter" ], "summary": "Lookup the permission set for changing the Notification Template Parameter.", "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": "LookupNotificationTemplateParameterChangePermissionTree", "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/NotificationTemplateParameterChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/NotificationTemplate/Parameters/Lookups/LookupNotificationTemplateParameterInsertPermissionTree": { "get": { "tags": [ "Notification Template Parameter" ], "summary": "Lookup the permission set for creating the Notification Template Parameter.", "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": "LookupNotificationTemplateParameterInsertPermissionTree", "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/NotificationTemplateParameterInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/NotificationTemplate/Parameters/Lookups/LookupNotificationTemplateParameterNotificationTemplate": { "get": { "tags": [ "Notification Template Parameter" ], "summary": "Lookup the Notification Template for the Notification Template Parameter.", "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 | NotificationTemplate->Id | integer | int64 |\r\n| description | NotificationTemplate->Description | string | |\r\n", "operationId": "LookupNotificationTemplateParameterNotificationTemplate", "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 Notification Template collection", "schema": { "$ref": "#/definitions/NotificationTemplateParametersChangeDataTriggerLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/NotificationTemplate/Parameters/Batch/{ids}": { "get": { "tags": [ "Notification Template Parameter" ], "summary": "Get a collection of Notification Template Parameter 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 | NotificationTemplateParameter->IsActive | boolean | |\r\n| createdByUserId | NotificationTemplateParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | NotificationTemplateParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | NotificationTemplateParameter->CreatedByUser_FullName | string | |\r\n| createdOn | NotificationTemplateParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | NotificationTemplateParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | NotificationTemplateParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | NotificationTemplateParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | NotificationTemplateParameter->ModifiedOn | string | date-time |\r\n| version | NotificationTemplateParameter->Version | integer | int32 |\r\n| permissionTreeId | NotificationTemplateParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | NotificationTemplateParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | NotificationTemplateParameter->PermissionTree_Description | string | |\r\n| id | NotificationTemplateParameter->Id | integer | int64 |\r\n| expressionType | NotificationTemplateParameter->ExpressionType | string (Allowed values: [Audience]) | enum |\r\n| notes | NotificationTemplateParameter->Notes | string | |\r\n| notificationTemplateId | NotificationTemplateParameter->NotificationTemplate_Id | integer | int64 |\r\n| notificationTemplateDescription | NotificationTemplateParameter->NotificationTemplate_Description | string | |\r\n| parameterName | NotificationTemplateParameter->ParameterName | string | |\r\n| sequenceNumber | NotificationTemplateParameter->SequenceNumber | integer | int32 |\r\n| value | NotificationTemplateParameter->Value | object | composite |\r\n", "operationId": "BatchGetNotificationTemplateParameter", "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 Notification Template Parameter 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 Notification Template Parameter collection", "schema": { "$ref": "#/definitions/BatchGetNotificationTemplateParameterResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/NotificationTemplate/Parameters/Batch": { "post": { "tags": [ "Notification Template Parameter" ], "summary": "Create a new collection of Notification Template Parameter 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| parameterName | NotificationTemplateParameter->ParameterName | string | |\r\n| expressionType | NotificationTemplateParameter->ExpressionType | string (Allowed values: [Audience]) | enum |\r\n| permissionTreeId | NotificationTemplateParameter->PermissionTree_Id | integer | int64 |\r\n| value | NotificationTemplateParameter->Value | object | composite |\r\n| notificationTemplateId | NotificationTemplateParameter->NotificationTemplate_Id | integer | int64 |\r\n| sequenceNumber | NotificationTemplateParameter->SequenceNumber | integer | int32 |\r\n| notes | NotificationTemplateParameter->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| parameterName | Required | True | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| expressionType | Required | True | |\r\n| expressionType | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| value | Required | True | |\r\n| value | Nullable | False | |\r\n| notificationTemplateId | Required | True | |\r\n| notificationTemplateId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateNotificationTemplateParameter", "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/BatchCreateNotificationTemplateParameterRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Notification Template Parameter 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": [ "Notification Template Parameter" ], "summary": "Update a collection of existing Notification Template Parameter 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 | NotificationTemplateParameter->Id | integer | int64 |\r\n| version | NotificationTemplateParameter->Version | integer | int32 |\r\n| parameterName | NotificationTemplateParameter->ParameterName | string | |\r\n| expressionType | NotificationTemplateParameter->ExpressionType | string (Allowed values: [Audience]) | enum |\r\n| value | NotificationTemplateParameter->Value | object | composite |\r\n| sequenceNumber | NotificationTemplateParameter->SequenceNumber | integer | int32 |\r\n| notes | NotificationTemplateParameter->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| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| expressionType | Nullable | False | |\r\n| value | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateNotificationTemplateParameter", "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/BatchUpdateNotificationTemplateParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Notification Template Parameter 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": [ "Notification Template Parameter" ], "summary": "Delete a collection of existing Notification Template Parameter 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 | NotificationTemplateParameter->Id | integer | int64 |\r\n| version | NotificationTemplateParameter->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": "BatchDeleteNotificationTemplateParameter", "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/BatchDeleteNotificationTemplateParameterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Notification Template Parameter 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/GEN/NotificationTemplate/Parameters/{id}/Active": { "patch": { "tags": [ "Notification Template Parameter" ], "summary": "Change the IsActive status for an existing Notification Template Parameter 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 | NotificationTemplateParameter->Version | integer | int32 |\r\n| isActive | NotificationTemplateParameter->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": "ChangeNotificationTemplateParameterIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Notification Template Parameter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeNotificationTemplateParameterIsActiveResourceActionRequest" } }, { "$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/GEN/NotificationTemplate/Parameters/{id}/PermissionTree": { "patch": { "tags": [ "Notification Template Parameter" ], "summary": "Change the PermissionTree for an existing Notification Template Parameter 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 | NotificationTemplateParameter->Version | integer | int32 |\r\n| permissionTreeId | NotificationTemplateParameter->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": "ChangeNotificationTemplateParameterPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Notification Template Parameter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeNotificationTemplateParameterPermissionTreeResourceActionRequest" } }, { "$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/GEN/NotificationTemplate/Parameters/Batch/Active": { "patch": { "tags": [ "Notification Template Parameter" ], "summary": "Change the IsActive status for a collection of existing Notification Template Parameter 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 | NotificationTemplateParameter->Id | integer | int64 |\r\n| version | NotificationTemplateParameter->Version | integer | int32 |\r\n| isActive | NotificationTemplateParameter->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": "BatchChangeNotificationTemplateParameterIsActive", "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/BatchChangeNotificationTemplateParameterIsActiveResourceActionRequest" } }, { "$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/GEN/NotificationTemplate/Parameters/Batch/PermissionTree": { "patch": { "tags": [ "Notification Template Parameter" ], "summary": "Change the PermissionTree status for a collection of existing Notification Template Parameter 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 | NotificationTemplateParameter->Id | integer | int64 |\r\n| version | NotificationTemplateParameter->Version | integer | int32 |\r\n| permissionTreeId | NotificationTemplateParameter->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": "BatchChangeNotificationTemplateParameterPermissionTree", "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/BatchChangeNotificationTemplateParameterPermissionTreeResourceActionRequest" } }, { "$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/GEN/PhoneNumberTypes/{id}": { "get": { "tags": [ "Phone Number Type" ], "summary": "Get a Phone Number Type 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 | PhoneNumberType->Code | string | |\r\n| isActive | PhoneNumberType->IsActive | boolean | |\r\n| version | PhoneNumberType->Version | integer | int32 |\r\n| permissionTreeId | PhoneNumberType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PhoneNumberType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PhoneNumberType->PermissionTree_Description | string | |\r\n| createdByUserId | PhoneNumberType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PhoneNumberType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PhoneNumberType->CreatedByUser_FullName | string | |\r\n| createdOn | PhoneNumberType->CreatedOn | string | date-time |\r\n| modifiedByUserId | PhoneNumberType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PhoneNumberType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PhoneNumberType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PhoneNumberType->ModifiedOn | string | date-time |\r\n| id | PhoneNumberType->Id | integer | int64 |\r\n| description | PhoneNumberType->Description | string | |\r\n| notes | PhoneNumberType->Notes | string | |\r\n| sequenceNumber | PhoneNumberType->SequenceNumber | integer | int32 |\r\n", "operationId": "GetPhoneNumberType", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Phone Number Type Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Phone Number Type", "schema": { "$ref": "#/definitions/GetPhoneNumberTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Phone Number Type" ], "summary": "Update an existing Phone Number Type 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 | PhoneNumberType->Version | integer | int32 |\r\n| code | PhoneNumberType->Code | string | |\r\n| description | PhoneNumberType->Description | string | |\r\n| sequenceNumber | PhoneNumberType->SequenceNumber | integer | int32 |\r\n| notes | PhoneNumberType->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": "UpdatePhoneNumberType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Phone Number Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePhoneNumberTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Phone Number Type 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": [ "Phone Number Type" ], "summary": "Delete an existing Phone Number Type 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 | PhoneNumberType->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": "DeletePhoneNumberType", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Phone Number Type Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePhoneNumberTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Phone Number Type 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/GEN/PhoneNumberTypes": { "get": { "tags": [ "Phone Number Type" ], "summary": "Get a collection of Phone Number Type 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 | PhoneNumberType->Version | integer | int32 |\r\n| id | PhoneNumberType->Id | integer | int64 |\r\n| code | PhoneNumberType->Code | string | |\r\n| description | PhoneNumberType->Description | string | |\r\n| notes | PhoneNumberType->Notes | string | |\r\n| sequenceNumber | PhoneNumberType->SequenceNumber | integer | int32 |\r\n| isActive | PhoneNumberType->IsActive | boolean | |\r\n| createdOn | PhoneNumberType->CreatedOn | string | date-time |\r\n| modifiedOn | PhoneNumberType->ModifiedOn | string | date-time |\r\n", "operationId": "GetPhoneNumberTypeCollection", "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 Phone Number Type collection", "schema": { "$ref": "#/definitions/GetPhoneNumberTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Phone Number Type" ], "summary": "Create a new Phone Number Type 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 | PhoneNumberType->Code | string | |\r\n| description | PhoneNumberType->Description | string | |\r\n| permissionTreeId | PhoneNumberType->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | PhoneNumberType->SequenceNumber | integer | int32 |\r\n| notes | PhoneNumberType->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 | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreatePhoneNumberType", "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/CreatePhoneNumberTypeResourceActionRequest" } }, { "$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/GEN/PhoneNumberTypes/Lookups/LookupPhoneNumberTypeChangePermissionTree": { "get": { "tags": [ "Phone Number Type" ], "summary": "Lookup the permission set for changing the Phone Number Type.", "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": "LookupPhoneNumberTypeChangePermissionTree", "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/PhoneNumberTypeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/PhoneNumberTypes/Lookups/LookupPhoneNumberTypeInsertPermissionTree": { "get": { "tags": [ "Phone Number Type" ], "summary": "Lookup the permission set for creating the Phone Number Type.", "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": "LookupPhoneNumberTypeInsertPermissionTree", "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/PhoneNumberTypeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/PhoneNumberTypes/Batch/{ids}": { "get": { "tags": [ "Phone Number Type" ], "summary": "Get a collection of Phone Number Type 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 | PhoneNumberType->Code | string | |\r\n| isActive | PhoneNumberType->IsActive | boolean | |\r\n| version | PhoneNumberType->Version | integer | int32 |\r\n| permissionTreeId | PhoneNumberType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PhoneNumberType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PhoneNumberType->PermissionTree_Description | string | |\r\n| createdByUserId | PhoneNumberType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PhoneNumberType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PhoneNumberType->CreatedByUser_FullName | string | |\r\n| createdOn | PhoneNumberType->CreatedOn | string | date-time |\r\n| modifiedByUserId | PhoneNumberType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PhoneNumberType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PhoneNumberType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PhoneNumberType->ModifiedOn | string | date-time |\r\n| id | PhoneNumberType->Id | integer | int64 |\r\n| description | PhoneNumberType->Description | string | |\r\n| notes | PhoneNumberType->Notes | string | |\r\n| sequenceNumber | PhoneNumberType->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetPhoneNumberType", "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 Phone Number Type 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 Phone Number Type collection", "schema": { "$ref": "#/definitions/BatchGetPhoneNumberTypeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/PhoneNumberTypes/Batch": { "post": { "tags": [ "Phone Number Type" ], "summary": "Create a new collection of Phone Number Type 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 | PhoneNumberType->Code | string | |\r\n| description | PhoneNumberType->Description | string | |\r\n| sequenceNumber | PhoneNumberType->SequenceNumber | integer | int32 |\r\n| permissionTreeId | PhoneNumberType->PermissionTree_Id | integer | int64 |\r\n| notes | PhoneNumberType->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 | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePhoneNumberType", "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/BatchCreatePhoneNumberTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Phone Number Type 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": [ "Phone Number Type" ], "summary": "Update a collection of existing Phone Number Type 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 | PhoneNumberType->Id | integer | int64 |\r\n| version | PhoneNumberType->Version | integer | int32 |\r\n| code | PhoneNumberType->Code | string | |\r\n| description | PhoneNumberType->Description | string | |\r\n| notes | PhoneNumberType->Notes | string | |\r\n| sequenceNumber | PhoneNumberType->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdatePhoneNumberType", "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/BatchUpdatePhoneNumberTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Phone Number Type 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": [ "Phone Number Type" ], "summary": "Delete a collection of existing Phone Number Type 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 | PhoneNumberType->Id | integer | int64 |\r\n| version | PhoneNumberType->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": "BatchDeletePhoneNumberType", "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/BatchDeletePhoneNumberTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Phone Number Type 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/GEN/PhoneNumberTypes/{id}/Active": { "patch": { "tags": [ "Phone Number Type" ], "summary": "Change the IsActive status for an existing Phone Number Type 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 | PhoneNumberType->Version | integer | int32 |\r\n| isActive | PhoneNumberType->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": "ChangePhoneNumberTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Phone Number Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePhoneNumberTypeIsActiveResourceActionRequest" } }, { "$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/GEN/PhoneNumberTypes/{id}/PermissionTree": { "patch": { "tags": [ "Phone Number Type" ], "summary": "Change the PermissionTree for an existing Phone Number Type 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 | PhoneNumberType->Version | integer | int32 |\r\n| permissionTreeId | PhoneNumberType->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": "ChangePhoneNumberTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Phone Number Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePhoneNumberTypePermissionTreeResourceActionRequest" } }, { "$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/GEN/PhoneNumberTypes/Batch/Active": { "patch": { "tags": [ "Phone Number Type" ], "summary": "Change the IsActive status for a collection of existing Phone Number Type 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 | PhoneNumberType->Id | integer | int64 |\r\n| version | PhoneNumberType->Version | integer | int32 |\r\n| isActive | PhoneNumberType->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": "BatchChangePhoneNumberTypeIsActive", "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/BatchChangePhoneNumberTypeIsActiveResourceActionRequest" } }, { "$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/GEN/PhoneNumberTypes/Batch/PermissionTree": { "patch": { "tags": [ "Phone Number Type" ], "summary": "Change the PermissionTree status for a collection of existing Phone Number Type 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 | PhoneNumberType->Id | integer | int64 |\r\n| version | PhoneNumberType->Version | integer | int32 |\r\n| permissionTreeId | PhoneNumberType->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": "BatchChangePhoneNumberTypePermissionTree", "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/BatchChangePhoneNumberTypePermissionTreeResourceActionRequest" } }, { "$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/GEN/PreconfiguredReasons/{id}": { "get": { "tags": [ "Preconfigured Reason" ], "summary": "Get a Preconfigured Reason 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 | PreconfiguredReason->Id | integer | int64 |\r\n| code | PreconfiguredReason->Code | string | |\r\n| isActive | PreconfiguredReason->IsActive | boolean | |\r\n| permissionTreeId | PreconfiguredReason->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PreconfiguredReason->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PreconfiguredReason->PermissionTree_Description | string | |\r\n| createdByUserId | PreconfiguredReason->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PreconfiguredReason->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PreconfiguredReason->CreatedByUser_FullName | string | |\r\n| createdOn | PreconfiguredReason->CreatedOn | string | date-time |\r\n| modifiedByUserId | PreconfiguredReason->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PreconfiguredReason->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PreconfiguredReason->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PreconfiguredReason->ModifiedOn | string | date-time |\r\n| version | PreconfiguredReason->Version | integer | int32 |\r\n| description | PreconfiguredReason->Description | string | |\r\n| preconfiguredReasonType | PreconfiguredReason->PreconfiguredReasonType | string (Allowed values: [TaskNotDone, WorkOrderTaskFailedReason, WorkOrderProgressLog]) | enum |\r\n| sequenceNumber | PreconfiguredReason->SequenceNumber | integer | int32 |\r\n| notes | PreconfiguredReason->Notes | string | |\r\n", "operationId": "GetPreconfiguredReason", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Preconfigured Reason Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Preconfigured Reason", "schema": { "$ref": "#/definitions/GetPreconfiguredReasonResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Preconfigured Reason" ], "summary": "Update an existing Preconfigured Reason 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 | PreconfiguredReason->Version | integer | int32 |\r\n| code | PreconfiguredReason->Code | string | |\r\n| description | PreconfiguredReason->Description | string | |\r\n| preconfiguredReasonType | PreconfiguredReason->PreconfiguredReasonType | string (Allowed values: [TaskNotDone, WorkOrderTaskFailedReason, WorkOrderProgressLog]) | enum |\r\n| sequenceNumber | PreconfiguredReason->SequenceNumber | integer | int32 |\r\n| notes | PreconfiguredReason->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| preconfiguredReasonType | Nullable | False | |\r\n\r\n", "operationId": "UpdatePreconfiguredReason", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Preconfigured Reason Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdatePreconfiguredReasonResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Preconfigured Reason 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": [ "Preconfigured Reason" ], "summary": "Delete an existing Preconfigured Reason 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 | PreconfiguredReason->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": "DeletePreconfiguredReason", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Preconfigured Reason Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeletePreconfiguredReasonResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Preconfigured Reason 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/GEN/PreconfiguredReasons": { "get": { "tags": [ "Preconfigured Reason" ], "summary": "Get a collection of Preconfigured Reason 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 | PreconfiguredReason->Id | integer | int64 |\r\n| version | PreconfiguredReason->Version | integer | int32 |\r\n| code | PreconfiguredReason->Code | string | |\r\n| description | PreconfiguredReason->Description | string | |\r\n| isActive | PreconfiguredReason->IsActive | boolean | |\r\n| preconfiguredReasonType | PreconfiguredReason->PreconfiguredReasonType | string (Allowed values: [TaskNotDone, WorkOrderTaskFailedReason, WorkOrderProgressLog]) | enum |\r\n| sequenceNumber | PreconfiguredReason->SequenceNumber | integer | int32 |\r\n", "operationId": "GetPreconfiguredReasonCollection", "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 Preconfigured Reason collection", "schema": { "$ref": "#/definitions/GetPreconfiguredReasonCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Preconfigured Reason" ], "summary": "Create a new Preconfigured Reason 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 | PreconfiguredReason->Code | string | |\r\n| description | PreconfiguredReason->Description | string | |\r\n| permissionTreeId | PreconfiguredReason->PermissionTree_Id | integer | int64 |\r\n| preconfiguredReasonType | PreconfiguredReason->PreconfiguredReasonType | string (Allowed values: [TaskNotDone, WorkOrderTaskFailedReason, WorkOrderProgressLog]) | enum |\r\n| sequenceNumber | PreconfiguredReason->SequenceNumber | integer | int32 |\r\n| notes | PreconfiguredReason->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| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| preconfiguredReasonType | Required | True | |\r\n| preconfiguredReasonType | Nullable | False | |\r\n\r\n", "operationId": "CreatePreconfiguredReason", "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/CreatePreconfiguredReasonResourceActionRequest" } }, { "$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/GEN/PreconfiguredReasons/Lookups/LookupPreconfiguredReasonChangePermissionTree": { "get": { "tags": [ "Preconfigured Reason" ], "summary": "Lookup the permission set for changing the Preconfigured Reason.", "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": "LookupPreconfiguredReasonChangePermissionTree", "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/PreconfiguredReasonChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/PreconfiguredReasons/Lookups/LookupPreconfiguredReasonInsertPermissionTree": { "get": { "tags": [ "Preconfigured Reason" ], "summary": "Lookup the permission set for creating the Preconfigured Reason.", "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": "LookupPreconfiguredReasonInsertPermissionTree", "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/PreconfiguredReasonInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/PreconfiguredReasons/Batch/{ids}": { "get": { "tags": [ "Preconfigured Reason" ], "summary": "Get a collection of Preconfigured Reason 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| id | PreconfiguredReason->Id | integer | int64 |\r\n| code | PreconfiguredReason->Code | string | |\r\n| isActive | PreconfiguredReason->IsActive | boolean | |\r\n| permissionTreeId | PreconfiguredReason->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | PreconfiguredReason->PermissionTree_Code | string | |\r\n| permissionTreeDescription | PreconfiguredReason->PermissionTree_Description | string | |\r\n| createdByUserId | PreconfiguredReason->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PreconfiguredReason->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PreconfiguredReason->CreatedByUser_FullName | string | |\r\n| createdOn | PreconfiguredReason->CreatedOn | string | date-time |\r\n| modifiedByUserId | PreconfiguredReason->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | PreconfiguredReason->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | PreconfiguredReason->ModifiedByUser_FullName | string | |\r\n| modifiedOn | PreconfiguredReason->ModifiedOn | string | date-time |\r\n| version | PreconfiguredReason->Version | integer | int32 |\r\n| description | PreconfiguredReason->Description | string | |\r\n| preconfiguredReasonType | PreconfiguredReason->PreconfiguredReasonType | string (Allowed values: [TaskNotDone, WorkOrderTaskFailedReason, WorkOrderProgressLog]) | enum |\r\n| sequenceNumber | PreconfiguredReason->SequenceNumber | integer | int32 |\r\n| notes | PreconfiguredReason->Notes | string | |\r\n", "operationId": "BatchGetPreconfiguredReason", "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 Preconfigured Reason 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 Preconfigured Reason collection", "schema": { "$ref": "#/definitions/BatchGetPreconfiguredReasonResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/PreconfiguredReasons/Batch": { "post": { "tags": [ "Preconfigured Reason" ], "summary": "Create a new collection of Preconfigured Reason 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 | PreconfiguredReason->Code | string | |\r\n| description | PreconfiguredReason->Description | string | |\r\n| permissionTreeId | PreconfiguredReason->PermissionTree_Id | integer | int64 |\r\n| preconfiguredReasonType | PreconfiguredReason->PreconfiguredReasonType | string (Allowed values: [TaskNotDone, WorkOrderTaskFailedReason, WorkOrderProgressLog]) | enum |\r\n| sequenceNumber | PreconfiguredReason->SequenceNumber | integer | int32 |\r\n| notes | PreconfiguredReason->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| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| preconfiguredReasonType | Required | True | |\r\n| preconfiguredReasonType | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePreconfiguredReason", "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/BatchCreatePreconfiguredReasonResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Preconfigured Reason 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": [ "Preconfigured Reason" ], "summary": "Update a collection of existing Preconfigured Reason 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 | PreconfiguredReason->Id | integer | int64 |\r\n| version | PreconfiguredReason->Version | integer | int32 |\r\n| code | PreconfiguredReason->Code | string | |\r\n| description | PreconfiguredReason->Description | string | |\r\n| preconfiguredReasonType | PreconfiguredReason->PreconfiguredReasonType | string (Allowed values: [TaskNotDone, WorkOrderTaskFailedReason, WorkOrderProgressLog]) | enum |\r\n| sequenceNumber | PreconfiguredReason->SequenceNumber | integer | int32 |\r\n| notes | PreconfiguredReason->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| preconfiguredReasonType | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdatePreconfiguredReason", "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/BatchUpdatePreconfiguredReasonResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Preconfigured Reason 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": [ "Preconfigured Reason" ], "summary": "Delete a collection of existing Preconfigured Reason 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 | PreconfiguredReason->Id | integer | int64 |\r\n| version | PreconfiguredReason->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": "BatchDeletePreconfiguredReason", "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/BatchDeletePreconfiguredReasonResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Preconfigured Reason 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/GEN/PreconfiguredReasons/{id}/Active": { "patch": { "tags": [ "Preconfigured Reason" ], "summary": "Change the IsActive status for an existing Preconfigured Reason 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 | PreconfiguredReason->Version | integer | int32 |\r\n| isActive | PreconfiguredReason->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": "ChangePreconfiguredReasonIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Preconfigured Reason Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangePreconfiguredReasonIsActiveResourceActionRequest" } }, { "$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/GEN/PreconfiguredReasons/Batch/Active": { "patch": { "tags": [ "Preconfigured Reason" ], "summary": "Change the IsActive status for a collection of existing Preconfigured Reason 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 | PreconfiguredReason->Id | integer | int64 |\r\n| version | PreconfiguredReason->Version | integer | int32 |\r\n| isActive | PreconfiguredReason->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": "BatchChangePreconfiguredReasonIsActive", "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/BatchChangePreconfiguredReasonIsActiveResourceActionRequest" } }, { "$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/GEN/RequestTypes/{id}": { "get": { "tags": [ "Request Type" ], "summary": "Get a Request Type 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 | RequestType->Code | string | |\r\n| isActive | RequestType->IsActive | boolean | |\r\n| createdByUserId | RequestType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequestType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequestType->CreatedByUser_FullName | string | |\r\n| createdOn | RequestType->CreatedOn | string | date-time |\r\n| modifiedByUserId | RequestType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequestType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequestType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequestType->ModifiedOn | string | date-time |\r\n| version | RequestType->Version | integer | int32 |\r\n| permissionTreeId | RequestType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequestType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequestType->PermissionTree_Description | string | |\r\n| id | RequestType->Id | integer | int64 |\r\n| description | RequestType->Description | string | |\r\n| notes | RequestType->Notes | string | |\r\n| sequenceNumber | RequestType->SequenceNumber | integer | int32 |\r\n", "operationId": "GetRequestType", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Request Type Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Request Type", "schema": { "$ref": "#/definitions/GetRequestTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Request Type" ], "summary": "Update an existing Request Type 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 | RequestType->Version | integer | int32 |\r\n| code | RequestType->Code | string | |\r\n| description | RequestType->Description | string | |\r\n| sequenceNumber | RequestType->SequenceNumber | integer | int32 |\r\n| notes | RequestType->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": "UpdateRequestType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Request Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateRequestTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Request Type 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": [ "Request Type" ], "summary": "Delete an existing Request Type 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 | RequestType->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": "DeleteRequestType", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Request Type Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteRequestTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Request Type 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/GEN/RequestTypes": { "get": { "tags": [ "Request Type" ], "summary": "Get a collection of Request Type 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 | RequestType->Version | integer | int32 |\r\n| id | RequestType->Id | integer | int64 |\r\n| code | RequestType->Code | string | |\r\n| description | RequestType->Description | string | |\r\n| sequenceNumber | RequestType->SequenceNumber | integer | int32 |\r\n| notes | RequestType->Notes | string | |\r\n| createdOn | RequestType->CreatedOn | string | date-time |\r\n| modifiedOn | RequestType->ModifiedOn | string | date-time |\r\n", "operationId": "GetRequestTypeCollection", "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 Request Type collection", "schema": { "$ref": "#/definitions/GetRequestTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Request Type" ], "summary": "Create a new Request Type 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 | RequestType->PermissionTree_Id | integer | int64 |\r\n| code | RequestType->Code | string | |\r\n| description | RequestType->Description | string | |\r\n| sequenceNumber | RequestType->SequenceNumber | integer | int32 |\r\n| notes | RequestType->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": "CreateRequestType", "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/CreateRequestTypeResourceActionRequest" } }, { "$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/GEN/RequestTypes/Lookups/LookupRequestTypeChangePermissionTree": { "get": { "tags": [ "Request Type" ], "summary": "Lookup the permission set for changing the Request Type.", "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": "LookupRequestTypeChangePermissionTree", "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/RequestTypeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/RequestTypes/Lookups/LookupRequestTypeInsertPermissionTree": { "get": { "tags": [ "Request Type" ], "summary": "Lookup the permission set for creating the Request Type.", "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": "LookupRequestTypeInsertPermissionTree", "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/RequestTypeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/RequestTypes/Batch/{ids}": { "get": { "tags": [ "Request Type" ], "summary": "Get a collection of Request Type 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 | RequestType->Code | string | |\r\n| isActive | RequestType->IsActive | boolean | |\r\n| createdByUserId | RequestType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | RequestType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | RequestType->CreatedByUser_FullName | string | |\r\n| createdOn | RequestType->CreatedOn | string | date-time |\r\n| modifiedByUserId | RequestType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | RequestType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | RequestType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | RequestType->ModifiedOn | string | date-time |\r\n| version | RequestType->Version | integer | int32 |\r\n| permissionTreeId | RequestType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | RequestType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | RequestType->PermissionTree_Description | string | |\r\n| id | RequestType->Id | integer | int64 |\r\n| description | RequestType->Description | string | |\r\n| notes | RequestType->Notes | string | |\r\n| sequenceNumber | RequestType->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetRequestType", "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 Request Type 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 Request Type collection", "schema": { "$ref": "#/definitions/BatchGetRequestTypeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/RequestTypes/Batch": { "post": { "tags": [ "Request Type" ], "summary": "Create a new collection of Request Type 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 | RequestType->PermissionTree_Id | integer | int64 |\r\n| code | RequestType->Code | string | |\r\n| description | RequestType->Description | string | |\r\n| sequenceNumber | RequestType->SequenceNumber | integer | int32 |\r\n| notes | RequestType->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": "BatchCreateRequestType", "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/BatchCreateRequestTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Request Type 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": [ "Request Type" ], "summary": "Update a collection of existing Request Type 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 | RequestType->Id | integer | int64 |\r\n| version | RequestType->Version | integer | int32 |\r\n| code | RequestType->Code | string | |\r\n| description | RequestType->Description | string | |\r\n| sequenceNumber | RequestType->SequenceNumber | integer | int32 |\r\n| notes | RequestType->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": "BatchUpdateRequestType", "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/BatchUpdateRequestTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Request Type 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": [ "Request Type" ], "summary": "Delete a collection of existing Request Type 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 | RequestType->Id | integer | int64 |\r\n| version | RequestType->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": "BatchDeleteRequestType", "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/BatchDeleteRequestTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Request Type 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/GEN/RequestTypes/{id}/Active": { "patch": { "tags": [ "Request Type" ], "summary": "Change the IsActive status for an existing Request Type 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 | RequestType->Version | integer | int32 |\r\n| isActive | RequestType->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": "ChangeRequestTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Request Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRequestTypeIsActiveResourceActionRequest" } }, { "$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/GEN/RequestTypes/{id}/PermissionTree": { "patch": { "tags": [ "Request Type" ], "summary": "Change the PermissionTree for an existing Request Type 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 | RequestType->Version | integer | int32 |\r\n| permissionTreeId | RequestType->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": "ChangeRequestTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Request Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeRequestTypePermissionTreeResourceActionRequest" } }, { "$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/GEN/RequestTypes/Batch/Active": { "patch": { "tags": [ "Request Type" ], "summary": "Change the IsActive status for a collection of existing Request Type 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 | RequestType->Id | integer | int64 |\r\n| version | RequestType->Version | integer | int32 |\r\n| isActive | RequestType->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": "BatchChangeRequestTypeIsActive", "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/BatchChangeRequestTypeIsActiveResourceActionRequest" } }, { "$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/GEN/RequestTypes/Batch/PermissionTree": { "patch": { "tags": [ "Request Type" ], "summary": "Change the PermissionTree status for a collection of existing Request Type 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 | RequestType->Id | integer | int64 |\r\n| version | RequestType->Version | integer | int32 |\r\n| permissionTreeId | RequestType->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": "BatchChangeRequestTypePermissionTree", "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/BatchChangeRequestTypePermissionTreeResourceActionRequest" } }, { "$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/GEN/Sites/{id}": { "get": { "tags": [ "Site" ], "summary": "Get a Site 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 | Site->Code | string | |\r\n| geographicId | Site->GeographicId | integer | int64 |\r\n| geographicEndPosition | Site->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | Site->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | Site->GeographicLength | number | decimal |\r\n| geographicLocation | Site->GeographicLocation | object | |\r\n| geographicNotes | Site->GeographicNotes | string | |\r\n| geographicReferenceEntityId | Site->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | Site->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | Site->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | Site->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | Site->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | Site->GeographicUnitOfMeasurement_Code | string | |\r\n| isActive | Site->IsActive | boolean | |\r\n| createdByUserId | Site->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Site->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Site->CreatedByUser_FullName | string | |\r\n| createdOn | Site->CreatedOn | string | date-time |\r\n| modifiedByUserId | Site->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Site->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Site->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Site->ModifiedOn | string | date-time |\r\n| version | Site->Version | integer | int32 |\r\n| permissionTreeId | Site->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Site->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Site->PermissionTree_Description | string | |\r\n| id | Site->Id | integer | int64 |\r\n| contentTranslate | Site->ContentTranslate | boolean | |\r\n| costElementId | Site->CostElement_Id | integer | int64 |\r\n| costElementCode | Site->CostElement_Code | string | |\r\n| costElementDescription | Site->CostElement_Description | string | |\r\n| currencyId | Site->Currency_Id | integer | int64 |\r\n| currencyCode | Site->Currency_Code | string | |\r\n| currencyDescription | Site->Currency_Description | string | |\r\n| dateFormat | Site->DateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| dateSeparator | Site->DateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| defaultLanguageId | Site->DefaultLanguage_Id | integer | int64 |\r\n| defaultLanguageCode | Site->DefaultLanguage_Code | string | |\r\n| defaultLanguageDescription | Site->DefaultLanguage_Description | string | |\r\n| description | Site->Description | string | |\r\n| enableRequisitionApprovalWorkflow | Site->EnableRequisitionApprovalWorkflow | string (Allowed values: [SystemOption, True, False]) | enum |\r\n| financialYearPeriodId | Site->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | Site->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | Site->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodFinancialYearId | Site->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | Site->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | Site->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| isVirtual | Site->IsVirtual | boolean | |\r\n| notes | Site->Notes | string | |\r\n| parentSiteId | Site->ParentSite_Id | integer | int64 |\r\n| parentSiteCode | Site->ParentSite_Code | string | |\r\n| parentSiteDescription | Site->ParentSite_Description | string | |\r\n| reportServerReportLanguage | Site->ReportServerReportLanguage | string | |\r\n| reportServerReportLanguageDisplayName | Site->ReportServerReportLanguageDisplayName | string | |\r\n| reportServerUILanguage | Site->ReportServerUILanguage | string | |\r\n| reportServerUILanguageDisplayName | Site->ReportServerUILanguageDisplayName | string | |\r\n| sequenceNumber | Site->SequenceNumber | integer | int32 |\r\n| siteTypeId | Site->SiteType_Id | integer | int64 |\r\n| siteTypeCode | Site->SiteType_Code | string | |\r\n| siteTypeDescription | Site->SiteType_Description | string | |\r\n| timeFormat | Site->TimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| timeZoneOffset | Site->TimeZoneOffset | number | float |\r\n| warehouseId | Site->Warehouse_Id | integer | int64 |\r\n| warehouseCode | Site->Warehouse_Code | string | |\r\n| warehouseDescription | Site->Warehouse_Description | string | |\r\n", "operationId": "GetSite", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Site", "schema": { "$ref": "#/definitions/GetSiteResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Site" ], "summary": "Update an existing Site 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 | Site->Version | integer | int32 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n| sequenceNumber | Site->SequenceNumber | integer | int32 |\r\n| siteTypeId | Site->SiteType_Id | integer | int64 |\r\n| currencyId | Site->Currency_Id | integer | int64 |\r\n| costElementId | Site->CostElement_Id | integer | int64 |\r\n| financialYearPeriodId | Site->FinancialYearPeriod_Id | integer | int64 |\r\n| defaultLanguageId | Site->DefaultLanguage_Id | integer | int64 |\r\n| warehouseId | Site->Warehouse_Id | integer | int64 |\r\n| timeZoneOffset | Site->TimeZoneOffset | number | float |\r\n| contentTranslate | Site->ContentTranslate | boolean | |\r\n| dateFormat | Site->DateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| dateSeparator | Site->DateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| timeFormat | Site->TimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| reportServerUILanguage | Site->ReportServerUILanguage | string | |\r\n| reportServerReportLanguage | Site->ReportServerReportLanguage | string | |\r\n| notes | Site->Notes | string | |\r\n| enableRequisitionApprovalWorkflow | Site->EnableRequisitionApprovalWorkflow | string (Allowed values: [SystemOption, True, False]) | enum |\r\n| geographicLocation | Site->GeographicLocation | object | |\r\n| geographicStartPosition | Site->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | Site->GeographicEndPosition | number | decimal |\r\n| geographicLength | Site->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | Site->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | Site->GeographicNotes | string | |\r\n| geographicReferenceEntityType | Site->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | Site->GeographicReferenceEntityId | 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| 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| siteTypeId | Nullable | False | |\r\n| currencyId | Nullable | False | |\r\n| timeZoneOffset | Nullable | False | |\r\n| reportServerUILanguage | Max Length | <= 50 chars| |\r\n| reportServerReportLanguage | Max Length | <= 50 chars| |\r\n| enableRequisitionApprovalWorkflow | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "UpdateSite", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSiteResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site 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": [ "Site" ], "summary": "Delete an existing Site 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 | Site->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": "DeleteSite", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSiteResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site 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/GEN/Sites": { "get": { "tags": [ "Site" ], "summary": "Get a collection of Site 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 | Site->Version | integer | int32 |\r\n| id | Site->Id | integer | int64 |\r\n| parentSiteId | Site->ParentSite_Id | integer | int64 |\r\n| parentSiteCode | Site->ParentSite_Code | string | |\r\n| parentSiteDescription | Site->ParentSite_Description | string | |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n| sequenceNumber | Site->SequenceNumber | integer | int32 |\r\n| siteTypeId | Site->SiteType_Id | integer | int64 |\r\n| siteTypeCode | Site->SiteType_Code | string | |\r\n| siteTypeDescription | Site->SiteType_Description | string | |\r\n| costElementId | Site->CostElement_Id | integer | int64 |\r\n| costElementCode | Site->CostElement_Code | string | |\r\n| costElementDescription | Site->CostElement_Description | string | |\r\n| currencyId | Site->Currency_Id | integer | int64 |\r\n| currencyCode | Site->Currency_Code | string | |\r\n| currencyDescription | Site->Currency_Description | string | |\r\n| timeZoneOffset | Site->TimeZoneOffset | number | float |\r\n| notes | Site->Notes | string | |\r\n| createdOn | Site->CreatedOn | string | date-time |\r\n| modifiedOn | Site->ModifiedOn | string | date-time |\r\n| warehouseId | Site->Warehouse_Id | integer | int64 |\r\n| warehouseCode | Site->Warehouse_Code | string | |\r\n| warehouseDescription | Site->Warehouse_Description | string | |\r\n", "operationId": "GetSiteCollection", "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/GetSiteCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Site" ], "summary": "Create a new Site 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 | Site->PermissionTree_Id | integer | int64 |\r\n| parentSiteId | Site->ParentSite_Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n| isVirtual | Site->IsVirtual | boolean | |\r\n| sequenceNumber | Site->SequenceNumber | integer | int32 |\r\n| siteTypeId | Site->SiteType_Id | integer | int64 |\r\n| currencyId | Site->Currency_Id | integer | int64 |\r\n| costElementId | Site->CostElement_Id | integer | int64 |\r\n| financialYearPeriodId | Site->FinancialYearPeriod_Id | integer | int64 |\r\n| defaultLanguageId | Site->DefaultLanguage_Id | integer | int64 |\r\n| warehouseId | Site->Warehouse_Id | integer | int64 |\r\n| timeZoneOffset | Site->TimeZoneOffset | number | float |\r\n| contentTranslate | Site->ContentTranslate | boolean | |\r\n| dateFormat | Site->DateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| dateSeparator | Site->DateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| timeFormat | Site->TimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| reportServerUILanguage | Site->ReportServerUILanguage | string | |\r\n| reportServerReportLanguage | Site->ReportServerReportLanguage | string | |\r\n| notes | Site->Notes | string | |\r\n| enableRequisitionApprovalWorkflow | Site->EnableRequisitionApprovalWorkflow | string (Allowed values: [SystemOption, True, False]) | enum |\r\n| geographicLocation | Site->GeographicLocation | object | |\r\n| geographicStartPosition | Site->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | Site->GeographicEndPosition | number | decimal |\r\n| geographicLength | Site->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | Site->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | Site->GeographicNotes | string | |\r\n| geographicReferenceEntityType | Site->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | Site->GeographicReferenceEntityId | 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| permissionTreeId | System Generated | true | If no value specified |\r\n| parentSiteId | Nullable | False | Site->Id NE 1L |\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| isVirtual | Nullable | False | |\r\n| siteTypeId | Required | True | |\r\n| siteTypeId | Nullable | False | |\r\n| currencyId | System Generated | true | If no value specified |\r\n| currencyId | Nullable | False | |\r\n| timeZoneOffset | Required | True | |\r\n| timeZoneOffset | Nullable | False | |\r\n| reportServerUILanguage | Max Length | <= 50 chars| |\r\n| reportServerReportLanguage | Max Length | <= 50 chars| |\r\n| enableRequisitionApprovalWorkflow | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "CreateSite", "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/CreateSiteResourceActionRequest" } }, { "$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/GEN/Sites/Lookups/LookupFinancialYearPeriod": { "get": { "tags": [ "Site" ], "summary": "Lookup the Financial Year for the Site.", "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 | FinancialYearPeriod->Id | integer | int64 |\r\n| code | FinancialYearPeriod->Code | string | |\r\n| description | FinancialYearPeriod->Description | string | |\r\n| financialYearId | FinancialYearPeriod->FinancialYear_Id | integer | int64 |\r\n| financialYearCode | FinancialYearPeriod->FinancialYear_Code | string | |\r\n| financialYearDescription | FinancialYearPeriod->FinancialYear_Description | string | |\r\n", "operationId": "LookupFinancialYearPeriod", "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 Financial Year Period collection", "schema": { "$ref": "#/definitions/SiteFinancialYearPeriodLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Lookups/LookupSiteChangePermissionTree": { "get": { "tags": [ "Site" ], "summary": "Lookup the permission set for changing the Site.", "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": "LookupSiteChangePermissionTree", "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/SiteChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Lookups/LookupSiteCostElement": { "get": { "tags": [ "Site" ], "summary": "Lookup the Cost Element for the Site.", "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": "LookupSiteCostElement", "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/SiteCostElementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Lookups/LookupSiteCurrency": { "get": { "tags": [ "Site" ], "summary": "Lookup the Currency for the Site.", "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 | Currency->Id | integer | int64 |\r\n| code | Currency->Code | string | |\r\n| description | Currency->Description | string | |\r\n", "operationId": "LookupSiteCurrency", "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 Currency collection", "schema": { "$ref": "#/definitions/SiteCurrencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Lookups/LookupSiteDefaultLanguage": { "get": { "tags": [ "Site" ], "summary": "Lookup the Language for the Site.", "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": "LookupSiteDefaultLanguage", "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/SiteDefaultLanguageLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Lookups/LookupFinancialYear": { "get": { "tags": [ "Site" ], "summary": "Lookup the Financial Year for the Site.", "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 | FinancialYear->Id | integer | int64 |\r\n| code | FinancialYear->Code | string | |\r\n| description | FinancialYear->Description | string | |\r\n", "operationId": "LookupFinancialYear", "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 Financial Year collection", "schema": { "$ref": "#/definitions/SiteFinancialYearLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Lookups/LookupSiteInsertPermissionTree": { "get": { "tags": [ "Site" ], "summary": "Lookup the permission set for creating the Site.", "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": "LookupSiteInsertPermissionTree", "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/SiteInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Lookups/LookupSiteParentSite": { "get": { "tags": [ "Site" ], "summary": "Lookup the parent Site.", "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": "LookupSiteParentSite", "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/SiteParentSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Lookups/LookupSiteSiteType": { "get": { "tags": [ "Site" ], "summary": "Lookup the Site Type for the Site.", "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 | SiteType->Id | integer | int64 |\r\n| code | SiteType->Code | string | |\r\n| description | SiteType->Description | string | |\r\n", "operationId": "LookupSiteSiteType", "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 Type collection", "schema": { "$ref": "#/definitions/SiteSiteTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Lookups/LookupSiteWarehouse": { "get": { "tags": [ "Site" ], "summary": "Lookup the Warehouse for the Site.", "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 | Warehouse->Id | integer | int64 |\r\n| code | Warehouse->Code | string | |\r\n| description | Warehouse->Description | string | |\r\n", "operationId": "LookupSiteWarehouse", "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 Warehouse collection", "schema": { "$ref": "#/definitions/SiteWarehouseLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Batch/{ids}": { "get": { "tags": [ "Site" ], "summary": "Get a collection of Site 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 | Site->Code | string | |\r\n| geographicId | Site->GeographicId | integer | int64 |\r\n| geographicEndPosition | Site->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | Site->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | Site->GeographicLength | number | decimal |\r\n| geographicLocation | Site->GeographicLocation | object | |\r\n| geographicNotes | Site->GeographicNotes | string | |\r\n| geographicReferenceEntityId | Site->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | Site->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | Site->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | Site->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | Site->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | Site->GeographicUnitOfMeasurement_Code | string | |\r\n| isActive | Site->IsActive | boolean | |\r\n| createdByUserId | Site->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Site->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Site->CreatedByUser_FullName | string | |\r\n| createdOn | Site->CreatedOn | string | date-time |\r\n| modifiedByUserId | Site->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Site->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Site->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Site->ModifiedOn | string | date-time |\r\n| version | Site->Version | integer | int32 |\r\n| permissionTreeId | Site->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Site->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Site->PermissionTree_Description | string | |\r\n| id | Site->Id | integer | int64 |\r\n| contentTranslate | Site->ContentTranslate | boolean | |\r\n| costElementId | Site->CostElement_Id | integer | int64 |\r\n| costElementCode | Site->CostElement_Code | string | |\r\n| costElementDescription | Site->CostElement_Description | string | |\r\n| currencyId | Site->Currency_Id | integer | int64 |\r\n| currencyCode | Site->Currency_Code | string | |\r\n| currencyDescription | Site->Currency_Description | string | |\r\n| dateFormat | Site->DateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| dateSeparator | Site->DateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| defaultLanguageId | Site->DefaultLanguage_Id | integer | int64 |\r\n| defaultLanguageCode | Site->DefaultLanguage_Code | string | |\r\n| defaultLanguageDescription | Site->DefaultLanguage_Description | string | |\r\n| description | Site->Description | string | |\r\n| enableRequisitionApprovalWorkflow | Site->EnableRequisitionApprovalWorkflow | string (Allowed values: [SystemOption, True, False]) | enum |\r\n| financialYearPeriodId | Site->FinancialYearPeriod_Id | integer | int64 |\r\n| financialYearPeriodCode | Site->FinancialYearPeriod_Code | string | |\r\n| financialYearPeriodDescription | Site->FinancialYearPeriod_Description | string | |\r\n| financialYearPeriodFinancialYearId | Site->FinancialYearPeriod_FinancialYear_Id | integer | int64 |\r\n| financialYearPeriodFinancialYearCode | Site->FinancialYearPeriod_FinancialYear_Code | string | |\r\n| financialYearPeriodFinancialYearDescription | Site->FinancialYearPeriod_FinancialYear_Description | string | |\r\n| isVirtual | Site->IsVirtual | boolean | |\r\n| notes | Site->Notes | string | |\r\n| parentSiteId | Site->ParentSite_Id | integer | int64 |\r\n| parentSiteCode | Site->ParentSite_Code | string | |\r\n| parentSiteDescription | Site->ParentSite_Description | string | |\r\n| reportServerReportLanguage | Site->ReportServerReportLanguage | string | |\r\n| reportServerReportLanguageDisplayName | Site->ReportServerReportLanguageDisplayName | string | |\r\n| reportServerUILanguage | Site->ReportServerUILanguage | string | |\r\n| reportServerUILanguageDisplayName | Site->ReportServerUILanguageDisplayName | string | |\r\n| sequenceNumber | Site->SequenceNumber | integer | int32 |\r\n| siteTypeId | Site->SiteType_Id | integer | int64 |\r\n| siteTypeCode | Site->SiteType_Code | string | |\r\n| siteTypeDescription | Site->SiteType_Description | string | |\r\n| timeFormat | Site->TimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| timeZoneOffset | Site->TimeZoneOffset | number | float |\r\n| warehouseId | Site->Warehouse_Id | integer | int64 |\r\n| warehouseCode | Site->Warehouse_Code | string | |\r\n| warehouseDescription | Site->Warehouse_Description | string | |\r\n", "operationId": "BatchGetSite", "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 Site 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 Site collection", "schema": { "$ref": "#/definitions/BatchGetSiteResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Batch": { "post": { "tags": [ "Site" ], "summary": "Create a new collection of Site 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 | Site->PermissionTree_Id | integer | int64 |\r\n| parentSiteId | Site->ParentSite_Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n| isVirtual | Site->IsVirtual | boolean | |\r\n| sequenceNumber | Site->SequenceNumber | integer | int32 |\r\n| siteTypeId | Site->SiteType_Id | integer | int64 |\r\n| currencyId | Site->Currency_Id | integer | int64 |\r\n| costElementId | Site->CostElement_Id | integer | int64 |\r\n| financialYearPeriodId | Site->FinancialYearPeriod_Id | integer | int64 |\r\n| defaultLanguageId | Site->DefaultLanguage_Id | integer | int64 |\r\n| warehouseId | Site->Warehouse_Id | integer | int64 |\r\n| contentTranslate | Site->ContentTranslate | boolean | |\r\n| dateFormat | Site->DateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| dateSeparator | Site->DateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| timeFormat | Site->TimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| reportServerUILanguage | Site->ReportServerUILanguage | string | |\r\n| reportServerReportLanguage | Site->ReportServerReportLanguage | string | |\r\n| timeZoneOffset | Site->TimeZoneOffset | number | float |\r\n| notes | Site->Notes | string | |\r\n| enableRequisitionApprovalWorkflow | Site->EnableRequisitionApprovalWorkflow | string (Allowed values: [SystemOption, True, False]) | enum |\r\n| geographicLocation | Site->GeographicLocation | object | |\r\n| geographicStartPosition | Site->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | Site->GeographicEndPosition | number | decimal |\r\n| geographicLength | Site->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | Site->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | Site->GeographicNotes | string | |\r\n| geographicReferenceEntityType | Site->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | Site->GeographicReferenceEntityId | 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| permissionTreeId | System Generated | true | If no value specified |\r\n| parentSiteId | Nullable | False | Site->Id NE 1L |\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| isVirtual | Nullable | False | |\r\n| siteTypeId | Required | True | |\r\n| siteTypeId | Nullable | False | |\r\n| currencyId | System Generated | true | If no value specified |\r\n| currencyId | Nullable | False | |\r\n| reportServerUILanguage | Max Length | <= 50 chars| |\r\n| reportServerReportLanguage | Max Length | <= 50 chars| |\r\n| timeZoneOffset | Required | True | |\r\n| timeZoneOffset | Nullable | False | |\r\n| enableRequisitionApprovalWorkflow | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateSite", "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/BatchCreateSiteResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Site 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": [ "Site" ], "summary": "Update a collection of existing Site 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 | Site->Id | integer | int64 |\r\n| version | Site->Version | integer | int32 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n| sequenceNumber | Site->SequenceNumber | integer | int32 |\r\n| siteTypeId | Site->SiteType_Id | integer | int64 |\r\n| currencyId | Site->Currency_Id | integer | int64 |\r\n| costElementId | Site->CostElement_Id | integer | int64 |\r\n| financialYearPeriodId | Site->FinancialYearPeriod_Id | integer | int64 |\r\n| defaultLanguageId | Site->DefaultLanguage_Id | integer | int64 |\r\n| warehouseId | Site->Warehouse_Id | integer | int64 |\r\n| timeZoneOffset | Site->TimeZoneOffset | number | float |\r\n| contentTranslate | Site->ContentTranslate | boolean | |\r\n| dateFormat | Site->DateFormat | string (Allowed values: [YYYYMMDD, YYYYDDMM, DDMMYYYY, MMDDYYYY]) | enum |\r\n| dateSeparator | Site->DateSeparator | string (Allowed values: [Slash, Dot]) | enum |\r\n| timeFormat | Site->TimeFormat | string (Allowed values: [Clock24h, Clock12h]) | enum |\r\n| reportServerUILanguage | Site->ReportServerUILanguage | string | |\r\n| reportServerReportLanguage | Site->ReportServerReportLanguage | string | |\r\n| notes | Site->Notes | string | |\r\n| enableRequisitionApprovalWorkflow | Site->EnableRequisitionApprovalWorkflow | string (Allowed values: [SystemOption, True, False]) | enum |\r\n| geographicLocation | Site->GeographicLocation | object | |\r\n| geographicStartPosition | Site->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | Site->GeographicEndPosition | number | decimal |\r\n| geographicLength | Site->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | Site->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | Site->GeographicNotes | string | |\r\n| geographicReferenceEntityType | Site->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | Site->GeographicReferenceEntityId | 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| 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| siteTypeId | Nullable | False | |\r\n| currencyId | Nullable | False | |\r\n| timeZoneOffset | Nullable | False | |\r\n| reportServerUILanguage | Max Length | <= 50 chars| |\r\n| reportServerReportLanguage | Max Length | <= 50 chars| |\r\n| enableRequisitionApprovalWorkflow | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateSite", "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/BatchUpdateSiteResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site 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": [ "Site" ], "summary": "Delete a collection of existing Site 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 | Site->Id | integer | int64 |\r\n| version | Site->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": "BatchDeleteSite", "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/BatchDeleteSiteResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site 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/GEN/Sites/{id}/Active": { "patch": { "tags": [ "Site" ], "summary": "Change the IsActive status for an existing Site 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 | Site->Version | integer | int32 |\r\n| isActive | Site->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": "ChangeSiteIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSiteIsActiveResourceActionRequest" } }, { "$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/GEN/Sites/{id}/PermissionTree": { "patch": { "tags": [ "Site" ], "summary": "Change the PermissionTree for an existing Site 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 | Site->Version | integer | int32 |\r\n| permissionTreeId | Site->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": "ChangeSitePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSitePermissionTreeResourceActionRequest" } }, { "$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/GEN/Sites/Move": { "post": { "tags": [ "Site" ], "summary": "Move Site.", "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| sourceId | MoveEntity->SourceId | integer | int64 |\r\n| targetId | MoveEntity->TargetId | 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| sourceId | Required | True | |\r\n| sourceId | Nullable | False | |\r\n| targetId | Required | True | |\r\n| targetId | Nullable | False | |\r\n\r\n", "operationId": "MoveSite", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "moveEntity", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/MoveSiteResourceActionRequest" } }, { "$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/GEN/Sites/Batch/Active": { "patch": { "tags": [ "Site" ], "summary": "Change the IsActive status for a collection of existing Site 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 | Site->Id | integer | int64 |\r\n| version | Site->Version | integer | int32 |\r\n| isActive | Site->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": "BatchChangeSiteIsActive", "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/BatchChangeSiteIsActiveResourceActionRequest" } }, { "$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/GEN/Sites/Batch/PermissionTree": { "patch": { "tags": [ "Site" ], "summary": "Change the PermissionTree status for a collection of existing Site 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 | Site->Id | integer | int64 |\r\n| version | Site->Version | integer | int32 |\r\n| permissionTreeId | Site->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": "BatchChangeSitePermissionTree", "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/BatchChangeSitePermissionTreeResourceActionRequest" } }, { "$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/GEN/Sites/MatchBatch": { "patch": { "tags": [ "Site" ], "summary": "Update a collection of existing Site 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 | Site->Id | integer | int64 |\r\n| version | Site->Version | integer | int32 |\r\n| financialYearPeriodId | Site->FinancialYearPeriod_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\r\n", "operationId": "MatchUpdateSite", "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/MatchUpdateSiteResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site 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/GEN/Sites/Attributes/{id}": { "get": { "tags": [ "Site Attribute" ], "summary": "Get a collection of Site Attribute resources for the Site.", "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| siteId | SiteAttribute->Site_Id | integer | int64 |\r\n| siteCode | SiteAttribute->Site_Code | string | |\r\n| siteDescription | SiteAttribute->Site_Description | string | |\r\n| createdByUserId | SiteAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SiteAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SiteAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | SiteAttribute->CreatedOn | string | date-time |\r\n| isActive | SiteAttribute->IsActive | boolean | |\r\n| modifiedByUserId | SiteAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SiteAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SiteAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SiteAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | SiteAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SiteAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SiteAttribute->PermissionTree_Description | string | |\r\n| version | SiteAttribute->Version | integer | int32 |\r\n| id | SiteAttribute->Id | integer | int64 |\r\n| attributeId | SiteAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | SiteAttribute->Attribute_Code | string | |\r\n| attributeDescription | SiteAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | SiteAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | SiteAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | SiteAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | SiteAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | SiteAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | SiteAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | SiteAttribute->Notes | string | |\r\n| predefinedValueId | SiteAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | SiteAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | SiteAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | SiteAttribute->SequenceNumber | integer | int32 |\r\n| value | SiteAttribute->Value | object | composite |\r\n", "operationId": "GetSiteAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Site Attribute", "schema": { "$ref": "#/definitions/GetSiteAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Site Attribute" ], "summary": "Update an existing Site 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 | SiteAttribute->Version | integer | int32 |\r\n| value | SiteAttribute->Value | object | composite |\r\n| predefinedValueId | SiteAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | SiteAttribute->SequenceNumber | integer | int32 |\r\n| notes | SiteAttribute->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": "UpdateSiteAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSiteAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site 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": [ "Site Attribute" ], "summary": "Delete an existing Site 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 | SiteAttribute->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": "DeleteSiteAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSiteAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site 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/GEN/Sites/{siteId}/Attributes": { "get": { "tags": [ "Site Attribute" ], "summary": "Get a collection of Site Attribute resources for the Site.", "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 | SiteAttribute->Id | integer | int64 |\r\n| version | SiteAttribute->Version | integer | int32 |\r\n| sequenceNumber | SiteAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | SiteAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | SiteAttribute->Attribute_Code | string | |\r\n| attributeDescription | SiteAttribute->Attribute_Description | string | |\r\n| attributeDataType | SiteAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | SiteAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | SiteAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | SiteAttribute->PredefinedValue_Value | object | composite |\r\n| value | SiteAttribute->Value | object | composite |\r\n| notes | SiteAttribute->Notes | string | |\r\n| createdOn | SiteAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | SiteAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetSiteAttributeCollectionForSite", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "siteId", "in": "path", "required": true, "description": "Site 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 Site Attribute collection", "schema": { "$ref": "#/definitions/GetSiteAttributeCollectionForSiteResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Attributes": { "get": { "tags": [ "Site Attribute" ], "summary": "Get a collection of Site 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 | SiteAttribute->Id | integer | int64 |\r\n| version | SiteAttribute->Version | integer | int32 |\r\n| sequenceNumber | SiteAttribute->SequenceNumber | integer | int32 |\r\n| siteCode | SiteAttribute->Site_Code | string | |\r\n| siteDescription | SiteAttribute->Site_Description | string | |\r\n| attributeId | SiteAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | SiteAttribute->Attribute_Code | string | |\r\n| attributeDescription | SiteAttribute->Attribute_Description | string | |\r\n| attributeDataType | SiteAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | SiteAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | SiteAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | SiteAttribute->PredefinedValue_Value | object | composite |\r\n| value | SiteAttribute->Value | object | composite |\r\n| notes | SiteAttribute->Notes | string | |\r\n| createdOn | SiteAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | SiteAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetSiteAttributeCollection", "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 Attribute collection", "schema": { "$ref": "#/definitions/GetSiteAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Site Attribute" ], "summary": "Create a new Site 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| siteId | SiteAttribute->Site_Id | integer | int64 |\r\n| attributeId | SiteAttribute->Attribute_Id | integer | int64 |\r\n| value | SiteAttribute->Value | object | composite |\r\n| predefinedValueId | SiteAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | SiteAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | SiteAttribute->SequenceNumber | integer | int32 |\r\n| notes | SiteAttribute->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| siteId | Required | True | |\r\n| siteId | 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": "CreateSiteAttribute", "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/CreateSiteAttributeResourceActionRequest" } }, { "$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/GEN/Sites/Attributes/Lookups/LookupSiteAttributeAllowedValue": { "get": { "tags": [ "Site Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Site 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": "LookupSiteAttributeAllowedValue", "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/SiteAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Attributes/Lookups/LookupSiteAttribute": { "get": { "tags": [ "Site Attribute" ], "summary": "Lookup the Attribute for the Site 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": "LookupSiteAttribute", "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/SiteAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Attributes/Lookups/LookupSiteAttributeInsertPermissionTree": { "get": { "tags": [ "Site Attribute" ], "summary": "Lookup the permission set for creating the Site 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": "LookupSiteAttributeInsertPermissionTree", "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/SiteAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Attributes/Lookups/LookupSiteAttributeSite": { "get": { "tags": [ "Site Attribute" ], "summary": "Lookup the Site Attribute for the Site 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 | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n", "operationId": "LookupSiteAttributeSite", "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/SiteAttributeSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Attributes/Batch/{ids}": { "get": { "tags": [ "Site Attribute" ], "summary": "Get a collection of Site 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| siteId | SiteAttribute->Site_Id | integer | int64 |\r\n| siteCode | SiteAttribute->Site_Code | string | |\r\n| siteDescription | SiteAttribute->Site_Description | string | |\r\n| createdByUserId | SiteAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SiteAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SiteAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | SiteAttribute->CreatedOn | string | date-time |\r\n| isActive | SiteAttribute->IsActive | boolean | |\r\n| modifiedByUserId | SiteAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SiteAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SiteAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SiteAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | SiteAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SiteAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SiteAttribute->PermissionTree_Description | string | |\r\n| version | SiteAttribute->Version | integer | int32 |\r\n| id | SiteAttribute->Id | integer | int64 |\r\n| attributeId | SiteAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | SiteAttribute->Attribute_Code | string | |\r\n| attributeDescription | SiteAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | SiteAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | SiteAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | SiteAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | SiteAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | SiteAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | SiteAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | SiteAttribute->Notes | string | |\r\n| predefinedValueId | SiteAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | SiteAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | SiteAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | SiteAttribute->SequenceNumber | integer | int32 |\r\n| value | SiteAttribute->Value | object | composite |\r\n", "operationId": "BatchGetSiteAttribute", "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 Site 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 Site Attribute collection", "schema": { "$ref": "#/definitions/BatchGetSiteAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Attributes/Batch": { "post": { "tags": [ "Site Attribute" ], "summary": "Create a new collection of Site 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| siteId | SiteAttribute->Site_Id | integer | int64 |\r\n| attributeId | SiteAttribute->Attribute_Id | integer | int64 |\r\n| value | SiteAttribute->Value | object | composite |\r\n| predefinedValueId | SiteAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | SiteAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | SiteAttribute->SequenceNumber | integer | int32 |\r\n| notes | SiteAttribute->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| siteId | Required | True | |\r\n| siteId | 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": "BatchCreateSiteAttribute", "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/BatchCreateSiteAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Site 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": [ "Site Attribute" ], "summary": "Update a collection of existing Site 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 | SiteAttribute->Id | integer | int64 |\r\n| version | SiteAttribute->Version | integer | int32 |\r\n| value | SiteAttribute->Value | object | composite |\r\n| predefinedValueId | SiteAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | SiteAttribute->SequenceNumber | integer | int32 |\r\n| notes | SiteAttribute->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": "BatchUpdateSiteAttribute", "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/BatchUpdateSiteAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site 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": [ "Site Attribute" ], "summary": "Delete a collection of existing Site 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 | SiteAttribute->Id | integer | int64 |\r\n| version | SiteAttribute->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": "BatchDeleteSiteAttribute", "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/BatchDeleteSiteAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site 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/GEN/Sites/Attributes/{id}/Active": { "patch": { "tags": [ "Site Attribute" ], "summary": "Change the IsActive status for an existing Site 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 | SiteAttribute->Version | integer | int32 |\r\n| isActive | SiteAttribute->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": "ChangeSiteAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSiteAttributeIsActiveResourceActionRequest" } }, { "$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/GEN/Sites/Attributes/Batch/Active": { "patch": { "tags": [ "Site Attribute" ], "summary": "Change the IsActive status for a collection of existing Site 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 | SiteAttribute->Id | integer | int64 |\r\n| version | SiteAttribute->Version | integer | int32 |\r\n| isActive | SiteAttribute->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": "BatchChangeSiteAttributeIsActive", "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/BatchChangeSiteAttributeIsActiveResourceActionRequest" } }, { "$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/GEN/Sites/ContactAddresses/{id}": { "get": { "tags": [ "Site Contact Address" ], "summary": "Get a Site Contact Address 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 | SiteContactAddress->IsActive | boolean | |\r\n| createdByUserId | SiteContactAddress->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SiteContactAddress->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SiteContactAddress->CreatedByUser_FullName | string | |\r\n| createdOn | SiteContactAddress->CreatedOn | string | date-time |\r\n| modifiedByUserId | SiteContactAddress->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SiteContactAddress->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SiteContactAddress->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SiteContactAddress->ModifiedOn | string | date-time |\r\n| version | SiteContactAddress->Version | integer | int32 |\r\n| permissionTreeId | SiteContactAddress->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SiteContactAddress->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SiteContactAddress->PermissionTree_Description | string | |\r\n| siteId | SiteContactAddress->Site_Id | integer | int64 |\r\n| siteCode | SiteContactAddress->Site_Code | string | |\r\n| siteDescription | SiteContactAddress->Site_Description | string | |\r\n| id | SiteContactAddress->Id | integer | int64 |\r\n| addressTypeId | SiteContactAddress->AddressType_Id | integer | int64 |\r\n| addressTypeCode | SiteContactAddress->AddressType_Code | string | |\r\n| addressTypeDescription | SiteContactAddress->AddressType_Description | string | |\r\n| body | SiteContactAddress->Body | string | |\r\n| country | SiteContactAddress->Country | string | |\r\n| notes | SiteContactAddress->Notes | string | |\r\n| postalCode | SiteContactAddress->PostalCode | string | |\r\n| sequenceNumber | SiteContactAddress->SequenceNumber | integer | int32 |\r\n", "operationId": "GetSiteContactAddress", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Contact Address Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Site Contact Address", "schema": { "$ref": "#/definitions/GetSiteContactAddressResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Site Contact Address" ], "summary": "Update an existing Site Contact Address 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 | SiteContactAddress->Version | integer | int32 |\r\n| addressTypeId | SiteContactAddress->AddressType_Id | integer | int64 |\r\n| body | SiteContactAddress->Body | string | |\r\n| sequenceNumber | SiteContactAddress->SequenceNumber | integer | int32 |\r\n| postalCode | SiteContactAddress->PostalCode | string | |\r\n| country | SiteContactAddress->Country | string | |\r\n| notes | SiteContactAddress->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| addressTypeId | Nullable | False | |\r\n| body | Nullable | False | |\r\n| postalCode | Min Length | >= 1 chars| |\r\n| postalCode | Max Length | <= 50 chars| |\r\n| country | Min Length | >= 1 chars| |\r\n| country | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "UpdateSiteContactAddress", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Contact Address Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSiteContactAddressResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site Contact Address 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": [ "Site Contact Address" ], "summary": "Delete an existing Site Contact Address 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 | SiteContactAddress->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": "DeleteSiteContactAddress", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Contact Address Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSiteContactAddressResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site Contact Address 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/GEN/Sites/ContactAddresses": { "get": { "tags": [ "Site Contact Address" ], "summary": "Get a collection of Site Contact Address 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 | SiteContactAddress->Id | integer | int64 |\r\n| version | SiteContactAddress->Version | integer | int32 |\r\n| siteId | SiteContactAddress->Site_Id | integer | int64 |\r\n| siteCode | SiteContactAddress->Site_Code | string | |\r\n| siteDescription | SiteContactAddress->Site_Description | string | |\r\n| addressTypeId | SiteContactAddress->AddressType_Id | integer | int64 |\r\n| addressTypeCode | SiteContactAddress->AddressType_Code | string | |\r\n| addressTypeDescription | SiteContactAddress->AddressType_Description | string | |\r\n| body | SiteContactAddress->Body | string | |\r\n| sequenceNumber | SiteContactAddress->SequenceNumber | integer | int32 |\r\n| notes | SiteContactAddress->Notes | string | |\r\n| createdOn | SiteContactAddress->CreatedOn | string | date-time |\r\n| modifiedOn | SiteContactAddress->ModifiedOn | string | date-time |\r\n", "operationId": "GetSiteContactAddressCollection", "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 Contact Address collection", "schema": { "$ref": "#/definitions/GetSiteContactAddressCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Site Contact Address" ], "summary": "Create a new Site Contact Address 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| siteId | SiteContactAddress->Site_Id | integer | int64 |\r\n| permissionTreeId | SiteContactAddress->PermissionTree_Id | integer | int64 |\r\n| addressTypeId | SiteContactAddress->AddressType_Id | integer | int64 |\r\n| body | SiteContactAddress->Body | string | |\r\n| postalCode | SiteContactAddress->PostalCode | string | |\r\n| country | SiteContactAddress->Country | string | |\r\n| sequenceNumber | SiteContactAddress->SequenceNumber | integer | int32 |\r\n| notes | SiteContactAddress->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| siteId | Required | True | |\r\n| siteId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| addressTypeId | Required | True | |\r\n| addressTypeId | Nullable | False | |\r\n| body | Nullable | False | |\r\n| postalCode | Min Length | >= 1 chars| |\r\n| postalCode | Max Length | <= 50 chars| |\r\n| country | Min Length | >= 1 chars| |\r\n| country | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "CreateSiteContactAddress", "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/CreateSiteContactAddressResourceActionRequest" } }, { "$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/GEN/Sites/{siteId}/ContactAddresses": { "get": { "tags": [ "Site Contact Address" ], "summary": "Get a collection of Site Contact Address resources for the Site", "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 | SiteContactAddress->Id | integer | int64 |\r\n| version | SiteContactAddress->Version | integer | int32 |\r\n| addressTypeId | SiteContactAddress->AddressType_Id | integer | int64 |\r\n| addressTypeCode | SiteContactAddress->AddressType_Code | string | |\r\n| addressTypeDescription | SiteContactAddress->AddressType_Description | string | |\r\n| body | SiteContactAddress->Body | string | |\r\n| sequenceNumber | SiteContactAddress->SequenceNumber | integer | int32 |\r\n| notes | SiteContactAddress->Notes | string | |\r\n| createdOn | SiteContactAddress->CreatedOn | string | date-time |\r\n| modifiedOn | SiteContactAddress->ModifiedOn | string | date-time |\r\n", "operationId": "GetSiteContactAddressForSiteCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "siteId", "in": "path", "required": true, "description": "Site 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 Site Contact Address collection", "schema": { "$ref": "#/definitions/GetSiteContactAddressForSiteCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/ContactAddresses/Lookups/LookupSiteContactAddressAddressType": { "get": { "tags": [ "Site Contact Address" ], "summary": "Site Contact Address", "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 | AddressType->Id | integer | int64 |\r\n| code | AddressType->Code | string | |\r\n| description | AddressType->Description | string | |\r\n", "operationId": "LookupSiteContactAddressAddressType", "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 Address Type collection", "schema": { "$ref": "#/definitions/SiteContactAddressAddressTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/ContactAddresses/Lookups/LookupSiteContactAddressInsertPermissionTree": { "get": { "tags": [ "Site Contact Address" ], "summary": "Lookup the permission set for creating the Site Contact Address.", "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": "LookupSiteContactAddressInsertPermissionTree", "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/SiteContactAddressInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/ContactAddresses/Lookups/LookupSiteContactAddressSite": { "get": { "tags": [ "Site Contact Address" ], "summary": "Lookup the Site Contact Address for the Site Contact Address.", "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": "LookupSiteContactAddressSite", "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/SiteContactAddressSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/ContactAddresses/Batch/{ids}": { "get": { "tags": [ "Site Contact Address" ], "summary": "Get a collection of Site Contact Address 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 | SiteContactAddress->IsActive | boolean | |\r\n| createdByUserId | SiteContactAddress->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SiteContactAddress->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SiteContactAddress->CreatedByUser_FullName | string | |\r\n| createdOn | SiteContactAddress->CreatedOn | string | date-time |\r\n| modifiedByUserId | SiteContactAddress->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SiteContactAddress->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SiteContactAddress->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SiteContactAddress->ModifiedOn | string | date-time |\r\n| version | SiteContactAddress->Version | integer | int32 |\r\n| permissionTreeId | SiteContactAddress->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SiteContactAddress->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SiteContactAddress->PermissionTree_Description | string | |\r\n| siteId | SiteContactAddress->Site_Id | integer | int64 |\r\n| siteCode | SiteContactAddress->Site_Code | string | |\r\n| siteDescription | SiteContactAddress->Site_Description | string | |\r\n| id | SiteContactAddress->Id | integer | int64 |\r\n| addressTypeId | SiteContactAddress->AddressType_Id | integer | int64 |\r\n| addressTypeCode | SiteContactAddress->AddressType_Code | string | |\r\n| addressTypeDescription | SiteContactAddress->AddressType_Description | string | |\r\n| body | SiteContactAddress->Body | string | |\r\n| country | SiteContactAddress->Country | string | |\r\n| notes | SiteContactAddress->Notes | string | |\r\n| postalCode | SiteContactAddress->PostalCode | string | |\r\n| sequenceNumber | SiteContactAddress->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetSiteContactAddress", "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 Site Contact Address 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 Site Contact Address collection", "schema": { "$ref": "#/definitions/BatchGetSiteContactAddressResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/ContactAddresses/Batch": { "post": { "tags": [ "Site Contact Address" ], "summary": "Create a new collection of Site Contact Address 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| siteId | SiteContactAddress->Site_Id | integer | int64 |\r\n| permissionTreeId | SiteContactAddress->PermissionTree_Id | integer | int64 |\r\n| addressTypeId | SiteContactAddress->AddressType_Id | integer | int64 |\r\n| body | SiteContactAddress->Body | string | |\r\n| sequenceNumber | SiteContactAddress->SequenceNumber | integer | int32 |\r\n| postalCode | SiteContactAddress->PostalCode | string | |\r\n| country | SiteContactAddress->Country | string | |\r\n| notes | SiteContactAddress->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| siteId | Required | True | |\r\n| siteId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| addressTypeId | Required | True | |\r\n| addressTypeId | Nullable | False | |\r\n| body | Nullable | False | |\r\n| postalCode | Min Length | >= 1 chars| |\r\n| postalCode | Max Length | <= 50 chars| |\r\n| country | Min Length | >= 1 chars| |\r\n| country | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "BatchCreateSiteContactAddress", "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/BatchCreateSiteContactAddressResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Site Contact Address 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": [ "Site Contact Address" ], "summary": "Update a collection of existing Site Contact Address 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 | SiteContactAddress->Id | integer | int64 |\r\n| version | SiteContactAddress->Version | integer | int32 |\r\n| addressTypeId | SiteContactAddress->AddressType_Id | integer | int64 |\r\n| body | SiteContactAddress->Body | string | |\r\n| postalCode | SiteContactAddress->PostalCode | string | |\r\n| country | SiteContactAddress->Country | string | |\r\n| sequenceNumber | SiteContactAddress->SequenceNumber | integer | int32 |\r\n| notes | SiteContactAddress->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| addressTypeId | Nullable | False | |\r\n| body | Nullable | False | |\r\n| postalCode | Min Length | >= 1 chars| |\r\n| postalCode | Max Length | <= 50 chars| |\r\n| country | Min Length | >= 1 chars| |\r\n| country | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "BatchUpdateSiteContactAddress", "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/BatchUpdateSiteContactAddressResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site Contact Address 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": [ "Site Contact Address" ], "summary": "Delete a collection of existing Site Contact Address 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 | SiteContactAddress->Id | integer | int64 |\r\n| version | SiteContactAddress->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": "BatchDeleteSiteContactAddress", "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/BatchDeleteSiteContactAddressResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site Contact Address 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/GEN/Sites/ContactAddresses/{id}/Active": { "patch": { "tags": [ "Site Contact Address" ], "summary": "Change the IsActive status for an existing Site Contact Address 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 | SiteContactAddress->Version | integer | int32 |\r\n| isActive | SiteContactAddress->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": "ChangeSiteContactAddressIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Contact Address Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSiteContactAddressIsActiveResourceActionRequest" } }, { "$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/GEN/Sites/ContactAddresses/Batch/Active": { "patch": { "tags": [ "Site Contact Address" ], "summary": "Change the IsActive status for a collection of existing Site Contact Address 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 | SiteContactAddress->Id | integer | int64 |\r\n| version | SiteContactAddress->Version | integer | int32 |\r\n| isActive | SiteContactAddress->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": "BatchChangeSiteContactAddressIsActive", "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/BatchChangeSiteContactAddressIsActiveResourceActionRequest" } }, { "$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/GEN/Sites/ContactEmails/{id}": { "get": { "tags": [ "Site Contact Email" ], "summary": "Get a Site Contact Email 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 | SiteContactEmail->IsActive | boolean | |\r\n| createdByUserId | SiteContactEmail->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SiteContactEmail->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SiteContactEmail->CreatedByUser_FullName | string | |\r\n| createdOn | SiteContactEmail->CreatedOn | string | date-time |\r\n| modifiedByUserId | SiteContactEmail->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SiteContactEmail->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SiteContactEmail->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SiteContactEmail->ModifiedOn | string | date-time |\r\n| version | SiteContactEmail->Version | integer | int32 |\r\n| permissionTreeId | SiteContactEmail->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SiteContactEmail->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SiteContactEmail->PermissionTree_Description | string | |\r\n| siteId | SiteContactEmail->Site_Id | integer | int64 |\r\n| siteCode | SiteContactEmail->Site_Code | string | |\r\n| siteDescription | SiteContactEmail->Site_Description | string | |\r\n| id | SiteContactEmail->Id | integer | int64 |\r\n| email | SiteContactEmail->Email | string | |\r\n| emailTypeId | SiteContactEmail->EmailType_Id | integer | int64 |\r\n| emailTypeCode | SiteContactEmail->EmailType_Code | string | |\r\n| emailTypeDescription | SiteContactEmail->EmailType_Description | string | |\r\n| notes | SiteContactEmail->Notes | string | |\r\n| sequenceNumber | SiteContactEmail->SequenceNumber | integer | int32 |\r\n", "operationId": "GetSiteContactEmail", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Contact Email Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Site Contact Email", "schema": { "$ref": "#/definitions/GetSiteContactEmailResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Site Contact Email" ], "summary": "Update an existing Site Contact Email 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 | SiteContactEmail->Version | integer | int32 |\r\n| emailTypeId | SiteContactEmail->EmailType_Id | integer | int64 |\r\n| email | SiteContactEmail->Email | string | |\r\n| sequenceNumber | SiteContactEmail->SequenceNumber | integer | int32 |\r\n| notes | SiteContactEmail->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| emailTypeId | Nullable | False | |\r\n| email | Nullable | False | |\r\n| email | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "UpdateSiteContactEmail", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Contact Email Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSiteContactEmailResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site Contact Email 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": [ "Site Contact Email" ], "summary": "Delete an existing Site Contact Email 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 | SiteContactEmail->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": "DeleteSiteContactEmail", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Contact Email Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSiteContactEmailResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site Contact Email 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/GEN/Sites/ContactEmails": { "get": { "tags": [ "Site Contact Email" ], "summary": "Get a collection of Site Contact Email 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 | SiteContactEmail->Id | integer | int64 |\r\n| version | SiteContactEmail->Version | integer | int32 |\r\n| siteId | SiteContactEmail->Site_Id | integer | int64 |\r\n| siteCode | SiteContactEmail->Site_Code | string | |\r\n| siteDescription | SiteContactEmail->Site_Description | string | |\r\n| emailTypeId | SiteContactEmail->EmailType_Id | integer | int64 |\r\n| emailTypeCode | SiteContactEmail->EmailType_Code | string | |\r\n| emailTypeDescription | SiteContactEmail->EmailType_Description | string | |\r\n| email | SiteContactEmail->Email | string | |\r\n| sequenceNumber | SiteContactEmail->SequenceNumber | integer | int32 |\r\n| notes | SiteContactEmail->Notes | string | |\r\n| createdOn | SiteContactEmail->CreatedOn | string | date-time |\r\n| modifiedOn | SiteContactEmail->ModifiedOn | string | date-time |\r\n", "operationId": "GetSiteContactEmailCollection", "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 Contact Email collection", "schema": { "$ref": "#/definitions/GetSiteContactEmailCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Site Contact Email" ], "summary": "Create a new Site Contact Email 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| siteId | SiteContactEmail->Site_Id | integer | int64 |\r\n| permissionTreeId | SiteContactEmail->PermissionTree_Id | integer | int64 |\r\n| emailTypeId | SiteContactEmail->EmailType_Id | integer | int64 |\r\n| email | SiteContactEmail->Email | string | |\r\n| sequenceNumber | SiteContactEmail->SequenceNumber | integer | int32 |\r\n| notes | SiteContactEmail->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| siteId | Required | True | |\r\n| siteId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| emailTypeId | Required | True | |\r\n| emailTypeId | Nullable | False | |\r\n| email | Required | True | |\r\n| email | Nullable | False | |\r\n| email | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "CreateSiteContactEmail", "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/CreateSiteContactEmailResourceActionRequest" } }, { "$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/GEN/Sites/{siteId}/ContactEmails": { "get": { "tags": [ "Site Contact Email" ], "summary": "Get a collection of Site Contact Email resources for the Site", "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 | SiteContactEmail->Id | integer | int64 |\r\n| version | SiteContactEmail->Version | integer | int32 |\r\n| emailTypeId | SiteContactEmail->EmailType_Id | integer | int64 |\r\n| emailTypeCode | SiteContactEmail->EmailType_Code | string | |\r\n| emailTypeDescription | SiteContactEmail->EmailType_Description | string | |\r\n| email | SiteContactEmail->Email | string | |\r\n| sequenceNumber | SiteContactEmail->SequenceNumber | integer | int32 |\r\n| notes | SiteContactEmail->Notes | string | |\r\n| createdOn | SiteContactEmail->CreatedOn | string | date-time |\r\n| modifiedOn | SiteContactEmail->ModifiedOn | string | date-time |\r\n", "operationId": "GetSiteContactEmailForSiteCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "siteId", "in": "path", "required": true, "description": "Site 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 Site Contact Email collection", "schema": { "$ref": "#/definitions/GetSiteContactEmailForSiteCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/ContactEmails/Lookups/LookupSiteContactEmailEmailType": { "get": { "tags": [ "Site Contact Email" ], "summary": "Site Contact Email", "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 | EmailType->Id | integer | int64 |\r\n| code | EmailType->Code | string | |\r\n| description | EmailType->Description | string | |\r\n", "operationId": "LookupSiteContactEmailEmailType", "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 Email Type collection", "schema": { "$ref": "#/definitions/SiteContactEmailEmailTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/ContactEmails/Lookups/LookupSiteContactEmailInsertPermissionTree": { "get": { "tags": [ "Site Contact Email" ], "summary": "Lookup the permission set for creating the Site Contact Email.", "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": "LookupSiteContactEmailInsertPermissionTree", "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/SiteContactEmailInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/ContactEmails/Lookups/LookupSiteContactEmailSite": { "get": { "tags": [ "Site Contact Email" ], "summary": "Lookup the Site Contact Email for the Site Contact Email.", "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": "LookupSiteContactEmailSite", "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/SiteContactEmailSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/ContactEmails/Batch/{ids}": { "get": { "tags": [ "Site Contact Email" ], "summary": "Get a collection of Site Contact Email 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 | SiteContactEmail->IsActive | boolean | |\r\n| createdByUserId | SiteContactEmail->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SiteContactEmail->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SiteContactEmail->CreatedByUser_FullName | string | |\r\n| createdOn | SiteContactEmail->CreatedOn | string | date-time |\r\n| modifiedByUserId | SiteContactEmail->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SiteContactEmail->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SiteContactEmail->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SiteContactEmail->ModifiedOn | string | date-time |\r\n| version | SiteContactEmail->Version | integer | int32 |\r\n| permissionTreeId | SiteContactEmail->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SiteContactEmail->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SiteContactEmail->PermissionTree_Description | string | |\r\n| siteId | SiteContactEmail->Site_Id | integer | int64 |\r\n| siteCode | SiteContactEmail->Site_Code | string | |\r\n| siteDescription | SiteContactEmail->Site_Description | string | |\r\n| id | SiteContactEmail->Id | integer | int64 |\r\n| email | SiteContactEmail->Email | string | |\r\n| emailTypeId | SiteContactEmail->EmailType_Id | integer | int64 |\r\n| emailTypeCode | SiteContactEmail->EmailType_Code | string | |\r\n| emailTypeDescription | SiteContactEmail->EmailType_Description | string | |\r\n| notes | SiteContactEmail->Notes | string | |\r\n| sequenceNumber | SiteContactEmail->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetSiteContactEmail", "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 Site Contact Email 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 Site Contact Email collection", "schema": { "$ref": "#/definitions/BatchGetSiteContactEmailResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/ContactEmails/Batch": { "post": { "tags": [ "Site Contact Email" ], "summary": "Create a new collection of Site Contact Email 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| siteId | SiteContactEmail->Site_Id | integer | int64 |\r\n| permissionTreeId | SiteContactEmail->PermissionTree_Id | integer | int64 |\r\n| emailTypeId | SiteContactEmail->EmailType_Id | integer | int64 |\r\n| email | SiteContactEmail->Email | string | |\r\n| sequenceNumber | SiteContactEmail->SequenceNumber | integer | int32 |\r\n| notes | SiteContactEmail->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| siteId | Required | True | |\r\n| siteId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| emailTypeId | Required | True | |\r\n| emailTypeId | Nullable | False | |\r\n| email | Required | True | |\r\n| email | Nullable | False | |\r\n| email | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "BatchCreateSiteContactEmail", "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/BatchCreateSiteContactEmailResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Site Contact Email 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": [ "Site Contact Email" ], "summary": "Update a collection of existing Site Contact Email 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 | SiteContactEmail->Id | integer | int64 |\r\n| version | SiteContactEmail->Version | integer | int32 |\r\n| emailTypeId | SiteContactEmail->EmailType_Id | integer | int64 |\r\n| email | SiteContactEmail->Email | string | |\r\n| sequenceNumber | SiteContactEmail->SequenceNumber | integer | int32 |\r\n| notes | SiteContactEmail->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| emailTypeId | Nullable | False | |\r\n| email | Nullable | False | |\r\n| email | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "BatchUpdateSiteContactEmail", "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/BatchUpdateSiteContactEmailResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site Contact Email 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": [ "Site Contact Email" ], "summary": "Delete a collection of existing Site Contact Email 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 | SiteContactEmail->Id | integer | int64 |\r\n| version | SiteContactEmail->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": "BatchDeleteSiteContactEmail", "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/BatchDeleteSiteContactEmailResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site Contact Email 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/GEN/Sites/ContactEmails/{id}/Active": { "patch": { "tags": [ "Site Contact Email" ], "summary": "Change the IsActive status for an existing Site Contact Email 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 | SiteContactEmail->Version | integer | int32 |\r\n| isActive | SiteContactEmail->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": "ChangeSiteContactEmailIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Contact Email Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSiteContactEmailIsActiveResourceActionRequest" } }, { "$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/GEN/Sites/ContactEmails/Batch/Active": { "patch": { "tags": [ "Site Contact Email" ], "summary": "Change the IsActive status for a collection of existing Site Contact Email 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 | SiteContactEmail->Id | integer | int64 |\r\n| version | SiteContactEmail->Version | integer | int32 |\r\n| isActive | SiteContactEmail->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": "BatchChangeSiteContactEmailIsActive", "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/BatchChangeSiteContactEmailIsActiveResourceActionRequest" } }, { "$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/GEN/Sites/ContactPhoneNumbers/{id}": { "get": { "tags": [ "Site Contact Phone Number" ], "summary": "Get a Site Contact Phone Number 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 | SiteContactPhoneNumber->IsActive | boolean | |\r\n| createdByUserId | SiteContactPhoneNumber->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SiteContactPhoneNumber->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SiteContactPhoneNumber->CreatedByUser_FullName | string | |\r\n| createdOn | SiteContactPhoneNumber->CreatedOn | string | date-time |\r\n| modifiedByUserId | SiteContactPhoneNumber->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SiteContactPhoneNumber->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SiteContactPhoneNumber->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SiteContactPhoneNumber->ModifiedOn | string | date-time |\r\n| version | SiteContactPhoneNumber->Version | integer | int32 |\r\n| permissionTreeId | SiteContactPhoneNumber->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SiteContactPhoneNumber->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SiteContactPhoneNumber->PermissionTree_Description | string | |\r\n| siteId | SiteContactPhoneNumber->Site_Id | integer | int64 |\r\n| siteCode | SiteContactPhoneNumber->Site_Code | string | |\r\n| siteDescription | SiteContactPhoneNumber->Site_Description | string | |\r\n| id | SiteContactPhoneNumber->Id | integer | int64 |\r\n| notes | SiteContactPhoneNumber->Notes | string | |\r\n| phoneNumber | SiteContactPhoneNumber->PhoneNumber | string | |\r\n| phoneNumberTypeId | SiteContactPhoneNumber->PhoneNumberType_Id | integer | int64 |\r\n| phoneNumberTypeCode | SiteContactPhoneNumber->PhoneNumberType_Code | string | |\r\n| phoneNumberTypeDescription | SiteContactPhoneNumber->PhoneNumberType_Description | string | |\r\n| sequenceNumber | SiteContactPhoneNumber->SequenceNumber | integer | int32 |\r\n", "operationId": "GetSiteContactPhoneNumber", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Contact Phone Number Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Site Contact Phone Number", "schema": { "$ref": "#/definitions/GetSiteContactPhoneNumberResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Site Contact Phone Number" ], "summary": "Update an existing Site Contact Phone Number 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 | SiteContactPhoneNumber->Version | integer | int32 |\r\n| phoneNumberTypeId | SiteContactPhoneNumber->PhoneNumberType_Id | integer | int64 |\r\n| phoneNumber | SiteContactPhoneNumber->PhoneNumber | string | |\r\n| sequenceNumber | SiteContactPhoneNumber->SequenceNumber | integer | int32 |\r\n| notes | SiteContactPhoneNumber->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| phoneNumberTypeId | Nullable | False | |\r\n| phoneNumber | Nullable | False | |\r\n| phoneNumber | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phoneNumber | Min Length | >= 1 chars| |\r\n| phoneNumber | Max Length | <= 30 chars| |\r\n\r\n", "operationId": "UpdateSiteContactPhoneNumber", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Contact Phone Number Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSiteContactPhoneNumberResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site Contact Phone Number 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": [ "Site Contact Phone Number" ], "summary": "Delete an existing Site Contact Phone Number 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 | SiteContactPhoneNumber->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": "DeleteSiteContactPhoneNumber", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Contact Phone Number Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSiteContactPhoneNumberResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site Contact Phone Number 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/GEN/Sites/ContactPhoneNumbers": { "get": { "tags": [ "Site Contact Phone Number" ], "summary": "Get a collection of Site Contact Phone Number 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 | SiteContactPhoneNumber->Id | integer | int64 |\r\n| version | SiteContactPhoneNumber->Version | integer | int32 |\r\n| siteId | SiteContactPhoneNumber->Site_Id | integer | int64 |\r\n| siteCode | SiteContactPhoneNumber->Site_Code | string | |\r\n| siteDescription | SiteContactPhoneNumber->Site_Description | string | |\r\n| phoneNumberTypeId | SiteContactPhoneNumber->PhoneNumberType_Id | integer | int64 |\r\n| phoneNumberTypeCode | SiteContactPhoneNumber->PhoneNumberType_Code | string | |\r\n| phoneNumberTypeDescription | SiteContactPhoneNumber->PhoneNumberType_Description | string | |\r\n| phoneNumber | SiteContactPhoneNumber->PhoneNumber | string | |\r\n| sequenceNumber | SiteContactPhoneNumber->SequenceNumber | integer | int32 |\r\n| notes | SiteContactPhoneNumber->Notes | string | |\r\n| createdOn | SiteContactPhoneNumber->CreatedOn | string | date-time |\r\n| modifiedOn | SiteContactPhoneNumber->ModifiedOn | string | date-time |\r\n", "operationId": "GetSiteContactPhoneNumberCollection", "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 Contact Phone Number collection", "schema": { "$ref": "#/definitions/GetSiteContactPhoneNumberCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Site Contact Phone Number" ], "summary": "Create a new Site Contact Phone Number 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| siteId | SiteContactPhoneNumber->Site_Id | integer | int64 |\r\n| permissionTreeId | SiteContactPhoneNumber->PermissionTree_Id | integer | int64 |\r\n| phoneNumberTypeId | SiteContactPhoneNumber->PhoneNumberType_Id | integer | int64 |\r\n| phoneNumber | SiteContactPhoneNumber->PhoneNumber | string | |\r\n| sequenceNumber | SiteContactPhoneNumber->SequenceNumber | integer | int32 |\r\n| notes | SiteContactPhoneNumber->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| siteId | Required | True | |\r\n| siteId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| phoneNumberTypeId | Required | True | |\r\n| phoneNumberTypeId | Nullable | False | |\r\n| phoneNumber | Required | True | |\r\n| phoneNumber | Nullable | False | |\r\n| phoneNumber | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phoneNumber | Min Length | >= 1 chars| |\r\n| phoneNumber | Max Length | <= 30 chars| |\r\n\r\n", "operationId": "CreateSiteContactPhoneNumber", "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/CreateSiteContactPhoneNumberResourceActionRequest" } }, { "$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/GEN/Sites/{siteId}/ContactPhoneNumbers": { "get": { "tags": [ "Site Contact Phone Number" ], "summary": "Get a collection of Site Contact Phone Number resources for the Site", "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 | SiteContactPhoneNumber->Id | integer | int64 |\r\n| version | SiteContactPhoneNumber->Version | integer | int32 |\r\n| phoneNumberTypeId | SiteContactPhoneNumber->PhoneNumberType_Id | integer | int64 |\r\n| phoneNumberTypeCode | SiteContactPhoneNumber->PhoneNumberType_Code | string | |\r\n| phoneNumberTypeDescription | SiteContactPhoneNumber->PhoneNumberType_Description | string | |\r\n| phoneNumber | SiteContactPhoneNumber->PhoneNumber | string | |\r\n| sequenceNumber | SiteContactPhoneNumber->SequenceNumber | integer | int32 |\r\n| notes | SiteContactPhoneNumber->Notes | string | |\r\n| createdOn | SiteContactPhoneNumber->CreatedOn | string | date-time |\r\n| modifiedOn | SiteContactPhoneNumber->ModifiedOn | string | date-time |\r\n", "operationId": "GetSiteContactPhoneNumberForSiteCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "siteId", "in": "path", "required": true, "description": "Site 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 Site Contact Phone Number collection", "schema": { "$ref": "#/definitions/GetSiteContactPhoneNumberForSiteCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/ContactPhoneNumbers/Lookups/LookupSiteContactPhoneNumberInsertPermissionTree": { "get": { "tags": [ "Site Contact Phone Number" ], "summary": "Lookup the permission set for creating the Site Contact Phone Number.", "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": "LookupSiteContactPhoneNumberInsertPermissionTree", "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/SiteContactPhoneNumberInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/ContactPhoneNumbers/Lookups/LookupSiteContactPhoneNumberPhoneNumberType": { "get": { "tags": [ "Site Contact Phone Number" ], "summary": "Site Contact Phone Number", "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 | PhoneNumberType->Id | integer | int64 |\r\n| code | PhoneNumberType->Code | string | |\r\n| description | PhoneNumberType->Description | string | |\r\n", "operationId": "LookupSiteContactPhoneNumberPhoneNumberType", "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 Phone Number Type collection", "schema": { "$ref": "#/definitions/SiteContactPhoneNumberPhoneNumberTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/ContactPhoneNumbers/Lookups/LookupSiteContactPhoneNumberSite": { "get": { "tags": [ "Site Contact Phone Number" ], "summary": "Lookup the Site Contact Phone Number for the Site Contact Phone Number.", "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": "LookupSiteContactPhoneNumberSite", "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/SiteContactPhoneNumberSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/ContactPhoneNumbers/Batch/{ids}": { "get": { "tags": [ "Site Contact Phone Number" ], "summary": "Get a collection of Site Contact Phone Number 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 | SiteContactPhoneNumber->IsActive | boolean | |\r\n| createdByUserId | SiteContactPhoneNumber->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SiteContactPhoneNumber->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SiteContactPhoneNumber->CreatedByUser_FullName | string | |\r\n| createdOn | SiteContactPhoneNumber->CreatedOn | string | date-time |\r\n| modifiedByUserId | SiteContactPhoneNumber->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SiteContactPhoneNumber->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SiteContactPhoneNumber->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SiteContactPhoneNumber->ModifiedOn | string | date-time |\r\n| version | SiteContactPhoneNumber->Version | integer | int32 |\r\n| permissionTreeId | SiteContactPhoneNumber->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SiteContactPhoneNumber->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SiteContactPhoneNumber->PermissionTree_Description | string | |\r\n| siteId | SiteContactPhoneNumber->Site_Id | integer | int64 |\r\n| siteCode | SiteContactPhoneNumber->Site_Code | string | |\r\n| siteDescription | SiteContactPhoneNumber->Site_Description | string | |\r\n| id | SiteContactPhoneNumber->Id | integer | int64 |\r\n| notes | SiteContactPhoneNumber->Notes | string | |\r\n| phoneNumber | SiteContactPhoneNumber->PhoneNumber | string | |\r\n| phoneNumberTypeId | SiteContactPhoneNumber->PhoneNumberType_Id | integer | int64 |\r\n| phoneNumberTypeCode | SiteContactPhoneNumber->PhoneNumberType_Code | string | |\r\n| phoneNumberTypeDescription | SiteContactPhoneNumber->PhoneNumberType_Description | string | |\r\n| sequenceNumber | SiteContactPhoneNumber->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetSiteContactPhoneNumber", "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 Site Contact Phone Number 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 Site Contact Phone Number collection", "schema": { "$ref": "#/definitions/BatchGetSiteContactPhoneNumberResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/ContactPhoneNumbers/Batch": { "post": { "tags": [ "Site Contact Phone Number" ], "summary": "Create a new collection of Site Contact Phone Number 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| siteId | SiteContactPhoneNumber->Site_Id | integer | int64 |\r\n| permissionTreeId | SiteContactPhoneNumber->PermissionTree_Id | integer | int64 |\r\n| phoneNumberTypeId | SiteContactPhoneNumber->PhoneNumberType_Id | integer | int64 |\r\n| phoneNumber | SiteContactPhoneNumber->PhoneNumber | string | |\r\n| sequenceNumber | SiteContactPhoneNumber->SequenceNumber | integer | int32 |\r\n| notes | SiteContactPhoneNumber->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| siteId | Required | True | |\r\n| siteId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| phoneNumberTypeId | Required | True | |\r\n| phoneNumberTypeId | Nullable | False | |\r\n| phoneNumber | Required | True | |\r\n| phoneNumber | Nullable | False | |\r\n| phoneNumber | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phoneNumber | Min Length | >= 1 chars| |\r\n| phoneNumber | Max Length | <= 30 chars| |\r\n\r\n", "operationId": "BatchCreateSiteContactPhoneNumber", "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/BatchCreateSiteContactPhoneNumberResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Site Contact Phone Number 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": [ "Site Contact Phone Number" ], "summary": "Update a collection of existing Site Contact Phone Number 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 | SiteContactPhoneNumber->Id | integer | int64 |\r\n| version | SiteContactPhoneNumber->Version | integer | int32 |\r\n| phoneNumberTypeId | SiteContactPhoneNumber->PhoneNumberType_Id | integer | int64 |\r\n| phoneNumber | SiteContactPhoneNumber->PhoneNumber | string | |\r\n| sequenceNumber | SiteContactPhoneNumber->SequenceNumber | integer | int32 |\r\n| notes | SiteContactPhoneNumber->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| phoneNumberTypeId | Nullable | False | |\r\n| phoneNumber | Nullable | False | |\r\n| phoneNumber | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phoneNumber | Min Length | >= 1 chars| |\r\n| phoneNumber | Max Length | <= 30 chars| |\r\n\r\n", "operationId": "BatchUpdateSiteContactPhoneNumber", "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/BatchUpdateSiteContactPhoneNumberResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site Contact Phone Number 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": [ "Site Contact Phone Number" ], "summary": "Delete a collection of existing Site Contact Phone Number 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 | SiteContactPhoneNumber->Id | integer | int64 |\r\n| version | SiteContactPhoneNumber->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": "BatchDeleteSiteContactPhoneNumber", "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/BatchDeleteSiteContactPhoneNumberResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site Contact Phone Number 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/GEN/Sites/ContactPhoneNumbers/{id}/Active": { "patch": { "tags": [ "Site Contact Phone Number" ], "summary": "Change the IsActive status for an existing Site Contact Phone Number 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 | SiteContactPhoneNumber->Version | integer | int32 |\r\n| isActive | SiteContactPhoneNumber->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": "ChangeSiteContactPhoneNumberIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Contact Phone Number Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSiteContactPhoneNumberIsActiveResourceActionRequest" } }, { "$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/GEN/Sites/ContactPhoneNumbers/Batch/Active": { "patch": { "tags": [ "Site Contact Phone Number" ], "summary": "Change the IsActive status for a collection of existing Site Contact Phone Number 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 | SiteContactPhoneNumber->Id | integer | int64 |\r\n| version | SiteContactPhoneNumber->Version | integer | int32 |\r\n| isActive | SiteContactPhoneNumber->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": "BatchChangeSiteContactPhoneNumberIsActive", "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/BatchChangeSiteContactPhoneNumberIsActiveResourceActionRequest" } }, { "$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/GEN/Sites/Documents/{id}": { "get": { "tags": [ "Site Document" ], "summary": "Get a Site 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| siteId | SiteDocument->Site_Id | integer | int64 |\r\n| siteCode | SiteDocument->Site_Code | string | |\r\n| siteDescription | SiteDocument->Site_Description | string | |\r\n| isActive | SiteDocument->IsActive | boolean | |\r\n| createdByUserId | SiteDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SiteDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SiteDocument->CreatedByUser_FullName | string | |\r\n| createdOn | SiteDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | SiteDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SiteDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SiteDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SiteDocument->ModifiedOn | string | date-time |\r\n| version | SiteDocument->Version | integer | int32 |\r\n| permissionTreeId | SiteDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SiteDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SiteDocument->PermissionTree_Description | string | |\r\n| id | SiteDocument->Id | integer | int64 |\r\n| documentRecordId | SiteDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | SiteDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | SiteDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | SiteDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | SiteDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | SiteDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | SiteDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | SiteDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | SiteDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | SiteDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | SiteDocument->Notes | string | |\r\n| sequenceNumber | SiteDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetSiteDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Site Document", "schema": { "$ref": "#/definitions/GetSiteDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Site Document" ], "summary": "Update an existing Site 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 | SiteDocument->Version | integer | int32 |\r\n| sequenceNumber | SiteDocument->SequenceNumber | integer | int32 |\r\n| notes | SiteDocument->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": "UpdateSiteDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSiteDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site 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": [ "Site Document" ], "summary": "Delete an existing Site 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 | SiteDocument->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": "DeleteSiteDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSiteDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site 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/GEN/Sites/{id}/Documents": { "get": { "tags": [ "Site Document" ], "summary": "Get a collection of Site Document resources for the Site.", "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 | SiteDocument->Id | integer | int64 |\r\n| version | SiteDocument->Version | integer | int32 |\r\n| sequenceNumber | SiteDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | SiteDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | SiteDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | SiteDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | SiteDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | SiteDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | SiteDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | SiteDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetSiteDocumentCollectionForSite", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site 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 Site Document collection", "schema": { "$ref": "#/definitions/GetSiteDocumentCollectionForSiteResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Documents": { "get": { "tags": [ "Site Document" ], "summary": "Get a collection of Site 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 | SiteDocument->Id | integer | int64 |\r\n| version | SiteDocument->Version | integer | int32 |\r\n| siteId | SiteDocument->Site_Id | integer | int64 |\r\n| siteCode | SiteDocument->Site_Code | string | |\r\n| siteDescription | SiteDocument->Site_Description | string | |\r\n| sequenceNumber | SiteDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | SiteDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | SiteDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | SiteDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | SiteDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | SiteDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | SiteDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | SiteDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetSiteDocumentCollection", "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 Document collection", "schema": { "$ref": "#/definitions/GetSiteDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Site Document" ], "summary": "Create a new Site 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| siteId | SiteDocument->Site_Id | integer | int64 |\r\n| documentRecordId | SiteDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | SiteDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | SiteDocument->SequenceNumber | integer | int32 |\r\n| notes | SiteDocument->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| siteId | Required | True | |\r\n| siteId | 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": "CreateSiteDocument", "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/CreateSiteDocumentResourceActionRequest" } }, { "$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/GEN/Sites/Documents/Lookups/LookupSiteDocumentChangePermissionTree": { "get": { "tags": [ "Site Document" ], "summary": "Lookup the permission set for changing the Site 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": "LookupSiteDocumentChangePermissionTree", "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/SiteDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Documents/Lookups/LookupSiteDocument": { "get": { "tags": [ "Site Document" ], "summary": "Site 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": "LookupSiteDocument", "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/SiteDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Documents/Lookups/LookupSiteDocumentInsertPermissionTree": { "get": { "tags": [ "Site Document" ], "summary": "Lookup the permission set for creating the Site 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": "LookupSiteDocumentInsertPermissionTree", "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/SiteDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Documents/Lookups/LookupSiteDocumentSite": { "get": { "tags": [ "Site Document" ], "summary": "Lookup the Site Document for the Site 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 | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n", "operationId": "LookupSiteDocumentSite", "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/SiteDocumentSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Documents/Batch/{ids}": { "get": { "tags": [ "Site Document" ], "summary": "Get a collection of Site 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| siteId | SiteDocument->Site_Id | integer | int64 |\r\n| siteCode | SiteDocument->Site_Code | string | |\r\n| siteDescription | SiteDocument->Site_Description | string | |\r\n| isActive | SiteDocument->IsActive | boolean | |\r\n| createdByUserId | SiteDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SiteDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SiteDocument->CreatedByUser_FullName | string | |\r\n| createdOn | SiteDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | SiteDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SiteDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SiteDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SiteDocument->ModifiedOn | string | date-time |\r\n| version | SiteDocument->Version | integer | int32 |\r\n| permissionTreeId | SiteDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SiteDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SiteDocument->PermissionTree_Description | string | |\r\n| id | SiteDocument->Id | integer | int64 |\r\n| documentRecordId | SiteDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | SiteDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | SiteDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | SiteDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | SiteDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | SiteDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | SiteDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | SiteDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | SiteDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | SiteDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | SiteDocument->Notes | string | |\r\n| sequenceNumber | SiteDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetSiteDocument", "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 Site 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 Site Document collection", "schema": { "$ref": "#/definitions/BatchGetSiteDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Documents/Batch": { "post": { "tags": [ "Site Document" ], "summary": "Create a new collection of Site 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| siteId | SiteDocument->Site_Id | integer | int64 |\r\n| documentRecordId | SiteDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | SiteDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | SiteDocument->SequenceNumber | integer | int32 |\r\n| notes | SiteDocument->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| siteId | Required | True | |\r\n| siteId | 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": "BatchCreateSiteDocument", "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/BatchCreateSiteDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Site 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": [ "Site Document" ], "summary": "Update a collection of existing Site 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 | SiteDocument->Id | integer | int64 |\r\n| version | SiteDocument->Version | integer | int32 |\r\n| sequenceNumber | SiteDocument->SequenceNumber | integer | int32 |\r\n| notes | SiteDocument->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": "BatchUpdateSiteDocument", "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/BatchUpdateSiteDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site 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": [ "Site Document" ], "summary": "Delete a collection of existing Site 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 | SiteDocument->Id | integer | int64 |\r\n| version | SiteDocument->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": "BatchDeleteSiteDocument", "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/BatchDeleteSiteDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site 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/GEN/Sites/Documents/{id}/Active": { "patch": { "tags": [ "Site Document" ], "summary": "Change the IsActive status for an existing Site 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 | SiteDocument->Version | integer | int32 |\r\n| isActive | SiteDocument->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": "ChangeSiteDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSiteDocumentIsActiveResourceActionRequest" } }, { "$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/GEN/Sites/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Site Document" ], "summary": "Change the PermissionTree for an existing Site 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 | SiteDocument->Version | integer | int32 |\r\n| permissionTreeId | SiteDocument->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": "ChangeSiteDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSiteDocumentPermissionTreeResourceActionRequest" } }, { "$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/GEN/Sites/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Site Document" ], "summary": "Change the PermissionTree status for a collection of existing Site 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 | SiteDocument->Id | integer | int64 |\r\n| version | SiteDocument->Version | integer | int32 |\r\n| permissionTreeId | SiteDocument->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": "BatchChangeSiteDocumentPermissionTree", "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/BatchChangeSiteDocumentPermissionTreeResourceActionRequest" } }, { "$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/GEN/Sites/Documents/Batch/Active": { "patch": { "tags": [ "Site Document" ], "summary": "Change the IsActive status for a collection of existing Site 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 | SiteDocument->Id | integer | int64 |\r\n| version | SiteDocument->Version | integer | int32 |\r\n| isActive | SiteDocument->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": "BatchChangeSiteDocumentIsActive", "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/BatchChangeSiteDocumentIsActiveResourceActionRequest" } }, { "$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/GEN/SiteResources/{id}": { "get": { "tags": [ "Site Resource" ], "summary": "Get a Site 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| isActive | SiteResource->IsActive | boolean | |\r\n| createdByUserId | SiteResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SiteResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SiteResource->CreatedByUser_FullName | string | |\r\n| createdOn | SiteResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | SiteResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SiteResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SiteResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SiteResource->ModifiedOn | string | date-time |\r\n| version | SiteResource->Version | integer | int32 |\r\n| permissionTreeId | SiteResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SiteResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SiteResource->PermissionTree_Description | string | |\r\n| siteId | SiteResource->Site_Id | integer | int64 |\r\n| siteCode | SiteResource->Site_Code | string | |\r\n| siteDescription | SiteResource->Site_Description | string | |\r\n| id | SiteResource->Id | integer | int64 |\r\n| notes | SiteResource->Notes | string | |\r\n| resourceId | SiteResource->Resource_Id | integer | int64 |\r\n| resourceCode | SiteResource->Resource_Code | string | |\r\n| resourceContextId | SiteResource->ResourceContext_Id | integer | int64 |\r\n| resourceContextCode | SiteResource->ResourceContext_Code | string | |\r\n| resourceContextDescription | SiteResource->ResourceContext_Description | string | |\r\n", "operationId": "GetSiteResource", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Resource Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Site Resource", "schema": { "$ref": "#/definitions/GetSiteResourceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Site Resource" ], "summary": "Update an existing Site 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 | SiteResource->Version | integer | int32 |\r\n| resourceId | SiteResource->Resource_Id | integer | int64 |\r\n| resourceContextId | SiteResource->ResourceContext_Id | integer | int64 |\r\n| notes | SiteResource->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| resourceId | Nullable | False | |\r\n| resourceContextId | Nullable | False | |\r\n\r\n", "operationId": "UpdateSiteResource", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSiteResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site 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": [ "Site Resource" ], "summary": "Delete an existing Site 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 | SiteResource->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": "DeleteSiteResource", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Resource Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSiteResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site 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/GEN/SiteResources/{siteId}/Resources": { "get": { "tags": [ "Site Resource" ], "summary": "Get a collection of Site Resource resources for the Site 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 | SiteResource->Id | integer | int64 |\r\n| version | SiteResource->Version | integer | int32 |\r\n| resourceId | SiteResource->Resource_Id | integer | int64 |\r\n| resourceCode | SiteResource->Resource_Code | string | |\r\n| permissionTreeId | SiteResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SiteResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SiteResource->PermissionTree_Description | string | |\r\n| resourceContextId | SiteResource->ResourceContext_Id | integer | int64 |\r\n| resourceContextCode | SiteResource->ResourceContext_Code | string | |\r\n| resourceContextDescription | SiteResource->ResourceContext_Description | string | |\r\n", "operationId": "GetSiteResourceForSiteCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "siteId", "in": "path", "required": true, "description": "Site 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 Site Resource collection", "schema": { "$ref": "#/definitions/GetSiteResourceForSiteCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/SiteResources": { "get": { "tags": [ "Site Resource" ], "summary": "Get a collection of Site 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 | SiteResource->Version | integer | int32 |\r\n| id | SiteResource->Id | integer | int64 |\r\n| siteId | SiteResource->Site_Id | integer | int64 |\r\n| siteCode | SiteResource->Site_Code | string | |\r\n| siteDescription | SiteResource->Site_Description | string | |\r\n| resourceId | SiteResource->Resource_Id | integer | int64 |\r\n| resourceCode | SiteResource->Resource_Code | string | |\r\n| resourceContextId | SiteResource->ResourceContext_Id | integer | int64 |\r\n| resourceContextCode | SiteResource->ResourceContext_Code | string | |\r\n| resourceContextDescription | SiteResource->ResourceContext_Description | string | |\r\n| notes | SiteResource->Notes | string | |\r\n| createdOn | SiteResource->CreatedOn | string | date-time |\r\n| modifiedOn | SiteResource->ModifiedOn | string | date-time |\r\n", "operationId": "GetSiteResourceCollection", "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 Resource collection", "schema": { "$ref": "#/definitions/GetSiteResourceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Site Resource" ], "summary": "Create a new Site 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| permissionTreeId | SiteResource->PermissionTree_Id | integer | int64 |\r\n| siteId | SiteResource->Site_Id | integer | int64 |\r\n| resourceId | SiteResource->Resource_Id | integer | int64 |\r\n| resourceContextId | SiteResource->ResourceContext_Id | integer | int64 |\r\n| notes | SiteResource->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| siteId | Required | True | |\r\n| siteId | Nullable | False | |\r\n| resourceId | Required | True | |\r\n| resourceId | Nullable | False | |\r\n| resourceContextId | Required | True | |\r\n| resourceContextId | Nullable | False | |\r\n\r\n", "operationId": "CreateSiteResource", "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/CreateSiteResourceResourceActionRequest" } }, { "$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/GEN/SiteResources/Lookups/LookupSiteResourceChangePermissionTree": { "get": { "tags": [ "Site Resource" ], "summary": "Lookup the permission set for changing the Site 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 | 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": "LookupSiteResourceChangePermissionTree", "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/SiteResourceChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/SiteResources/Lookups/LookupSiteResourceInsertPermissionTree": { "get": { "tags": [ "Site Resource" ], "summary": "Lookup the permission set for creating the Site 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 | 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": "LookupSiteResourceInsertPermissionTree", "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/SiteResourceInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/SiteResources/Lookups/LookupSiteResourceResourceContext": { "get": { "tags": [ "Site Resource" ], "summary": "Lookup the for the Site 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 | ResourceContext->Id | integer | int64 |\r\n| code | ResourceContext->Code | string | |\r\n| description | ResourceContext->Description | string | |\r\n", "operationId": "LookupSiteResourceResourceContext", "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 Context collection", "schema": { "$ref": "#/definitions/SiteResourceResourceContextLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/SiteResources/Lookups/LookupSiteResourceResource": { "get": { "tags": [ "Site Resource" ], "summary": "Site 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 | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| description | Resource->Description | string | |\r\n| contactDetailFirstName | Resource->ContactDetailFirstName | string | |\r\n| contactDetailLastName | Resource->ContactDetailLastName | string | |\r\n", "operationId": "LookupSiteResourceResource", "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/SiteResourceResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/SiteResources/Lookups/LookupSiteResourceSite": { "get": { "tags": [ "Site Resource" ], "summary": "Lookup the Site for the Site 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 | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n", "operationId": "LookupSiteResourceSite", "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/SiteResourceSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/SiteResources/Batch/{ids}": { "get": { "tags": [ "Site Resource" ], "summary": "Get a collection of Site 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| isActive | SiteResource->IsActive | boolean | |\r\n| createdByUserId | SiteResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SiteResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SiteResource->CreatedByUser_FullName | string | |\r\n| createdOn | SiteResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | SiteResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SiteResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SiteResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SiteResource->ModifiedOn | string | date-time |\r\n| version | SiteResource->Version | integer | int32 |\r\n| permissionTreeId | SiteResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SiteResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SiteResource->PermissionTree_Description | string | |\r\n| siteId | SiteResource->Site_Id | integer | int64 |\r\n| siteCode | SiteResource->Site_Code | string | |\r\n| siteDescription | SiteResource->Site_Description | string | |\r\n| id | SiteResource->Id | integer | int64 |\r\n| notes | SiteResource->Notes | string | |\r\n| resourceId | SiteResource->Resource_Id | integer | int64 |\r\n| resourceCode | SiteResource->Resource_Code | string | |\r\n| resourceContextId | SiteResource->ResourceContext_Id | integer | int64 |\r\n| resourceContextCode | SiteResource->ResourceContext_Code | string | |\r\n| resourceContextDescription | SiteResource->ResourceContext_Description | string | |\r\n", "operationId": "BatchGetSiteResource", "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 Site 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 Site Resource collection", "schema": { "$ref": "#/definitions/BatchGetSiteResourceResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/SiteResources/Batch": { "post": { "tags": [ "Site Resource" ], "summary": "Create a new collection of Site 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| permissionTreeId | SiteResource->PermissionTree_Id | integer | int64 |\r\n| resourceId | SiteResource->Resource_Id | integer | int64 |\r\n| resourceContextId | SiteResource->ResourceContext_Id | integer | int64 |\r\n| siteId | SiteResource->Site_Id | integer | int64 |\r\n| notes | SiteResource->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| resourceId | Required | True | |\r\n| resourceId | Nullable | False | |\r\n| resourceContextId | Required | True | |\r\n| resourceContextId | Nullable | False | |\r\n| siteId | Required | True | |\r\n| siteId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateSiteResource", "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/BatchCreateSiteResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Site 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": [ "Site Resource" ], "summary": "Update a collection of existing Site 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 | SiteResource->Id | integer | int64 |\r\n| version | SiteResource->Version | integer | int32 |\r\n| siteId | SiteResource->Site_Id | integer | int64 |\r\n| resourceId | SiteResource->Resource_Id | integer | int64 |\r\n| resourceContextId | SiteResource->ResourceContext_Id | integer | int64 |\r\n| notes | SiteResource->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| siteId | Nullable | False | |\r\n| resourceId | Nullable | False | |\r\n| resourceContextId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateSiteResource", "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/BatchUpdateSiteResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site 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": [ "Site Resource" ], "summary": "Delete a collection of existing Site 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 | SiteResource->Id | integer | int64 |\r\n| version | SiteResource->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": "BatchDeleteSiteResource", "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/BatchDeleteSiteResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site 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/GEN/SiteResources/{id}/Active": { "patch": { "tags": [ "Site Resource" ], "summary": "Change the IsActive status for an existing Site 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 | SiteResource->Version | integer | int32 |\r\n| isActive | SiteResource->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": "ChangeSiteResourceIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSiteResourceIsActiveResourceActionRequest" } }, { "$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/GEN/SiteResources/{id}/PermissionTree": { "patch": { "tags": [ "Site Resource" ], "summary": "Change the PermissionTree for an existing Site 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 | SiteResource->Version | integer | int32 |\r\n| permissionTreeId | SiteResource->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": "ChangeSiteResourcePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSiteResourcePermissionTreeResourceActionRequest" } }, { "$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/GEN/SiteResources/{id}/Site": { "patch": { "tags": [ "Site Resource" ], "summary": "Change the Site status for an existing Site 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 | SiteResource->Version | integer | int32 |\r\n| siteId | SiteResource->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": "ChangeSiteResourceSite", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSiteResourceSiteResourceActionRequest" } }, { "$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/GEN/SiteResources/Batch/Active": { "patch": { "tags": [ "Site Resource" ], "summary": "Change the IsActive status for a collection of existing Site 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 | SiteResource->Id | integer | int64 |\r\n| version | SiteResource->Version | integer | int32 |\r\n| isActive | SiteResource->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": "BatchChangeSiteResourceIsActive", "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/BatchChangeSiteResourceIsActiveResourceActionRequest" } }, { "$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/GEN/SiteResources/Batch/PermissionTree": { "patch": { "tags": [ "Site Resource" ], "summary": "Change the PermissionTree status for a collection of existing Site 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 | SiteResource->Id | integer | int64 |\r\n| version | SiteResource->Version | integer | int32 |\r\n| permissionTreeId | SiteResource->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": "BatchChangeSiteResourcePermissionTree", "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/BatchChangeSiteResourcePermissionTreeResourceActionRequest" } }, { "$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/GEN/SiteResources/Batch/Site": { "patch": { "tags": [ "Site Resource" ], "summary": "Change the Site status for a collection of existing Site 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 | SiteResource->Id | integer | int64 |\r\n| version | SiteResource->Version | integer | int32 |\r\n| siteId | SiteResource->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": "BatchChangeSiteResourceSite", "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/BatchChangeSiteResourceSiteResourceActionRequest" } }, { "$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/GEN/Sites/Tree/Site/{id}/PathMap": { "get": { "tags": [ "Site 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": "GetSiteTreePathMap", "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 Site Tree collection", "schema": { "$ref": "#/definitions/GetSiteTreePathMapResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Tree": { "get": { "tags": [ "Site Tree" ], "summary": "Get a collection of Site 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 | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n", "operationId": "GetSiteTreeRoot", "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 Site Tree", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Sites/Tree/{parentNodeType}/{parentId}/Sites": { "get": { "tags": [ "Site Tree" ], "summary": "Get a collection of Site 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 | Site->Id | integer | int64 |\r\n| version | Site->Version | integer | int32 |\r\n| isActive | Site->IsActive | boolean | |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n| isVirtual | Site->IsVirtual | boolean | |\r\n", "operationId": "GetTreeSiteCollection", "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 Site Tree collection", "schema": { "$ref": "#/definitions/AssetRegisterTreeNodeCollectionPageSchema" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/SiteTypes/{id}": { "get": { "tags": [ "Site Type" ], "summary": "Get a Site Type 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 | SiteType->Code | string | |\r\n| createdByUserId | SiteType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SiteType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SiteType->CreatedByUser_FullName | string | |\r\n| createdOn | SiteType->CreatedOn | string | date-time |\r\n| isActive | SiteType->IsActive | boolean | |\r\n| modifiedByUserId | SiteType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SiteType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SiteType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SiteType->ModifiedOn | string | date-time |\r\n| permissionTreeId | SiteType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SiteType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SiteType->PermissionTree_Description | string | |\r\n| version | SiteType->Version | integer | int32 |\r\n| id | SiteType->Id | integer | int64 |\r\n| description | SiteType->Description | string | |\r\n| notes | SiteType->Notes | string | |\r\n| sequenceNumber | SiteType->SequenceNumber | integer | int32 |\r\n", "operationId": "GetSiteType", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Type Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Site Type", "schema": { "$ref": "#/definitions/GetSiteTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Site Type" ], "summary": "Update an existing Site Type 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 | SiteType->Version | integer | int32 |\r\n| code | SiteType->Code | string | |\r\n| description | SiteType->Description | string | |\r\n| sequenceNumber | SiteType->SequenceNumber | integer | int32 |\r\n| notes | SiteType->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": "UpdateSiteType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSiteTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site Type 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": [ "Site Type" ], "summary": "Delete an existing Site Type 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 | SiteType->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": "DeleteSiteType", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Type Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSiteTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site Type 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/GEN/SiteTypes": { "get": { "tags": [ "Site Type" ], "summary": "Get a collection of Site Type 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 | SiteType->Version | integer | int32 |\r\n| id | SiteType->Id | integer | int64 |\r\n| code | SiteType->Code | string | |\r\n| description | SiteType->Description | string | |\r\n| sequenceNumber | SiteType->SequenceNumber | integer | int32 |\r\n| isActive | SiteType->IsActive | boolean | |\r\n| notes | SiteType->Notes | string | |\r\n| createdOn | SiteType->CreatedOn | string | date-time |\r\n| modifiedOn | SiteType->ModifiedOn | string | date-time |\r\n", "operationId": "GetSiteTypeCollection", "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 Type collection", "schema": { "$ref": "#/definitions/GetSiteTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Site Type" ], "summary": "Create a new Site Type 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 | SiteType->PermissionTree_Id | integer | int64 |\r\n| code | SiteType->Code | string | |\r\n| description | SiteType->Description | string | |\r\n| sequenceNumber | SiteType->SequenceNumber | integer | int32 |\r\n| notes | SiteType->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": "CreateSiteType", "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/CreateSiteTypeResourceActionRequest" } }, { "$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/GEN/SiteTypes/Lookups/LookupSiteTypeChangePermissionTree": { "get": { "tags": [ "Site Type" ], "summary": "Lookup the permission set for changing the Site Type.", "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": "LookupSiteTypeChangePermissionTree", "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/SiteTypeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/SiteTypes/Lookups/LookupSiteTypeInsertPermissionTree": { "get": { "tags": [ "Site Type" ], "summary": "Lookup the permission set for creating the Site Type.", "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": "LookupSiteTypeInsertPermissionTree", "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/SiteTypeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/SiteTypes/Batch/{ids}": { "get": { "tags": [ "Site Type" ], "summary": "Get a collection of Site Type 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 | SiteType->Code | string | |\r\n| createdByUserId | SiteType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SiteType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SiteType->CreatedByUser_FullName | string | |\r\n| createdOn | SiteType->CreatedOn | string | date-time |\r\n| isActive | SiteType->IsActive | boolean | |\r\n| modifiedByUserId | SiteType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SiteType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SiteType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SiteType->ModifiedOn | string | date-time |\r\n| permissionTreeId | SiteType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SiteType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SiteType->PermissionTree_Description | string | |\r\n| version | SiteType->Version | integer | int32 |\r\n| id | SiteType->Id | integer | int64 |\r\n| description | SiteType->Description | string | |\r\n| notes | SiteType->Notes | string | |\r\n| sequenceNumber | SiteType->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetSiteType", "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 Site Type 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 Site Type collection", "schema": { "$ref": "#/definitions/BatchGetSiteTypeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/SiteTypes/Batch": { "post": { "tags": [ "Site Type" ], "summary": "Create a new collection of Site Type 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 | SiteType->PermissionTree_Id | integer | int64 |\r\n| code | SiteType->Code | string | |\r\n| description | SiteType->Description | string | |\r\n| sequenceNumber | SiteType->SequenceNumber | integer | int32 |\r\n| notes | SiteType->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": "BatchCreateSiteType", "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/BatchCreateSiteTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Site Type 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": [ "Site Type" ], "summary": "Update a collection of existing Site Type 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 | SiteType->Id | integer | int64 |\r\n| version | SiteType->Version | integer | int32 |\r\n| code | SiteType->Code | string | |\r\n| description | SiteType->Description | string | |\r\n| sequenceNumber | SiteType->SequenceNumber | integer | int32 |\r\n| notes | SiteType->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": "BatchUpdateSiteType", "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/BatchUpdateSiteTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site Type 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": [ "Site Type" ], "summary": "Delete a collection of existing Site Type 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 | SiteType->Id | integer | int64 |\r\n| version | SiteType->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": "BatchDeleteSiteType", "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/BatchDeleteSiteTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Site Type 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/GEN/SiteTypes/{id}/Active": { "patch": { "tags": [ "Site Type" ], "summary": "Change the IsActive status for an existing Site Type 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 | SiteType->Version | integer | int32 |\r\n| isActive | SiteType->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": "ChangeSiteTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSiteTypeIsActiveResourceActionRequest" } }, { "$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/GEN/SiteTypes/{id}/PermissionTree": { "patch": { "tags": [ "Site Type" ], "summary": "Change the PermissionTree for an existing Site Type 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 | SiteType->Version | integer | int32 |\r\n| permissionTreeId | SiteType->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": "ChangeSiteTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Site Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSiteTypePermissionTreeResourceActionRequest" } }, { "$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/GEN/SiteTypes/Batch/Active": { "patch": { "tags": [ "Site Type" ], "summary": "Change the IsActive status for a collection of existing Site Type 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 | SiteType->Id | integer | int64 |\r\n| version | SiteType->Version | integer | int32 |\r\n| isActive | SiteType->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": "BatchChangeSiteTypeIsActive", "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/BatchChangeSiteTypeIsActiveResourceActionRequest" } }, { "$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/GEN/SiteTypes/Batch/PermissionTree": { "patch": { "tags": [ "Site Type" ], "summary": "Change the PermissionTree status for a collection of existing Site Type 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 | SiteType->Id | integer | int64 |\r\n| version | SiteType->Version | integer | int32 |\r\n| permissionTreeId | SiteType->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": "BatchChangeSiteTypePermissionTree", "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/BatchChangeSiteTypePermissionTreeResourceActionRequest" } }, { "$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/GEN/Suppliers/{id}": { "get": { "tags": [ "Supplier" ], "summary": "Get a Supplier 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 | Supplier->Code | string | |\r\n| isActive | Supplier->IsActive | boolean | |\r\n| createdByUserId | Supplier->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Supplier->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Supplier->CreatedByUser_FullName | string | |\r\n| createdOn | Supplier->CreatedOn | string | date-time |\r\n| modifiedByUserId | Supplier->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Supplier->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Supplier->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Supplier->ModifiedOn | string | date-time |\r\n| version | Supplier->Version | integer | int32 |\r\n| permissionTreeId | Supplier->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Supplier->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Supplier->PermissionTree_Description | string | |\r\n| siteId | Supplier->Site_Id | integer | int64 |\r\n| siteCode | Supplier->Site_Code | string | |\r\n| siteDescription | Supplier->Site_Description | string | |\r\n| id | Supplier->Id | integer | int64 |\r\n| currencyId | Supplier->Currency_Id | integer | int64 |\r\n| currencyCode | Supplier->Currency_Code | string | |\r\n| currencyDescription | Supplier->Currency_Description | string | |\r\n| currencyIsoCode | Supplier->Currency_IsoCode | string | |\r\n| defaultTaxRatePercentageId | Supplier->DefaultTaxRatePercentage_Id | integer | int64 |\r\n| defaultTaxRatePercentageTaxRate | Supplier->DefaultTaxRatePercentage_TaxRate | number | decimal |\r\n| defaultTaxRatePercentageBuyingSiteId | Supplier->DefaultTaxRatePercentage_BuyingSite_Id | integer | int64 |\r\n| defaultTaxRatePercentageBuyingSiteCode | Supplier->DefaultTaxRatePercentage_BuyingSite_Code | string | |\r\n| description | Supplier->Description | string | |\r\n| discountPercentage | Supplier->DiscountPercentage | number | decimal |\r\n| isApproved | Supplier->IsApproved | boolean | |\r\n| isContractLabourSupplier | Supplier->IsContractLabourSupplier | boolean | |\r\n| isMaterialSupplier | Supplier->IsMaterialSupplier | boolean | |\r\n| notes | Supplier->Notes | string | |\r\n| sequenceNumber | Supplier->SequenceNumber | integer | int32 |\r\n| taxNumber | Supplier->TaxNumber | string | |\r\n", "operationId": "GetSupplier", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Supplier", "schema": { "$ref": "#/definitions/GetSupplierResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Supplier" ], "summary": "Update an existing Supplier 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 | Supplier->Version | integer | int32 |\r\n| code | Supplier->Code | string | |\r\n| currencyId | Supplier->Currency_Id | integer | int64 |\r\n| defaultTaxRatePercentageId | Supplier->DefaultTaxRatePercentage_Id | integer | int64 |\r\n| description | Supplier->Description | string | |\r\n| discountPercentage | Supplier->DiscountPercentage | number | decimal |\r\n| isApproved | Supplier->IsApproved | boolean | |\r\n| isContractLabourSupplier | Supplier->IsContractLabourSupplier | boolean | |\r\n| isMaterialSupplier | Supplier->IsMaterialSupplier | boolean | |\r\n| notes | Supplier->Notes | string | |\r\n| sequenceNumber | Supplier->SequenceNumber | integer | int32 |\r\n| taxNumber | Supplier->TaxNumber | 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| currencyId | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| discountPercentage | Nullable | False | |\r\n| discountPercentage | Min Value | >= 0| |\r\n| discountPercentage | Max Value | <= 100| |\r\n| isApproved | Nullable | False | |\r\n| isContractLabourSupplier | Nullable | False | |\r\n| isMaterialSupplier | Nullable | False | |\r\n| taxNumber | Min Length | >= 1 chars| |\r\n| taxNumber | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "UpdateSupplier", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSupplierResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier 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": [ "Supplier" ], "summary": "Delete an existing Supplier 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 | Supplier->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": "DeleteSupplier", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSupplierResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier 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/GEN/Suppliers": { "get": { "tags": [ "Supplier" ], "summary": "Get a collection of Supplier 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 | Supplier->Version | integer | int32 |\r\n| id | Supplier->Id | integer | int64 |\r\n| code | Supplier->Code | string | |\r\n| description | Supplier->Description | string | |\r\n| siteCode | Supplier->Site_Code | string | |\r\n| sequenceNumber | Supplier->SequenceNumber | integer | int32 |\r\n| notes | Supplier->Notes | string | |\r\n| createdOn | Supplier->CreatedOn | string | date-time |\r\n| modifiedOn | Supplier->ModifiedOn | string | date-time |\r\n", "operationId": "GetSupplierCollection", "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/GetSupplierCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Supplier" ], "summary": "Create a new Supplier 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 | Supplier->Code | string | |\r\n| currencyId | Supplier->Currency_Id | integer | int64 |\r\n| description | Supplier->Description | string | |\r\n| discountPercentage | Supplier->DiscountPercentage | number | decimal |\r\n| isApproved | Supplier->IsApproved | boolean | |\r\n| isContractLabourSupplier | Supplier->IsContractLabourSupplier | boolean | |\r\n| isMaterialSupplier | Supplier->IsMaterialSupplier | boolean | |\r\n| notes | Supplier->Notes | string | |\r\n| permissionTreeId | Supplier->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | Supplier->SequenceNumber | integer | int32 |\r\n| siteId | Supplier->Site_Id | integer | int64 |\r\n| taxNumber | Supplier->TaxNumber | 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| currencyId | System Generated | true | If no value specified |\r\n| currencyId | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| discountPercentage | System Generated | true | If no value specified |\r\n| discountPercentage | Nullable | False | |\r\n| discountPercentage | Min Value | >= 0| |\r\n| discountPercentage | Max Value | <= 100| |\r\n| isApproved | Nullable | False | |\r\n| isContractLabourSupplier | Nullable | False | |\r\n| isMaterialSupplier | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| siteId | Required | True | |\r\n| siteId | Nullable | False | |\r\n| taxNumber | Min Length | >= 1 chars| |\r\n| taxNumber | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "CreateSupplier", "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/CreateSupplierResourceActionRequest" } }, { "$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/GEN/Suppliers/Lookups/LookupSupplierChangePermissionTree": { "get": { "tags": [ "Supplier" ], "summary": "Lookup the permission set for changing the Supplier.", "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": "LookupSupplierChangePermissionTree", "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/SupplierChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Lookups/LookupSupplierCurrency": { "get": { "tags": [ "Supplier" ], "summary": "Lookup the Currency for the Supplier.", "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 | Currency->Id | integer | int64 |\r\n| code | Currency->Code | string | |\r\n| description | Currency->Description | string | |\r\n", "operationId": "LookupSupplierCurrency", "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 Currency collection", "schema": { "$ref": "#/definitions/SupplierCurrencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Lookups/LookupSupplierDefaultTaxRate": { "get": { "tags": [ "Supplier" ], "summary": "Lookup the Supplier Tax Rate for the Supplier.", "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 | SupplierTaxRate->Id | integer | int64 |\r\n| buyingSiteCode | SupplierTaxRate->BuyingSite_Code | string | |\r\n| taxRate | SupplierTaxRate->TaxRate | number | decimal |\r\n", "operationId": "LookupSupplierDefaultTaxRate", "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 Tax Rate collection", "schema": { "$ref": "#/definitions/SupplierDefaultTaxRateLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Lookups/LookupSupplierInsertPermissionTree": { "get": { "tags": [ "Supplier" ], "summary": "Lookup the permission set for creating the Supplier.", "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": "LookupSupplierInsertPermissionTree", "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/SupplierInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Lookups/LookupSupplierSite": { "get": { "tags": [ "Supplier" ], "summary": "Lookup the Site for the Supplier.", "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| currencyId | Site->Currency_Id | integer | int64 |\r\n| currencyCode | Site->Currency_Code | string | |\r\n| currencyDescription | Site->Currency_Description | string | |\r\n", "operationId": "LookupSupplierSite", "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/SupplierSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Batch/{ids}": { "get": { "tags": [ "Supplier" ], "summary": "Get a collection of Supplier 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 | Supplier->Code | string | |\r\n| isActive | Supplier->IsActive | boolean | |\r\n| createdByUserId | Supplier->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Supplier->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Supplier->CreatedByUser_FullName | string | |\r\n| createdOn | Supplier->CreatedOn | string | date-time |\r\n| modifiedByUserId | Supplier->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Supplier->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Supplier->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Supplier->ModifiedOn | string | date-time |\r\n| version | Supplier->Version | integer | int32 |\r\n| permissionTreeId | Supplier->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Supplier->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Supplier->PermissionTree_Description | string | |\r\n| siteId | Supplier->Site_Id | integer | int64 |\r\n| siteCode | Supplier->Site_Code | string | |\r\n| siteDescription | Supplier->Site_Description | string | |\r\n| id | Supplier->Id | integer | int64 |\r\n| currencyId | Supplier->Currency_Id | integer | int64 |\r\n| currencyCode | Supplier->Currency_Code | string | |\r\n| currencyDescription | Supplier->Currency_Description | string | |\r\n| currencyIsoCode | Supplier->Currency_IsoCode | string | |\r\n| defaultTaxRatePercentageId | Supplier->DefaultTaxRatePercentage_Id | integer | int64 |\r\n| defaultTaxRatePercentageTaxRate | Supplier->DefaultTaxRatePercentage_TaxRate | number | decimal |\r\n| defaultTaxRatePercentageBuyingSiteId | Supplier->DefaultTaxRatePercentage_BuyingSite_Id | integer | int64 |\r\n| defaultTaxRatePercentageBuyingSiteCode | Supplier->DefaultTaxRatePercentage_BuyingSite_Code | string | |\r\n| description | Supplier->Description | string | |\r\n| discountPercentage | Supplier->DiscountPercentage | number | decimal |\r\n| isApproved | Supplier->IsApproved | boolean | |\r\n| isContractLabourSupplier | Supplier->IsContractLabourSupplier | boolean | |\r\n| isMaterialSupplier | Supplier->IsMaterialSupplier | boolean | |\r\n| notes | Supplier->Notes | string | |\r\n| sequenceNumber | Supplier->SequenceNumber | integer | int32 |\r\n| taxNumber | Supplier->TaxNumber | string | |\r\n", "operationId": "BatchGetSupplier", "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 Supplier 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 Supplier collection", "schema": { "$ref": "#/definitions/BatchGetSupplierResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Batch": { "post": { "tags": [ "Supplier" ], "summary": "Create a new collection of Supplier 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 | Supplier->Code | string | |\r\n| currencyId | Supplier->Currency_Id | integer | int64 |\r\n| description | Supplier->Description | string | |\r\n| discountPercentage | Supplier->DiscountPercentage | number | decimal |\r\n| isApproved | Supplier->IsApproved | boolean | |\r\n| isContractLabourSupplier | Supplier->IsContractLabourSupplier | boolean | |\r\n| isMaterialSupplier | Supplier->IsMaterialSupplier | boolean | |\r\n| notes | Supplier->Notes | string | |\r\n| permissionTreeId | Supplier->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | Supplier->SequenceNumber | integer | int32 |\r\n| siteId | Supplier->Site_Id | integer | int64 |\r\n| taxNumber | Supplier->TaxNumber | 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| currencyId | System Generated | true | If no value specified |\r\n| currencyId | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| discountPercentage | System Generated | true | If no value specified |\r\n| discountPercentage | Nullable | False | |\r\n| discountPercentage | Min Value | >= 0| |\r\n| discountPercentage | Max Value | <= 100| |\r\n| isApproved | Nullable | False | |\r\n| isContractLabourSupplier | Nullable | False | |\r\n| isMaterialSupplier | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| siteId | Required | True | |\r\n| siteId | Nullable | False | |\r\n| taxNumber | Min Length | >= 1 chars| |\r\n| taxNumber | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "BatchCreateSupplier", "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/BatchCreateSupplierResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Supplier 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": [ "Supplier" ], "summary": "Update a collection of existing Supplier 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 | Supplier->Id | integer | int64 |\r\n| version | Supplier->Version | integer | int32 |\r\n| code | Supplier->Code | string | |\r\n| currencyId | Supplier->Currency_Id | integer | int64 |\r\n| defaultTaxRatePercentageId | Supplier->DefaultTaxRatePercentage_Id | integer | int64 |\r\n| description | Supplier->Description | string | |\r\n| discountPercentage | Supplier->DiscountPercentage | number | decimal |\r\n| isApproved | Supplier->IsApproved | boolean | |\r\n| isContractLabourSupplier | Supplier->IsContractLabourSupplier | boolean | |\r\n| isMaterialSupplier | Supplier->IsMaterialSupplier | boolean | |\r\n| notes | Supplier->Notes | string | |\r\n| sequenceNumber | Supplier->SequenceNumber | integer | int32 |\r\n| taxNumber | Supplier->TaxNumber | 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| currencyId | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| discountPercentage | Nullable | False | |\r\n| discountPercentage | Min Value | >= 0| |\r\n| discountPercentage | Max Value | <= 100| |\r\n| isApproved | Nullable | False | |\r\n| isContractLabourSupplier | Nullable | False | |\r\n| isMaterialSupplier | Nullable | False | |\r\n| taxNumber | Min Length | >= 1 chars| |\r\n| taxNumber | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "BatchUpdateSupplier", "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/BatchUpdateSupplierResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier 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": [ "Supplier" ], "summary": "Delete a collection of existing Supplier 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 | Supplier->Id | integer | int64 |\r\n| version | Supplier->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": "BatchDeleteSupplier", "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/BatchDeleteSupplierResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier 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/GEN/Suppliers/{id}/Active": { "patch": { "tags": [ "Supplier" ], "summary": "Change the IsActive status for an existing Supplier 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 | Supplier->Version | integer | int32 |\r\n| isActive | Supplier->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": "ChangeSupplierIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSupplierIsActiveResourceActionRequest" } }, { "$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/GEN/Suppliers/{id}/PermissionTree": { "patch": { "tags": [ "Supplier" ], "summary": "Change the PermissionTree for an existing Supplier 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 | Supplier->Version | integer | int32 |\r\n| permissionTreeId | Supplier->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": "ChangeSupplierPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSupplierPermissionTreeResourceActionRequest" } }, { "$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/GEN/Suppliers/{id}/Site": { "patch": { "tags": [ "Supplier" ], "summary": "Change the Site status for an existing Supplier 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 | Supplier->Version | integer | int32 |\r\n| siteId | Supplier->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": "ChangeSupplierSite", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSupplierSiteResourceActionRequest" } }, { "$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/GEN/Suppliers/Batch/Active": { "patch": { "tags": [ "Supplier" ], "summary": "Change the IsActive status for a collection of existing Supplier 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 | Supplier->Id | integer | int64 |\r\n| version | Supplier->Version | integer | int32 |\r\n| isActive | Supplier->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": "BatchChangeSupplierIsActive", "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/BatchChangeSupplierIsActiveResourceActionRequest" } }, { "$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/GEN/Suppliers/Batch/PermissionTree": { "patch": { "tags": [ "Supplier" ], "summary": "Change the PermissionTree status for a collection of existing Supplier 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 | Supplier->Id | integer | int64 |\r\n| version | Supplier->Version | integer | int32 |\r\n| permissionTreeId | Supplier->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": "BatchChangeSupplierPermissionTree", "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/BatchChangeSupplierPermissionTreeResourceActionRequest" } }, { "$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/GEN/Suppliers/Batch/Site": { "patch": { "tags": [ "Supplier" ], "summary": "Change the Site status for a collection of existing Supplier 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 | Supplier->Id | integer | int64 |\r\n| version | Supplier->Version | integer | int32 |\r\n| siteId | Supplier->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": "BatchChangeSupplierSite", "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/BatchChangeSupplierSiteResourceActionRequest" } }, { "$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/GEN/Suppliers/Attributes/{id}": { "get": { "tags": [ "Supplier Attribute" ], "summary": "Get a collection of Supplier Attribute resources for the Supplier.", "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| supplierId | SupplierAttribute->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierAttribute->Supplier_Code | string | |\r\n| supplierDescription | SupplierAttribute->Supplier_Description | string | |\r\n| createdByUserId | SupplierAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SupplierAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SupplierAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | SupplierAttribute->CreatedOn | string | date-time |\r\n| isActive | SupplierAttribute->IsActive | boolean | |\r\n| modifiedByUserId | SupplierAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SupplierAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SupplierAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SupplierAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | SupplierAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierAttribute->PermissionTree_Description | string | |\r\n| version | SupplierAttribute->Version | integer | int32 |\r\n| id | SupplierAttribute->Id | integer | int64 |\r\n| attributeId | SupplierAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | SupplierAttribute->Attribute_Code | string | |\r\n| attributeDescription | SupplierAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | SupplierAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | SupplierAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | SupplierAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | SupplierAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | SupplierAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | SupplierAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | SupplierAttribute->Notes | string | |\r\n| predefinedValueId | SupplierAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | SupplierAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | SupplierAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | SupplierAttribute->SequenceNumber | integer | int32 |\r\n| value | SupplierAttribute->Value | object | composite |\r\n", "operationId": "GetSupplierAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Supplier Attribute", "schema": { "$ref": "#/definitions/GetSupplierAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Supplier Attribute" ], "summary": "Update an existing Supplier 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 | SupplierAttribute->Version | integer | int32 |\r\n| value | SupplierAttribute->Value | object | composite |\r\n| predefinedValueId | SupplierAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | SupplierAttribute->SequenceNumber | integer | int32 |\r\n| notes | SupplierAttribute->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": "UpdateSupplierAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSupplierAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier 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": [ "Supplier Attribute" ], "summary": "Delete an existing Supplier 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 | SupplierAttribute->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": "DeleteSupplierAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSupplierAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier 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/GEN/Suppliers/{supplierId}/Attributes": { "get": { "tags": [ "Supplier Attribute" ], "summary": "Get a collection of Supplier Attribute resources for the Supplier.", "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 | SupplierAttribute->Id | integer | int64 |\r\n| version | SupplierAttribute->Version | integer | int32 |\r\n| sequenceNumber | SupplierAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | SupplierAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | SupplierAttribute->Attribute_Code | string | |\r\n| attributeDescription | SupplierAttribute->Attribute_Description | string | |\r\n| attributeDataType | SupplierAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | SupplierAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | SupplierAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | SupplierAttribute->PredefinedValue_Value | object | composite |\r\n| value | SupplierAttribute->Value | object | composite |\r\n| notes | SupplierAttribute->Notes | string | |\r\n| createdOn | SupplierAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | SupplierAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetSupplierAttributeCollectionForSupplier", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "supplierId", "in": "path", "required": true, "description": "Supplier 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 Supplier Attribute collection", "schema": { "$ref": "#/definitions/GetSupplierAttributeCollectionForSupplierResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Attributes": { "get": { "tags": [ "Supplier Attribute" ], "summary": "Get a collection of Supplier 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 | SupplierAttribute->Id | integer | int64 |\r\n| version | SupplierAttribute->Version | integer | int32 |\r\n| sequenceNumber | SupplierAttribute->SequenceNumber | integer | int32 |\r\n| supplierCode | SupplierAttribute->Supplier_Code | string | |\r\n| supplierDescription | SupplierAttribute->Supplier_Description | string | |\r\n| attributeId | SupplierAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | SupplierAttribute->Attribute_Code | string | |\r\n| attributeDescription | SupplierAttribute->Attribute_Description | string | |\r\n| attributeDataType | SupplierAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | SupplierAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | SupplierAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | SupplierAttribute->PredefinedValue_Value | object | composite |\r\n| value | SupplierAttribute->Value | object | composite |\r\n| notes | SupplierAttribute->Notes | string | |\r\n| createdOn | SupplierAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | SupplierAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetSupplierAttributeCollection", "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 Attribute collection", "schema": { "$ref": "#/definitions/GetSupplierAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Supplier Attribute" ], "summary": "Create a new Supplier 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| supplierId | SupplierAttribute->Supplier_Id | integer | int64 |\r\n| attributeId | SupplierAttribute->Attribute_Id | integer | int64 |\r\n| value | SupplierAttribute->Value | object | composite |\r\n| predefinedValueId | SupplierAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | SupplierAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | SupplierAttribute->SequenceNumber | integer | int32 |\r\n| notes | SupplierAttribute->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| supplierId | Required | True | |\r\n| supplierId | 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": "CreateSupplierAttribute", "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/CreateSupplierAttributeResourceActionRequest" } }, { "$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/GEN/Suppliers/Attributes/Lookups/LookupSupplierAttributeAllowedValue": { "get": { "tags": [ "Supplier Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Supplier 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": "LookupSupplierAttributeAllowedValue", "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/SupplierAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Attributes/Lookups/LookupSupplierAttribute": { "get": { "tags": [ "Supplier Attribute" ], "summary": "Lookup the Attribute for the Supplier 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": "LookupSupplierAttribute", "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/SupplierAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Attributes/Lookups/LookupSupplierAttributeInsertPermissionTree": { "get": { "tags": [ "Supplier Attribute" ], "summary": "Lookup the permission set for creating the Supplier 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": "LookupSupplierAttributeInsertPermissionTree", "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/SupplierAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Attributes/Lookups/LookupSupplierAttributeSupplier": { "get": { "tags": [ "Supplier Attribute" ], "summary": "Lookup the Supplier Attribute for the Supplier 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 | Supplier->Id | integer | int64 |\r\n| code | Supplier->Code | string | |\r\n| description | Supplier->Description | string | |\r\n", "operationId": "LookupSupplierAttributeSupplier", "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/SupplierAttributeSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Attributes/Batch/{ids}": { "get": { "tags": [ "Supplier Attribute" ], "summary": "Get a collection of Supplier 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| supplierId | SupplierAttribute->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierAttribute->Supplier_Code | string | |\r\n| supplierDescription | SupplierAttribute->Supplier_Description | string | |\r\n| createdByUserId | SupplierAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SupplierAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SupplierAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | SupplierAttribute->CreatedOn | string | date-time |\r\n| isActive | SupplierAttribute->IsActive | boolean | |\r\n| modifiedByUserId | SupplierAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SupplierAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SupplierAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SupplierAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | SupplierAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierAttribute->PermissionTree_Description | string | |\r\n| version | SupplierAttribute->Version | integer | int32 |\r\n| id | SupplierAttribute->Id | integer | int64 |\r\n| attributeId | SupplierAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | SupplierAttribute->Attribute_Code | string | |\r\n| attributeDescription | SupplierAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | SupplierAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | SupplierAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | SupplierAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | SupplierAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | SupplierAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | SupplierAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | SupplierAttribute->Notes | string | |\r\n| predefinedValueId | SupplierAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | SupplierAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | SupplierAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | SupplierAttribute->SequenceNumber | integer | int32 |\r\n| value | SupplierAttribute->Value | object | composite |\r\n", "operationId": "BatchGetSupplierAttribute", "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 Supplier 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 Supplier Attribute collection", "schema": { "$ref": "#/definitions/BatchGetSupplierAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Attributes/Batch": { "post": { "tags": [ "Supplier Attribute" ], "summary": "Create a new collection of Supplier 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| supplierId | SupplierAttribute->Supplier_Id | integer | int64 |\r\n| attributeId | SupplierAttribute->Attribute_Id | integer | int64 |\r\n| value | SupplierAttribute->Value | object | composite |\r\n| predefinedValueId | SupplierAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | SupplierAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | SupplierAttribute->SequenceNumber | integer | int32 |\r\n| notes | SupplierAttribute->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| supplierId | Required | True | |\r\n| supplierId | 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": "BatchCreateSupplierAttribute", "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/BatchCreateSupplierAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Supplier 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": [ "Supplier Attribute" ], "summary": "Update a collection of existing Supplier 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 | SupplierAttribute->Id | integer | int64 |\r\n| version | SupplierAttribute->Version | integer | int32 |\r\n| value | SupplierAttribute->Value | object | composite |\r\n| predefinedValueId | SupplierAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | SupplierAttribute->SequenceNumber | integer | int32 |\r\n| notes | SupplierAttribute->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": "BatchUpdateSupplierAttribute", "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/BatchUpdateSupplierAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier 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": [ "Supplier Attribute" ], "summary": "Delete a collection of existing Supplier 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 | SupplierAttribute->Id | integer | int64 |\r\n| version | SupplierAttribute->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": "BatchDeleteSupplierAttribute", "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/BatchDeleteSupplierAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier 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/GEN/Suppliers/Attributes/{id}/Active": { "patch": { "tags": [ "Supplier Attribute" ], "summary": "Change the IsActive status for an existing Supplier 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 | SupplierAttribute->Version | integer | int32 |\r\n| isActive | SupplierAttribute->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": "ChangeSupplierAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSupplierAttributeIsActiveResourceActionRequest" } }, { "$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/GEN/Suppliers/Attributes/Batch/Active": { "patch": { "tags": [ "Supplier Attribute" ], "summary": "Change the IsActive status for a collection of existing Supplier 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 | SupplierAttribute->Id | integer | int64 |\r\n| version | SupplierAttribute->Version | integer | int32 |\r\n| isActive | SupplierAttribute->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": "BatchChangeSupplierAttributeIsActive", "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/BatchChangeSupplierAttributeIsActiveResourceActionRequest" } }, { "$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/GEN/Suppliers/ContactAddresses/{id}": { "get": { "tags": [ "Supplier Contact Address" ], "summary": "Get a Supplier Contact Address 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 | SupplierContactAddress->IsActive | boolean | |\r\n| createdByUserId | SupplierContactAddress->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SupplierContactAddress->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SupplierContactAddress->CreatedByUser_FullName | string | |\r\n| createdOn | SupplierContactAddress->CreatedOn | string | date-time |\r\n| modifiedByUserId | SupplierContactAddress->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SupplierContactAddress->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SupplierContactAddress->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SupplierContactAddress->ModifiedOn | string | date-time |\r\n| version | SupplierContactAddress->Version | integer | int32 |\r\n| permissionTreeId | SupplierContactAddress->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierContactAddress->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierContactAddress->PermissionTree_Description | string | |\r\n| id | SupplierContactAddress->Id | integer | int64 |\r\n| addressTypeId | SupplierContactAddress->AddressType_Id | integer | int64 |\r\n| addressTypeCode | SupplierContactAddress->AddressType_Code | string | |\r\n| addressTypeDescription | SupplierContactAddress->AddressType_Description | string | |\r\n| body | SupplierContactAddress->Body | string | |\r\n| country | SupplierContactAddress->Country | string | |\r\n| notes | SupplierContactAddress->Notes | string | |\r\n| postalCode | SupplierContactAddress->PostalCode | string | |\r\n| sequenceNumber | SupplierContactAddress->SequenceNumber | integer | int32 |\r\n| supplierId | SupplierContactAddress->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierContactAddress->Supplier_Code | string | |\r\n| supplierDescription | SupplierContactAddress->Supplier_Description | string | |\r\n", "operationId": "GetSupplierContactAddress", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Contact Address Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Supplier Contact Address", "schema": { "$ref": "#/definitions/GetSupplierContactAddressResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Supplier Contact Address" ], "summary": "Update an existing Supplier Contact Address 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 | SupplierContactAddress->Version | integer | int32 |\r\n| addressTypeId | SupplierContactAddress->AddressType_Id | integer | int64 |\r\n| body | SupplierContactAddress->Body | string | |\r\n| sequenceNumber | SupplierContactAddress->SequenceNumber | integer | int32 |\r\n| postalCode | SupplierContactAddress->PostalCode | string | |\r\n| country | SupplierContactAddress->Country | string | |\r\n| notes | SupplierContactAddress->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| addressTypeId | Nullable | False | |\r\n| body | Nullable | False | |\r\n| postalCode | Min Length | >= 1 chars| |\r\n| postalCode | Max Length | <= 50 chars| |\r\n| country | Min Length | >= 1 chars| |\r\n| country | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "UpdateSupplierContactAddress", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Contact Address Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSupplierContactAddressResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier Contact Address 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": [ "Supplier Contact Address" ], "summary": "Delete an existing Supplier Contact Address 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 | SupplierContactAddress->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": "DeleteSupplierContactAddress", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Contact Address Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSupplierContactAddressResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier Contact Address 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/GEN/Suppliers/ContactAddresses": { "get": { "tags": [ "Supplier Contact Address" ], "summary": "Get a collection of Supplier Contact Address 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 | SupplierContactAddress->Id | integer | int64 |\r\n| version | SupplierContactAddress->Version | integer | int32 |\r\n| supplierId | SupplierContactAddress->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierContactAddress->Supplier_Code | string | |\r\n| supplierDescription | SupplierContactAddress->Supplier_Description | string | |\r\n| addressTypeId | SupplierContactAddress->AddressType_Id | integer | int64 |\r\n| addressTypeCode | SupplierContactAddress->AddressType_Code | string | |\r\n| addressTypeDescription | SupplierContactAddress->AddressType_Description | string | |\r\n| body | SupplierContactAddress->Body | string | |\r\n| sequenceNumber | SupplierContactAddress->SequenceNumber | integer | int32 |\r\n| notes | SupplierContactAddress->Notes | string | |\r\n| createdOn | SupplierContactAddress->CreatedOn | string | date-time |\r\n| modifiedOn | SupplierContactAddress->ModifiedOn | string | date-time |\r\n", "operationId": "GetSupplierContactAddressCollection", "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 Contact Address collection", "schema": { "$ref": "#/definitions/GetSupplierContactAddressCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Supplier Contact Address" ], "summary": "Create a new Supplier Contact Address 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| supplierId | SupplierContactAddress->Supplier_Id | integer | int64 |\r\n| permissionTreeId | SupplierContactAddress->PermissionTree_Id | integer | int64 |\r\n| addressTypeId | SupplierContactAddress->AddressType_Id | integer | int64 |\r\n| body | SupplierContactAddress->Body | string | |\r\n| postalCode | SupplierContactAddress->PostalCode | string | |\r\n| country | SupplierContactAddress->Country | string | |\r\n| sequenceNumber | SupplierContactAddress->SequenceNumber | integer | int32 |\r\n| notes | SupplierContactAddress->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| supplierId | Required | True | |\r\n| supplierId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| addressTypeId | Required | True | |\r\n| addressTypeId | Nullable | False | |\r\n| body | Nullable | False | |\r\n| postalCode | Min Length | >= 1 chars| |\r\n| postalCode | Max Length | <= 50 chars| |\r\n| country | Min Length | >= 1 chars| |\r\n| country | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "CreateSupplierContactAddress", "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/CreateSupplierContactAddressResourceActionRequest" } }, { "$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/GEN/Suppliers/{supplierId}/ContactAddresses": { "get": { "tags": [ "Supplier Contact Address" ], "summary": "Get a collection of Supplier Contact Address resources for the Supplier", "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 | SupplierContactAddress->Id | integer | int64 |\r\n| version | SupplierContactAddress->Version | integer | int32 |\r\n| addressTypeId | SupplierContactAddress->AddressType_Id | integer | int64 |\r\n| addressTypeCode | SupplierContactAddress->AddressType_Code | string | |\r\n| addressTypeDescription | SupplierContactAddress->AddressType_Description | string | |\r\n| body | SupplierContactAddress->Body | string | |\r\n| sequenceNumber | SupplierContactAddress->SequenceNumber | integer | int32 |\r\n| notes | SupplierContactAddress->Notes | string | |\r\n| createdOn | SupplierContactAddress->CreatedOn | string | date-time |\r\n| modifiedOn | SupplierContactAddress->ModifiedOn | string | date-time |\r\n", "operationId": "GetSupplierContactAddressForSupplierCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "supplierId", "in": "path", "required": true, "description": "Supplier 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 Supplier Contact Address collection", "schema": { "$ref": "#/definitions/GetSupplierContactAddressForSupplierCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/ContactAddresses/Lookups/LookupSupplierContactAddressAddressType": { "get": { "tags": [ "Supplier Contact Address" ], "summary": "Supplier Contact Address", "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 | AddressType->Id | integer | int64 |\r\n| code | AddressType->Code | string | |\r\n| description | AddressType->Description | string | |\r\n", "operationId": "LookupSupplierContactAddressAddressType", "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 Address Type collection", "schema": { "$ref": "#/definitions/SupplierContactAddressAddressTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/ContactAddresses/Lookups/LookupSupplierContactAddressInsertPermissionTree": { "get": { "tags": [ "Supplier Contact Address" ], "summary": "Lookup the permission set for creating the Supplier Contact Address.", "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": "LookupSupplierContactAddressInsertPermissionTree", "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/SupplierContactAddressInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/ContactAddresses/Lookups/LookupSupplierContactAddressSupplier": { "get": { "tags": [ "Supplier Contact Address" ], "summary": "Lookup the Supplier Contact Address for the Supplier Contact Address.", "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": "LookupSupplierContactAddressSupplier", "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/SupplierContactAddressSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/ContactAddresses/Batch/{ids}": { "get": { "tags": [ "Supplier Contact Address" ], "summary": "Get a collection of Supplier Contact Address 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 | SupplierContactAddress->IsActive | boolean | |\r\n| createdByUserId | SupplierContactAddress->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SupplierContactAddress->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SupplierContactAddress->CreatedByUser_FullName | string | |\r\n| createdOn | SupplierContactAddress->CreatedOn | string | date-time |\r\n| modifiedByUserId | SupplierContactAddress->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SupplierContactAddress->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SupplierContactAddress->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SupplierContactAddress->ModifiedOn | string | date-time |\r\n| version | SupplierContactAddress->Version | integer | int32 |\r\n| permissionTreeId | SupplierContactAddress->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierContactAddress->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierContactAddress->PermissionTree_Description | string | |\r\n| id | SupplierContactAddress->Id | integer | int64 |\r\n| addressTypeId | SupplierContactAddress->AddressType_Id | integer | int64 |\r\n| addressTypeCode | SupplierContactAddress->AddressType_Code | string | |\r\n| addressTypeDescription | SupplierContactAddress->AddressType_Description | string | |\r\n| body | SupplierContactAddress->Body | string | |\r\n| country | SupplierContactAddress->Country | string | |\r\n| notes | SupplierContactAddress->Notes | string | |\r\n| postalCode | SupplierContactAddress->PostalCode | string | |\r\n| sequenceNumber | SupplierContactAddress->SequenceNumber | integer | int32 |\r\n| supplierId | SupplierContactAddress->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierContactAddress->Supplier_Code | string | |\r\n| supplierDescription | SupplierContactAddress->Supplier_Description | string | |\r\n", "operationId": "BatchGetSupplierContactAddress", "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 Supplier Contact Address 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 Supplier Contact Address collection", "schema": { "$ref": "#/definitions/BatchGetSupplierContactAddressResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/ContactAddresses/Batch": { "post": { "tags": [ "Supplier Contact Address" ], "summary": "Create a new collection of Supplier Contact Address 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| supplierId | SupplierContactAddress->Supplier_Id | integer | int64 |\r\n| permissionTreeId | SupplierContactAddress->PermissionTree_Id | integer | int64 |\r\n| addressTypeId | SupplierContactAddress->AddressType_Id | integer | int64 |\r\n| body | SupplierContactAddress->Body | string | |\r\n| sequenceNumber | SupplierContactAddress->SequenceNumber | integer | int32 |\r\n| postalCode | SupplierContactAddress->PostalCode | string | |\r\n| country | SupplierContactAddress->Country | string | |\r\n| notes | SupplierContactAddress->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| supplierId | Required | True | |\r\n| supplierId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| addressTypeId | Required | True | |\r\n| addressTypeId | Nullable | False | |\r\n| body | Nullable | False | |\r\n| postalCode | Min Length | >= 1 chars| |\r\n| postalCode | Max Length | <= 50 chars| |\r\n| country | Min Length | >= 1 chars| |\r\n| country | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "BatchCreateSupplierContactAddress", "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/BatchCreateSupplierContactAddressResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Supplier Contact Address 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": [ "Supplier Contact Address" ], "summary": "Update a collection of existing Supplier Contact Address 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 | SupplierContactAddress->Id | integer | int64 |\r\n| version | SupplierContactAddress->Version | integer | int32 |\r\n| addressTypeId | SupplierContactAddress->AddressType_Id | integer | int64 |\r\n| body | SupplierContactAddress->Body | string | |\r\n| postalCode | SupplierContactAddress->PostalCode | string | |\r\n| country | SupplierContactAddress->Country | string | |\r\n| sequenceNumber | SupplierContactAddress->SequenceNumber | integer | int32 |\r\n| notes | SupplierContactAddress->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| addressTypeId | Nullable | False | |\r\n| body | Nullable | False | |\r\n| postalCode | Min Length | >= 1 chars| |\r\n| postalCode | Max Length | <= 50 chars| |\r\n| country | Min Length | >= 1 chars| |\r\n| country | Max Length | <= 50 chars| |\r\n\r\n", "operationId": "BatchUpdateSupplierContactAddress", "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/BatchUpdateSupplierContactAddressResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier Contact Address 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": [ "Supplier Contact Address" ], "summary": "Delete a collection of existing Supplier Contact Address 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 | SupplierContactAddress->Id | integer | int64 |\r\n| version | SupplierContactAddress->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": "BatchDeleteSupplierContactAddress", "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/BatchDeleteSupplierContactAddressResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier Contact Address 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/GEN/Suppliers/ContactAddresses/{id}/Active": { "patch": { "tags": [ "Supplier Contact Address" ], "summary": "Change the IsActive status for an existing Supplier Contact Address 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 | SupplierContactAddress->Version | integer | int32 |\r\n| isActive | SupplierContactAddress->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": "ChangeSupplierContactAddressIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Contact Address Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSupplierContactAddressIsActiveResourceActionRequest" } }, { "$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/GEN/Suppliers/ContactAddresses/Batch/Active": { "patch": { "tags": [ "Supplier Contact Address" ], "summary": "Change the IsActive status for a collection of existing Supplier Contact Address 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 | SupplierContactAddress->Id | integer | int64 |\r\n| version | SupplierContactAddress->Version | integer | int32 |\r\n| isActive | SupplierContactAddress->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": "BatchChangeSupplierContactAddressIsActive", "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/BatchChangeSupplierContactAddressIsActiveResourceActionRequest" } }, { "$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/GEN/Suppliers/ContactEmails/{id}": { "get": { "tags": [ "Supplier Contact Email" ], "summary": "Get a Supplier Contact Email 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 | SupplierContactEmail->IsActive | boolean | |\r\n| createdByUserId | SupplierContactEmail->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SupplierContactEmail->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SupplierContactEmail->CreatedByUser_FullName | string | |\r\n| createdOn | SupplierContactEmail->CreatedOn | string | date-time |\r\n| modifiedByUserId | SupplierContactEmail->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SupplierContactEmail->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SupplierContactEmail->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SupplierContactEmail->ModifiedOn | string | date-time |\r\n| version | SupplierContactEmail->Version | integer | int32 |\r\n| permissionTreeId | SupplierContactEmail->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierContactEmail->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierContactEmail->PermissionTree_Description | string | |\r\n| id | SupplierContactEmail->Id | integer | int64 |\r\n| email | SupplierContactEmail->Email | string | |\r\n| emailTypeId | SupplierContactEmail->EmailType_Id | integer | int64 |\r\n| emailTypeCode | SupplierContactEmail->EmailType_Code | string | |\r\n| emailTypeDescription | SupplierContactEmail->EmailType_Description | string | |\r\n| notes | SupplierContactEmail->Notes | string | |\r\n| sequenceNumber | SupplierContactEmail->SequenceNumber | integer | int32 |\r\n| supplierId | SupplierContactEmail->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierContactEmail->Supplier_Code | string | |\r\n| supplierDescription | SupplierContactEmail->Supplier_Description | string | |\r\n", "operationId": "GetSupplierContactEmail", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Contact Email Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Supplier Contact Email", "schema": { "$ref": "#/definitions/GetSupplierContactEmailResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Supplier Contact Email" ], "summary": "Update an existing Supplier Contact Email 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 | SupplierContactEmail->Version | integer | int32 |\r\n| emailTypeId | SupplierContactEmail->EmailType_Id | integer | int64 |\r\n| email | SupplierContactEmail->Email | string | |\r\n| sequenceNumber | SupplierContactEmail->SequenceNumber | integer | int32 |\r\n| notes | SupplierContactEmail->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| emailTypeId | Nullable | False | |\r\n| email | Nullable | False | |\r\n| email | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "UpdateSupplierContactEmail", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Contact Email Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSupplierContactEmailResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier Contact Email 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": [ "Supplier Contact Email" ], "summary": "Delete an existing Supplier Contact Email 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 | SupplierContactEmail->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": "DeleteSupplierContactEmail", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Contact Email Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSupplierContactEmailResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier Contact Email 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/GEN/Suppliers/ContactEmails": { "get": { "tags": [ "Supplier Contact Email" ], "summary": "Get a collection of Supplier Contact Email 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 | SupplierContactEmail->Id | integer | int64 |\r\n| version | SupplierContactEmail->Version | integer | int32 |\r\n| supplierId | SupplierContactEmail->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierContactEmail->Supplier_Code | string | |\r\n| supplierDescription | SupplierContactEmail->Supplier_Description | string | |\r\n| emailTypeId | SupplierContactEmail->EmailType_Id | integer | int64 |\r\n| emailTypeCode | SupplierContactEmail->EmailType_Code | string | |\r\n| emailTypeDescription | SupplierContactEmail->EmailType_Description | string | |\r\n| email | SupplierContactEmail->Email | string | |\r\n| sequenceNumber | SupplierContactEmail->SequenceNumber | integer | int32 |\r\n| notes | SupplierContactEmail->Notes | string | |\r\n| createdOn | SupplierContactEmail->CreatedOn | string | date-time |\r\n| modifiedOn | SupplierContactEmail->ModifiedOn | string | date-time |\r\n", "operationId": "GetSupplierContactEmailCollection", "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 Contact Email collection", "schema": { "$ref": "#/definitions/GetSupplierContactEmailCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Supplier Contact Email" ], "summary": "Create a new Supplier Contact Email 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| supplierId | SupplierContactEmail->Supplier_Id | integer | int64 |\r\n| permissionTreeId | SupplierContactEmail->PermissionTree_Id | integer | int64 |\r\n| emailTypeId | SupplierContactEmail->EmailType_Id | integer | int64 |\r\n| email | SupplierContactEmail->Email | string | |\r\n| sequenceNumber | SupplierContactEmail->SequenceNumber | integer | int32 |\r\n| notes | SupplierContactEmail->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| supplierId | Required | True | |\r\n| supplierId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| emailTypeId | Required | True | |\r\n| emailTypeId | Nullable | False | |\r\n| email | Required | True | |\r\n| email | Nullable | False | |\r\n| email | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "CreateSupplierContactEmail", "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/CreateSupplierContactEmailResourceActionRequest" } }, { "$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/GEN/Suppliers/{supplierId}/ContactEmails": { "get": { "tags": [ "Supplier Contact Email" ], "summary": "Get a collection of Supplier Contact Email resources for the Supplier", "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 | SupplierContactEmail->Id | integer | int64 |\r\n| version | SupplierContactEmail->Version | integer | int32 |\r\n| emailTypeId | SupplierContactEmail->EmailType_Id | integer | int64 |\r\n| emailTypeCode | SupplierContactEmail->EmailType_Code | string | |\r\n| emailTypeDescription | SupplierContactEmail->EmailType_Description | string | |\r\n| email | SupplierContactEmail->Email | string | |\r\n| sequenceNumber | SupplierContactEmail->SequenceNumber | integer | int32 |\r\n| notes | SupplierContactEmail->Notes | string | |\r\n| createdOn | SupplierContactEmail->CreatedOn | string | date-time |\r\n| modifiedOn | SupplierContactEmail->ModifiedOn | string | date-time |\r\n", "operationId": "GetSupplierContactEmailForSupplierCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "supplierId", "in": "path", "required": true, "description": "Supplier 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 Supplier Contact Email collection", "schema": { "$ref": "#/definitions/GetSupplierContactEmailForSupplierCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/ContactEmails/Lookups/LookupSupplierContactEmailEmailType": { "get": { "tags": [ "Supplier Contact Email" ], "summary": "Supplier Contact Email", "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 | EmailType->Id | integer | int64 |\r\n| code | EmailType->Code | string | |\r\n| description | EmailType->Description | string | |\r\n", "operationId": "LookupSupplierContactEmailEmailType", "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 Email Type collection", "schema": { "$ref": "#/definitions/SupplierContactEmailEmailTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/ContactEmails/Lookups/LookupSupplierContactEmailInsertPermissionTree": { "get": { "tags": [ "Supplier Contact Email" ], "summary": "Lookup the permission set for creating the Supplier Contact Email.", "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": "LookupSupplierContactEmailInsertPermissionTree", "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/SupplierContactEmailInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/ContactEmails/Lookups/LookupSupplierContactEmailSupplier": { "get": { "tags": [ "Supplier Contact Email" ], "summary": "Lookup the Supplier Contact Email for the Supplier Contact Email.", "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": "LookupSupplierContactEmailSupplier", "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/SupplierContactEmailSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/ContactEmails/Batch/{ids}": { "get": { "tags": [ "Supplier Contact Email" ], "summary": "Get a collection of Supplier Contact Email 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 | SupplierContactEmail->IsActive | boolean | |\r\n| createdByUserId | SupplierContactEmail->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SupplierContactEmail->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SupplierContactEmail->CreatedByUser_FullName | string | |\r\n| createdOn | SupplierContactEmail->CreatedOn | string | date-time |\r\n| modifiedByUserId | SupplierContactEmail->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SupplierContactEmail->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SupplierContactEmail->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SupplierContactEmail->ModifiedOn | string | date-time |\r\n| version | SupplierContactEmail->Version | integer | int32 |\r\n| permissionTreeId | SupplierContactEmail->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierContactEmail->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierContactEmail->PermissionTree_Description | string | |\r\n| id | SupplierContactEmail->Id | integer | int64 |\r\n| email | SupplierContactEmail->Email | string | |\r\n| emailTypeId | SupplierContactEmail->EmailType_Id | integer | int64 |\r\n| emailTypeCode | SupplierContactEmail->EmailType_Code | string | |\r\n| emailTypeDescription | SupplierContactEmail->EmailType_Description | string | |\r\n| notes | SupplierContactEmail->Notes | string | |\r\n| sequenceNumber | SupplierContactEmail->SequenceNumber | integer | int32 |\r\n| supplierId | SupplierContactEmail->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierContactEmail->Supplier_Code | string | |\r\n| supplierDescription | SupplierContactEmail->Supplier_Description | string | |\r\n", "operationId": "BatchGetSupplierContactEmail", "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 Supplier Contact Email 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 Supplier Contact Email collection", "schema": { "$ref": "#/definitions/BatchGetSupplierContactEmailResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/ContactEmails/Batch": { "post": { "tags": [ "Supplier Contact Email" ], "summary": "Create a new collection of Supplier Contact Email 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| supplierId | SupplierContactEmail->Supplier_Id | integer | int64 |\r\n| permissionTreeId | SupplierContactEmail->PermissionTree_Id | integer | int64 |\r\n| emailTypeId | SupplierContactEmail->EmailType_Id | integer | int64 |\r\n| email | SupplierContactEmail->Email | string | |\r\n| sequenceNumber | SupplierContactEmail->SequenceNumber | integer | int32 |\r\n| notes | SupplierContactEmail->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| supplierId | Required | True | |\r\n| supplierId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| emailTypeId | Required | True | |\r\n| emailTypeId | Nullable | False | |\r\n| email | Required | True | |\r\n| email | Nullable | False | |\r\n| email | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "BatchCreateSupplierContactEmail", "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/BatchCreateSupplierContactEmailResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Supplier Contact Email 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": [ "Supplier Contact Email" ], "summary": "Update a collection of existing Supplier Contact Email 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 | SupplierContactEmail->Id | integer | int64 |\r\n| version | SupplierContactEmail->Version | integer | int32 |\r\n| emailTypeId | SupplierContactEmail->EmailType_Id | integer | int64 |\r\n| email | SupplierContactEmail->Email | string | |\r\n| sequenceNumber | SupplierContactEmail->SequenceNumber | integer | int32 |\r\n| notes | SupplierContactEmail->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| emailTypeId | Nullable | False | |\r\n| email | Nullable | False | |\r\n| email | Max Length | <= 255 chars| |\r\n\r\n", "operationId": "BatchUpdateSupplierContactEmail", "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/BatchUpdateSupplierContactEmailResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier Contact Email 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": [ "Supplier Contact Email" ], "summary": "Delete a collection of existing Supplier Contact Email 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 | SupplierContactEmail->Id | integer | int64 |\r\n| version | SupplierContactEmail->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": "BatchDeleteSupplierContactEmail", "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/BatchDeleteSupplierContactEmailResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier Contact Email 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/GEN/Suppliers/ContactEmails/{id}/Active": { "patch": { "tags": [ "Supplier Contact Email" ], "summary": "Change the IsActive status for an existing Supplier Contact Email 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 | SupplierContactEmail->Version | integer | int32 |\r\n| isActive | SupplierContactEmail->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": "ChangeSupplierContactEmailIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Contact Email Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSupplierContactEmailIsActiveResourceActionRequest" } }, { "$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/GEN/Suppliers/ContactEmails/Batch/Active": { "patch": { "tags": [ "Supplier Contact Email" ], "summary": "Change the IsActive status for a collection of existing Supplier Contact Email 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 | SupplierContactEmail->Id | integer | int64 |\r\n| version | SupplierContactEmail->Version | integer | int32 |\r\n| isActive | SupplierContactEmail->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": "BatchChangeSupplierContactEmailIsActive", "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/BatchChangeSupplierContactEmailIsActiveResourceActionRequest" } }, { "$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/GEN/Suppliers/ContactPhoneNumbers/{id}": { "get": { "tags": [ "Supplier Contact Phone Number" ], "summary": "Get a Supplier Contact Phone Number 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 | SupplierContactPhoneNumber->IsActive | boolean | |\r\n| createdByUserId | SupplierContactPhoneNumber->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SupplierContactPhoneNumber->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SupplierContactPhoneNumber->CreatedByUser_FullName | string | |\r\n| createdOn | SupplierContactPhoneNumber->CreatedOn | string | date-time |\r\n| modifiedByUserId | SupplierContactPhoneNumber->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SupplierContactPhoneNumber->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SupplierContactPhoneNumber->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SupplierContactPhoneNumber->ModifiedOn | string | date-time |\r\n| version | SupplierContactPhoneNumber->Version | integer | int32 |\r\n| permissionTreeId | SupplierContactPhoneNumber->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierContactPhoneNumber->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierContactPhoneNumber->PermissionTree_Description | string | |\r\n| id | SupplierContactPhoneNumber->Id | integer | int64 |\r\n| notes | SupplierContactPhoneNumber->Notes | string | |\r\n| phoneNumber | SupplierContactPhoneNumber->PhoneNumber | string | |\r\n| phoneNumberTypeId | SupplierContactPhoneNumber->PhoneNumberType_Id | integer | int64 |\r\n| phoneNumberTypeCode | SupplierContactPhoneNumber->PhoneNumberType_Code | string | |\r\n| phoneNumberTypeDescription | SupplierContactPhoneNumber->PhoneNumberType_Description | string | |\r\n| sequenceNumber | SupplierContactPhoneNumber->SequenceNumber | integer | int32 |\r\n| supplierId | SupplierContactPhoneNumber->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierContactPhoneNumber->Supplier_Code | string | |\r\n| supplierDescription | SupplierContactPhoneNumber->Supplier_Description | string | |\r\n", "operationId": "GetSupplierContactPhoneNumber", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Contact Phone Number Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Supplier Contact Phone Number", "schema": { "$ref": "#/definitions/GetSupplierContactPhoneNumberResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Supplier Contact Phone Number" ], "summary": "Update an existing Supplier Contact Phone Number 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 | SupplierContactPhoneNumber->Version | integer | int32 |\r\n| phoneNumberTypeId | SupplierContactPhoneNumber->PhoneNumberType_Id | integer | int64 |\r\n| phoneNumber | SupplierContactPhoneNumber->PhoneNumber | string | |\r\n| sequenceNumber | SupplierContactPhoneNumber->SequenceNumber | integer | int32 |\r\n| notes | SupplierContactPhoneNumber->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| phoneNumberTypeId | Nullable | False | |\r\n| phoneNumber | Nullable | False | |\r\n| phoneNumber | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phoneNumber | Min Length | >= 1 chars| |\r\n| phoneNumber | Max Length | <= 30 chars| |\r\n\r\n", "operationId": "UpdateSupplierContactPhoneNumber", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Contact Phone Number Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSupplierContactPhoneNumberResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier Contact Phone Number 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": [ "Supplier Contact Phone Number" ], "summary": "Delete an existing Supplier Contact Phone Number 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 | SupplierContactPhoneNumber->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": "DeleteSupplierContactPhoneNumber", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Contact Phone Number Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSupplierContactPhoneNumberResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier Contact Phone Number 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/GEN/Suppliers/ContactPhoneNumbers": { "get": { "tags": [ "Supplier Contact Phone Number" ], "summary": "Get a collection of Supplier Contact Phone Number 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 | SupplierContactPhoneNumber->Id | integer | int64 |\r\n| version | SupplierContactPhoneNumber->Version | integer | int32 |\r\n| supplierId | SupplierContactPhoneNumber->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierContactPhoneNumber->Supplier_Code | string | |\r\n| supplierDescription | SupplierContactPhoneNumber->Supplier_Description | string | |\r\n| phoneNumberTypeId | SupplierContactPhoneNumber->PhoneNumberType_Id | integer | int64 |\r\n| phoneNumberTypeCode | SupplierContactPhoneNumber->PhoneNumberType_Code | string | |\r\n| phoneNumberTypeDescription | SupplierContactPhoneNumber->PhoneNumberType_Description | string | |\r\n| phoneNumber | SupplierContactPhoneNumber->PhoneNumber | string | |\r\n| sequenceNumber | SupplierContactPhoneNumber->SequenceNumber | integer | int32 |\r\n| notes | SupplierContactPhoneNumber->Notes | string | |\r\n| createdOn | SupplierContactPhoneNumber->CreatedOn | string | date-time |\r\n| modifiedOn | SupplierContactPhoneNumber->ModifiedOn | string | date-time |\r\n", "operationId": "GetSupplierContactPhoneNumberCollection", "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 Contact Phone Number collection", "schema": { "$ref": "#/definitions/GetSupplierContactPhoneNumberCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Supplier Contact Phone Number" ], "summary": "Create a new Supplier Contact Phone Number 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| supplierId | SupplierContactPhoneNumber->Supplier_Id | integer | int64 |\r\n| permissionTreeId | SupplierContactPhoneNumber->PermissionTree_Id | integer | int64 |\r\n| phoneNumberTypeId | SupplierContactPhoneNumber->PhoneNumberType_Id | integer | int64 |\r\n| phoneNumber | SupplierContactPhoneNumber->PhoneNumber | string | |\r\n| sequenceNumber | SupplierContactPhoneNumber->SequenceNumber | integer | int32 |\r\n| notes | SupplierContactPhoneNumber->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| supplierId | Required | True | |\r\n| supplierId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| phoneNumberTypeId | Required | True | |\r\n| phoneNumberTypeId | Nullable | False | |\r\n| phoneNumber | Required | True | |\r\n| phoneNumber | Nullable | False | |\r\n| phoneNumber | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phoneNumber | Min Length | >= 1 chars| |\r\n| phoneNumber | Max Length | <= 30 chars| |\r\n\r\n", "operationId": "CreateSupplierContactPhoneNumber", "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/CreateSupplierContactPhoneNumberResourceActionRequest" } }, { "$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/GEN/Suppliers/{supplierId}/ContactPhoneNumbers": { "get": { "tags": [ "Supplier Contact Phone Number" ], "summary": "Get a collection of Supplier Contact Phone Number resources for the Supplier", "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 | SupplierContactPhoneNumber->Id | integer | int64 |\r\n| version | SupplierContactPhoneNumber->Version | integer | int32 |\r\n| phoneNumberTypeId | SupplierContactPhoneNumber->PhoneNumberType_Id | integer | int64 |\r\n| phoneNumberTypeCode | SupplierContactPhoneNumber->PhoneNumberType_Code | string | |\r\n| phoneNumberTypeDescription | SupplierContactPhoneNumber->PhoneNumberType_Description | string | |\r\n| phoneNumber | SupplierContactPhoneNumber->PhoneNumber | string | |\r\n| sequenceNumber | SupplierContactPhoneNumber->SequenceNumber | integer | int32 |\r\n| notes | SupplierContactPhoneNumber->Notes | string | |\r\n| createdOn | SupplierContactPhoneNumber->CreatedOn | string | date-time |\r\n| modifiedOn | SupplierContactPhoneNumber->ModifiedOn | string | date-time |\r\n", "operationId": "GetSupplierContactPhoneNumberForSupplierCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "supplierId", "in": "path", "required": true, "description": "Supplier 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 Supplier Contact Phone Number collection", "schema": { "$ref": "#/definitions/GetSupplierContactPhoneNumberForSupplierCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/ContactPhoneNumbers/Lookups/LookupSupplierContactPhoneNumberInsertPermissionTree": { "get": { "tags": [ "Supplier Contact Phone Number" ], "summary": "Lookup the permission set for creating the Supplier Contact Phone Number.", "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": "LookupSupplierContactPhoneNumberInsertPermissionTree", "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/SupplierContactPhoneNumberInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/ContactPhoneNumbers/Lookups/LookupSupplierContactPhoneNumberPhoneNumberType": { "get": { "tags": [ "Supplier Contact Phone Number" ], "summary": "Supplier Contact Phone Number", "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 | PhoneNumberType->Id | integer | int64 |\r\n| code | PhoneNumberType->Code | string | |\r\n| description | PhoneNumberType->Description | string | |\r\n", "operationId": "LookupSupplierContactPhoneNumberPhoneNumberType", "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 Phone Number Type collection", "schema": { "$ref": "#/definitions/SupplierContactPhoneNumberPhoneNumberTypeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/ContactPhoneNumbers/Lookups/LookupSupplierContactPhoneNumberSupplier": { "get": { "tags": [ "Supplier Contact Phone Number" ], "summary": "Lookup the Supplier Contact Phone Number for the Supplier Contact Phone Number.", "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": "LookupSupplierContactPhoneNumberSupplier", "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/SupplierContactPhoneNumberSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/ContactPhoneNumbers/Batch/{ids}": { "get": { "tags": [ "Supplier Contact Phone Number" ], "summary": "Get a collection of Supplier Contact Phone Number 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 | SupplierContactPhoneNumber->IsActive | boolean | |\r\n| createdByUserId | SupplierContactPhoneNumber->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SupplierContactPhoneNumber->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SupplierContactPhoneNumber->CreatedByUser_FullName | string | |\r\n| createdOn | SupplierContactPhoneNumber->CreatedOn | string | date-time |\r\n| modifiedByUserId | SupplierContactPhoneNumber->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SupplierContactPhoneNumber->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SupplierContactPhoneNumber->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SupplierContactPhoneNumber->ModifiedOn | string | date-time |\r\n| version | SupplierContactPhoneNumber->Version | integer | int32 |\r\n| permissionTreeId | SupplierContactPhoneNumber->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierContactPhoneNumber->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierContactPhoneNumber->PermissionTree_Description | string | |\r\n| id | SupplierContactPhoneNumber->Id | integer | int64 |\r\n| notes | SupplierContactPhoneNumber->Notes | string | |\r\n| phoneNumber | SupplierContactPhoneNumber->PhoneNumber | string | |\r\n| phoneNumberTypeId | SupplierContactPhoneNumber->PhoneNumberType_Id | integer | int64 |\r\n| phoneNumberTypeCode | SupplierContactPhoneNumber->PhoneNumberType_Code | string | |\r\n| phoneNumberTypeDescription | SupplierContactPhoneNumber->PhoneNumberType_Description | string | |\r\n| sequenceNumber | SupplierContactPhoneNumber->SequenceNumber | integer | int32 |\r\n| supplierId | SupplierContactPhoneNumber->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierContactPhoneNumber->Supplier_Code | string | |\r\n| supplierDescription | SupplierContactPhoneNumber->Supplier_Description | string | |\r\n", "operationId": "BatchGetSupplierContactPhoneNumber", "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 Supplier Contact Phone Number 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 Supplier Contact Phone Number collection", "schema": { "$ref": "#/definitions/BatchGetSupplierContactPhoneNumberResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/ContactPhoneNumbers/Batch": { "post": { "tags": [ "Supplier Contact Phone Number" ], "summary": "Create a new collection of Supplier Contact Phone Number 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| supplierId | SupplierContactPhoneNumber->Supplier_Id | integer | int64 |\r\n| permissionTreeId | SupplierContactPhoneNumber->PermissionTree_Id | integer | int64 |\r\n| phoneNumberTypeId | SupplierContactPhoneNumber->PhoneNumberType_Id | integer | int64 |\r\n| phoneNumber | SupplierContactPhoneNumber->PhoneNumber | string | |\r\n| sequenceNumber | SupplierContactPhoneNumber->SequenceNumber | integer | int32 |\r\n| notes | SupplierContactPhoneNumber->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| supplierId | Required | True | |\r\n| supplierId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| phoneNumberTypeId | Required | True | |\r\n| phoneNumberTypeId | Nullable | False | |\r\n| phoneNumber | Required | True | |\r\n| phoneNumber | Nullable | False | |\r\n| phoneNumber | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phoneNumber | Min Length | >= 1 chars| |\r\n| phoneNumber | Max Length | <= 30 chars| |\r\n\r\n", "operationId": "BatchCreateSupplierContactPhoneNumber", "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/BatchCreateSupplierContactPhoneNumberResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Supplier Contact Phone Number 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": [ "Supplier Contact Phone Number" ], "summary": "Update a collection of existing Supplier Contact Phone Number 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 | SupplierContactPhoneNumber->Id | integer | int64 |\r\n| version | SupplierContactPhoneNumber->Version | integer | int32 |\r\n| phoneNumberTypeId | SupplierContactPhoneNumber->PhoneNumberType_Id | integer | int64 |\r\n| phoneNumber | SupplierContactPhoneNumber->PhoneNumber | string | |\r\n| sequenceNumber | SupplierContactPhoneNumber->SequenceNumber | integer | int32 |\r\n| notes | SupplierContactPhoneNumber->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| phoneNumberTypeId | Nullable | False | |\r\n| phoneNumber | Nullable | False | |\r\n| phoneNumber | Pattern | ^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$ | |\r\n| phoneNumber | Min Length | >= 1 chars| |\r\n| phoneNumber | Max Length | <= 30 chars| |\r\n\r\n", "operationId": "BatchUpdateSupplierContactPhoneNumber", "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/BatchUpdateSupplierContactPhoneNumberResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier Contact Phone Number 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": [ "Supplier Contact Phone Number" ], "summary": "Delete a collection of existing Supplier Contact Phone Number 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 | SupplierContactPhoneNumber->Id | integer | int64 |\r\n| version | SupplierContactPhoneNumber->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": "BatchDeleteSupplierContactPhoneNumber", "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/BatchDeleteSupplierContactPhoneNumberResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier Contact Phone Number 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/GEN/Suppliers/ContactPhoneNumbers/{id}/Active": { "patch": { "tags": [ "Supplier Contact Phone Number" ], "summary": "Change the IsActive status for an existing Supplier Contact Phone Number 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 | SupplierContactPhoneNumber->Version | integer | int32 |\r\n| isActive | SupplierContactPhoneNumber->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": "ChangeSupplierContactPhoneNumberIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Contact Phone Number Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSupplierContactPhoneNumberIsActiveResourceActionRequest" } }, { "$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/GEN/Suppliers/ContactPhoneNumbers/Batch/Active": { "patch": { "tags": [ "Supplier Contact Phone Number" ], "summary": "Change the IsActive status for a collection of existing Supplier Contact Phone Number 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 | SupplierContactPhoneNumber->Id | integer | int64 |\r\n| version | SupplierContactPhoneNumber->Version | integer | int32 |\r\n| isActive | SupplierContactPhoneNumber->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": "BatchChangeSupplierContactPhoneNumberIsActive", "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/BatchChangeSupplierContactPhoneNumberIsActiveResourceActionRequest" } }, { "$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/GEN/Suppliers/Documents/{id}": { "get": { "tags": [ "Supplier Document" ], "summary": "Get a Supplier 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| supplierId | SupplierDocument->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierDocument->Supplier_Code | string | |\r\n| supplierDescription | SupplierDocument->Supplier_Description | string | |\r\n| isActive | SupplierDocument->IsActive | boolean | |\r\n| createdByUserId | SupplierDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SupplierDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SupplierDocument->CreatedByUser_FullName | string | |\r\n| createdOn | SupplierDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | SupplierDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SupplierDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SupplierDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SupplierDocument->ModifiedOn | string | date-time |\r\n| version | SupplierDocument->Version | integer | int32 |\r\n| permissionTreeId | SupplierDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierDocument->PermissionTree_Description | string | |\r\n| id | SupplierDocument->Id | integer | int64 |\r\n| documentRecordId | SupplierDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | SupplierDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | SupplierDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | SupplierDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | SupplierDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | SupplierDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | SupplierDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | SupplierDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | SupplierDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | SupplierDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | SupplierDocument->Notes | string | |\r\n| sequenceNumber | SupplierDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetSupplierDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Supplier Document", "schema": { "$ref": "#/definitions/GetSupplierDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Supplier Document" ], "summary": "Update an existing Supplier 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 | SupplierDocument->Version | integer | int32 |\r\n| sequenceNumber | SupplierDocument->SequenceNumber | integer | int32 |\r\n| notes | SupplierDocument->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": "UpdateSupplierDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSupplierDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier 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": [ "Supplier Document" ], "summary": "Delete an existing Supplier 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 | SupplierDocument->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": "DeleteSupplierDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSupplierDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier 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/GEN/Suppliers/{id}/Documents": { "get": { "tags": [ "Supplier Document" ], "summary": "Get a collection of Supplier Document resources for the Supplier.", "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 | SupplierDocument->Id | integer | int64 |\r\n| version | SupplierDocument->Version | integer | int32 |\r\n| sequenceNumber | SupplierDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | SupplierDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | SupplierDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | SupplierDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | SupplierDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | SupplierDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | SupplierDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | SupplierDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetSupplierDocumentCollectionForSupplier", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier 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 Supplier Document collection", "schema": { "$ref": "#/definitions/GetSupplierDocumentCollectionForSupplierResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Documents": { "get": { "tags": [ "Supplier Document" ], "summary": "Get a collection of Supplier 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 | SupplierDocument->Id | integer | int64 |\r\n| version | SupplierDocument->Version | integer | int32 |\r\n| supplierId | SupplierDocument->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierDocument->Supplier_Code | string | |\r\n| supplierDescription | SupplierDocument->Supplier_Description | string | |\r\n| sequenceNumber | SupplierDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | SupplierDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | SupplierDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | SupplierDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | SupplierDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | SupplierDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | SupplierDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | SupplierDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetSupplierDocumentCollection", "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 Document collection", "schema": { "$ref": "#/definitions/GetSupplierDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Supplier Document" ], "summary": "Create a new Supplier 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| supplierId | SupplierDocument->Supplier_Id | integer | int64 |\r\n| documentRecordId | SupplierDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | SupplierDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | SupplierDocument->SequenceNumber | integer | int32 |\r\n| notes | SupplierDocument->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| supplierId | Required | True | |\r\n| supplierId | 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": "CreateSupplierDocument", "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/CreateSupplierDocumentResourceActionRequest" } }, { "$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/GEN/Suppliers/Documents/Lookups/LookupSupplierDocumentChangePermissionTree": { "get": { "tags": [ "Supplier Document" ], "summary": "Lookup the permission set for changing the Supplier 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": "LookupSupplierDocumentChangePermissionTree", "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/SupplierDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Documents/Lookups/LookupSupplierDocument": { "get": { "tags": [ "Supplier Document" ], "summary": "Supplier 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": "LookupSupplierDocument", "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/SupplierDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Documents/Lookups/LookupSupplierDocumentInsertPermissionTree": { "get": { "tags": [ "Supplier Document" ], "summary": "Lookup the permission set for creating the Supplier 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": "LookupSupplierDocumentInsertPermissionTree", "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/SupplierDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Documents/Lookups/LookupSupplierDocumentSupplier": { "get": { "tags": [ "Supplier Document" ], "summary": "Lookup the Supplier Document for the Supplier 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 | Supplier->Id | integer | int64 |\r\n| code | Supplier->Code | string | |\r\n| description | Supplier->Description | string | |\r\n", "operationId": "LookupSupplierDocumentSupplier", "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/SupplierDocumentSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Documents/Batch/{ids}": { "get": { "tags": [ "Supplier Document" ], "summary": "Get a collection of Supplier 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| supplierId | SupplierDocument->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierDocument->Supplier_Code | string | |\r\n| supplierDescription | SupplierDocument->Supplier_Description | string | |\r\n| isActive | SupplierDocument->IsActive | boolean | |\r\n| createdByUserId | SupplierDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SupplierDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SupplierDocument->CreatedByUser_FullName | string | |\r\n| createdOn | SupplierDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | SupplierDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SupplierDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SupplierDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SupplierDocument->ModifiedOn | string | date-time |\r\n| version | SupplierDocument->Version | integer | int32 |\r\n| permissionTreeId | SupplierDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierDocument->PermissionTree_Description | string | |\r\n| id | SupplierDocument->Id | integer | int64 |\r\n| documentRecordId | SupplierDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | SupplierDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | SupplierDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | SupplierDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | SupplierDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | SupplierDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | SupplierDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | SupplierDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | SupplierDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | SupplierDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | SupplierDocument->Notes | string | |\r\n| sequenceNumber | SupplierDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetSupplierDocument", "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 Supplier 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 Supplier Document collection", "schema": { "$ref": "#/definitions/BatchGetSupplierDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Documents/Batch": { "post": { "tags": [ "Supplier Document" ], "summary": "Create a new collection of Supplier 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| supplierId | SupplierDocument->Supplier_Id | integer | int64 |\r\n| documentRecordId | SupplierDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | SupplierDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | SupplierDocument->SequenceNumber | integer | int32 |\r\n| notes | SupplierDocument->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| supplierId | Required | True | |\r\n| supplierId | 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": "BatchCreateSupplierDocument", "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/BatchCreateSupplierDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Supplier 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": [ "Supplier Document" ], "summary": "Update a collection of existing Supplier 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 | SupplierDocument->Id | integer | int64 |\r\n| version | SupplierDocument->Version | integer | int32 |\r\n| sequenceNumber | SupplierDocument->SequenceNumber | integer | int32 |\r\n| notes | SupplierDocument->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": "BatchUpdateSupplierDocument", "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/BatchUpdateSupplierDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier 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": [ "Supplier Document" ], "summary": "Delete a collection of existing Supplier 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 | SupplierDocument->Id | integer | int64 |\r\n| version | SupplierDocument->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": "BatchDeleteSupplierDocument", "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/BatchDeleteSupplierDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier 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/GEN/Suppliers/Documents/{id}/Active": { "patch": { "tags": [ "Supplier Document" ], "summary": "Change the IsActive status for an existing Supplier 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 | SupplierDocument->Version | integer | int32 |\r\n| isActive | SupplierDocument->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": "ChangeSupplierDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSupplierDocumentIsActiveResourceActionRequest" } }, { "$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/GEN/Suppliers/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Supplier Document" ], "summary": "Change the PermissionTree for an existing Supplier 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 | SupplierDocument->Version | integer | int32 |\r\n| permissionTreeId | SupplierDocument->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": "ChangeSupplierDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSupplierDocumentPermissionTreeResourceActionRequest" } }, { "$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/GEN/Suppliers/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Supplier Document" ], "summary": "Change the PermissionTree status for a collection of existing Supplier 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 | SupplierDocument->Id | integer | int64 |\r\n| version | SupplierDocument->Version | integer | int32 |\r\n| permissionTreeId | SupplierDocument->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": "BatchChangeSupplierDocumentPermissionTree", "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/BatchChangeSupplierDocumentPermissionTreeResourceActionRequest" } }, { "$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/GEN/Suppliers/Documents/Batch/Active": { "patch": { "tags": [ "Supplier Document" ], "summary": "Change the IsActive status for a collection of existing Supplier 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 | SupplierDocument->Id | integer | int64 |\r\n| version | SupplierDocument->Version | integer | int32 |\r\n| isActive | SupplierDocument->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": "BatchChangeSupplierDocumentIsActive", "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/BatchChangeSupplierDocumentIsActiveResourceActionRequest" } }, { "$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/GEN/Suppliers/FileAttachments/{id}/Download": { "get": { "tags": [ "Supplier File Attachment" ], "summary": "Download the content for a Supplier File Attachment resource.", "description": "", "operationId": "GetSupplierFileAttachmentContent", "produces": [ "*/*", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "type": "integer", "name": "cv", "in": "query", "description": "Return older version of attachment content", "format": "int32", "x-nullable": true } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains file content", "schema": { "type": "string", "format": "binary" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/FileAttachments/{id}": { "get": { "tags": [ "Supplier File Attachment" ], "summary": "Get a Supplier File Attachment 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| supplierId | SupplierFileAttachment->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierFileAttachment->Supplier_Code | string | |\r\n| supplierDescription | SupplierFileAttachment->Supplier_Description | string | |\r\n| createdByUserId | SupplierFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SupplierFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SupplierFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | SupplierFileAttachment->CreatedOn | string | date-time |\r\n| contentId | SupplierFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | SupplierFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | SupplierFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | SupplierFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | SupplierFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | SupplierFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | SupplierFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | SupplierFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | SupplierFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | SupplierFileAttachment->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| fileCategoryId | SupplierFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | SupplierFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | SupplierFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | SupplierFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | SupplierFileAttachment->FileFullName | string | |\r\n| fileName | SupplierFileAttachment->FileName | string | |\r\n| fileTypeId | SupplierFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | SupplierFileAttachment->FileType_Extension | string | |\r\n| isRestricted | SupplierFileAttachment->IsRestricted | boolean | |\r\n| id | SupplierFileAttachment->Id | integer | int64 |\r\n| isActive | SupplierFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | SupplierFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SupplierFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SupplierFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SupplierFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | SupplierFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierFileAttachment->PermissionTree_Description | string | |\r\n| version | SupplierFileAttachment->Version | integer | int32 |\r\n", "operationId": "GetSupplierFileAttachment", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Supplier File Attachment", "schema": { "$ref": "#/definitions/GetSupplierFileAttachmentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Supplier File Attachment" ], "summary": "Update an existing Supplier File Attachment 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 | SupplierFileAttachment->Version | integer | int32 |\r\n| fileCategoryId | SupplierFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileName | SupplierFileAttachment->FileName | string | |\r\n| isRestricted | SupplierFileAttachment->IsRestricted | 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| fileName | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n\r\n", "operationId": "UpdateSupplierFileAttachment", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSupplierFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier File Attachment 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": [ "Supplier File Attachment" ], "summary": "Delete an existing Supplier File Attachment 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 | SupplierFileAttachment->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": "DeleteSupplierFileAttachment", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSupplierFileAttachmentResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier File Attachment 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/GEN/Suppliers/{id}/FileAttachments": { "get": { "tags": [ "Supplier File Attachment" ], "summary": "Get a collection of Supplier File Attachment resources for the Supplier.", "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 | SupplierFileAttachment->Id | integer | int64 |\r\n| version | SupplierFileAttachment->Version | integer | int32 |\r\n| fileFullName | SupplierFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | SupplierFileAttachment->Content_SizeInMb | number | decimal |\r\n| isRestricted | SupplierFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | SupplierFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | SupplierFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | SupplierFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | SupplierFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | SupplierFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | SupplierFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetSupplierFileAttachmentCollectionForSupplier", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "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 Supplier File Attachment collection", "schema": { "$ref": "#/definitions/GetSupplierFileAttachmentCollectionForSupplierResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/FileAttachments": { "get": { "tags": [ "Supplier File Attachment" ], "summary": "Get a collection of Supplier File Attachment 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 | SupplierFileAttachment->Id | integer | int64 |\r\n| version | SupplierFileAttachment->Version | integer | int32 |\r\n| supplierId | SupplierFileAttachment->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierFileAttachment->Supplier_Code | string | |\r\n| fileFullName | SupplierFileAttachment->FileFullName | string | |\r\n| contentSizeInMb | SupplierFileAttachment->Content_SizeInMb | number | decimal |\r\n| fileTypeExtension | SupplierFileAttachment->FileType_Extension | string | |\r\n| isRestricted | SupplierFileAttachment->IsRestricted | boolean | |\r\n| fileCategoryId | SupplierFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | SupplierFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | SupplierFileAttachment->FileCategory_Description | string | |\r\n| permissionTreeId | SupplierFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierFileAttachment->PermissionTree_Description | string | |\r\n| createdOn | SupplierFileAttachment->CreatedOn | string | date-time |\r\n| modifiedOn | SupplierFileAttachment->ModifiedOn | string | date-time |\r\n", "operationId": "GetSupplierFileAttachmentCollection", "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 File Attachment collection", "schema": { "$ref": "#/definitions/GetSupplierFileAttachmentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/FileAttachments/Upload": { "post": { "tags": [ "Supplier File Attachment" ], "summary": "Upload and create a new Supplier File Attachment 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| supplierId | SupplierFileAttachment->Supplier_Id | integer | int64 |\r\n| isRestricted | SupplierFileAttachment->IsRestricted | boolean | |\r\n| fileName | SupplierFileAttachment->FileName | string | |\r\n| fileCategoryId | SupplierFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | SupplierFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | SupplierFileAttachment->Bytes | 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| supplierId | Required | True | |\r\n| supplierId | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateSupplierFileAttachment", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "entityPost", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateSupplierFileAttachmentResourceActionRequest" } } ], "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" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/FileAttachments/{id}/Upload": { "put": { "tags": [ "Supplier File Attachment" ], "summary": "Upload new content for an existing Supplier File Attachment 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 | SupplierFileAttachment->Version | integer | int32 |\r\n| bytes | SupplierFileAttachment->Bytes | 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| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateSupplierFileAttachmentContent", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "name": "entityFilePatch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSupplierFileAttachmentContentResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier File Attachment was successfully updated" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/FileAttachments/Batch/{ids}": { "get": { "tags": [ "Supplier File Attachment" ], "summary": "Get a collection of Supplier File Attachment 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| supplierId | SupplierFileAttachment->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierFileAttachment->Supplier_Code | string | |\r\n| supplierDescription | SupplierFileAttachment->Supplier_Description | string | |\r\n| createdByUserId | SupplierFileAttachment->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SupplierFileAttachment->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SupplierFileAttachment->CreatedByUser_FullName | string | |\r\n| createdOn | SupplierFileAttachment->CreatedOn | string | date-time |\r\n| contentId | SupplierFileAttachment->Content_Id | integer | int64 |\r\n| contentFileLocationId | SupplierFileAttachment->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | SupplierFileAttachment->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | SupplierFileAttachment->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | SupplierFileAttachment->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | SupplierFileAttachment->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | SupplierFileAttachment->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | SupplierFileAttachment->Content_SizeInMb | number | decimal |\r\n| contentVersion | SupplierFileAttachment->ContentVersion | integer | int32 |\r\n| entityType | SupplierFileAttachment->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| fileCategoryId | SupplierFileAttachment->FileCategory_Id | integer | int64 |\r\n| fileCategoryCode | SupplierFileAttachment->FileCategory_Code | string | |\r\n| fileCategoryDescription | SupplierFileAttachment->FileCategory_Description | string | |\r\n| fileCategoryAutoIsRestricted | SupplierFileAttachment->FileCategory_AutoIsRestricted | boolean | |\r\n| fileFullName | SupplierFileAttachment->FileFullName | string | |\r\n| fileName | SupplierFileAttachment->FileName | string | |\r\n| fileTypeId | SupplierFileAttachment->FileType_Id | integer | int64 |\r\n| fileTypeExtension | SupplierFileAttachment->FileType_Extension | string | |\r\n| isRestricted | SupplierFileAttachment->IsRestricted | boolean | |\r\n| id | SupplierFileAttachment->Id | integer | int64 |\r\n| isActive | SupplierFileAttachment->IsActive | boolean | |\r\n| modifiedByUserId | SupplierFileAttachment->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SupplierFileAttachment->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SupplierFileAttachment->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SupplierFileAttachment->ModifiedOn | string | date-time |\r\n| permissionTreeId | SupplierFileAttachment->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierFileAttachment->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierFileAttachment->PermissionTree_Description | string | |\r\n| version | SupplierFileAttachment->Version | integer | int32 |\r\n", "operationId": "BatchGetSupplierFileAttachment", "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 Supplier File Attachment 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 Supplier File Attachment collection", "schema": { "$ref": "#/definitions/BatchGetSupplierFileAttachmentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/FileAttachments/{id}/ContentHistory": { "get": { "tags": [ "Supplier File Attachment" ], "summary": "Get a collection of File Attachment Content History resources for the Supplier File Attachment.", "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 | FileAttachmentContentHistory->Id | integer | int64 |\r\n| version | FileAttachmentContentHistory->Version | integer | int32 |\r\n| contentId | FileAttachmentContentHistory->Content_Id | integer | int64 |\r\n| contentFileLocationId | FileAttachmentContentHistory->Content_FileLocation_Id | integer | int64 |\r\n| contentFileLocationDescription | FileAttachmentContentHistory->Content_FileLocation_Description | string | |\r\n| contentFileLocationFileLocationType | FileAttachmentContentHistory->Content_FileLocation_FileLocationType | string (Allowed values: [FileSystem, Database]) | enum |\r\n| contentFileLocationOnKeyFileStoreId | FileAttachmentContentHistory->Content_FileLocation_OnKeyFileStoreId | string | uuid |\r\n| contentSizeInBytes | FileAttachmentContentHistory->Content_SizeInBytes | integer | int64 |\r\n| contentSizeInKb | FileAttachmentContentHistory->Content_SizeInKb | number | decimal |\r\n| contentSizeInMb | FileAttachmentContentHistory->Content_SizeInMb | number | decimal |\r\n| contentVersion | FileAttachmentContentHistory->ContentVersion | integer | int32 |\r\n| createdOn | FileAttachmentContentHistory->CreatedOn | string | date-time |\r\n| fileAttachmentId | FileAttachmentContentHistory->FileAttachment_Id | integer | int64 |\r\n", "operationId": "GetSupplierFileAttachmentContentHistory", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Supplier File Attachment collection", "schema": { "$ref": "#/definitions/GetSupplierFileAttachmentContentHistoryResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/FileAttachments/Upload/Batch": { "post": { "tags": [ "Supplier File Attachment" ], "summary": "Upload and create a new collection of Supplier File Attachment 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| supplierId | SupplierFileAttachment->Supplier_Id | integer | int64 |\r\n| isRestricted | SupplierFileAttachment->IsRestricted | boolean | |\r\n| fileName | SupplierFileAttachment->FileName | string | |\r\n| fileCategoryId | SupplierFileAttachment->FileCategory_Id | integer | int64 |\r\n| permissionTreeId | SupplierFileAttachment->PermissionTree_Id | integer | int64 |\r\n| bytes | SupplierFileAttachment->Bytes | 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| supplierId | Required | True | |\r\n| supplierId | Nullable | False | |\r\n| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateSupplierFileAttachment", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "entityPostCollection", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateSupplierFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Supplier File Attachment batch was successfully created" }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/FileAttachments/Batch": { "patch": { "tags": [ "Supplier File Attachment" ], "summary": "Update a collection of existing Supplier File Attachment 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 | SupplierFileAttachment->Id | integer | int64 |\r\n| version | SupplierFileAttachment->Version | integer | int32 |\r\n| isRestricted | SupplierFileAttachment->IsRestricted | boolean | |\r\n| fileName | SupplierFileAttachment->FileName | string | |\r\n| fileCategoryId | SupplierFileAttachment->FileCategory_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| isRestricted | Nullable | False | |\r\n| fileName | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateSupplierFileAttachment", "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/BatchUpdateSupplierFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier File Attachment 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": [ "Supplier File Attachment" ], "summary": "Delete a collection of existing Supplier File Attachment 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 | SupplierFileAttachment->Id | integer | int64 |\r\n| version | SupplierFileAttachment->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": "BatchDeleteSupplierFileAttachment", "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/BatchDeleteSupplierFileAttachmentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier File Attachment 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/GEN/Suppliers/Resources/{id}": { "get": { "tags": [ "Supplier Resource" ], "summary": "Get a Supplier 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| isActive | SupplierResource->IsActive | boolean | |\r\n| createdByUserId | SupplierResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SupplierResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SupplierResource->CreatedByUser_FullName | string | |\r\n| createdOn | SupplierResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | SupplierResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SupplierResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SupplierResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SupplierResource->ModifiedOn | string | date-time |\r\n| version | SupplierResource->Version | integer | int32 |\r\n| permissionTreeId | SupplierResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierResource->PermissionTree_Description | string | |\r\n| id | SupplierResource->Id | integer | int64 |\r\n| notes | SupplierResource->Notes | string | |\r\n| resourceId | SupplierResource->Resource_Id | integer | int64 |\r\n| resourceCode | SupplierResource->Resource_Code | string | |\r\n| resourceContextId | SupplierResource->ResourceContext_Id | integer | int64 |\r\n| resourceContextCode | SupplierResource->ResourceContext_Code | string | |\r\n| resourceContextDescription | SupplierResource->ResourceContext_Description | string | |\r\n| sequenceNumber | SupplierResource->SequenceNumber | integer | int32 |\r\n| supplierId | SupplierResource->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierResource->Supplier_Code | string | |\r\n| supplierDescription | SupplierResource->Supplier_Description | string | |\r\n", "operationId": "GetSupplierResource", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Resource Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Supplier Resource", "schema": { "$ref": "#/definitions/GetSupplierResourceResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Supplier Resource" ], "summary": "Update an existing Supplier 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 | SupplierResource->Version | integer | int32 |\r\n| resourceId | SupplierResource->Resource_Id | integer | int64 |\r\n| resourceContextId | SupplierResource->ResourceContext_Id | integer | int64 |\r\n| sequenceNumber | SupplierResource->SequenceNumber | integer | int32 |\r\n| notes | SupplierResource->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| resourceId | Nullable | False | |\r\n| resourceContextId | Nullable | False | |\r\n\r\n", "operationId": "UpdateSupplierResource", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSupplierResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier 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": [ "Supplier Resource" ], "summary": "Delete an existing Supplier 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 | SupplierResource->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": "DeleteSupplierResource", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Resource Id", "format": "int64", "x-nullable": false }, { "name": "input", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSupplierResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier 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/GEN/Suppliers/Resources": { "get": { "tags": [ "Supplier Resource" ], "summary": "Get a collection of Supplier 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 | SupplierResource->Version | integer | int32 |\r\n| id | SupplierResource->Id | integer | int64 |\r\n| supplierId | SupplierResource->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierResource->Supplier_Code | string | |\r\n| supplierDescription | SupplierResource->Supplier_Description | string | |\r\n| resourceId | SupplierResource->Resource_Id | integer | int64 |\r\n| resourceCode | SupplierResource->Resource_Code | string | |\r\n| resourceContextId | SupplierResource->ResourceContext_Id | integer | int64 |\r\n| resourceContextCode | SupplierResource->ResourceContext_Code | string | |\r\n| resourceContextDescription | SupplierResource->ResourceContext_Description | string | |\r\n| notes | SupplierResource->Notes | string | |\r\n| createdOn | SupplierResource->CreatedOn | string | date-time |\r\n| modifiedOn | SupplierResource->ModifiedOn | string | date-time |\r\n", "operationId": "GetSupplierResourceCollection", "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 Resource collection", "schema": { "$ref": "#/definitions/GetSupplierResourceCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Supplier Resource" ], "summary": "Create a new Supplier 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| permissionTreeId | SupplierResource->PermissionTree_Id | integer | int64 |\r\n| supplierId | SupplierResource->Supplier_Id | integer | int64 |\r\n| resourceId | SupplierResource->Resource_Id | integer | int64 |\r\n| resourceContextId | SupplierResource->ResourceContext_Id | integer | int64 |\r\n| sequenceNumber | SupplierResource->SequenceNumber | integer | int32 |\r\n| notes | SupplierResource->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| supplierId | Required | True | |\r\n| supplierId | Nullable | False | |\r\n| resourceId | Required | True | |\r\n| resourceId | Nullable | False | |\r\n| resourceContextId | Required | True | |\r\n| resourceContextId | Nullable | False | |\r\n\r\n", "operationId": "CreateSupplierResource", "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/CreateSupplierResourceResourceActionRequest" } }, { "$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/GEN/Suppliers/{supplierId}/Resources": { "get": { "tags": [ "Supplier Resource" ], "summary": "Get a collection of Supplier Resource resources for the Supplier 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 | SupplierResource->Id | integer | int64 |\r\n| version | SupplierResource->Version | integer | int32 |\r\n| resourceId | SupplierResource->Resource_Id | integer | int64 |\r\n| resourceCode | SupplierResource->Resource_Code | string | |\r\n| permissionTreeId | SupplierResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierResource->PermissionTree_Description | string | |\r\n| resourceContextId | SupplierResource->ResourceContext_Id | integer | int64 |\r\n| resourceContextCode | SupplierResource->ResourceContext_Code | string | |\r\n| resourceContextDescription | SupplierResource->ResourceContext_Description | string | |\r\n", "operationId": "GetSupplierResourceForSupplierCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "supplierId", "in": "path", "required": true, "description": "Supplier 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 Supplier Resource collection", "schema": { "$ref": "#/definitions/GetSupplierResourceForSupplierCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Resources/Lookups/LookupSupplierResourceChangePermissionTree": { "get": { "tags": [ "Supplier Resource" ], "summary": "Lookup the permission set for changing the Supplier 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 | 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": "LookupSupplierResourceChangePermissionTree", "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/SupplierResourceChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Resources/Lookups/LookupSupplierResourceInsertPermissionTree": { "get": { "tags": [ "Supplier Resource" ], "summary": "Lookup the permission set for creating the Supplier 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 | 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": "LookupSupplierResourceInsertPermissionTree", "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/SupplierResourceInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Resources/Lookups/LookupSupplierResourceResourceContext": { "get": { "tags": [ "Supplier Resource" ], "summary": "Lookup the for the Supplier 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 | ResourceContext->Id | integer | int64 |\r\n| code | ResourceContext->Code | string | |\r\n| description | ResourceContext->Description | string | |\r\n", "operationId": "LookupSupplierResourceResourceContext", "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 Context collection", "schema": { "$ref": "#/definitions/SupplierResourceResourceContextLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Resources/Lookups/LookupSupplierResourceResource": { "get": { "tags": [ "Supplier Resource" ], "summary": "Supplier 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 | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| description | Resource->Description | string | |\r\n| contactDetailFirstName | Resource->ContactDetailFirstName | string | |\r\n| contactDetailLastName | Resource->ContactDetailLastName | string | |\r\n", "operationId": "LookupSupplierResourceResource", "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/SupplierResourceResourceLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Resources/Lookups/LookupSupplierResourceSupplier": { "get": { "tags": [ "Supplier Resource" ], "summary": "Lookup the Supplier for the Supplier 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 | Supplier->Id | integer | int64 |\r\n| code | Supplier->Code | string | |\r\n| description | Supplier->Description | string | |\r\n", "operationId": "LookupSupplierResourceSupplier", "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/SupplierResourceSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Resources/Batch/{ids}": { "get": { "tags": [ "Supplier Resource" ], "summary": "Get a collection of Supplier 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| isActive | SupplierResource->IsActive | boolean | |\r\n| createdByUserId | SupplierResource->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SupplierResource->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SupplierResource->CreatedByUser_FullName | string | |\r\n| createdOn | SupplierResource->CreatedOn | string | date-time |\r\n| modifiedByUserId | SupplierResource->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SupplierResource->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SupplierResource->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SupplierResource->ModifiedOn | string | date-time |\r\n| version | SupplierResource->Version | integer | int32 |\r\n| permissionTreeId | SupplierResource->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierResource->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierResource->PermissionTree_Description | string | |\r\n| id | SupplierResource->Id | integer | int64 |\r\n| notes | SupplierResource->Notes | string | |\r\n| resourceId | SupplierResource->Resource_Id | integer | int64 |\r\n| resourceCode | SupplierResource->Resource_Code | string | |\r\n| resourceContextId | SupplierResource->ResourceContext_Id | integer | int64 |\r\n| resourceContextCode | SupplierResource->ResourceContext_Code | string | |\r\n| resourceContextDescription | SupplierResource->ResourceContext_Description | string | |\r\n| sequenceNumber | SupplierResource->SequenceNumber | integer | int32 |\r\n| supplierId | SupplierResource->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierResource->Supplier_Code | string | |\r\n| supplierDescription | SupplierResource->Supplier_Description | string | |\r\n", "operationId": "BatchGetSupplierResource", "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 Supplier 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 Supplier Resource collection", "schema": { "$ref": "#/definitions/BatchGetSupplierResourceResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/Resources/Batch": { "post": { "tags": [ "Supplier Resource" ], "summary": "Create a new collection of Supplier 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| permissionTreeId | SupplierResource->PermissionTree_Id | integer | int64 |\r\n| resourceId | SupplierResource->Resource_Id | integer | int64 |\r\n| resourceContextId | SupplierResource->ResourceContext_Id | integer | int64 |\r\n| supplierId | SupplierResource->Supplier_Id | integer | int64 |\r\n| sequenceNumber | SupplierResource->SequenceNumber | integer | int32 |\r\n| notes | SupplierResource->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| resourceId | Required | True | |\r\n| resourceId | Nullable | False | |\r\n| resourceContextId | Required | True | |\r\n| resourceContextId | Nullable | False | |\r\n| supplierId | Required | True | |\r\n| supplierId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateSupplierResource", "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/BatchCreateSupplierResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Supplier 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": [ "Supplier Resource" ], "summary": "Update a collection of existing Supplier 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 | SupplierResource->Id | integer | int64 |\r\n| version | SupplierResource->Version | integer | int32 |\r\n| supplierId | SupplierResource->Supplier_Id | integer | int64 |\r\n| resourceId | SupplierResource->Resource_Id | integer | int64 |\r\n| resourceContextId | SupplierResource->ResourceContext_Id | integer | int64 |\r\n| sequenceNumber | SupplierResource->SequenceNumber | integer | int32 |\r\n| notes | SupplierResource->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| supplierId | Nullable | False | |\r\n| resourceId | Nullable | False | |\r\n| resourceContextId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateSupplierResource", "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/BatchUpdateSupplierResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier 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": [ "Supplier Resource" ], "summary": "Delete a collection of existing Supplier 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 | SupplierResource->Id | integer | int64 |\r\n| version | SupplierResource->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": "BatchDeleteSupplierResource", "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/BatchDeleteSupplierResourceResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier 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/GEN/Suppliers/Resources/{id}/Active": { "patch": { "tags": [ "Supplier Resource" ], "summary": "Change the IsActive status for an existing Supplier 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 | SupplierResource->Version | integer | int32 |\r\n| isActive | SupplierResource->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": "ChangeSupplierResourceIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSupplierResourceIsActiveResourceActionRequest" } }, { "$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/GEN/Suppliers/Resources/{id}/PermissionTree": { "patch": { "tags": [ "Supplier Resource" ], "summary": "Change the PermissionTree for an existing Supplier 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 | SupplierResource->Version | integer | int32 |\r\n| permissionTreeId | SupplierResource->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": "ChangeSupplierResourcePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Resource Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSupplierResourcePermissionTreeResourceActionRequest" } }, { "$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/GEN/Suppliers/Resources/Batch/Active": { "patch": { "tags": [ "Supplier Resource" ], "summary": "Change the IsActive status for a collection of existing Supplier 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 | SupplierResource->Id | integer | int64 |\r\n| version | SupplierResource->Version | integer | int32 |\r\n| isActive | SupplierResource->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": "BatchChangeSupplierResourceIsActive", "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/BatchChangeSupplierResourceIsActiveResourceActionRequest" } }, { "$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/GEN/Suppliers/Resources/Batch/PermissionTree": { "patch": { "tags": [ "Supplier Resource" ], "summary": "Change the PermissionTree status for a collection of existing Supplier 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 | SupplierResource->Id | integer | int64 |\r\n| version | SupplierResource->Version | integer | int32 |\r\n| permissionTreeId | SupplierResource->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": "BatchChangeSupplierResourcePermissionTree", "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/BatchChangeSupplierResourcePermissionTreeResourceActionRequest" } }, { "$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/GEN/Suppliers/TaxRates/{id}": { "get": { "tags": [ "Supplier Tax Rate" ], "summary": "Get a Supplier Tax Rate 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 | SupplierTaxRate->IsActive | boolean | |\r\n| createdByUserId | SupplierTaxRate->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SupplierTaxRate->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SupplierTaxRate->CreatedByUser_FullName | string | |\r\n| createdOn | SupplierTaxRate->CreatedOn | string | date-time |\r\n| modifiedByUserId | SupplierTaxRate->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SupplierTaxRate->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SupplierTaxRate->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SupplierTaxRate->ModifiedOn | string | date-time |\r\n| version | SupplierTaxRate->Version | integer | int32 |\r\n| permissionTreeId | SupplierTaxRate->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierTaxRate->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierTaxRate->PermissionTree_Description | string | |\r\n| id | SupplierTaxRate->Id | integer | int64 |\r\n| applicableFrom | SupplierTaxRate->ApplicableFrom | string | date-time |\r\n| applicableTo | SupplierTaxRate->ApplicableTo | string | date-time |\r\n| buyingSiteId | SupplierTaxRate->BuyingSite_Id | integer | int64 |\r\n| buyingSiteCode | SupplierTaxRate->BuyingSite_Code | string | |\r\n| buyingSiteDescription | SupplierTaxRate->BuyingSite_Description | string | |\r\n| notes | SupplierTaxRate->Notes | string | |\r\n| sequenceNumber | SupplierTaxRate->SequenceNumber | integer | int32 |\r\n| supplierId | SupplierTaxRate->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierTaxRate->Supplier_Code | string | |\r\n| supplierDescription | SupplierTaxRate->Supplier_Description | string | |\r\n| taxRate | SupplierTaxRate->TaxRate | number | decimal |\r\n", "operationId": "GetSupplierTaxRate", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Tax Rate Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Supplier Tax Rate", "schema": { "$ref": "#/definitions/GetSupplierTaxRateResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Supplier Tax Rate" ], "summary": "Update an existing Supplier Tax Rate 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 | SupplierTaxRate->Version | integer | int32 |\r\n| applicableFrom | SupplierTaxRate->ApplicableFrom | string | date-time |\r\n| applicableTo | SupplierTaxRate->ApplicableTo | string | date-time |\r\n| buyingSiteId | SupplierTaxRate->BuyingSite_Id | integer | int64 |\r\n| notes | SupplierTaxRate->Notes | string | |\r\n| sequenceNumber | SupplierTaxRate->SequenceNumber | integer | int32 |\r\n| taxRate | SupplierTaxRate->TaxRate | number | decimal |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| buyingSiteId | Nullable | False | |\r\n| taxRate | Nullable | False | |\r\n| taxRate | Min Value | >= 0| |\r\n| taxRate | Max Value | <= 100| |\r\n\r\n", "operationId": "UpdateSupplierTaxRate", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Tax Rate Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateSupplierTaxRateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier Tax Rate 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": [ "Supplier Tax Rate" ], "summary": "Delete an existing Supplier Tax Rate 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 | SupplierTaxRate->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": "DeleteSupplierTaxRate", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Tax Rate Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteSupplierTaxRateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier Tax Rate 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/GEN/Suppliers/TaxRates": { "get": { "tags": [ "Supplier Tax Rate" ], "summary": "Get a collection of Supplier Tax Rate 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 | SupplierTaxRate->Id | integer | int64 |\r\n| version | SupplierTaxRate->Version | integer | int32 |\r\n| supplierId | SupplierTaxRate->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierTaxRate->Supplier_Code | string | |\r\n| supplierDescription | SupplierTaxRate->Supplier_Description | string | |\r\n| buyingSiteCode | SupplierTaxRate->BuyingSite_Code | string | |\r\n| taxRate | SupplierTaxRate->TaxRate | number | decimal |\r\n", "operationId": "GetSupplierTaxRateCollection", "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 Tax Rate collection", "schema": { "$ref": "#/definitions/GetSupplierTaxRateCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Supplier Tax Rate" ], "summary": "Create a new Supplier Tax Rate 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| applicableFrom | SupplierTaxRate->ApplicableFrom | string | date-time |\r\n| applicableTo | SupplierTaxRate->ApplicableTo | string | date-time |\r\n| buyingSiteId | SupplierTaxRate->BuyingSite_Id | integer | int64 |\r\n| notes | SupplierTaxRate->Notes | string | |\r\n| permissionTreeId | SupplierTaxRate->PermissionTree_Id | integer | int64 |\r\n| supplierId | SupplierTaxRate->Supplier_Id | integer | int64 |\r\n| sequenceNumber | SupplierTaxRate->SequenceNumber | integer | int32 |\r\n| taxRate | SupplierTaxRate->TaxRate | number | decimal |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| buyingSiteId | Required | True | |\r\n| buyingSiteId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| supplierId | Required | True | |\r\n| supplierId | Nullable | False | |\r\n| taxRate | Required | True | |\r\n| taxRate | Nullable | False | |\r\n| taxRate | Min Value | >= 0| |\r\n| taxRate | Max Value | <= 100| |\r\n\r\n", "operationId": "CreateSupplierTaxRate", "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/CreateSupplierTaxRateResourceActionRequest" } }, { "$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/GEN/Suppliers/{id}/TaxRates": { "get": { "tags": [ "Supplier Tax Rate" ], "summary": "Get a collection of Supplier Tax Rate resources for the Supplier.", "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 | SupplierTaxRate->Id | integer | int64 |\r\n| version | SupplierTaxRate->Version | integer | int32 |\r\n| buyingSiteId | SupplierTaxRate->BuyingSite_Id | integer | int64 |\r\n| buyingSiteCode | SupplierTaxRate->BuyingSite_Code | string | |\r\n| taxRate | SupplierTaxRate->TaxRate | number | decimal |\r\n", "operationId": "GetSupplierTaxRateForSupplierCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier 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 Supplier Tax Rate collection", "schema": { "$ref": "#/definitions/GetTaxRateForSupplierCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/TaxRates/Lookups/LookupSupplierTaxRateBuyingSite": { "get": { "tags": [ "Supplier Tax Rate" ], "summary": "Lookup the Site for the Supplier Tax Rate.", "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": "LookupSupplierTaxRateBuyingSite", "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/SupplierTaxRateBuyingSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/TaxRates/Lookups/LookupSupplierTaxRateChangePermissionTree": { "get": { "tags": [ "Supplier Tax Rate" ], "summary": "Lookup the permission set for changing the Supplier Tax Rate.", "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": "LookupSupplierTaxRateChangePermissionTree", "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/SupplierTaxRateChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/TaxRates/Lookups/LookupSupplierTaxRateInsertPermissionTree": { "get": { "tags": [ "Supplier Tax Rate" ], "summary": "Lookup the permission set for creating the Supplier Tax Rate.", "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": "LookupSupplierTaxRateInsertPermissionTree", "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/SupplierTaxRateInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/TaxRates/Lookups/LookupSupplierTaxRateSupplier": { "get": { "tags": [ "Supplier Tax Rate" ], "summary": "Lookup the Supplier for the Supplier Tax Rate.", "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": "LookupSupplierTaxRateSupplier", "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/SupplierTaxRateSupplierLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/TaxRates/Batch/{ids}": { "get": { "tags": [ "Supplier Tax Rate" ], "summary": "Get a collection of Supplier Tax Rate 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 | SupplierTaxRate->IsActive | boolean | |\r\n| createdByUserId | SupplierTaxRate->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | SupplierTaxRate->CreatedByUser_Code | string | |\r\n| createdByUserFullName | SupplierTaxRate->CreatedByUser_FullName | string | |\r\n| createdOn | SupplierTaxRate->CreatedOn | string | date-time |\r\n| modifiedByUserId | SupplierTaxRate->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | SupplierTaxRate->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | SupplierTaxRate->ModifiedByUser_FullName | string | |\r\n| modifiedOn | SupplierTaxRate->ModifiedOn | string | date-time |\r\n| version | SupplierTaxRate->Version | integer | int32 |\r\n| permissionTreeId | SupplierTaxRate->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | SupplierTaxRate->PermissionTree_Code | string | |\r\n| permissionTreeDescription | SupplierTaxRate->PermissionTree_Description | string | |\r\n| id | SupplierTaxRate->Id | integer | int64 |\r\n| applicableFrom | SupplierTaxRate->ApplicableFrom | string | date-time |\r\n| applicableTo | SupplierTaxRate->ApplicableTo | string | date-time |\r\n| buyingSiteId | SupplierTaxRate->BuyingSite_Id | integer | int64 |\r\n| buyingSiteCode | SupplierTaxRate->BuyingSite_Code | string | |\r\n| buyingSiteDescription | SupplierTaxRate->BuyingSite_Description | string | |\r\n| notes | SupplierTaxRate->Notes | string | |\r\n| sequenceNumber | SupplierTaxRate->SequenceNumber | integer | int32 |\r\n| supplierId | SupplierTaxRate->Supplier_Id | integer | int64 |\r\n| supplierCode | SupplierTaxRate->Supplier_Code | string | |\r\n| supplierDescription | SupplierTaxRate->Supplier_Description | string | |\r\n| taxRate | SupplierTaxRate->TaxRate | number | decimal |\r\n", "operationId": "BatchGetSupplierTaxRate", "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 Supplier Tax Rate 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 Supplier Tax Rate collection", "schema": { "$ref": "#/definitions/BatchGetSupplierTaxRateResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/Suppliers/TaxRates/Batch": { "post": { "tags": [ "Supplier Tax Rate" ], "summary": "Create a new collection of Supplier Tax Rate 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| applicableFrom | SupplierTaxRate->ApplicableFrom | string | date-time |\r\n| applicableTo | SupplierTaxRate->ApplicableTo | string | date-time |\r\n| buyingSiteId | SupplierTaxRate->BuyingSite_Id | integer | int64 |\r\n| notes | SupplierTaxRate->Notes | string | |\r\n| permissionTreeId | SupplierTaxRate->PermissionTree_Id | integer | int64 |\r\n| supplierId | SupplierTaxRate->Supplier_Id | integer | int64 |\r\n| sequenceNumber | SupplierTaxRate->SequenceNumber | integer | int32 |\r\n| taxRate | SupplierTaxRate->TaxRate | number | decimal |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| buyingSiteId | Required | True | |\r\n| buyingSiteId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| supplierId | Required | True | |\r\n| supplierId | Nullable | False | |\r\n| taxRate | Required | True | |\r\n| taxRate | Nullable | False | |\r\n| taxRate | Min Value | >= 0| |\r\n| taxRate | Max Value | <= 100| |\r\n\r\n", "operationId": "BatchCreateSupplierTaxRate", "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/BatchCreateSupplierTaxRateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Supplier Tax Rate 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": [ "Supplier Tax Rate" ], "summary": "Update a collection of existing Supplier Tax Rate 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 | SupplierTaxRate->Id | integer | int64 |\r\n| version | SupplierTaxRate->Version | integer | int32 |\r\n| applicableFrom | SupplierTaxRate->ApplicableFrom | string | date-time |\r\n| applicableTo | SupplierTaxRate->ApplicableTo | string | date-time |\r\n| buyingSiteId | SupplierTaxRate->BuyingSite_Id | integer | int64 |\r\n| notes | SupplierTaxRate->Notes | string | |\r\n| sequenceNumber | SupplierTaxRate->SequenceNumber | integer | int32 |\r\n| taxRate | SupplierTaxRate->TaxRate | number | decimal |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| buyingSiteId | Nullable | False | |\r\n| taxRate | Nullable | False | |\r\n| taxRate | Min Value | >= 0| |\r\n| taxRate | Max Value | <= 100| |\r\n\r\n", "operationId": "BatchUpdateSupplierTaxRate", "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/BatchUpdateSupplierTaxRateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier Tax Rate 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": [ "Supplier Tax Rate" ], "summary": "Delete a collection of existing Supplier Tax Rate 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 | SupplierTaxRate->Id | integer | int64 |\r\n| version | SupplierTaxRate->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": "BatchDeleteSupplierTaxRate", "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/BatchDeleteSupplierTaxRateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Supplier Tax Rate 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/GEN/Suppliers/TaxRates/{id}/Active": { "patch": { "tags": [ "Supplier Tax Rate" ], "summary": "Change the IsActive status for an existing Supplier Tax Rate 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 | SupplierTaxRate->Version | integer | int32 |\r\n| isActive | SupplierTaxRate->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": "ChangeSupplierTaxRateIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Tax Rate Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSupplierTaxRateIsActiveResourceActionRequest" } }, { "$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/GEN/Suppliers/TaxRates/{id}/PermissionTree": { "patch": { "tags": [ "Supplier Tax Rate" ], "summary": "Change the PermissionTree for an existing Supplier Tax Rate 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 | SupplierTaxRate->Version | integer | int32 |\r\n| permissionTreeId | SupplierTaxRate->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": "ChangeSupplierTaxRatePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Supplier Tax Rate Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeSupplierTaxRatePermissionTreeResourceActionRequest" } }, { "$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/GEN/Suppliers/TaxRates/Batch/Active": { "patch": { "tags": [ "Supplier Tax Rate" ], "summary": "Change the IsActive status for a collection of existing Supplier Tax Rate 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 | SupplierTaxRate->Id | integer | int64 |\r\n| version | SupplierTaxRate->Version | integer | int32 |\r\n| isActive | SupplierTaxRate->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": "BatchChangeSupplierTaxRateIsActive", "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/BatchChangeSupplierTaxRateIsActiveResourceActionRequest" } }, { "$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/GEN/Suppliers/TaxRates/Batch/PermissionTree": { "patch": { "tags": [ "Supplier Tax Rate" ], "summary": "Change the PermissionTree status for a collection of existing Supplier Tax Rate 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 | SupplierTaxRate->Id | integer | int64 |\r\n| version | SupplierTaxRate->Version | integer | int32 |\r\n| permissionTreeId | SupplierTaxRate->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": "BatchChangeSupplierTaxRatePermissionTree", "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/BatchChangeSupplierTaxRatePermissionTreeResourceActionRequest" } }, { "$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/GEN/UnitsOfMeasurement/{id}": { "get": { "tags": [ "Unit Of Measurement" ], "summary": "Get a Unit Of Measurement 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 | UnitOfMeasurement->Code | string | |\r\n| isActive | UnitOfMeasurement->IsActive | boolean | |\r\n| createdByUserId | UnitOfMeasurement->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UnitOfMeasurement->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UnitOfMeasurement->CreatedByUser_FullName | string | |\r\n| createdOn | UnitOfMeasurement->CreatedOn | string | date-time |\r\n| modifiedByUserId | UnitOfMeasurement->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UnitOfMeasurement->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UnitOfMeasurement->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UnitOfMeasurement->ModifiedOn | string | date-time |\r\n| version | UnitOfMeasurement->Version | integer | int32 |\r\n| permissionTreeId | UnitOfMeasurement->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UnitOfMeasurement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UnitOfMeasurement->PermissionTree_Description | string | |\r\n| id | UnitOfMeasurement->Id | integer | int64 |\r\n| basedOnUnitId | UnitOfMeasurement->BasedOnUnit_Id | integer | int64 |\r\n| basedOnUnitCode | UnitOfMeasurement->BasedOnUnit_Code | string | |\r\n| basedOnUnitDescription | UnitOfMeasurement->BasedOnUnit_Description | string | |\r\n| convertFactor | UnitOfMeasurement->ConvertFactor | number | decimal |\r\n| description | UnitOfMeasurement->Description | string | |\r\n| isBaseUnit | UnitOfMeasurement->IsBaseUnit | boolean | |\r\n| measurementType | UnitOfMeasurement->MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| measurementTypeQuantity | UnitOfMeasurement->MeasurementTypeQuantity | integer | int32 |\r\n| notes | UnitOfMeasurement->Notes | string | |\r\n| sequenceNumber | UnitOfMeasurement->SequenceNumber | integer | int32 |\r\n", "operationId": "GetUnitOfMeasurement", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Unit Of Measurement Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Unit Of Measurement", "schema": { "$ref": "#/definitions/GetUnitOfMeasurementResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Unit Of Measurement" ], "summary": "Update an existing Unit Of Measurement 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 | UnitOfMeasurement->Version | integer | int32 |\r\n| code | UnitOfMeasurement->Code | string | |\r\n| description | UnitOfMeasurement->Description | string | |\r\n| sequenceNumber | UnitOfMeasurement->SequenceNumber | integer | int32 |\r\n| notes | UnitOfMeasurement->Notes | string | |\r\n| isBaseUnit | UnitOfMeasurement->IsBaseUnit | boolean | |\r\n| basedOnUnitId | UnitOfMeasurement->BasedOnUnit_Id | integer | int64 |\r\n| measurementType | UnitOfMeasurement->MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| measurementTypeQuantity | UnitOfMeasurement->MeasurementTypeQuantity | integer | int32 |\r\n| convertFactor | UnitOfMeasurement->ConvertFactor | number | decimal |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| isBaseUnit | Nullable | False | |\r\n| basedOnUnitId | Nullable | True | UnitOfMeasurement->IsBaseUnit ne NULL and UnitOfMeasurement->IsBaseUnit eq TRUE |\r\n| basedOnUnitId | Nullable | False | UnitOfMeasurement->IsBaseUnit eq NULL or UnitOfMeasurement->IsBaseUnit eq FALSE |\r\n| measurementType | Nullable | False | |\r\n| measurementTypeQuantity | Nullable | True | UnitOfMeasurement->MeasurementType ne 'Duration' |\r\n| measurementTypeQuantity | Nullable | False | UnitOfMeasurement->MeasurementType eq 'Duration' |\r\n| measurementTypeQuantity | Min Value | >= 0| |\r\n| convertFactor | Nullable | True | UnitOfMeasurement->IsBaseUnit ne NULL and UnitOfMeasurement->IsBaseUnit eq TRUE |\r\n| convertFactor | Min Value | >= 0| |\r\n\r\n", "operationId": "UpdateUnitOfMeasurement", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Unit Of Measurement Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateUnitOfMeasurementResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Unit Of Measurement 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": [ "Unit Of Measurement" ], "summary": "Delete an existing Unit Of Measurement 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 | UnitOfMeasurement->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": "DeleteUnitOfMeasurement", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Unit Of Measurement Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteUnitOfMeasurementResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Unit Of Measurement 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/GEN/UnitsOfMeasurement": { "get": { "tags": [ "Unit Of Measurement" ], "summary": "Get a collection of Unit Of Measurement 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 | UnitOfMeasurement->Version | integer | int32 |\r\n| id | UnitOfMeasurement->Id | integer | int64 |\r\n| code | UnitOfMeasurement->Code | string | |\r\n| description | UnitOfMeasurement->Description | string | |\r\n| sequenceNumber | UnitOfMeasurement->SequenceNumber | integer | int32 |\r\n| isActive | UnitOfMeasurement->IsActive | boolean | |\r\n| isBaseUnit | UnitOfMeasurement->IsBaseUnit | boolean | |\r\n| basedOnUnitId | UnitOfMeasurement->BasedOnUnit_Id | integer | int64 |\r\n| basedOnUnitCode | UnitOfMeasurement->BasedOnUnit_Code | string | |\r\n| basedOnUnitDescription | UnitOfMeasurement->BasedOnUnit_Description | string | |\r\n| convertFactor | UnitOfMeasurement->ConvertFactor | number | decimal |\r\n| measurementType | UnitOfMeasurement->MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| measurementTypeQuantity | UnitOfMeasurement->MeasurementTypeQuantity | integer | int32 |\r\n", "operationId": "GetUnitOfMeasurementCollection", "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 Unit Of Measurement collection", "schema": { "$ref": "#/definitions/GetUnitOfMeasurementCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Unit Of Measurement" ], "summary": "Create a new Unit Of Measurement 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 | UnitOfMeasurement->PermissionTree_Id | integer | int64 |\r\n| code | UnitOfMeasurement->Code | string | |\r\n| description | UnitOfMeasurement->Description | string | |\r\n| sequenceNumber | UnitOfMeasurement->SequenceNumber | integer | int32 |\r\n| isBaseUnit | UnitOfMeasurement->IsBaseUnit | boolean | |\r\n| basedOnUnitId | UnitOfMeasurement->BasedOnUnit_Id | integer | int64 |\r\n| convertFactor | UnitOfMeasurement->ConvertFactor | number | decimal |\r\n| measurementType | UnitOfMeasurement->MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| measurementTypeQuantity | UnitOfMeasurement->MeasurementTypeQuantity | integer | int32 |\r\n| notes | UnitOfMeasurement->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| isBaseUnit | Required | True | |\r\n| isBaseUnit | Nullable | False | |\r\n| basedOnUnitId | Nullable | True | UnitOfMeasurement->IsBaseUnit ne NULL and UnitOfMeasurement->IsBaseUnit eq TRUE |\r\n| basedOnUnitId | Nullable | False | UnitOfMeasurement->IsBaseUnit eq NULL or UnitOfMeasurement->IsBaseUnit eq FALSE |\r\n| convertFactor | Nullable | True | UnitOfMeasurement->IsBaseUnit ne NULL and UnitOfMeasurement->IsBaseUnit eq TRUE |\r\n| convertFactor | Min Value | >= 0| |\r\n| measurementType | Nullable | False | |\r\n| measurementTypeQuantity | Nullable | True | UnitOfMeasurement->MeasurementType ne 'Duration' |\r\n| measurementTypeQuantity | Nullable | False | UnitOfMeasurement->MeasurementType eq 'Duration' |\r\n| measurementTypeQuantity | Min Value | >= 0| |\r\n\r\n", "operationId": "CreateUnitOfMeasurement", "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/CreateUnitOfMeasurementResourceActionRequest" } }, { "$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/GEN/UnitsOfMeasurement/Lookups/LookupUnitOfMeasurementBasedOnUnit": { "get": { "tags": [ "Unit Of Measurement" ], "summary": "Lookup the Unit of Measurement base Unit.", "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 | UnitOfMeasurement->Id | integer | int64 |\r\n| code | UnitOfMeasurement->Code | string | |\r\n| description | UnitOfMeasurement->Description | string | |\r\n", "operationId": "LookupUnitOfMeasurementBasedOnUnit", "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 Unit Of Measurement collection", "schema": { "$ref": "#/definitions/UnitOfMeasurementBasedOnUnitLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/UnitsOfMeasurement/Lookups/LookupUnitOfMeasurementChangePermissionTree": { "get": { "tags": [ "Unit Of Measurement" ], "summary": "Lookup the permission set for changing the Unit Of Measurement.", "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": "LookupUnitOfMeasurementChangePermissionTree", "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/UnitOfMeasurementChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/UnitsOfMeasurement/Lookups/LookupUnitOfMeasurementInsertPermissionTree": { "get": { "tags": [ "Unit Of Measurement" ], "summary": "Lookup the permission set for creating the Unit Of Measurement.", "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": "LookupUnitOfMeasurementInsertPermissionTree", "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/UnitOfMeasurementInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/UnitsOfMeasurement/Batch/{ids}": { "get": { "tags": [ "Unit Of Measurement" ], "summary": "Get a collection of Unit Of Measurement 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 | UnitOfMeasurement->Code | string | |\r\n| isActive | UnitOfMeasurement->IsActive | boolean | |\r\n| createdByUserId | UnitOfMeasurement->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UnitOfMeasurement->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UnitOfMeasurement->CreatedByUser_FullName | string | |\r\n| createdOn | UnitOfMeasurement->CreatedOn | string | date-time |\r\n| modifiedByUserId | UnitOfMeasurement->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UnitOfMeasurement->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UnitOfMeasurement->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UnitOfMeasurement->ModifiedOn | string | date-time |\r\n| version | UnitOfMeasurement->Version | integer | int32 |\r\n| permissionTreeId | UnitOfMeasurement->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UnitOfMeasurement->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UnitOfMeasurement->PermissionTree_Description | string | |\r\n| id | UnitOfMeasurement->Id | integer | int64 |\r\n| basedOnUnitId | UnitOfMeasurement->BasedOnUnit_Id | integer | int64 |\r\n| basedOnUnitCode | UnitOfMeasurement->BasedOnUnit_Code | string | |\r\n| basedOnUnitDescription | UnitOfMeasurement->BasedOnUnit_Description | string | |\r\n| convertFactor | UnitOfMeasurement->ConvertFactor | number | decimal |\r\n| description | UnitOfMeasurement->Description | string | |\r\n| isBaseUnit | UnitOfMeasurement->IsBaseUnit | boolean | |\r\n| measurementType | UnitOfMeasurement->MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| measurementTypeQuantity | UnitOfMeasurement->MeasurementTypeQuantity | integer | int32 |\r\n| notes | UnitOfMeasurement->Notes | string | |\r\n| sequenceNumber | UnitOfMeasurement->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetUnitOfMeasurement", "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 Unit Of Measurement 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 Unit Of Measurement collection", "schema": { "$ref": "#/definitions/BatchGetUnitOfMeasurementResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/UnitsOfMeasurement/Batch": { "post": { "tags": [ "Unit Of Measurement" ], "summary": "Create a new collection of Unit Of Measurement 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 | UnitOfMeasurement->PermissionTree_Id | integer | int64 |\r\n| code | UnitOfMeasurement->Code | string | |\r\n| description | UnitOfMeasurement->Description | string | |\r\n| sequenceNumber | UnitOfMeasurement->SequenceNumber | integer | int32 |\r\n| isBaseUnit | UnitOfMeasurement->IsBaseUnit | boolean | |\r\n| basedOnUnitId | UnitOfMeasurement->BasedOnUnit_Id | integer | int64 |\r\n| convertFactor | UnitOfMeasurement->ConvertFactor | number | decimal |\r\n| measurementType | UnitOfMeasurement->MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| measurementTypeQuantity | UnitOfMeasurement->MeasurementTypeQuantity | integer | int32 |\r\n| notes | UnitOfMeasurement->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| isBaseUnit | Required | True | |\r\n| isBaseUnit | Nullable | False | |\r\n| basedOnUnitId | Nullable | True | UnitOfMeasurement->IsBaseUnit ne NULL and UnitOfMeasurement->IsBaseUnit eq TRUE |\r\n| basedOnUnitId | Nullable | False | UnitOfMeasurement->IsBaseUnit eq NULL or UnitOfMeasurement->IsBaseUnit eq FALSE |\r\n| convertFactor | Nullable | True | UnitOfMeasurement->IsBaseUnit ne NULL and UnitOfMeasurement->IsBaseUnit eq TRUE |\r\n| convertFactor | Min Value | >= 0| |\r\n| measurementType | Nullable | False | |\r\n| measurementTypeQuantity | Nullable | True | UnitOfMeasurement->MeasurementType ne 'Duration' |\r\n| measurementTypeQuantity | Nullable | False | UnitOfMeasurement->MeasurementType eq 'Duration' |\r\n| measurementTypeQuantity | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchCreateUnitOfMeasurement", "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/BatchCreateUnitOfMeasurementResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Unit Of Measurement 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": [ "Unit Of Measurement" ], "summary": "Update a collection of existing Unit Of Measurement 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 | UnitOfMeasurement->Id | integer | int64 |\r\n| version | UnitOfMeasurement->Version | integer | int32 |\r\n| code | UnitOfMeasurement->Code | string | |\r\n| description | UnitOfMeasurement->Description | string | |\r\n| sequenceNumber | UnitOfMeasurement->SequenceNumber | integer | int32 |\r\n| notes | UnitOfMeasurement->Notes | string | |\r\n| isBaseUnit | UnitOfMeasurement->IsBaseUnit | boolean | |\r\n| basedOnUnitId | UnitOfMeasurement->BasedOnUnit_Id | integer | int64 |\r\n| measurementType | UnitOfMeasurement->MeasurementType | string (Allowed values: [None, Duration]) | enum |\r\n| measurementTypeQuantity | UnitOfMeasurement->MeasurementTypeQuantity | integer | int32 |\r\n| convertFactor | UnitOfMeasurement->ConvertFactor | number | decimal |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| isBaseUnit | Nullable | False | |\r\n| basedOnUnitId | Nullable | True | UnitOfMeasurement->IsBaseUnit ne NULL and UnitOfMeasurement->IsBaseUnit eq TRUE |\r\n| basedOnUnitId | Nullable | False | UnitOfMeasurement->IsBaseUnit eq NULL or UnitOfMeasurement->IsBaseUnit eq FALSE |\r\n| measurementType | Nullable | False | |\r\n| measurementTypeQuantity | Nullable | True | UnitOfMeasurement->MeasurementType ne 'Duration' |\r\n| measurementTypeQuantity | Nullable | False | UnitOfMeasurement->MeasurementType eq 'Duration' |\r\n| measurementTypeQuantity | Min Value | >= 0| |\r\n| convertFactor | Nullable | True | UnitOfMeasurement->IsBaseUnit ne NULL and UnitOfMeasurement->IsBaseUnit eq TRUE |\r\n| convertFactor | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchUpdateUnitOfMeasurement", "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/BatchUpdateUnitOfMeasurementResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Unit Of Measurement 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": [ "Unit Of Measurement" ], "summary": "Delete a collection of existing Unit Of Measurement 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 | UnitOfMeasurement->Id | integer | int64 |\r\n| version | UnitOfMeasurement->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": "BatchDeleteUnitOfMeasurement", "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/BatchDeleteUnitOfMeasurementResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Unit Of Measurement 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/GEN/UnitsOfMeasurement/{id}/Active": { "patch": { "tags": [ "Unit Of Measurement" ], "summary": "Change the IsActive status for an existing Unit Of Measurement 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 | UnitOfMeasurement->Version | integer | int32 |\r\n| isActive | UnitOfMeasurement->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": "ChangeUnitOfMeasurementIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Unit Of Measurement Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUnitOfMeasurementIsActiveResourceActionRequest" } }, { "$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/GEN/UnitsOfMeasurement/{id}/PermissionTree": { "patch": { "tags": [ "Unit Of Measurement" ], "summary": "Change the PermissionTree for an existing Unit Of Measurement 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 | UnitOfMeasurement->Version | integer | int32 |\r\n| permissionTreeId | UnitOfMeasurement->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": "ChangeUnitOfMeasurementPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Unit Of Measurement Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUnitOfMeasurementPermissionTreeResourceActionRequest" } }, { "$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/GEN/UnitsOfMeasurement/Batch/Active": { "patch": { "tags": [ "Unit Of Measurement" ], "summary": "Change the IsActive status for a collection of existing Unit Of Measurement 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 | UnitOfMeasurement->Id | integer | int64 |\r\n| version | UnitOfMeasurement->Version | integer | int32 |\r\n| isActive | UnitOfMeasurement->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": "BatchChangeUnitOfMeasurementIsActive", "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/BatchChangeUnitOfMeasurementIsActiveResourceActionRequest" } }, { "$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/GEN/UnitsOfMeasurement/Batch/PermissionTree": { "patch": { "tags": [ "Unit Of Measurement" ], "summary": "Change the PermissionTree status for a collection of existing Unit Of Measurement 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 | UnitOfMeasurement->Id | integer | int64 |\r\n| version | UnitOfMeasurement->Version | integer | int32 |\r\n| permissionTreeId | UnitOfMeasurement->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": "BatchChangeUnitOfMeasurementPermissionTree", "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/BatchChangeUnitOfMeasurementPermissionTreeResourceActionRequest" } }, { "$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/GEN/UserSiteApprovalRoles/{id}": { "get": { "tags": [ "User Site Approval Role" ], "summary": "Get a User Site Approval 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 | UserSiteApprovalRole->IsActive | boolean | |\r\n| createdByUserId | UserSiteApprovalRole->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserSiteApprovalRole->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserSiteApprovalRole->CreatedByUser_FullName | string | |\r\n| createdOn | UserSiteApprovalRole->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserSiteApprovalRole->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserSiteApprovalRole->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserSiteApprovalRole->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserSiteApprovalRole->ModifiedOn | string | date-time |\r\n| version | UserSiteApprovalRole->Version | integer | int32 |\r\n| permissionTreeId | UserSiteApprovalRole->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UserSiteApprovalRole->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UserSiteApprovalRole->PermissionTree_Description | string | |\r\n| id | UserSiteApprovalRole->Id | integer | int64 |\r\n| allSites | UserSiteApprovalRole->AllSites | boolean | |\r\n| approvalRoleId | UserSiteApprovalRole->ApprovalRole_Id | integer | int64 |\r\n| approvalRoleCode | UserSiteApprovalRole->ApprovalRole_Code | string | |\r\n| approvalRoleDescription | UserSiteApprovalRole->ApprovalRole_Description | string | |\r\n| notes | UserSiteApprovalRole->Notes | string | |\r\n| sequenceNumber | UserSiteApprovalRole->SequenceNumber | integer | int32 |\r\n| siteIds | UserSiteApprovalRole->SiteIds | array | array |\r\n| userId | UserSiteApprovalRole->User_Id | integer | int64 |\r\n| userCode | UserSiteApprovalRole->User_Code | string | |\r\n| userFullName | UserSiteApprovalRole->User_FullName | string | |\r\n", "operationId": "GetUserSiteApprovalRole", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Site Approval Role Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Site Approval Role", "schema": { "$ref": "#/definitions/GetUserSiteApprovalRoleResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "User Site Approval Role" ], "summary": "Update an existing User Site Approval 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 | UserSiteApprovalRole->Version | integer | int32 |\r\n| approvalRoleId | UserSiteApprovalRole->ApprovalRole_Id | integer | int64 |\r\n| allSites | UserSiteApprovalRole->AllSites | boolean | |\r\n| siteIds | UserSiteApprovalRole->SiteIds | array | array |\r\n| notes | UserSiteApprovalRole->Notes | string | |\r\n| sequenceNumber | UserSiteApprovalRole->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| approvalRoleId | Nullable | False | |\r\n| allSites | Nullable | False | |\r\n| siteIds | Nullable | False | |\r\n\r\n", "operationId": "UpdateUserSiteApprovalRole", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Site Approval Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateUserSiteApprovalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Site Approval 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 Site Approval Role" ], "summary": "Delete an existing User Site Approval 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 | UserSiteApprovalRole->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": "DeleteUserSiteApprovalRole", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Site Approval Role Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteUserSiteApprovalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Site Approval 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/GEN/UserSiteApprovalRoles/{userSiteApprovalRoleId}/Sites": { "get": { "tags": [ "User Site Approval Role" ], "summary": "Get a list of Site resources for the User Site Approval 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 | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n| isActive | Site->IsActive | boolean | |\r\n", "operationId": "GetUserSiteApprovalRoleSiteCollection", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "userSiteApprovalRoleId", "in": "path", "required": true, "format": "int64", "x-nullable": false } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains User Site Approval Role collection", "schema": { "$ref": "#/definitions/GetUserSiteApprovalRoleSiteCollectionResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/UserSiteApprovalRoles": { "get": { "tags": [ "User Site Approval Role" ], "summary": "Get a collection of User Site Approval 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 | UserSiteApprovalRole->Id | integer | int64 |\r\n| version | UserSiteApprovalRole->Version | integer | int32 |\r\n| allSites | UserSiteApprovalRole->AllSites | boolean | |\r\n| sequenceNumber | UserSiteApprovalRole->SequenceNumber | integer | int32 |\r\n| approvalRoleCode | UserSiteApprovalRole->ApprovalRole_Code | string | |\r\n| approvalRoleDescription | UserSiteApprovalRole->ApprovalRole_Description | string | |\r\n| permissionTreeCode | UserSiteApprovalRole->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UserSiteApprovalRole->PermissionTree_Description | string | |\r\n| userFullName | UserSiteApprovalRole->User_FullName | string | |\r\n| siteIds | UserSiteApprovalRole->SiteIds | array | array |\r\n", "operationId": "GetUserSiteApprovalRoleCollection", "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 Site Approval Role collection", "schema": { "$ref": "#/definitions/GetUserSiteApprovalRoleCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "User Site Approval Role" ], "summary": "Create a new User Site Approval 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 | UserSiteApprovalRole->PermissionTree_Id | integer | int64 |\r\n| userId | UserSiteApprovalRole->User_Id | integer | int64 |\r\n| approvalRoleId | UserSiteApprovalRole->ApprovalRole_Id | integer | int64 |\r\n| allSites | UserSiteApprovalRole->AllSites | boolean | |\r\n| siteIds | UserSiteApprovalRole->SiteIds | array | array |\r\n| notes | UserSiteApprovalRole->Notes | string | |\r\n| sequenceNumber | UserSiteApprovalRole->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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| userId | Required | True | |\r\n| userId | Nullable | False | |\r\n| approvalRoleId | Required | True | |\r\n| approvalRoleId | Nullable | False | |\r\n| allSites | Required | True | |\r\n| allSites | Nullable | False | |\r\n| siteIds | Nullable | False | |\r\n\r\n", "operationId": "CreateUserSiteApprovalRole", "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/CreateUserSiteApprovalRoleResourceActionRequest" } }, { "$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/GEN/UserSiteApprovalRoles/Lookups/LookupUserSiteApprovalRoleApprovalRole": { "get": { "tags": [ "User Site Approval Role" ], "summary": "Lookup the User Site Approval Role for the User Site Approval 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 | ApprovalRole->Id | integer | int64 |\r\n| code | ApprovalRole->Code | string | |\r\n| description | ApprovalRole->Description | string | |\r\n", "operationId": "LookupUserSiteApprovalRoleApprovalRole", "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 Approval Role collection", "schema": { "$ref": "#/definitions/UserSiteApprovalRoleApprovalRoleLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/UserSiteApprovalRoles/Lookups/LookupUserSiteApprovalRoleChangePermissionTree": { "get": { "tags": [ "User Site Approval Role" ], "summary": "Lookup the permission set for changing the User Site Approval 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": "LookupUserSiteApprovalRoleChangePermissionTree", "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/UserSiteApprovalRoleChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/UserSiteApprovalRoles/Lookups/LookupUserSiteApprovalRoleInsertPermissionTree": { "get": { "tags": [ "User Site Approval Role" ], "summary": "Lookup the permission set for creating the User Site Approval 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": "LookupUserSiteApprovalRoleInsertPermissionTree", "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/UserSiteApprovalRoleInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/UserSiteApprovalRoles/Lookups/LookupUserSiteApprovalRoleSite": { "get": { "tags": [ "User Site Approval Role" ], "summary": "User Site Approval 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 | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n| isActive | Site->IsActive | boolean | |\r\n", "operationId": "LookupUserSiteApprovalRoleSite", "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/UserSiteApprovalRoleSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/UserSiteApprovalRoles/Lookups/LookupUserSiteApprovalRoleUser": { "get": { "tags": [ "User Site Approval Role" ], "summary": "Lookup the User Site Approval Role for the User Site Approval 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": "LookupUserSiteApprovalRoleUser", "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/UserSiteApprovalRoleUserLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/UserSiteApprovalRoles/Batch/{ids}": { "get": { "tags": [ "User Site Approval Role" ], "summary": "Get a collection of User Site Approval 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 | UserSiteApprovalRole->IsActive | boolean | |\r\n| createdByUserId | UserSiteApprovalRole->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | UserSiteApprovalRole->CreatedByUser_Code | string | |\r\n| createdByUserFullName | UserSiteApprovalRole->CreatedByUser_FullName | string | |\r\n| createdOn | UserSiteApprovalRole->CreatedOn | string | date-time |\r\n| modifiedByUserId | UserSiteApprovalRole->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | UserSiteApprovalRole->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | UserSiteApprovalRole->ModifiedByUser_FullName | string | |\r\n| modifiedOn | UserSiteApprovalRole->ModifiedOn | string | date-time |\r\n| version | UserSiteApprovalRole->Version | integer | int32 |\r\n| permissionTreeId | UserSiteApprovalRole->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | UserSiteApprovalRole->PermissionTree_Code | string | |\r\n| permissionTreeDescription | UserSiteApprovalRole->PermissionTree_Description | string | |\r\n| id | UserSiteApprovalRole->Id | integer | int64 |\r\n| allSites | UserSiteApprovalRole->AllSites | boolean | |\r\n| approvalRoleId | UserSiteApprovalRole->ApprovalRole_Id | integer | int64 |\r\n| approvalRoleCode | UserSiteApprovalRole->ApprovalRole_Code | string | |\r\n| approvalRoleDescription | UserSiteApprovalRole->ApprovalRole_Description | string | |\r\n| notes | UserSiteApprovalRole->Notes | string | |\r\n| sequenceNumber | UserSiteApprovalRole->SequenceNumber | integer | int32 |\r\n| siteIds | UserSiteApprovalRole->SiteIds | array | array |\r\n| userId | UserSiteApprovalRole->User_Id | integer | int64 |\r\n| userCode | UserSiteApprovalRole->User_Code | string | |\r\n| userFullName | UserSiteApprovalRole->User_FullName | string | |\r\n", "operationId": "BatchGetUserSiteApprovalRole", "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 Site Approval 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 Site Approval Role collection", "schema": { "$ref": "#/definitions/BatchGetUserSiteApprovalRoleResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/GEN/UserSiteApprovalRoles/Batch": { "post": { "tags": [ "User Site Approval Role" ], "summary": "Create a new collection of User Site Approval 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 | UserSiteApprovalRole->PermissionTree_Id | integer | int64 |\r\n| userId | UserSiteApprovalRole->User_Id | integer | int64 |\r\n| approvalRoleId | UserSiteApprovalRole->ApprovalRole_Id | integer | int64 |\r\n| allSites | UserSiteApprovalRole->AllSites | boolean | |\r\n| siteIds | UserSiteApprovalRole->SiteIds | array | array |\r\n| notes | UserSiteApprovalRole->Notes | string | |\r\n| sequenceNumber | UserSiteApprovalRole->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| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| userId | Required | True | |\r\n| userId | Nullable | False | |\r\n| approvalRoleId | Required | True | |\r\n| approvalRoleId | Nullable | False | |\r\n| allSites | Required | True | |\r\n| allSites | Nullable | False | |\r\n| siteIds | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateUserSiteApprovalRole", "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/BatchCreateUserSiteApprovalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - User Site Approval 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 Site Approval Role" ], "summary": "Update a collection of existing User Site Approval 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 | UserSiteApprovalRole->Id | integer | int64 |\r\n| version | UserSiteApprovalRole->Version | integer | int32 |\r\n| approvalRoleId | UserSiteApprovalRole->ApprovalRole_Id | integer | int64 |\r\n| allSites | UserSiteApprovalRole->AllSites | boolean | |\r\n| siteIds | UserSiteApprovalRole->SiteIds | array | array |\r\n| notes | UserSiteApprovalRole->Notes | string | |\r\n| sequenceNumber | UserSiteApprovalRole->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| approvalRoleId | Nullable | False | |\r\n| allSites | Nullable | False | |\r\n| siteIds | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateUserSiteApprovalRole", "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/BatchUpdateUserSiteApprovalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Site Approval 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 Site Approval Role" ], "summary": "Delete a collection of existing User Site Approval 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 | UserSiteApprovalRole->Id | integer | int64 |\r\n| version | UserSiteApprovalRole->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": "BatchDeleteUserSiteApprovalRole", "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/BatchDeleteUserSiteApprovalRoleResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - User Site Approval 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/GEN/UserSiteApprovalRoles/{id}/Active": { "patch": { "tags": [ "User Site Approval Role" ], "summary": "Change the IsActive status for an existing User Site Approval 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 | UserSiteApprovalRole->Version | integer | int32 |\r\n| isActive | UserSiteApprovalRole->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": "ChangeUserSiteApprovalRoleIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Site Approval Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUserSiteApprovalRoleIsActiveResourceActionRequest" } }, { "$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/GEN/UserSiteApprovalRoles/{id}/PermissionTree": { "patch": { "tags": [ "User Site Approval Role" ], "summary": "Change the PermissionTree for an existing User Site Approval 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 | UserSiteApprovalRole->Version | integer | int32 |\r\n| permissionTreeId | UserSiteApprovalRole->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": "ChangeUserSiteApprovalRolePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "User Site Approval Role Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeUserSiteApprovalRolePermissionTreeResourceActionRequest" } }, { "$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/GEN/UserSiteApprovalRoles/Batch/Active": { "patch": { "tags": [ "User Site Approval Role" ], "summary": "Change the IsActive status for a collection of existing User Site Approval 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 | UserSiteApprovalRole->Id | integer | int64 |\r\n| version | UserSiteApprovalRole->Version | integer | int32 |\r\n| isActive | UserSiteApprovalRole->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": "BatchChangeUserSiteApprovalRoleIsActive", "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/BatchChangeUserSiteApprovalRoleIsActiveResourceActionRequest" } }, { "$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/GEN/UserSiteApprovalRoles/Batch/PermissionTree": { "patch": { "tags": [ "User Site Approval Role" ], "summary": "Change the PermissionTree status for a collection of existing User Site Approval 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 | UserSiteApprovalRole->Id | integer | int64 |\r\n| version | UserSiteApprovalRole->Version | integer | int32 |\r\n| permissionTreeId | UserSiteApprovalRole->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": "BatchChangeUserSiteApprovalRolePermissionTree", "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/BatchChangeUserSiteApprovalRolePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } } }, "definitions": { "OperationExecutionMode": { "type": "string", "description": "", "x-enumNames": [ "AllOrNone", "PerRecord" ], "enum": [ "AllOrNone", "PerRecord" ] }, "SeverityType": { "type": "string", "description": "", "x-nullable": false, "x-enumNames": [ "Error", "Warning", "Information" ], "enum": [ "error", "warning", "information" ] }, "NotificationItemSchema": { "title": "NotificationItemSchema", "type": "object", "properties": { "code": { "title": "code", "type": "string", "description": "Unique code for message", "x-nullable": false }, "message": { "title": "message", "type": "string", "x-nullable": false }, "objectId": { "title": "objectId", "type": "string", "description": "Optional id of record to which the message applies", "x-nullable": true }, "objectType": { "title": "objectType", "type": "string", "format": "enum", "x-nullable": true, "x-formatSpecifier": "EntityType" }, "properties": { "title": "properties", "type": "array", "description": "Collection of properties referenced by the message using property path syntax", "x-nullable": true, "example": [ "Asset->Code" ], "items": { "type": "string" } }, "severity": { "$ref": "#/definitions/SeverityType" }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Optional provided unique external record identifier to echo back with message", "x-nullable": true } } }, "NotificationSchema": { "title": "NotificationSchema", "type": "object", "properties": { "messages": { "title": "messages", "type": "array", "description": "Collection of messages", "x-nullable": false, "items": { "$ref": "#/definitions/NotificationItemSchema" } } } }, "EntityPermissionViolationSchema": { "type": "object", "required": [ "permissionId", "permissionTreeId", "propertyPaths" ], "properties": { "permissionId": { "type": "integer", "format": "int64" }, "permissionTreeId": { "type": "integer", "format": "int64" }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "EntityPhraseTranslationSchema": { "type": "object", "required": [ "phrase", "translation", "propertyPaths" ], "properties": { "phrase": { "type": "string" }, "translation": { "type": "string" }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "Link": { "type": "object", "required": [ "href", "method" ], "properties": { "doc": { "type": "string", "description": "Documentation endpoint that describes the link" }, "href": { "type": "string", "description": "Endpoint to invoke link", "minLength": 1 }, "mapping": { "type": "array", "items": { "$ref": "#/definitions/LinkMapping" } }, "method": { "type": "string", "description": "HTTP method used for link", "minLength": 1 }, "module": { "type": "string", "description": "Module used by link" }, "rel": { "type": "string" }, "resource": { "type": "string", "description": "Resource used by link" }, "resourceAction": { "type": "string", "description": "Resource Action used by link" }, "title": { "type": "string", "description": "Title" }, "type": { "description": "Type of link", "$ref": "#/definitions/ResourceLinkType" } } }, "LinkMapping": { "type": "object", "required": [ "source" ], "properties": { "source": { "type": "string" }, "target": { "type": "string" } } }, "ResourceLinkType": { "type": "string", "description": "", "x-enumNames": [ "Association", "PrimaryAction", "CustomAction", "Collection", "Detail", "Lookup", "Documentation", "Navigation", "Specification" ], "enum": [ "association", "primaryAction", "customAction", "collection", "detail", "lookup", "documentation", "navigation", "specification" ] }, "GetAddressTypeResourceActionResponse": { "title": "GetAddressTypeResourceActionResponse", "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": "GetAddressTypeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AddressType->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AddressType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AddressType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AddressType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AddressType->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AddressType->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AddressType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AddressType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AddressType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AddressType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AddressType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AddressType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AddressType->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AddressType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AddressType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AddressType->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" } } }, "GetAddressTypeCollectionResourceActionResponse": { "title": "GetAddressTypeCollectionResourceActionResponse", "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": "GetAddressTypeCollectionResourceActionResponseItem", "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": "GetAddressTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AddressType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AddressType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AddressType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AddressType->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AddressType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AddressType->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" } } } }, "AddressTypeChangePermissionTreeLookupResourceActionResponse": { "title": "AddressTypeChangePermissionTreeLookupResourceActionResponse", "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": "AddressTypeChangePermissionTreeLookupResourceActionResponseItem", "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": "AddressTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AddressTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "AddressTypeInsertPermissionTreeLookupResourceActionResponse", "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": "AddressTypeInsertPermissionTreeLookupResourceActionResponseItem", "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": "AddressTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateAddressTypeResourceActionRequest": { "title": "CreateAddressTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateAddressTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AddressType->PermissionTree_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AddressType->SequenceNumber" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "AddressType->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "AddressType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AddressType->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" } } }, "UpdateAddressTypeResourceActionRequest": { "title": "UpdateAddressTypeResourceActionRequest", "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": "AddressType->SequenceNumber" }, { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "AddressType->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "AddressType->Description" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AddressType->Notes" } ] } } }, "DeleteAddressTypeResourceActionRequest": { "title": "DeleteAddressTypeResourceActionRequest", "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 } } }, "BatchGetAddressTypeResourceAction": { "title": "BatchGetAddressTypeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Address Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Address Type entities", "items": { "$ref": "#/definitions/GetAddressTypeResourceActionResponse" } }, "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" } } }, "BatchCreateAddressTypeResourceActionRequest": { "title": "BatchCreateAddressTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAddressTypeResourceActionRequest" } }, "BatchUpdateAddressTypeResourceActionRequest": { "title": "BatchUpdateAddressTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateAddressTypeResourceActionRequest" } }, "BatchDeleteAddressTypeResourceActionRequest": { "title": "BatchDeleteAddressTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteAddressTypeResourceActionRequest" } }, "ChangeAddressTypeIsActiveResourceActionRequest": { "title": "ChangeAddressTypeIsActiveResourceActionRequest", "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": "AddressType->IsActive" } ] } } }, "ChangeAddressTypePermissionTreeResourceActionRequest": { "title": "ChangeAddressTypePermissionTreeResourceActionRequest", "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": "AddressType->PermissionTree_Id" } ] } } }, "BatchChangeAddressTypeIsActiveResourceActionRequest": { "title": "BatchChangeAddressTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAddressTypeIsActiveResourceActionRequest" } }, "BatchChangeAddressTypePermissionTreeResourceActionRequest": { "title": "BatchChangeAddressTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAddressTypePermissionTreeResourceActionRequest" } }, "GetApprovalResourceActionResponse": { "title": "GetApprovalResourceActionResponse", "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": "GetApprovalResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Approval->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Approval->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Approval->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Approval->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Approval->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Approval->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Approval->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Approval->ModifiedOn" }, "entitySiteId": { "title": "entitySiteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Approval->EntitySite_Id" }, "entitySiteCode": { "title": "entitySiteCode", "type": "string", "x-nullable": true, "x-propertyPath": "Approval->EntitySite_Code" }, "entitySiteDescription": { "title": "entitySiteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Approval->EntitySite_Description" }, "entityId": { "title": "entityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Approval->EntityId" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Approval->EntityType", "x-formatSpecifier": "EntityType" }, "entityVersion": { "title": "entityVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "Approval->EntityVersion" }, "expressionId": { "title": "expressionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Approval->Expression_Id" }, "expressionDescription": { "title": "expressionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Approval->Expression_Description" }, "expressionVersion": { "title": "expressionVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "Approval->ExpressionVersion" }, "reviewedByUserId": { "title": "reviewedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Approval->ReviewedByUser_Id" }, "reviewedByUserCode": { "title": "reviewedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Approval->ReviewedByUser_Code" }, "reviewedByUserFullName": { "title": "reviewedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Approval->ReviewedByUser_FullName" }, "reviewedOn": { "title": "reviewedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Approval->ReviewedOn" }, "isHistoric": { "title": "isHistoric", "type": "boolean", "x-nullable": true, "x-propertyPath": "Approval->IsHistoric" }, "isLocked": { "title": "isLocked", "type": "boolean", "x-nullable": true, "x-propertyPath": "Approval->IsLocked" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Approval->Notes" }, "remark": { "title": "remark", "type": "string", "x-nullable": true, "x-propertyPath": "Approval->Remark" }, "roleId": { "title": "roleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Approval->Role_Id" }, "roleCode": { "title": "roleCode", "type": "string", "x-nullable": true, "x-propertyPath": "Approval->Role_Code" }, "roleDescription": { "title": "roleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Approval->Role_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Approval->SequenceNumber" }, "status": { "title": "status", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Approval->Status", "x-formatSpecifier": "ApprovalStatus" } } }, "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" } } }, "GetApprovalCollectionResourceActionResponse": { "title": "GetApprovalCollectionResourceActionResponse", "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": "GetApprovalCollectionResourceActionResponseItem", "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": "GetApprovalCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "entityId": { "title": "entityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Approval->EntityId" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Approval->EntityType", "x-formatSpecifier": "EntityType" }, "isLocked": { "title": "isLocked", "type": "boolean", "x-nullable": true, "x-propertyPath": "Approval->IsLocked" }, "roleCode": { "title": "roleCode", "type": "string", "x-nullable": false, "x-propertyPath": "Approval->Role_Code" }, "reviewedByUserCode": { "title": "reviewedByUserCode", "type": "string", "x-nullable": false, "x-propertyPath": "Approval->ReviewedByUser_Code" }, "reviewedOn": { "title": "reviewedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Approval->ReviewedOn" }, "remark": { "title": "remark", "type": "string", "x-nullable": true, "x-propertyPath": "Approval->Remark" }, "isHistoric": { "title": "isHistoric", "type": "boolean", "x-nullable": true, "x-propertyPath": "Approval->IsHistoric" }, "status": { "title": "status", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Approval->Status", "x-formatSpecifier": "ApprovalStatus" } } }, "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" } } } }, "BatchGetApprovalResourceAction": { "title": "BatchGetApprovalResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Approval entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Approval entities", "items": { "$ref": "#/definitions/GetApprovalResourceActionResponse" } }, "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" } } }, "GetApprovalRoleResourceActionResponse": { "title": "GetApprovalRoleResourceActionResponse", "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": "GetApprovalRoleResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalRole->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ApprovalRole->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ApprovalRole->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalRole->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalRole->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ApprovalRole->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ApprovalRole->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalRole->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalRole->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ApprovalRole->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ApprovalRole->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalRole->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalRole->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalRole->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalRole->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ApprovalRole->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" } } }, "GetApprovalRoleCollectionResourceActionResponse": { "title": "GetApprovalRoleCollectionResourceActionResponse", "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": "GetApprovalRoleCollectionResourceActionResponseItem", "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": "GetApprovalRoleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalRole->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalRole->Description" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalRole->PermissionTree_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ApprovalRole->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalRole->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ApprovalRole->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ApprovalRole->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" } } } }, "ApprovalRoleChangePermissionTreeLookupResourceActionResponse": { "title": "ApprovalRoleChangePermissionTreeLookupResourceActionResponse", "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": "ApprovalRoleChangePermissionTreeLookupResourceActionResponseItem", "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": "ApprovalRoleChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ApprovalRoleInsertPermissionTreeLookupResourceActionResponse": { "title": "ApprovalRoleInsertPermissionTreeLookupResourceActionResponse", "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": "ApprovalRoleInsertPermissionTreeLookupResourceActionResponseItem", "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": "ApprovalRoleInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateApprovalRoleResourceActionRequest": { "title": "CreateApprovalRoleResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateApprovalRoleResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ApprovalRole->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "ApprovalRole->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "ApprovalRole->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ApprovalRole->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalRole->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateApprovalRoleResourceActionRequest": { "title": "UpdateApprovalRoleResourceActionRequest", "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": "ApprovalRole->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "ApprovalRole->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ApprovalRole->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalRole->Notes" } ] } } }, "DeleteApprovalRoleResourceActionRequest": { "title": "DeleteApprovalRoleResourceActionRequest", "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 } } }, "BatchGetApprovalRoleResourceAction": { "title": "BatchGetApprovalRoleResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Approval Role entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Approval Role entities", "items": { "$ref": "#/definitions/GetApprovalRoleResourceActionResponse" } }, "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" } } }, "BatchCreateApprovalRoleResourceActionRequest": { "title": "BatchCreateApprovalRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateApprovalRoleResourceActionRequest" } }, "BatchUpdateApprovalRoleResourceActionRequest": { "title": "BatchUpdateApprovalRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateApprovalRoleResourceActionRequest" } }, "BatchDeleteApprovalRoleResourceActionRequest": { "title": "BatchDeleteApprovalRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteApprovalRoleResourceActionRequest" } }, "ChangeApprovalRoleIsActiveResourceActionRequest": { "title": "ChangeApprovalRoleIsActiveResourceActionRequest", "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": "ApprovalRole->IsActive" } ] } } }, "ChangeApprovalRolePermissionTreeResourceActionRequest": { "title": "ChangeApprovalRolePermissionTreeResourceActionRequest", "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": "ApprovalRole->PermissionTree_Id" } ] } } }, "BatchChangeApprovalRoleIsActiveResourceActionRequest": { "title": "BatchChangeApprovalRoleIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeApprovalRoleIsActiveResourceActionRequest" } }, "BatchChangeApprovalRolePermissionTreeResourceActionRequest": { "title": "BatchChangeApprovalRolePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeApprovalRolePermissionTreeResourceActionRequest" } }, "GetApprovalWorkflowResourceActionResponse": { "title": "GetApprovalWorkflowResourceActionResponse", "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": "GetApprovalWorkflowResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ApprovalWorkflow->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ApprovalWorkflow->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->Site_Description" }, "approvalEntity": { "title": "approvalEntity", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->ApprovalEntity", "x-formatSpecifier": "EntityType" }, "defaultApprovalRoleStrategy": { "title": "defaultApprovalRoleStrategy", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->DefaultApprovalRoleStrategy", "x-formatSpecifier": "ApprovalRoleStrategy" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->Description" }, "expressionMatchType": { "title": "expressionMatchType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->ExpressionMatchType", "x-formatSpecifier": "ExpressionMatchType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->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" } } }, "GetApprovalWorkflowCollectionResourceActionResponse": { "title": "GetApprovalWorkflowCollectionResourceActionResponse", "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": "GetApprovalWorkflowCollectionResourceActionResponseItem", "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": "GetApprovalWorkflowCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->Description" }, "approvalEntity": { "title": "approvalEntity", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->ApprovalEntity", "x-formatSpecifier": "EntityType" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->Site_Description" }, "expressionMatchType": { "title": "expressionMatchType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->ExpressionMatchType", "x-formatSpecifier": "ExpressionMatchType" }, "defaultApprovalRoleStrategy": { "title": "defaultApprovalRoleStrategy", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->DefaultApprovalRoleStrategy", "x-formatSpecifier": "ApprovalRoleStrategy" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ApprovalWorkflow->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ApprovalWorkflow->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" } } } }, "ApprovalWorkflowChangePermissionTreeLookupResourceActionResponse": { "title": "ApprovalWorkflowChangePermissionTreeLookupResourceActionResponse", "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": "ApprovalWorkflowChangePermissionTreeLookupResourceActionResponseItem", "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": "ApprovalWorkflowChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ApprovalWorkflowInsertPermissionTreeLookupResourceActionResponse": { "title": "ApprovalWorkflowInsertPermissionTreeLookupResourceActionResponse", "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": "ApprovalWorkflowInsertPermissionTreeLookupResourceActionResponseItem", "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": "ApprovalWorkflowInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ApprovalWorkflowSiteLookupResourceActionResponse": { "title": "ApprovalWorkflowSiteLookupResourceActionResponse", "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": "ApprovalWorkflowSiteLookupResourceActionResponseItem", "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": "ApprovalWorkflowSiteLookupResourceActionResponseItemProperties", "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" } } } }, "CreateApprovalWorkflowResourceActionRequest": { "title": "CreateApprovalWorkflowResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateApprovalWorkflowResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "expressionMatchType", "approvalEntity" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->Description" }, "defaultApprovalRoleStrategy": { "title": "defaultApprovalRoleStrategy", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->DefaultApprovalRoleStrategy", "x-formatSpecifier": "ApprovalRoleStrategy" }, "expressionMatchType": { "title": "expressionMatchType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->ExpressionMatchType", "x-formatSpecifier": "ExpressionMatchType" }, "approvalEntity": { "title": "approvalEntity", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->ApprovalEntity", "x-formatSpecifier": "EntityType" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->Site_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateApprovalWorkflowResourceActionRequest": { "title": "UpdateApprovalWorkflowResourceActionRequest", "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": "ApprovalWorkflow->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->Description" }, { "title": "defaultApprovalRoleStrategy", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->DefaultApprovalRoleStrategy", "x-formatSpecifier": "ApprovalRoleStrategy" }, { "title": "expressionMatchType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->ExpressionMatchType", "x-formatSpecifier": "ExpressionMatchType" }, { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->Site_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->Notes" } ] } } }, "DeleteApprovalWorkflowResourceActionRequest": { "title": "DeleteApprovalWorkflowResourceActionRequest", "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 } } }, "BatchGetApprovalWorkflowResourceAction": { "title": "BatchGetApprovalWorkflowResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Approval Workflow entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Approval Workflow entities", "items": { "$ref": "#/definitions/GetApprovalWorkflowResourceActionResponse" } }, "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" } } }, "BatchCreateApprovalWorkflowResourceActionRequest": { "title": "BatchCreateApprovalWorkflowResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateApprovalWorkflowResourceActionRequest" } }, "BatchUpdateApprovalWorkflowResourceActionRequest": { "title": "BatchUpdateApprovalWorkflowResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateApprovalWorkflowResourceActionRequest" } }, "BatchDeleteApprovalWorkflowResourceActionRequest": { "title": "BatchDeleteApprovalWorkflowResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteApprovalWorkflowResourceActionRequest" } }, "ChangeApprovalWorkflowIsActiveResourceActionRequest": { "title": "ChangeApprovalWorkflowIsActiveResourceActionRequest", "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": "ApprovalWorkflow->IsActive" } ] } } }, "ChangeApprovalWorkflowPermissionTreeResourceActionRequest": { "title": "ChangeApprovalWorkflowPermissionTreeResourceActionRequest", "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": "ApprovalWorkflow->PermissionTree_Id" } ] } } }, "ChangeApprovalWorkflowSiteResourceActionRequest": { "title": "ChangeApprovalWorkflowSiteResourceActionRequest", "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": "ApprovalWorkflow->Site_Id" } ] } } }, "BatchChangeApprovalWorkflowIsActiveResourceActionRequest": { "title": "BatchChangeApprovalWorkflowIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeApprovalWorkflowIsActiveResourceActionRequest" } }, "BatchChangeApprovalWorkflowPermissionTreeResourceActionRequest": { "title": "BatchChangeApprovalWorkflowPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeApprovalWorkflowPermissionTreeResourceActionRequest" } }, "BatchChangeApprovalWorkflowSiteResourceActionRequest": { "title": "BatchChangeApprovalWorkflowSiteResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeApprovalWorkflowSiteResourceActionRequest" } }, "GetApprovalWorkflowExpressionResourceActionResponse": { "title": "GetApprovalWorkflowExpressionResourceActionResponse", "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": "GetApprovalWorkflowExpressionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpression->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpression->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpression->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ApprovalWorkflowExpression->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpression->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpression->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpression->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ApprovalWorkflowExpression->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpression->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpression->PermissionTree_Description" }, "approvalWorkflowId": { "title": "approvalWorkflowId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->ApprovalWorkflow_Id" }, "approvalWorkflowCode": { "title": "approvalWorkflowCode", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpression->ApprovalWorkflow_Code" }, "approvalWorkflowDescription": { "title": "approvalWorkflowDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpression->ApprovalWorkflow_Description" }, "approvalRoleStrategy": { "title": "approvalRoleStrategy", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->ApprovalRoleStrategy", "x-formatSpecifier": "ApprovalRoleStrategy" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->Description" }, "expression": { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->Expression" }, "requiredApprovalCount": { "title": "requiredApprovalCount", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->RequiredApprovalCount", "x-NullExpression": "ApprovalWorkflowExpression->ApprovalRoleStrategy eq 'CountBased'" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpression->Notes" }, "matchSequenceNumber": { "title": "matchSequenceNumber", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->MatchSequenceNumber" }, "status": { "title": "status", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->Status", "x-formatSpecifier": "ApprovalExpressionStatus" } } }, "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" } } }, "GetApprovalWorkflowExpressionCollectionResourceActionResponse": { "title": "GetApprovalWorkflowExpressionCollectionResourceActionResponse", "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": "GetApprovalWorkflowExpressionCollectionResourceActionResponseItem", "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": "GetApprovalWorkflowExpressionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "expression": { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->Expression" }, "approvalWorkflowCode": { "title": "approvalWorkflowCode", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->ApprovalWorkflow_Code" }, "approvalWorkflowDescription": { "title": "approvalWorkflowDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->ApprovalWorkflow_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->Description" }, "matchSequenceNumber": { "title": "matchSequenceNumber", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->MatchSequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpression->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ApprovalWorkflowExpression->CreatedOn" }, "approvalRoleStrategy": { "title": "approvalRoleStrategy", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->ApprovalRoleStrategy", "x-formatSpecifier": "ApprovalRoleStrategy" }, "requiredApprovalCount": { "title": "requiredApprovalCount", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->RequiredApprovalCount", "x-NullExpression": "ApprovalWorkflowExpression->ApprovalRoleStrategy eq 'CountBased'" }, "status": { "title": "status", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->Status", "x-formatSpecifier": "ApprovalExpressionStatus" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ApprovalWorkflowExpression->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" } } } }, "GetApprovalWorkflowExpressionForApprovalWorkflowCollectionResourceActionResponse": { "title": "GetApprovalWorkflowExpressionForApprovalWorkflowCollectionResourceActionResponse", "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": "GetApprovalWorkflowExpressionForApprovalWorkflowCollectionResourceActionResponseItem", "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": "GetApprovalWorkflowExpressionForApprovalWorkflowCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "requiredApprovalCount": { "title": "requiredApprovalCount", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->RequiredApprovalCount", "x-NullExpression": "ApprovalWorkflowExpression->ApprovalRoleStrategy eq 'CountBased'" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->Description" }, "approvalRoleStrategy": { "title": "approvalRoleStrategy", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->ApprovalRoleStrategy", "x-formatSpecifier": "ApprovalRoleStrategy" }, "status": { "title": "status", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->Status", "x-formatSpecifier": "ApprovalExpressionStatus" } } }, "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" } } } }, "ApprovalWorkflowExpressionApprovalWorkflowLookupResourceActionResponse": { "title": "ApprovalWorkflowExpressionApprovalWorkflowLookupResourceActionResponse", "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": "ApprovalWorkflowExpressionApprovalWorkflowLookupResourceActionResponseItem", "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": "ApprovalWorkflowExpressionApprovalWorkflowLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflow->Description" }, "defaultApprovalRoleStrategy": { "title": "defaultApprovalRoleStrategy", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ApprovalWorkflow->DefaultApprovalRoleStrategy", "x-formatSpecifier": "ApprovalRoleStrategy" } } }, "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" } } } }, "ApprovalWorkflowExpressionChangePermissionTreeLookupResourceActionResponse": { "title": "ApprovalWorkflowExpressionChangePermissionTreeLookupResourceActionResponse", "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": "ApprovalWorkflowExpressionChangePermissionTreeLookupResourceActionResponseItem", "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": "ApprovalWorkflowExpressionChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ApprovalWorkflowExpressionInsertPermissionTreeLookupResourceActionResponse": { "title": "ApprovalWorkflowExpressionInsertPermissionTreeLookupResourceActionResponse", "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": "ApprovalWorkflowExpressionInsertPermissionTreeLookupResourceActionResponseItem", "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": "ApprovalWorkflowExpressionInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateApprovalWorkflowExpressionResourceActionRequest": { "title": "CreateApprovalWorkflowExpressionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateApprovalWorkflowExpressionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "approvalWorkflowId", "expression", "description", "matchSequenceNumber" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->PermissionTree_Id", "x-systemGenerated": true }, "approvalWorkflowId": { "title": "approvalWorkflowId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->ApprovalWorkflow_Id" }, "expression": { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->Expression" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->Description" }, "matchSequenceNumber": { "title": "matchSequenceNumber", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->MatchSequenceNumber" }, "approvalRoleStrategy": { "title": "approvalRoleStrategy", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->ApprovalRoleStrategy", "x-formatSpecifier": "ApprovalRoleStrategy" }, "requiredApprovalCount": { "title": "requiredApprovalCount", "type": "integer", "format": "int32", "minimum": 1.0, "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->RequiredApprovalCount", "x-NullExpression": "ApprovalWorkflowExpression->ApprovalRoleStrategy eq 'CountBased'" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpression->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateApprovalWorkflowExpressionResourceActionRequest": { "title": "UpdateApprovalWorkflowExpressionResourceActionRequest", "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": "approvalWorkflowId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->ApprovalWorkflow_Id" }, { "title": "expression", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->Expression" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->Description" }, { "title": "matchSequenceNumber", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->MatchSequenceNumber" }, { "title": "approvalRoleStrategy", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->ApprovalRoleStrategy", "x-formatSpecifier": "ApprovalRoleStrategy" }, { "title": "requiredApprovalCount", "type": "integer", "format": "int32", "minimum": 1.0, "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->RequiredApprovalCount", "x-NullExpression": "ApprovalWorkflowExpression->ApprovalRoleStrategy eq 'CountBased'" }, { "title": "status", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->Status", "x-formatSpecifier": "ApprovalExpressionStatus" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpression->Notes" } ] } } }, "DeleteApprovalWorkflowExpressionResourceActionRequest": { "title": "DeleteApprovalWorkflowExpressionResourceActionRequest", "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 } } }, "BatchGetApprovalWorkflowExpressionResourceAction": { "title": "BatchGetApprovalWorkflowExpressionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Approval Workflow Expression entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Approval Workflow Expression entities", "items": { "$ref": "#/definitions/GetApprovalWorkflowExpressionResourceActionResponse" } }, "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" } } }, "BatchCreateApprovalWorkflowExpressionResourceActionRequest": { "title": "BatchCreateApprovalWorkflowExpressionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateApprovalWorkflowExpressionResourceActionRequest" } }, "BatchUpdateApprovalWorkflowExpressionResourceActionRequest": { "title": "BatchUpdateApprovalWorkflowExpressionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateApprovalWorkflowExpressionResourceActionRequest" } }, "BatchDeleteApprovalWorkflowExpressionResourceActionRequest": { "title": "BatchDeleteApprovalWorkflowExpressionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteApprovalWorkflowExpressionResourceActionRequest" } }, "ChangeApprovalWorkflowExpressionIsActiveResourceActionRequest": { "title": "ChangeApprovalWorkflowExpressionIsActiveResourceActionRequest", "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": "ApprovalWorkflowExpression->IsActive" } ] } } }, "ChangeApprovalWorkflowExpressionPermissionTreeResourceActionRequest": { "title": "ChangeApprovalWorkflowExpressionPermissionTreeResourceActionRequest", "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": "ApprovalWorkflowExpression->PermissionTree_Id" } ] } } }, "BatchChangeApprovalWorkflowExpressionIsActiveResourceActionRequest": { "title": "BatchChangeApprovalWorkflowExpressionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeApprovalWorkflowExpressionIsActiveResourceActionRequest" } }, "BatchChangeApprovalWorkflowExpressionPermissionTreeResourceActionRequest": { "title": "BatchChangeApprovalWorkflowExpressionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeApprovalWorkflowExpressionPermissionTreeResourceActionRequest" } }, "GetApprovalWorkflowExpressionApprovalRoleResourceActionResponse": { "title": "GetApprovalWorkflowExpressionApprovalRoleResourceActionResponse", "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": "GetApprovalWorkflowExpressionApprovalRoleResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->PermissionTree_Description" }, "approvalRoleId": { "title": "approvalRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Id" }, "approvalRoleCode": { "title": "approvalRoleCode", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Code" }, "approvalRoleDescription": { "title": "approvalRoleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Description" }, "approvalWorkflowExpressionId": { "title": "approvalWorkflowExpressionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_Id" }, "approvalWorkflowExpressionDescription": { "title": "approvalWorkflowExpressionDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->Notes" }, "approvalSequenceNumber": { "title": "approvalSequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalSequenceNumber" } } }, "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" } } }, "GetApprovalWorkflowExpressionApprovalRoleCollectionResourceActionResponse": { "title": "GetApprovalWorkflowExpressionApprovalRoleCollectionResourceActionResponse", "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": "GetApprovalWorkflowExpressionApprovalRoleCollectionResourceActionResponseItem", "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": "GetApprovalWorkflowExpressionApprovalRoleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "approvalWorkflowExpressionApprovalWorkflowSiteId": { "title": "approvalWorkflowExpressionApprovalWorkflowSiteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_ApprovalWorkflow_Site_Id" }, "approvalWorkflowExpressionApprovalWorkflowSiteCode": { "title": "approvalWorkflowExpressionApprovalWorkflowSiteCode", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_ApprovalWorkflow_Site_Code" }, "approvalWorkflowExpressionApprovalWorkflowSiteDescription": { "title": "approvalWorkflowExpressionApprovalWorkflowSiteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_ApprovalWorkflow_Site_Description" }, "approvalWorkflowExpressionDescription": { "title": "approvalWorkflowExpressionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_Description" }, "approvalRoleCode": { "title": "approvalRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Code" }, "approvalRoleDescription": { "title": "approvalRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Description" }, "approvalSequenceNumber": { "title": "approvalSequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalSequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->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" } } } }, "GetApprovalWorkflowExpressionApprovalRoleForApprovalWorkflowExpressionCollectionResourceActionResponse": { "title": "GetApprovalWorkflowExpressionApprovalRoleForApprovalWorkflowExpressionCollectionResourceActionResponse", "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": "GetApprovalWorkflowExpressionApprovalRoleForApprovalWorkflowExpressionCollectionResourceActionResponseItem", "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": "GetApprovalWorkflowExpressionApprovalRoleForApprovalWorkflowExpressionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "approvalWorkflowExpressionDescription": { "title": "approvalWorkflowExpressionDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_Description" }, "approvalRoleCode": { "title": "approvalRoleCode", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Code" }, "approvalRoleDescription": { "title": "approvalRoleDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Description" }, "approvalSequenceNumber": { "title": "approvalSequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalSequenceNumber" } } }, "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" } } } }, "ApprovalWorkflowExpressionApprovalRoleApprovalRoleLookupResourceActionResponse": { "title": "ApprovalWorkflowExpressionApprovalRoleApprovalRoleLookupResourceActionResponse", "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": "ApprovalWorkflowExpressionApprovalRoleApprovalRoleLookupResourceActionResponseItem", "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": "ApprovalWorkflowExpressionApprovalRoleApprovalRoleLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalRole->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "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" } } } }, "ApprovalWorkflowExpressionApprovalRoleApprovalWorkflowExpressionLookupResourceActionResponse": { "title": "ApprovalWorkflowExpressionApprovalRoleApprovalWorkflowExpressionLookupResourceActionResponse", "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": "ApprovalWorkflowExpressionApprovalRoleApprovalWorkflowExpressionLookupResourceActionResponseItem", "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": "ApprovalWorkflowExpressionApprovalRoleApprovalWorkflowExpressionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpression->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" } } } }, "ApprovalWorkflowExpressionApprovalRoleChangePermissionTreeLookupResourceActionResponse": { "title": "ApprovalWorkflowExpressionApprovalRoleChangePermissionTreeLookupResourceActionResponse", "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": "ApprovalWorkflowExpressionApprovalRoleChangePermissionTreeLookupResourceActionResponseItem", "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": "ApprovalWorkflowExpressionApprovalRoleChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ApprovalWorkflowExpressionApprovalRoleInsertPermissionTreeLookupResourceActionResponse": { "title": "ApprovalWorkflowExpressionApprovalRoleInsertPermissionTreeLookupResourceActionResponse", "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": "ApprovalWorkflowExpressionApprovalRoleInsertPermissionTreeLookupResourceActionResponseItem", "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": "ApprovalWorkflowExpressionApprovalRoleInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateApprovalWorkflowExpressionApprovalRoleResourceActionRequest": { "title": "CreateApprovalWorkflowExpressionApprovalRoleResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateApprovalWorkflowExpressionApprovalRoleResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "approvalWorkflowExpressionId", "approvalRoleId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->PermissionTree_Id", "x-systemGenerated": true }, "approvalWorkflowExpressionId": { "title": "approvalWorkflowExpressionId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalWorkflowExpression_Id" }, "approvalRoleId": { "title": "approvalRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalRole_Id" }, "approvalSequenceNumber": { "title": "approvalSequenceNumber", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalSequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateApprovalWorkflowExpressionApprovalRoleResourceActionRequest": { "title": "UpdateApprovalWorkflowExpressionApprovalRoleResourceActionRequest", "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": "approvalSequenceNumber", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->ApprovalSequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ApprovalWorkflowExpressionApprovalRole->Notes" } ] } } }, "DeleteApprovalWorkflowExpressionApprovalRoleResourceActionRequest": { "title": "DeleteApprovalWorkflowExpressionApprovalRoleResourceActionRequest", "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 } } }, "BatchGetApprovalWorkflowExpressionApprovalRoleResourceAction": { "title": "BatchGetApprovalWorkflowExpressionApprovalRoleResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Approval Workflow Expression Approval Role entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Approval Workflow Expression Approval Role entities", "items": { "$ref": "#/definitions/GetApprovalWorkflowExpressionApprovalRoleResourceActionResponse" } }, "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" } } }, "BatchCreateApprovalWorkflowExpressionApprovalRoleResourceActionRequest": { "title": "BatchCreateApprovalWorkflowExpressionApprovalRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateApprovalWorkflowExpressionApprovalRoleResourceActionRequest" } }, "BatchUpdateApprovalWorkflowExpressionApprovalRoleResourceActionRequest": { "title": "BatchUpdateApprovalWorkflowExpressionApprovalRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateApprovalWorkflowExpressionApprovalRoleResourceActionRequest" } }, "BatchDeleteApprovalWorkflowExpressionApprovalRoleResourceActionRequest": { "title": "BatchDeleteApprovalWorkflowExpressionApprovalRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteApprovalWorkflowExpressionApprovalRoleResourceActionRequest" } }, "ChangeApprovalWorkflowExpressionApprovalRoleIsActiveResourceActionRequest": { "title": "ChangeApprovalWorkflowExpressionApprovalRoleIsActiveResourceActionRequest", "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": "ApprovalWorkflowExpressionApprovalRole->IsActive" } ] } } }, "ChangeApprovalWorkflowExpressionApprovalRolePermissionTreeResourceActionRequest": { "title": "ChangeApprovalWorkflowExpressionApprovalRolePermissionTreeResourceActionRequest", "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": "ApprovalWorkflowExpressionApprovalRole->PermissionTree_Id" } ] } } }, "BatchChangeApprovalWorkflowExpressionApprovalRoleIsActiveResourceActionRequest": { "title": "BatchChangeApprovalWorkflowExpressionApprovalRoleIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeApprovalWorkflowExpressionApprovalRoleIsActiveResourceActionRequest" } }, "BatchChangeApprovalWorkflowExpressionApprovalRolePermissionTreeResourceActionRequest": { "title": "BatchChangeApprovalWorkflowExpressionApprovalRolePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeApprovalWorkflowExpressionApprovalRolePermissionTreeResourceActionRequest" } }, "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" } } }, "GetAttributeResourceActionResponse": { "title": "GetAttributeResourceActionResponse", "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": "GetAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Attribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Attribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Attribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Attribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Attribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Attribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->PermissionTree_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" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id", "x-NullExpression": "Attribute->AllowAnyValue eq true" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultValue": { "title": "defaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Description" }, "explanation": { "title": "explanation", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Explanation" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Attribute->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" } } }, "GetAttributeCollectionResourceActionResponse": { "title": "GetAttributeCollectionResourceActionResponse", "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": "GetAttributeCollectionResourceActionResponseItem", "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": "GetAttributeCollectionResourceActionResponseItemProperties", "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" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Attribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Attribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Attribute->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" } } } }, "AttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "AttributeAttributeAllowedValueLookupResourceActionResponse", "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": "AttributeAttributeAllowedValueLookupResourceActionResponseItem", "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": "AttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->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" } } } }, "AttributeChangePermissionTreeLookupResourceActionResponse": { "title": "AttributeChangePermissionTreeLookupResourceActionResponse", "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": "AttributeChangePermissionTreeLookupResourceActionResponseItem", "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": "AttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "AttributeInsertPermissionTreeLookupResourceActionResponse", "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": "AttributeInsertPermissionTreeLookupResourceActionResponseItem", "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": "AttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateAttributeResourceActionRequest": { "title": "CreateAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "allowAnyValue", "dataType" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Attribute->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Attribute->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Attribute->SequenceNumber" }, "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", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id", "x-NullExpression": "Attribute->AllowAnyValue eq true" }, "explanation": { "title": "explanation", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Explanation" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateAttributeResourceActionRequest": { "title": "UpdateAttributeResourceActionRequest", "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": "Attribute->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Attribute->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Attribute->SequenceNumber" }, { "title": "allowAnyValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, { "title": "defaultValue", "format": "composite", "x-nullable": true, "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id", "x-NullExpression": "Attribute->AllowAnyValue eq true" }, { "title": "explanation", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Explanation" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Notes" } ] } } }, "DeleteAttributeResourceActionRequest": { "title": "DeleteAttributeResourceActionRequest", "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 } } }, "BatchGetAttributeResourceAction": { "title": "BatchGetAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Attribute entities", "items": { "$ref": "#/definitions/GetAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateAttributeResourceActionRequest": { "title": "BatchCreateAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAttributeResourceActionRequest" } }, "BatchUpdateAttributeResourceActionRequest": { "title": "BatchUpdateAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateAttributeResourceActionRequest" } }, "BatchDeleteAttributeResourceActionRequest": { "title": "BatchDeleteAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteAttributeResourceActionRequest" } }, "ChangeAttributeIsActiveResourceActionRequest": { "title": "ChangeAttributeIsActiveResourceActionRequest", "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": "Attribute->IsActive" } ] } } }, "ChangeAttributePermissionTreeResourceActionRequest": { "title": "ChangeAttributePermissionTreeResourceActionRequest", "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": "Attribute->PermissionTree_Id" } ] } } }, "BatchChangeAttributeIsActiveResourceActionRequest": { "title": "BatchChangeAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAttributeIsActiveResourceActionRequest" } }, "BatchChangeAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAttributePermissionTreeResourceActionRequest" } }, "GetAttributeAllowedValueResourceActionResponse": { "title": "GetAttributeAllowedValueResourceActionResponse", "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": "GetAttributeAllowedValueResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AttributeAllowedValue->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "AttributeAllowedValue->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AttributeAllowedValue->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AttributeAllowedValue->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AttributeAllowedValue->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->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" } } }, "GetAllowedValueForAttributeCollectionResourceActionResponse": { "title": "GetAllowedValueForAttributeCollectionResourceActionResponse", "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": "GetAllowedValueForAttributeCollectionResourceActionResponseItem", "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": "GetAllowedValueForAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->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" } } } }, "GetAttributeAllowedValueCollectionResourceActionResponse": { "title": "GetAttributeAllowedValueCollectionResourceActionResponse", "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": "GetAttributeAllowedValueCollectionResourceActionResponseItem", "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": "GetAttributeAllowedValueCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AttributeAllowedValue->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AttributeAllowedValue->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" } } } }, "AttributeAllowedValueAttributeLookupResourceActionResponse": { "title": "AttributeAllowedValueAttributeLookupResourceActionResponse", "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": "AttributeAllowedValueAttributeLookupResourceActionResponseItem", "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": "AttributeAllowedValueAttributeLookupResourceActionResponseItemProperties", "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" } } }, "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" } } } }, "AttributeAllowedValueChangePermissionTreeLookupResourceActionResponse": { "title": "AttributeAllowedValueChangePermissionTreeLookupResourceActionResponse", "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": "AttributeAllowedValueChangePermissionTreeLookupResourceActionResponseItem", "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": "AttributeAllowedValueChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "AttributeAllowedValueInsertPermissionTreeLookupResourceActionResponse": { "title": "AttributeAllowedValueInsertPermissionTreeLookupResourceActionResponse", "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": "AttributeAllowedValueInsertPermissionTreeLookupResourceActionResponseItem", "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": "AttributeAllowedValueInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateAttributeAllowedValueResourceActionRequest": { "title": "CreateAttributeAllowedValueResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateAttributeAllowedValueResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "value", "description", "attributeId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AttributeAllowedValue->PermissionTree_Id", "x-systemGenerated": true }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AttributeAllowedValue->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "AttributeAllowedValue->Attribute_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateAttributeAllowedValueResourceActionRequest": { "title": "UpdateAttributeAllowedValueResourceActionRequest", "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": false, "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Notes" } ] } } }, "DeleteAttributeAllowedValueResourceActionRequest": { "title": "DeleteAttributeAllowedValueResourceActionRequest", "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 } } }, "BatchGetAttributeAllowedValueResourceAction": { "title": "BatchGetAttributeAllowedValueResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Attribute Allowed Value entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Attribute Allowed Value entities", "items": { "$ref": "#/definitions/GetAttributeAllowedValueResourceActionResponse" } }, "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" } } }, "BatchCreateAttributeAllowedValueResourceActionRequest": { "title": "BatchCreateAttributeAllowedValueResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateAttributeAllowedValueResourceActionRequest" } }, "BatchUpdateAttributeAllowedValueResourceActionRequest": { "title": "BatchUpdateAttributeAllowedValueResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateAttributeAllowedValueResourceActionRequest" } }, "BatchDeleteAttributeAllowedValueResourceActionRequest": { "title": "BatchDeleteAttributeAllowedValueResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteAttributeAllowedValueResourceActionRequest" } }, "ChangeAttributeAllowedValueIsActiveResourceActionRequest": { "title": "ChangeAttributeAllowedValueIsActiveResourceActionRequest", "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": "AttributeAllowedValue->IsActive" } ] } } }, "ChangeAttributeAllowedValuePermissionTreeResourceActionRequest": { "title": "ChangeAttributeAllowedValuePermissionTreeResourceActionRequest", "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": "AttributeAllowedValue->PermissionTree_Id" } ] } } }, "BatchChangeAttributeAllowedValueIsActiveResourceActionRequest": { "title": "BatchChangeAttributeAllowedValueIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAttributeAllowedValueIsActiveResourceActionRequest" } }, "BatchChangeAttributeAllowedValuePermissionTreeResourceActionRequest": { "title": "BatchChangeAttributeAllowedValuePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeAttributeAllowedValuePermissionTreeResourceActionRequest" } }, "GetCalendarResourceActionResponse": { "title": "GetCalendarResourceActionResponse", "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": "GetCalendarResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Calendar->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Calendar->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Calendar->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Calendar->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Calendar->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Calendar->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Calendar->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Calendar->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Calendar->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Calendar->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Calendar->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Calendar->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Calendar->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Calendar->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "Calendar->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Calendar->Site_Description" }, "calendarType": { "title": "calendarType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Calendar->CalendarType", "x-formatSpecifier": "CalendarType" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Calendar->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Calendar->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Calendar->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" } } }, "GetCalendarCollectionResourceActionResponse": { "title": "GetCalendarCollectionResourceActionResponse", "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": "GetCalendarCollectionResourceActionResponseItem", "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": "GetCalendarCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Calendar->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Calendar->Description" }, "calendarType": { "title": "calendarType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Calendar->CalendarType", "x-formatSpecifier": "CalendarType" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Calendar->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Calendar->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" } } } }, "CalendarChangePermissionTreeLookupResourceActionResponse": { "title": "CalendarChangePermissionTreeLookupResourceActionResponse", "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": "CalendarChangePermissionTreeLookupResourceActionResponseItem", "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": "CalendarChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CalendarInsertPermissionTreeLookupResourceActionResponse": { "title": "CalendarInsertPermissionTreeLookupResourceActionResponse", "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": "CalendarInsertPermissionTreeLookupResourceActionResponseItem", "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": "CalendarInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CalendarSiteLookupResourceActionResponse": { "title": "CalendarSiteLookupResourceActionResponse", "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": "CalendarSiteLookupResourceActionResponseItem", "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": "CalendarSiteLookupResourceActionResponseItemProperties", "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" } } } }, "CreateCalendarResourceActionRequest": { "title": "CreateCalendarResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateCalendarResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "calendarType" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Calendar->PermissionTree_Id", "x-systemGenerated": true }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Calendar->Site_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Calendar->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Calendar->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Calendar->SequenceNumber" }, "calendarType": { "title": "calendarType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Calendar->CalendarType", "x-formatSpecifier": "CalendarType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Calendar->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateCalendarResourceActionRequest": { "title": "UpdateCalendarResourceActionRequest", "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": "Calendar->Code" }, { "title": "calendarType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Calendar->CalendarType", "x-formatSpecifier": "CalendarType" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Calendar->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Calendar->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Calendar->Notes" } ] } } }, "DeleteCalendarResourceActionRequest": { "title": "DeleteCalendarResourceActionRequest", "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 } } }, "BatchGetCalendarResourceAction": { "title": "BatchGetCalendarResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Calendar entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Calendar entities", "items": { "$ref": "#/definitions/GetCalendarResourceActionResponse" } }, "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" } } }, "BatchCreateCalendarResourceActionRequest": { "title": "BatchCreateCalendarResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateCalendarResourceActionRequest" } }, "BatchUpdateCalendarResourceActionRequest": { "title": "BatchUpdateCalendarResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateCalendarResourceActionRequest" } }, "BatchDeleteCalendarResourceActionRequest": { "title": "BatchDeleteCalendarResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteCalendarResourceActionRequest" } }, "ChangeCalendarIsActiveResourceActionRequest": { "title": "ChangeCalendarIsActiveResourceActionRequest", "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": "Calendar->IsActive" } ] } } }, "ChangeCalendarPermissionTreeResourceActionRequest": { "title": "ChangeCalendarPermissionTreeResourceActionRequest", "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": "Calendar->PermissionTree_Id" } ] } } }, "ChangeCalendarSiteResourceActionRequest": { "title": "ChangeCalendarSiteResourceActionRequest", "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": "Calendar->Site_Id" } ] } } }, "BatchChangeCalendarIsActiveResourceActionRequest": { "title": "BatchChangeCalendarIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeCalendarIsActiveResourceActionRequest" } }, "BatchChangeCalendarPermissionTreeResourceActionRequest": { "title": "BatchChangeCalendarPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeCalendarPermissionTreeResourceActionRequest" } }, "BatchChangeCalendarSiteResourceActionRequest": { "title": "BatchChangeCalendarSiteResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeCalendarSiteResourceActionRequest" } }, "GetCalendarDayResourceActionResponse": { "title": "GetCalendarDayResourceActionResponse", "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": "GetCalendarDayResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CalendarDay->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarDay->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarDay->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CalendarDay->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CalendarDay->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarDay->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarDay->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CalendarDay->ModifiedOn" }, "calendarId": { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CalendarDay->Calendar_Id" }, "calendarCode": { "title": "calendarCode", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarDay->Calendar_Code" }, "calendarDescription": { "title": "calendarDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarDay->Calendar_Description" }, "dayOfWeek": { "title": "dayOfWeek", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "CalendarDay->DayOfWeek", "x-formatSpecifier": "CalendarDayOfWeek" }, "isWorkingDay": { "title": "isWorkingDay", "type": "boolean", "x-nullable": false, "x-propertyPath": "CalendarDay->IsWorkingDay" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarDay->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" } } }, "GetCalendarDayCollectionResourceActionResponse": { "title": "GetCalendarDayCollectionResourceActionResponse", "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": "GetCalendarDayCollectionResourceActionResponseItem", "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": "GetCalendarDayCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "calendarCode": { "title": "calendarCode", "type": "string", "x-nullable": false, "x-propertyPath": "CalendarDay->Calendar_Code" }, "dayOfWeek": { "title": "dayOfWeek", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "CalendarDay->DayOfWeek", "x-formatSpecifier": "CalendarDayOfWeek" }, "isWorkingDay": { "title": "isWorkingDay", "type": "boolean", "x-nullable": false, "x-propertyPath": "CalendarDay->IsWorkingDay" } } }, "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" } } } }, "GetCalendarDayForCalendarCollectionResourceActionResponse": { "title": "GetCalendarDayForCalendarCollectionResourceActionResponse", "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": "GetCalendarDayForCalendarCollectionResourceActionResponseItem", "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": "GetCalendarDayForCalendarCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "dayOfWeek": { "title": "dayOfWeek", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "CalendarDay->DayOfWeek", "x-formatSpecifier": "CalendarDayOfWeek" }, "isWorkingDay": { "title": "isWorkingDay", "type": "boolean", "x-nullable": false, "x-propertyPath": "CalendarDay->IsWorkingDay" } } }, "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" } } } }, "UpdateCalendarDayResourceActionRequest": { "title": "UpdateCalendarDayResourceActionRequest", "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": "isWorkingDay", "type": "boolean", "x-nullable": false, "x-propertyPath": "CalendarDay->IsWorkingDay" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarDay->Notes" } ] } } }, "BatchGetCalendarDayResourceAction": { "title": "BatchGetCalendarDayResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Calendar Day entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Calendar Day entities", "items": { "$ref": "#/definitions/GetCalendarDayResourceActionResponse" } }, "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" } } }, "BatchUpdateCalendarDayResourceActionRequest": { "title": "BatchUpdateCalendarDayResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateCalendarDayResourceActionRequest" } }, "GetCalendarDayHourResourceActionResponse": { "title": "GetCalendarDayHourResourceActionResponse", "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": "GetCalendarDayHourResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CalendarDayHour->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarDayHour->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarDayHour->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CalendarDayHour->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CalendarDayHour->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarDayHour->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarDayHour->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CalendarDayHour->ModifiedOn" }, "calendarDayId": { "title": "calendarDayId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CalendarDayHour->CalendarDay_Id" }, "calendarDayDayOfWeek": { "title": "calendarDayDayOfWeek", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "CalendarDayHour->CalendarDay_DayOfWeek", "x-formatSpecifier": "CalendarDayOfWeek" }, "calendarDayIsWorkingDay": { "title": "calendarDayIsWorkingDay", "type": "boolean", "x-nullable": true, "x-propertyPath": "CalendarDayHour->CalendarDay_IsWorkingDay" }, "calendarDayCalendarId": { "title": "calendarDayCalendarId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CalendarDayHour->CalendarDay_Calendar_Id" }, "calendarDayCalendarCode": { "title": "calendarDayCalendarCode", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarDayHour->CalendarDay_Calendar_Code" }, "calendarDayCalendarDescription": { "title": "calendarDayCalendarDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarDayHour->CalendarDay_Calendar_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarDayHour->Notes" }, "timeFrom": { "title": "timeFrom", "type": "string", "format": "time", "x-nullable": true, "example": "10:32:55", "x-propertyPath": "CalendarDayHour->TimeFrom" }, "timeTo": { "title": "timeTo", "type": "string", "format": "time", "x-nullable": true, "example": "10:32:55", "x-propertyPath": "CalendarDayHour->TimeTo" } } }, "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" } } }, "GetCalendarDayHourCollectionResourceActionResponse": { "title": "GetCalendarDayHourCollectionResourceActionResponse", "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": "GetCalendarDayHourCollectionResourceActionResponseItem", "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": "GetCalendarDayHourCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "calendarDayId": { "title": "calendarDayId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CalendarDayHour->CalendarDay_Id" }, "calendarDayDayOfWeek": { "title": "calendarDayDayOfWeek", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "CalendarDayHour->CalendarDay_DayOfWeek", "x-formatSpecifier": "CalendarDayOfWeek" }, "calendarDayIsWorkingDay": { "title": "calendarDayIsWorkingDay", "type": "boolean", "x-nullable": false, "x-propertyPath": "CalendarDayHour->CalendarDay_IsWorkingDay" }, "calendarDayCalendarCode": { "title": "calendarDayCalendarCode", "type": "string", "x-nullable": false, "x-propertyPath": "CalendarDayHour->CalendarDay_Calendar_Code" }, "calendarDayCalendarDescription": { "title": "calendarDayCalendarDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CalendarDayHour->CalendarDay_Calendar_Description" }, "timeFrom": { "title": "timeFrom", "type": "string", "format": "time", "x-nullable": true, "example": "10:32:55", "x-propertyPath": "CalendarDayHour->TimeFrom" }, "timeTo": { "title": "timeTo", "type": "string", "format": "time", "x-nullable": true, "example": "10:32:55", "x-propertyPath": "CalendarDayHour->TimeTo" } } }, "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" } } } }, "GetCalendarDayHourForCalendarDayCollectionResourceActionResponse": { "title": "GetCalendarDayHourForCalendarDayCollectionResourceActionResponse", "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": "GetCalendarDayHourForCalendarDayCollectionResourceActionResponseItem", "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": "GetCalendarDayHourForCalendarDayCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "timeFrom": { "title": "timeFrom", "type": "string", "format": "time", "x-nullable": true, "example": "10:32:55", "x-propertyPath": "CalendarDayHour->TimeFrom" }, "timeTo": { "title": "timeTo", "type": "string", "format": "time", "x-nullable": true, "example": "10:32:55", "x-propertyPath": "CalendarDayHour->TimeTo" } } }, "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" } } } }, "CalendarDayHourCalendarDayLookupResourceActionResponse": { "title": "CalendarDayHourCalendarDayLookupResourceActionResponse", "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": "CalendarDayHourCalendarDayLookupResourceActionResponseItem", "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": "CalendarDayHourCalendarDayLookupResourceActionResponseItemProperties", "type": "object", "properties": { "dayOfWeek": { "title": "dayOfWeek", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "CalendarDay->DayOfWeek", "x-formatSpecifier": "CalendarDayOfWeek" }, "calendarCode": { "title": "calendarCode", "type": "string", "x-nullable": false, "x-propertyPath": "CalendarDay->Calendar_Code" }, "calendarDescription": { "title": "calendarDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CalendarDay->Calendar_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" } } } }, "CreateCalendarDayHourResourceActionRequest": { "title": "CreateCalendarDayHourResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateCalendarDayHourResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "calendarDayId", "timeFrom", "timeTo" ], "properties": { "calendarDayId": { "title": "calendarDayId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CalendarDayHour->CalendarDay_Id" }, "timeFrom": { "title": "timeFrom", "type": "string", "format": "time", "maximum": 86400.0, "x-nullable": false, "example": "10:32:55", "exclusiveMaximum": true, "x-propertyPath": "CalendarDayHour->TimeFrom" }, "timeTo": { "title": "timeTo", "type": "string", "format": "time", "maximum": 86400.0, "x-nullable": false, "example": "10:32:55", "exclusiveMaximum": true, "x-propertyPath": "CalendarDayHour->TimeTo" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarDayHour->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateCalendarDayHourResourceActionRequest": { "title": "UpdateCalendarDayHourResourceActionRequest", "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": "timeTo", "type": "string", "format": "time", "maximum": 86400.0, "x-nullable": true, "example": "10:32:55", "exclusiveMaximum": true, "x-propertyPath": "CalendarDayHour->TimeTo" }, { "title": "timeFrom", "type": "string", "format": "time", "maximum": 86400.0, "x-nullable": true, "example": "10:32:55", "exclusiveMaximum": true, "x-propertyPath": "CalendarDayHour->TimeFrom" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarDayHour->Notes" } ] } } }, "DeleteCalendarDayHourResourceActionRequest": { "title": "DeleteCalendarDayHourResourceActionRequest", "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 } } }, "BatchGetCalendarDayHourResourceAction": { "title": "BatchGetCalendarDayHourResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Calendar Day Hour entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Calendar Day Hour entities", "items": { "$ref": "#/definitions/GetCalendarDayHourResourceActionResponse" } }, "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" } } }, "BatchCreateCalendarDayHourResourceActionRequest": { "title": "BatchCreateCalendarDayHourResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateCalendarDayHourResourceActionRequest" } }, "BatchUpdateCalendarDayHourResourceActionRequest": { "title": "BatchUpdateCalendarDayHourResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateCalendarDayHourResourceActionRequest" } }, "BatchDeleteCalendarDayHourResourceActionRequest": { "title": "BatchDeleteCalendarDayHourResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteCalendarDayHourResourceActionRequest" } }, "GetCalendarExceptionResourceActionResponse": { "title": "GetCalendarExceptionResourceActionResponse", "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": "GetCalendarExceptionResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CalendarException->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarException->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarException->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CalendarException->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CalendarException->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarException->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarException->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "CalendarException->ModifiedOn" }, "calendarId": { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CalendarException->Calendar_Id" }, "calendarCode": { "title": "calendarCode", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarException->Calendar_Code" }, "calendarDescription": { "title": "calendarDescription", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarException->Calendar_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CalendarException->Description" }, "exceptionOn": { "title": "exceptionOn", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "CalendarException->ExceptionOn" }, "isWorkingDay": { "title": "isWorkingDay", "type": "boolean", "x-nullable": false, "x-propertyPath": "CalendarException->IsWorkingDay" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarException->Notes" }, "timeFrom": { "title": "timeFrom", "type": "string", "format": "time", "x-nullable": true, "example": "10:32:55", "x-propertyPath": "CalendarException->TimeFrom" }, "timeTo": { "title": "timeTo", "type": "string", "format": "time", "x-nullable": true, "example": "10:32:55", "x-propertyPath": "CalendarException->TimeTo" } } }, "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" } } }, "GetCalendarExceptionCollectionResourceActionResponse": { "title": "GetCalendarExceptionCollectionResourceActionResponse", "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": "GetCalendarExceptionCollectionResourceActionResponseItem", "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": "GetCalendarExceptionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "calendarId": { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "CalendarException->Calendar_Id" }, "calendarCode": { "title": "calendarCode", "type": "string", "x-nullable": false, "x-propertyPath": "CalendarException->Calendar_Code" }, "calendarDescription": { "title": "calendarDescription", "type": "string", "x-nullable": false, "x-propertyPath": "CalendarException->Calendar_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CalendarException->Description" }, "isWorkingDay": { "title": "isWorkingDay", "type": "boolean", "x-nullable": false, "x-propertyPath": "CalendarException->IsWorkingDay" }, "exceptionOn": { "title": "exceptionOn", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "CalendarException->ExceptionOn" }, "timeFrom": { "title": "timeFrom", "type": "string", "format": "time", "x-nullable": true, "example": "10:32:55", "x-propertyPath": "CalendarException->TimeFrom" }, "timeTo": { "title": "timeTo", "type": "string", "format": "time", "x-nullable": true, "example": "10:32:55", "x-propertyPath": "CalendarException->TimeTo" } } }, "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" } } } }, "GetCalendarExceptionForCalendarCollectionResourceActionResponse": { "title": "GetCalendarExceptionForCalendarCollectionResourceActionResponse", "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": "GetCalendarExceptionForCalendarCollectionResourceActionResponseItem", "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": "GetCalendarExceptionForCalendarCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "CalendarException->Description" }, "exceptionOn": { "title": "exceptionOn", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "CalendarException->ExceptionOn" }, "timeFrom": { "title": "timeFrom", "type": "string", "format": "time", "x-nullable": true, "example": "10:32:55", "x-propertyPath": "CalendarException->TimeFrom" }, "timeTo": { "title": "timeTo", "type": "string", "format": "time", "x-nullable": true, "example": "10:32:55", "x-propertyPath": "CalendarException->TimeTo" }, "isWorkingDay": { "title": "isWorkingDay", "type": "boolean", "x-nullable": false, "x-propertyPath": "CalendarException->IsWorkingDay" } } }, "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" } } } }, "CalendarExceptionCalendarLookupResourceActionResponse": { "title": "CalendarExceptionCalendarLookupResourceActionResponse", "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": "CalendarExceptionCalendarLookupResourceActionResponseItem", "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": "CalendarExceptionCalendarLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Calendar->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Calendar->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" } } } }, "CreateCalendarExceptionResourceActionRequest": { "title": "CreateCalendarExceptionResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateCalendarExceptionResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "calendarId", "description", "isWorkingDay", "exceptionOn" ], "properties": { "calendarId": { "title": "calendarId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "CalendarException->Calendar_Id" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "CalendarException->Description" }, "isWorkingDay": { "title": "isWorkingDay", "type": "boolean", "x-nullable": false, "x-propertyPath": "CalendarException->IsWorkingDay" }, "exceptionOn": { "title": "exceptionOn", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "CalendarException->ExceptionOn" }, "timeFrom": { "title": "timeFrom", "type": "string", "format": "time", "maximum": 86400.0, "x-nullable": true, "example": "10:32:55", "exclusiveMaximum": true, "x-propertyPath": "CalendarException->TimeFrom" }, "timeTo": { "title": "timeTo", "type": "string", "format": "time", "maximum": 86400.0, "x-nullable": true, "example": "10:32:55", "exclusiveMaximum": true, "x-propertyPath": "CalendarException->TimeTo" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarException->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateCalendarExceptionResourceActionRequest": { "title": "UpdateCalendarExceptionResourceActionRequest", "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": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "CalendarException->Description" }, { "title": "isWorkingDay", "type": "boolean", "x-nullable": false, "x-propertyPath": "CalendarException->IsWorkingDay" }, { "title": "exceptionOn", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "CalendarException->ExceptionOn" }, { "title": "timeFrom", "type": "string", "format": "time", "maximum": 86400.0, "x-nullable": true, "example": "10:32:55", "exclusiveMaximum": true, "x-propertyPath": "CalendarException->TimeFrom" }, { "title": "timeTo", "type": "string", "format": "time", "maximum": 86400.0, "x-nullable": true, "example": "10:32:55", "exclusiveMaximum": true, "x-propertyPath": "CalendarException->TimeTo" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "CalendarException->Notes" } ] } } }, "DeleteCalendarExceptionResourceActionRequest": { "title": "DeleteCalendarExceptionResourceActionRequest", "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 } } }, "BatchGetCalendarExceptionResourceAction": { "title": "BatchGetCalendarExceptionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Calendar Exception entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Calendar Exception entities", "items": { "$ref": "#/definitions/GetCalendarExceptionResourceActionResponse" } }, "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" } } }, "BatchCreateCalendarExceptionResourceActionRequest": { "title": "BatchCreateCalendarExceptionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateCalendarExceptionResourceActionRequest" } }, "BatchUpdateCalendarExceptionResourceActionRequest": { "title": "BatchUpdateCalendarExceptionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateCalendarExceptionResourceActionRequest" } }, "BatchDeleteCalendarExceptionResourceActionRequest": { "title": "BatchDeleteCalendarExceptionResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteCalendarExceptionResourceActionRequest" } }, "GetChangeDataTriggerResourceActionResponse": { "title": "GetChangeDataTriggerResourceActionResponse", "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": "GetChangeDataTriggerResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTrigger->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTrigger->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTrigger->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataTrigger->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTrigger->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTrigger->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTrigger->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataTrigger->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTrigger->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTrigger->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->Description" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->EntityType", "x-formatSpecifier": "EntityType" }, "isSystem": { "title": "isSystem", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->IsSystem" }, "triggerOnce": { "title": "triggerOnce", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->TriggerOnce" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTrigger->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTrigger->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" } } }, "GetChangeDataTriggerCollectionResourceActionResponse": { "title": "GetChangeDataTriggerCollectionResourceActionResponse", "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": "GetChangeDataTriggerCollectionResourceActionResponseItem", "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": "GetChangeDataTriggerCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTrigger->SequenceNumber" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->EntityType", "x-formatSpecifier": "EntityType" }, "triggerOnce": { "title": "triggerOnce", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->TriggerOnce" } } }, "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" } } } }, "ChangeDataTriggerChangePermissionTreeLookupResourceActionResponse": { "title": "ChangeDataTriggerChangePermissionTreeLookupResourceActionResponse", "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": "ChangeDataTriggerChangePermissionTreeLookupResourceActionResponseItem", "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": "ChangeDataTriggerChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ChangeDataTriggerInsertPermissionTreeLookupResourceActionResponse": { "title": "ChangeDataTriggerInsertPermissionTreeLookupResourceActionResponse", "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": "ChangeDataTriggerInsertPermissionTreeLookupResourceActionResponseItem", "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": "ChangeDataTriggerInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateChangeDataTriggerResourceActionRequest": { "title": "CreateChangeDataTriggerResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateChangeDataTriggerResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->Code" }, "description": { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->PermissionTree_Id" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->EntityType", "x-formatSpecifier": "EntityType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTrigger->SequenceNumber" }, "triggerOnce": { "title": "triggerOnce", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->TriggerOnce" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTrigger->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateChangeDataTriggerResourceActionRequest": { "title": "UpdateChangeDataTriggerResourceActionRequest", "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": "ChangeDataTrigger->Code" }, { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTrigger->SequenceNumber" }, { "title": "triggerOnce", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->TriggerOnce" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTrigger->Notes" } ] } } }, "DeleteChangeDataTriggerResourceActionRequest": { "title": "DeleteChangeDataTriggerResourceActionRequest", "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 } } }, "BatchGetChangeDataTriggerResourceAction": { "title": "BatchGetChangeDataTriggerResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Change Data Trigger entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Change Data Trigger entities", "items": { "$ref": "#/definitions/GetChangeDataTriggerResourceActionResponse" } }, "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" } } }, "BatchCreateChangeDataTriggerRequest": { "title": "BatchCreateChangeDataTriggerRequest", "type": "array", "items": { "$ref": "#/definitions/CreateChangeDataTriggerResourceActionRequest" } }, "BatchUpdateChangeDataTriggerResourceActionRequest": { "title": "BatchUpdateChangeDataTriggerResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateChangeDataTriggerResourceActionRequest" } }, "BatchDeleteChangeDataTriggerResourceActionRequest": { "title": "BatchDeleteChangeDataTriggerResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteChangeDataTriggerResourceActionRequest" } }, "ChangeChangeDataTriggerIsActiveResourceActionRequest": { "title": "ChangeChangeDataTriggerIsActiveResourceActionRequest", "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": "ChangeDataTrigger->IsActive" } ] } } }, "ChangeChangeDataTriggerPermissionTreeResourceActionRequest": { "title": "ChangeChangeDataTriggerPermissionTreeResourceActionRequest", "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": "ChangeDataTrigger->PermissionTree_Id" } ] } } }, "BatchChangeChangeDataTriggerIsActiveResourceActionRequest": { "title": "BatchChangeChangeDataTriggerIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeChangeDataTriggerIsActiveResourceActionRequest" } }, "BatchChangeChangeDataTriggerPermissionTreeResourceActionRequest": { "title": "BatchChangeChangeDataTriggerPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeChangeDataTriggerPermissionTreeResourceActionRequest" } }, "GetChangeDataTriggerCriteriaResourceActionResponse": { "title": "GetChangeDataTriggerCriteriaResourceActionResponse", "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": "GetChangeDataTriggerCriteriaResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataTriggerCriteria->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataTriggerCriteria->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->PermissionTree_Description" }, "changeDataTriggerId": { "title": "changeDataTriggerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeDataTrigger_Id" }, "changeDataTriggerCode": { "title": "changeDataTriggerCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeDataTrigger_Code" }, "changeDataTriggerDescription": { "title": "changeDataTriggerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeDataTrigger_Description" }, "changeDataTriggerEntityType": { "title": "changeDataTriggerEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeDataTrigger_EntityType", "x-formatSpecifier": "EntityType" }, "changeDataTriggerIsSystem": { "title": "changeDataTriggerIsSystem", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeDataTrigger_IsSystem" }, "changeType": { "title": "changeType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeType", "x-formatSpecifier": "EditState" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->Description" }, "filterExpression": { "title": "filterExpression", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->FilterExpression" }, "newValueExpression": { "title": "newValueExpression", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->NewValueExpression" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->Notes" }, "oldValueExpression": { "title": "oldValueExpression", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->OldValueExpression" }, "repeatNotification": { "title": "repeatNotification", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "ChangeDataTriggerCriteria->RepeatNotification", "x-NullExpression": "ChangeDataTriggerCriteria->FilterExpression eq null" }, "repeatNotificationLimit": { "title": "repeatNotificationLimit", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->RepeatNotificationLimit" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->SequenceNumber" }, "triggerProperties": { "title": "triggerProperties", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "ChangeDataTriggerCriteria->TriggerProperties", "x-formatSpecifier": "String" } } }, "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" } } }, "GetChangeDataTriggerCriteriaCollectionResourceActionResponse": { "title": "GetChangeDataTriggerCriteriaCollectionResourceActionResponse", "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": "GetChangeDataTriggerCriteriaCollectionResourceActionResponseItem", "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": "GetChangeDataTriggerCriteriaCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "changeDataTriggerId": { "title": "changeDataTriggerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeDataTrigger_Id" }, "changeDataTriggerCode": { "title": "changeDataTriggerCode", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeDataTrigger_Code" }, "changeDataTriggerDescription": { "title": "changeDataTriggerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeDataTrigger_Description" }, "changeType": { "title": "changeType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeType", "x-formatSpecifier": "EditState" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->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" } } } }, "GetChangeDataTriggerCriteriaForChangeDataTriggerCollectionResourceActionResponse": { "title": "GetChangeDataTriggerCriteriaForChangeDataTriggerCollectionResourceActionResponse", "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": "GetChangeDataTriggerCriteriaForChangeDataTriggerCollectionResourceActionResponseItem", "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": "GetChangeDataTriggerCriteriaForChangeDataTriggerCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "changeDataTriggerId": { "title": "changeDataTriggerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeDataTrigger_Id" }, "changeDataTriggerCode": { "title": "changeDataTriggerCode", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeDataTrigger_Code" }, "changeDataTriggerDescription": { "title": "changeDataTriggerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeDataTrigger_Description" }, "changeType": { "title": "changeType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeType", "x-formatSpecifier": "EditState" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->Description" }, "repeatNotification": { "title": "repeatNotification", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "ChangeDataTriggerCriteria->RepeatNotification", "x-NullExpression": "ChangeDataTriggerCriteria->FilterExpression eq null" }, "repeatNotificationLimit": { "title": "repeatNotificationLimit", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->RepeatNotificationLimit" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->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" } } } }, "ChangeDataTriggerCriteriaChangeDataTriggerLookupResourceActionResponse": { "title": "ChangeDataTriggerCriteriaChangeDataTriggerLookupResourceActionResponse", "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": "ChangeDataTriggerCriteriaChangeDataTriggerLookupResourceActionResponseItem", "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": "ChangeDataTriggerCriteriaChangeDataTriggerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->Description" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->EntityType", "x-formatSpecifier": "EntityType" } } }, "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" } } } }, "ChangeDataTriggerCriteriaChangePermissionTreeLookupResourceActionResponse": { "title": "ChangeDataTriggerCriteriaChangePermissionTreeLookupResourceActionResponse", "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": "ChangeDataTriggerCriteriaChangePermissionTreeLookupResourceActionResponseItem", "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": "ChangeDataTriggerCriteriaChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ChangeDataTriggerCriteriaEntityPropertyLookupResourceActionResponse": { "title": "ChangeDataTriggerCriteriaEntityPropertyLookupResourceActionResponse", "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": "ChangeDataTriggerCriteriaEntityPropertyLookupResourceActionResponseItem", "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": "ChangeDataTriggerCriteriaEntityPropertyLookupResourceActionResponseItemProperties", "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" } } } }, "ChangeDataTriggerCriteriaInsertPermissionTreeLookupResourceActionResponse": { "title": "ChangeDataTriggerCriteriaInsertPermissionTreeLookupResourceActionResponse", "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": "ChangeDataTriggerCriteriaInsertPermissionTreeLookupResourceActionResponseItem", "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": "ChangeDataTriggerCriteriaInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateChangeDataTriggerCriteriaResourceActionRequest": { "title": "CreateChangeDataTriggerCriteriaResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateChangeDataTriggerCriteriaResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "changeDataTriggerId", "description", "changeType" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->PermissionTree_Id", "x-systemGenerated": true }, "changeDataTriggerId": { "title": "changeDataTriggerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeDataTrigger_Id" }, "description": { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->Description" }, "changeType": { "title": "changeType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeType", "x-formatSpecifier": "EditState" }, "triggerProperties": { "title": "triggerProperties", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "ChangeDataTriggerCriteria->TriggerProperties", "x-formatSpecifier": "String" }, "filterExpression": { "title": "filterExpression", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->FilterExpression" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->IsActive" }, "newValueExpression": { "title": "newValueExpression", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->NewValueExpression" }, "oldValueExpression": { "title": "oldValueExpression", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->OldValueExpression" }, "repeatNotification": { "title": "repeatNotification", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "ChangeDataTriggerCriteria->RepeatNotification", "x-NullExpression": "ChangeDataTriggerCriteria->FilterExpression eq null" }, "repeatNotificationLimit": { "title": "repeatNotificationLimit", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "ChangeDataTriggerCriteria->RepeatNotificationLimit", "x-MinValueExpression": "ChangeDataTriggerCriteria->RepeatNotificationLimit ne null" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateChangeDataTriggerCriteriaResourceActionRequest": { "title": "UpdateChangeDataTriggerCriteriaResourceActionRequest", "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": "changeDataTriggerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeDataTrigger_Id" }, { "title": "triggerProperties", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "ChangeDataTriggerCriteria->TriggerProperties", "x-formatSpecifier": "String" }, { "title": "description", "type": "string", "maxLength": 255, "minLength": 1, "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->Description" }, { "title": "changeType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->ChangeType", "x-formatSpecifier": "EditState" }, { "title": "filterExpression", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->FilterExpression" }, { "title": "newValueExpression", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->NewValueExpression" }, { "title": "oldValueExpression", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->OldValueExpression" }, { "title": "repeatNotification", "type": "string", "format": "duration", "x-nullable": true, "example": "P4DT12H30M5S", "x-propertyPath": "ChangeDataTriggerCriteria->RepeatNotification", "x-NullExpression": "ChangeDataTriggerCriteria->FilterExpression eq null" }, { "title": "repeatNotificationLimit", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": true, "exclusiveMinimum": true, "x-propertyPath": "ChangeDataTriggerCriteria->RepeatNotificationLimit", "x-MinValueExpression": "ChangeDataTriggerCriteria->RepeatNotificationLimit ne null" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteria->Notes" } ] } } }, "DeleteChangeDataTriggerCriteriaResourceActionRequest": { "title": "DeleteChangeDataTriggerCriteriaResourceActionRequest", "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 } } }, "BatchGetChangeDataTriggerCriteriaResourceAction": { "title": "BatchGetChangeDataTriggerCriteriaResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Change Data Trigger Criteria entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Change Data Trigger Criteria entities", "items": { "$ref": "#/definitions/GetChangeDataTriggerCriteriaResourceActionResponse" } }, "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" } } }, "BatchCreateChangeDataTriggerCriteriaResourceActionRequest": { "title": "BatchCreateChangeDataTriggerCriteriaResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateChangeDataTriggerCriteriaResourceActionRequest" } }, "BatchUpdateChangeDataTriggerCriteriaResourceActionRequest": { "title": "BatchUpdateChangeDataTriggerCriteriaResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateChangeDataTriggerCriteriaResourceActionRequest" } }, "BatchDeleteChangeDataTriggerCriteriaResourceActionRequest": { "title": "BatchDeleteChangeDataTriggerCriteriaResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteChangeDataTriggerCriteriaResourceActionRequest" } }, "ChangeChangeDataTriggerCriteriaIsActiveResourceActionRequest": { "title": "ChangeChangeDataTriggerCriteriaIsActiveResourceActionRequest", "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": "ChangeDataTriggerCriteria->IsActive" } ] } } }, "ChangeChangeDataTriggerCriteriaPermissionTreeResourceActionRequest": { "title": "ChangeChangeDataTriggerCriteriaPermissionTreeResourceActionRequest", "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": "ChangeDataTriggerCriteria->PermissionTree_Id" } ] } } }, "BatchChangeChangeDataTriggerCriteriaIsActiveResourceActionRequest": { "title": "BatchChangeChangeDataTriggerCriteriaIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeChangeDataTriggerCriteriaIsActiveResourceActionRequest" } }, "BatchChangeChangeDataTriggerCriteriaPermissionTreeResourceActionRequest": { "title": "BatchChangeChangeDataTriggerCriteriaPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeChangeDataTriggerCriteriaPermissionTreeResourceActionRequest" } }, "GetChangeDataTriggerCriteriaEvaluationCollectionResourceActionResponse": { "title": "GetChangeDataTriggerCriteriaEvaluationCollectionResourceActionResponse", "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": "GetChangeDataTriggerCriteriaEvaluationCollectionResourceActionResponseItem", "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": "GetChangeDataTriggerCriteriaEvaluationCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaEvaluation->EntityType", "x-formatSpecifier": "EntityType" }, "entityId": { "title": "entityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaEvaluation->EntityId" }, "changeDataTriggerCode": { "title": "changeDataTriggerCode", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaEvaluation->ChangeDataTrigger_Code" }, "changeDataTriggerCriteriaDescription": { "title": "changeDataTriggerCriteriaDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaEvaluation->ChangeDataTriggerCriteria_Description" }, "evaluationAborted": { "title": "evaluationAborted", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaEvaluation->EvaluationAborted" }, "criteriaPropertiesMatched": { "title": "criteriaPropertiesMatched", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaEvaluation->CriteriaPropertiesMatched" }, "filterExpressionMatched": { "title": "filterExpressionMatched", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaEvaluation->FilterExpressionMatched" }, "oldValueExpressionMatched": { "title": "oldValueExpressionMatched", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaEvaluation->OldValueExpressionMatched" }, "newValueExpressionMatched": { "title": "newValueExpressionMatched", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaEvaluation->NewValueExpressionMatched" }, "triggerCriteriaEvalMatched": { "title": "triggerCriteriaEvalMatched", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaEvaluation->TriggerCriteriaEvalMatched" }, "evaluatedOn": { "title": "evaluatedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataTriggerCriteriaEvaluation->EvaluatedOn" } } }, "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" } } } }, "GetChangeDataTriggerCriteriaParameterResourceActionResponse": { "title": "GetChangeDataTriggerCriteriaParameterResourceActionResponse", "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": "GetChangeDataTriggerCriteriaParameterResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataTriggerCriteriaParameter->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->PermissionTree_Description" }, "changeDataTriggerCriteriaId": { "title": "changeDataTriggerCriteriaId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ChangeDataTriggerCriteria_Id" }, "changeDataTriggerCriteriaDescription": { "title": "changeDataTriggerCriteriaDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ChangeDataTriggerCriteria_Description" }, "expressionType": { "title": "expressionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ExpressionType", "x-formatSpecifier": "ExpressionTypeType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->Notes" }, "parameterName": { "title": "parameterName", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ParameterName" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "ChangeDataTriggerCriteriaParameter->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" } } }, "GetChangeDataTriggerCriteriaParameterCollectionResourceActionResponse": { "title": "GetChangeDataTriggerCriteriaParameterCollectionResourceActionResponse", "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": "GetChangeDataTriggerCriteriaParameterCollectionResourceActionResponseItem", "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": "GetChangeDataTriggerCriteriaParameterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "parameterName": { "title": "parameterName", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ParameterName" }, "expressionType": { "title": "expressionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ExpressionType", "x-formatSpecifier": "ExpressionTypeType" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "ChangeDataTriggerCriteriaParameter->Value", "x-formatSpecifier": "DynamicValue" }, "changeDataTriggerCriteriaId": { "title": "changeDataTriggerCriteriaId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ChangeDataTriggerCriteria_Id" }, "changeDataTriggerCriteriaDescription": { "title": "changeDataTriggerCriteriaDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ChangeDataTriggerCriteria_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" } } } }, "GetChangeDataTriggerCriteriaParameterForChangeDataTriggerCriteriaCollectionResourceActionResponse": { "title": "GetChangeDataTriggerCriteriaParameterForChangeDataTriggerCriteriaCollectionResourceActionResponse", "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": "GetChangeDataTriggerCriteriaParameterForChangeDataTriggerCriteriaCollectionResourceActionResponseItem", "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": "GetChangeDataTriggerCriteriaParameterForChangeDataTriggerCriteriaCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "changeDataTriggerCriteriaId": { "title": "changeDataTriggerCriteriaId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ChangeDataTriggerCriteria_Id" }, "changeDataTriggerCriteriaDescription": { "title": "changeDataTriggerCriteriaDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ChangeDataTriggerCriteria_Description" }, "expressionType": { "title": "expressionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ExpressionType", "x-formatSpecifier": "ExpressionTypeType" }, "parameterName": { "title": "parameterName", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ParameterName" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "ChangeDataTriggerCriteriaParameter->Value", "x-formatSpecifier": "DynamicValue" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->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" } } } }, "ChangeDataTriggerCriteriaParametersChangeDataTriggerLookupResourceActionResponse": { "title": "ChangeDataTriggerCriteriaParametersChangeDataTriggerLookupResourceActionResponse", "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": "ChangeDataTriggerCriteriaParametersChangeDataTriggerLookupResourceActionResponseItem", "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": "ChangeDataTriggerCriteriaParametersChangeDataTriggerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteria->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" } } } }, "ChangeDataTriggerCriteriaParameterChangePermissionTreeLookupResourceActionResponse": { "title": "ChangeDataTriggerCriteriaParameterChangePermissionTreeLookupResourceActionResponse", "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": "ChangeDataTriggerCriteriaParameterChangePermissionTreeLookupResourceActionResponseItem", "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": "ChangeDataTriggerCriteriaParameterChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ChangeDataTriggerCriteriaParameterInsertPermissionTreeLookupResourceActionResponse": { "title": "ChangeDataTriggerCriteriaParameterInsertPermissionTreeLookupResourceActionResponse", "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": "ChangeDataTriggerCriteriaParameterInsertPermissionTreeLookupResourceActionResponseItem", "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": "ChangeDataTriggerCriteriaParameterInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateChangeDataTriggerCriteriaParameterResourceActionRequest": { "title": "CreateChangeDataTriggerCriteriaParameterResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateChangeDataTriggerCriteriaParameterResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "parameterName", "expressionType", "value", "changeDataTriggerCriteriaId" ], "properties": { "parameterName": { "title": "parameterName", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ParameterName" }, "expressionType": { "title": "expressionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ExpressionType", "x-formatSpecifier": "ExpressionTypeType" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->PermissionTree_Id", "x-systemGenerated": true }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "ChangeDataTriggerCriteriaParameter->Value", "x-formatSpecifier": "DynamicValue" }, "changeDataTriggerCriteriaId": { "title": "changeDataTriggerCriteriaId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ChangeDataTriggerCriteria_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateChangeDataTriggerCriteriaParameterResourceActionRequest": { "title": "UpdateChangeDataTriggerCriteriaParameterResourceActionRequest", "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": "parameterName", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ParameterName" }, { "title": "expressionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->ExpressionType", "x-formatSpecifier": "ExpressionTypeType" }, { "title": "value", "format": "composite", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerCriteriaParameter->Notes" } ] } } }, "DeleteChangeDataTriggerCriteriaParameterResourceActionRequest": { "title": "DeleteChangeDataTriggerCriteriaParameterResourceActionRequest", "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 } } }, "BatchGetChangeDataTriggerCriteriaParameterResourceAction": { "title": "BatchGetChangeDataTriggerCriteriaParameterResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Change Data Trigger Criteria Parameter entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Change Data Trigger Criteria Parameter entities", "items": { "$ref": "#/definitions/GetChangeDataTriggerCriteriaParameterResourceActionResponse" } }, "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" } } }, "BatchCreateChangeDataTriggerCriteriaParameterRequest": { "title": "BatchCreateChangeDataTriggerCriteriaParameterRequest", "type": "array", "items": { "$ref": "#/definitions/CreateChangeDataTriggerCriteriaParameterResourceActionRequest" } }, "BatchUpdateChangeDataTriggerCriteriaParameterResourceActionRequest": { "title": "BatchUpdateChangeDataTriggerCriteriaParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateChangeDataTriggerCriteriaParameterResourceActionRequest" } }, "BatchDeleteChangeDataTriggerCriteriaParameterResourceActionRequest": { "title": "BatchDeleteChangeDataTriggerCriteriaParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteChangeDataTriggerCriteriaParameterResourceActionRequest" } }, "ChangeChangeDataTriggerCriteriaParameterIsActiveResourceActionRequest": { "title": "ChangeChangeDataTriggerCriteriaParameterIsActiveResourceActionRequest", "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": "ChangeDataTriggerCriteriaParameter->IsActive" } ] } } }, "ChangeChangeDataTriggerCriteriaParameterPermissionTreeResourceActionRequest": { "title": "ChangeChangeDataTriggerCriteriaParameterPermissionTreeResourceActionRequest", "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": "ChangeDataTriggerCriteriaParameter->PermissionTree_Id" } ] } } }, "BatchChangeChangeDataTriggerCriteriaParameterIsActiveResourceActionRequest": { "title": "BatchChangeChangeDataTriggerCriteriaParameterIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeChangeDataTriggerCriteriaParameterIsActiveResourceActionRequest" } }, "BatchChangeChangeDataTriggerCriteriaParameterPermissionTreeResourceActionRequest": { "title": "BatchChangeChangeDataTriggerCriteriaParameterPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeChangeDataTriggerCriteriaParameterPermissionTreeResourceActionRequest" } }, "GetChangeDataTriggerNotificationEventResourceActionResponse": { "title": "GetChangeDataTriggerNotificationEventResourceActionResponse", "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": "GetChangeDataTriggerNotificationEventResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataTriggerNotificationEvent->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataTriggerNotificationEvent->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->PermissionTree_Description" }, "audience": { "title": "audience", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "string" }, "x-propertyPath": "ChangeDataTriggerNotificationEvent->Audience", "x-formatSpecifier": "String", "x-NullExpression": "ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience eq TRUE" }, "changeDataTriggerId": { "title": "changeDataTriggerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Id" }, "changeDataTriggerCode": { "title": "changeDataTriggerCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Code" }, "changeDataTriggerDescription": { "title": "changeDataTriggerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Description" }, "ignoreTemplateAudience": { "title": "ignoreTemplateAudience", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->Notes" }, "notificationTemplateId": { "title": "notificationTemplateId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->NotificationTemplate_Id" }, "notificationTemplateCode": { "title": "notificationTemplateCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->NotificationTemplate_Code" }, "notificationTemplateDescription": { "title": "notificationTemplateDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->NotificationTemplate_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->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" } } }, "GetChangeDataTriggerNotificationEventCollectionResourceActionResponse": { "title": "GetChangeDataTriggerNotificationEventCollectionResourceActionResponse", "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": "GetChangeDataTriggerNotificationEventCollectionResourceActionResponseItem", "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": "GetChangeDataTriggerNotificationEventCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "changeDataTriggerId": { "title": "changeDataTriggerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Id" }, "changeDataTriggerCode": { "title": "changeDataTriggerCode", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Code" }, "changeDataTriggerDescription": { "title": "changeDataTriggerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Description" }, "notificationTemplateId": { "title": "notificationTemplateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->NotificationTemplate_Id" }, "notificationTemplateCode": { "title": "notificationTemplateCode", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->NotificationTemplate_Code" }, "notificationTemplateDescription": { "title": "notificationTemplateDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->NotificationTemplate_Description" }, "ignoreTemplateAudience": { "title": "ignoreTemplateAudience", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience" }, "audience": { "title": "audience", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "string" }, "x-propertyPath": "ChangeDataTriggerNotificationEvent->Audience", "x-formatSpecifier": "String", "x-NullExpression": "ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience eq TRUE" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->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" } } } }, "GetChangeDataTriggerNotificationEventForChangeDataTriggerCollectionResourceActionResponse": { "title": "GetChangeDataTriggerNotificationEventForChangeDataTriggerCollectionResourceActionResponse", "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": "GetChangeDataTriggerNotificationEventForChangeDataTriggerCollectionResourceActionResponseItem", "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": "GetChangeDataTriggerNotificationEventForChangeDataTriggerCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "changeDataTriggerId": { "title": "changeDataTriggerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Id" }, "changeDataTriggerCode": { "title": "changeDataTriggerCode", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Code" }, "changeDataTriggerDescription": { "title": "changeDataTriggerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Description" }, "notificationTemplateId": { "title": "notificationTemplateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->NotificationTemplate_Id" }, "notificationTemplateCode": { "title": "notificationTemplateCode", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->NotificationTemplate_Code" }, "notificationTemplateDescription": { "title": "notificationTemplateDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->NotificationTemplate_Description" }, "ignoreTemplateAudience": { "title": "ignoreTemplateAudience", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience" }, "audience": { "title": "audience", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "string" }, "x-propertyPath": "ChangeDataTriggerNotificationEvent->Audience", "x-formatSpecifier": "String", "x-NullExpression": "ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience eq TRUE" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->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" } } } }, "ChangeDataTriggerNotificationEventChangeDataTriggerLookupResourceActionResponse": { "title": "ChangeDataTriggerNotificationEventChangeDataTriggerLookupResourceActionResponse", "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": "ChangeDataTriggerNotificationEventChangeDataTriggerLookupResourceActionResponseItem", "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": "ChangeDataTriggerNotificationEventChangeDataTriggerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->Description" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTrigger->EntityType", "x-formatSpecifier": "EntityType" } } }, "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" } } } }, "ChangeDataTriggerNotificationEventChangePermissionTreeLookupResourceActionResponse": { "title": "ChangeDataTriggerNotificationEventChangePermissionTreeLookupResourceActionResponse", "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": "ChangeDataTriggerNotificationEventChangePermissionTreeLookupResourceActionResponseItem", "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": "ChangeDataTriggerNotificationEventChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ChangeDataTriggerNotificationEventInsertPermissionTreeLookupResourceActionResponse": { "title": "ChangeDataTriggerNotificationEventInsertPermissionTreeLookupResourceActionResponse", "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": "ChangeDataTriggerNotificationEventInsertPermissionTreeLookupResourceActionResponseItem", "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": "ChangeDataTriggerNotificationEventInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ChangeDataTriggerNotificationNotificationTemplateTemplateLookupResourceActionResponse": { "title": "ChangeDataTriggerNotificationNotificationTemplateTemplateLookupResourceActionResponse", "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": "ChangeDataTriggerNotificationNotificationTemplateTemplateLookupResourceActionResponseItem", "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": "ChangeDataTriggerNotificationNotificationTemplateTemplateLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->Description" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationTemplate->EntityType", "x-formatSpecifier": "EntityType" } } }, "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" } } } }, "CreateChangeDataTriggerNotificationEventResourceActionRequest": { "title": "CreateChangeDataTriggerNotificationEventResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateChangeDataTriggerNotificationEventResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "changeDataTriggerId", "notificationTemplateId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->PermissionTree_Id", "x-systemGenerated": true }, "changeDataTriggerId": { "title": "changeDataTriggerId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Id" }, "notificationTemplateId": { "title": "notificationTemplateId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->NotificationTemplate_Id" }, "ignoreTemplateAudience": { "title": "ignoreTemplateAudience", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience" }, "audience": { "title": "audience", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "string" }, "x-propertyPath": "ChangeDataTriggerNotificationEvent->Audience", "x-formatSpecifier": "String", "x-NullExpression": "ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience eq TRUE" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateChangeDataTriggerNotificationEventResourceActionRequest": { "title": "UpdateChangeDataTriggerNotificationEventResourceActionRequest", "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": "ignoreTemplateAudience", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience" }, { "title": "audience", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "string" }, "x-propertyPath": "ChangeDataTriggerNotificationEvent->Audience", "x-formatSpecifier": "String", "x-NullExpression": "ChangeDataTriggerNotificationEvent->IgnoreTemplateAudience eq TRUE" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->Notes" } ] } } }, "DeleteChangeDataTriggerNotificationEventResourceActionRequest": { "title": "DeleteChangeDataTriggerNotificationEventResourceActionRequest", "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 } } }, "BatchGetChangeDataTriggerNotificationEventResourceAction": { "title": "BatchGetChangeDataTriggerNotificationEventResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Change Data Trigger Notification Event entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Change Data Trigger Notification Event entities", "items": { "$ref": "#/definitions/GetChangeDataTriggerNotificationEventResourceActionResponse" } }, "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" } } }, "BatchCreateChangeDataTriggerNotificationEventResourceActionRequest": { "title": "BatchCreateChangeDataTriggerNotificationEventResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateChangeDataTriggerNotificationEventResourceActionRequest" } }, "BatchUpdateChangeDataTriggerNotificationEventResourceActionRequest": { "title": "BatchUpdateChangeDataTriggerNotificationEventResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateChangeDataTriggerNotificationEventResourceActionRequest" } }, "BatchDeleteChangeDataTriggerNotificationEventResourceActionRequest": { "title": "BatchDeleteChangeDataTriggerNotificationEventResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteChangeDataTriggerNotificationEventResourceActionRequest" } }, "ChangeChangeDataTriggerNotificationEventIsActiveResourceActionRequest": { "title": "ChangeChangeDataTriggerNotificationEventIsActiveResourceActionRequest", "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": "ChangeDataTriggerNotificationEvent->IsActive" } ] } } }, "ChangeChangeDataTriggerNotificationEventPermissionTreeResourceActionRequest": { "title": "ChangeChangeDataTriggerNotificationEventPermissionTreeResourceActionRequest", "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": "ChangeDataTriggerNotificationEvent->PermissionTree_Id" } ] } } }, "BatchChangeChangeDataTriggerNotificationEventPermissionTreeResourceActionRequest": { "title": "BatchChangeChangeDataTriggerNotificationEventPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeChangeDataTriggerNotificationEventPermissionTreeResourceActionRequest" } }, "BatchChangeChangeDataTriggerNotificationEventIsActiveResourceActionRequest": { "title": "BatchChangeChangeDataTriggerNotificationEventIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeChangeDataTriggerNotificationEventIsActiveResourceActionRequest" } }, "GetChangeDataTriggerNotificationEventAttachmentResourceActionResponse": { "title": "GetChangeDataTriggerNotificationEventAttachmentResourceActionResponse", "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": "GetChangeDataTriggerNotificationEventAttachmentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->PermissionTree_Description" }, "attachmentType": { "title": "attachmentType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->AttachmentType", "x-formatSpecifier": "AttachmentType" }, "changeDataTriggerNotificationEventId": { "title": "changeDataTriggerNotificationEventId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_Id" }, "changeDataTriggerNotificationEventChangeDataTriggerId": { "title": "changeDataTriggerNotificationEventChangeDataTriggerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_ChangeDataTrigger_Id" }, "changeDataTriggerNotificationEventChangeDataTriggerCode": { "title": "changeDataTriggerNotificationEventChangeDataTriggerCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_ChangeDataTrigger_Code" }, "changeDataTriggerNotificationEventChangeDataTriggerDescription": { "title": "changeDataTriggerNotificationEventChangeDataTriggerDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_ChangeDataTrigger_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->Notes" }, "reportFormat": { "title": "reportFormat", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ReportFormat", "x-formatSpecifier": "ReportFormat", "x-NullExpression": "ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report'" }, "reportName": { "title": "reportName", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ReportName", "x-NullExpression": "ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report'" }, "reportUserFullName": { "title": "reportUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ReportUserFullName" }, "reportUserId": { "title": "reportUserId", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ReportUserId", "x-NullExpression": "ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false" }, "reportUserName": { "title": "reportUserName", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ReportUserName", "x-NullExpression": "ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false" }, "runAsAdminUser": { "title": "runAsAdminUser", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->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" } } }, "GetChangeDataTriggerNotificationEventAttachmentCollectionResourceActionResponse": { "title": "GetChangeDataTriggerNotificationEventAttachmentCollectionResourceActionResponse", "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": "GetChangeDataTriggerNotificationEventAttachmentCollectionResourceActionResponseItem", "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": "GetChangeDataTriggerNotificationEventAttachmentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->Code" }, "reportName": { "title": "reportName", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ReportName", "x-NullExpression": "ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report'" }, "attachmentType": { "title": "attachmentType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->AttachmentType", "x-formatSpecifier": "AttachmentType" }, "runAsAdminUser": { "title": "runAsAdminUser", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->IsActive" }, "changeDataTriggerNotificationEventChangeDataTriggerId": { "title": "changeDataTriggerNotificationEventChangeDataTriggerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_ChangeDataTrigger_Id" }, "changeDataTriggerNotificationEventChangeDataTriggerCode": { "title": "changeDataTriggerNotificationEventChangeDataTriggerCode", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_ChangeDataTrigger_Code" }, "changeDataTriggerNotificationEventChangeDataTriggerDescription": { "title": "changeDataTriggerNotificationEventChangeDataTriggerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_ChangeDataTrigger_Description" }, "changeDataTriggerNotificationEventNotificationTemplateId": { "title": "changeDataTriggerNotificationEventNotificationTemplateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_NotificationTemplate_Id" }, "changeDataTriggerNotificationEventNotificationTemplateCode": { "title": "changeDataTriggerNotificationEventNotificationTemplateCode", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_NotificationTemplate_Code" }, "changeDataTriggerNotificationEventNotificationTemplateDescription": { "title": "changeDataTriggerNotificationEventNotificationTemplateDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_NotificationTemplate_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" } } } }, "GetChangeDataTriggerNotificationEventAttachmentForChangeDataTriggerNotificationEventCollectionResourceActionResponse": { "title": "GetChangeDataTriggerNotificationEventAttachmentForChangeDataTriggerNotificationEventCollectionResourceActionResponse", "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": "GetChangeDataTriggerNotificationEventAttachmentForChangeDataTriggerNotificationEventCollectionResourceActionResponseItem", "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": "GetChangeDataTriggerNotificationEventAttachmentForChangeDataTriggerNotificationEventCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "reportName": { "title": "reportName", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ReportName", "x-NullExpression": "ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report'" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->Code" }, "attachmentType": { "title": "attachmentType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->AttachmentType", "x-formatSpecifier": "AttachmentType" }, "runAsAdminUser": { "title": "runAsAdminUser", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->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" } } } }, "ChangeDataTriggerNotificationEventAttachmentInsertPermissionTreeLookupResourceActionResponse": { "title": "ChangeDataTriggerNotificationEventAttachmentInsertPermissionTreeLookupResourceActionResponse", "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": "ChangeDataTriggerNotificationEventAttachmentInsertPermissionTreeLookupResourceActionResponseItem", "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": "ChangeDataTriggerNotificationEventAttachmentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ChangeDataTriggerNotificationEventAttachmentChangeDataTriggerNotificationEventLookupResourceActionResponse": { "title": "ChangeDataTriggerNotificationEventAttachmentChangeDataTriggerNotificationEventLookupResourceActionResponse", "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": "ChangeDataTriggerNotificationEventAttachmentChangeDataTriggerNotificationEventLookupResourceActionResponseItem", "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": "ChangeDataTriggerNotificationEventAttachmentChangeDataTriggerNotificationEventLookupResourceActionResponseItemProperties", "type": "object", "properties": { "changeDataTriggerId": { "title": "changeDataTriggerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Id" }, "changeDataTriggerCode": { "title": "changeDataTriggerCode", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Code" }, "changeDataTriggerDescription": { "title": "changeDataTriggerDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->ChangeDataTrigger_Description" }, "notificationTemplateId": { "title": "notificationTemplateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEvent->NotificationTemplate_Id" }, "notificationTemplateCode": { "title": "notificationTemplateCode", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->NotificationTemplate_Code" }, "notificationTemplateDescription": { "title": "notificationTemplateDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEvent->NotificationTemplate_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" } } } }, "ChangeDataTriggerNotificationEventAttachmentChangePermissionTreeLookupResourceActionResponse": { "title": "ChangeDataTriggerNotificationEventAttachmentChangePermissionTreeLookupResourceActionResponse", "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": "ChangeDataTriggerNotificationEventAttachmentChangePermissionTreeLookupResourceActionResponseItem", "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": "ChangeDataTriggerNotificationEventAttachmentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ChangeDataTriggerNotificationEventAttachmentReportLookupResourceActionResponse": { "title": "ChangeDataTriggerNotificationEventAttachmentReportLookupResourceActionResponse", "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": "ChangeDataTriggerNotificationEventAttachmentReportLookupResourceActionResponseItem", "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": "ChangeDataTriggerNotificationEventAttachmentReportLookupResourceActionResponseItemProperties", "type": "object", "properties": { "title": { "title": "title", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerReport->Title" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerReport->Description" }, "category": { "title": "category", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerReport->Category" } } }, "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" } } } }, "ChangeDataTriggerNotificationEventAttachmentReportUserLookupResourceActionResponse": { "title": "ChangeDataTriggerNotificationEventAttachmentReportUserLookupResourceActionResponse", "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": "ChangeDataTriggerNotificationEventAttachmentReportUserLookupResourceActionResponseItem", "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": "ChangeDataTriggerNotificationEventAttachmentReportUserLookupResourceActionResponseItemProperties", "type": "object", "properties": { "email": { "title": "email", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerUser->Email" }, "firstName": { "title": "firstName", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerUser->FirstName" }, "lastName": { "title": "lastName", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerUser->LastName" }, "fullName": { "title": "fullName", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerUser->FullName" }, "userName": { "title": "userName", "type": "string", "x-nullable": true, "x-propertyPath": "ReportServerUser->UserName" } } }, "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" } } } }, "CreateChangeDataTriggerNotificationEventAttachmentResourceActionRequest": { "title": "CreateChangeDataTriggerNotificationEventAttachmentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateChangeDataTriggerNotificationEventAttachmentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "changeDataTriggerNotificationEventId", "code", "attachmentType" ], "properties": { "changeDataTriggerNotificationEventId": { "title": "changeDataTriggerNotificationEventId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ChangeDataTriggerNotificationEvent_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->PermissionTree_Id", "x-systemGenerated": true }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->Code" }, "attachmentType": { "title": "attachmentType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->AttachmentType", "x-formatSpecifier": "AttachmentType" }, "reportName": { "title": "reportName", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ReportName", "x-NullExpression": "ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report'" }, "reportFormat": { "title": "reportFormat", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ReportFormat", "x-formatSpecifier": "ReportFormat", "x-NullExpression": "ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report'" }, "runAsAdminUser": { "title": "runAsAdminUser", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser" }, "reportPassword": { "title": "reportPassword", "type": "string", "format": "password", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ReportPassword", "x-NullExpression": "ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false" }, "reportUserId": { "title": "reportUserId", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ReportUserId", "x-NullExpression": "ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateChangeDataTriggerNotificationEventAttachmentResourceActionRequest": { "title": "UpdateChangeDataTriggerNotificationEventAttachmentResourceActionRequest", "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", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->Code" }, { "title": "reportName", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ReportName", "x-NullExpression": "ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report'" }, { "title": "reportFormat", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ReportFormat", "x-formatSpecifier": "ReportFormat", "x-NullExpression": "ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report'" }, { "title": "runAsAdminUser", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser" }, { "title": "reportPassword", "type": "string", "format": "password", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ReportPassword", "x-NullExpression": "ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false" }, { "title": "reportUserId", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ReportUserId", "x-NullExpression": "ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report' and ChangeDataTriggerNotificationEventAttachment->RunAsAdminUser eq false" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->Notes" } ] } } }, "DeleteChangeDataTriggerNotificationEventAttachmentResourceActionRequest": { "title": "DeleteChangeDataTriggerNotificationEventAttachmentResourceActionRequest", "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 } } }, "BatchGetChangeDataTriggerNotificationEventAttachmentResourceAction": { "title": "BatchGetChangeDataTriggerNotificationEventAttachmentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Change Data Trigger Notification Event Attachment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Change Data Trigger Notification Event Attachment entities", "items": { "$ref": "#/definitions/GetChangeDataTriggerNotificationEventAttachmentResourceActionResponse" } }, "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" } } }, "BatchCreateChangeDataTriggerNotificationEventAttachmentResourceActionRequest": { "title": "BatchCreateChangeDataTriggerNotificationEventAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateChangeDataTriggerNotificationEventAttachmentResourceActionRequest" } }, "BatchUpdateChangeDataTriggerNotificationEventAttachmentResourceActionRequest": { "title": "BatchUpdateChangeDataTriggerNotificationEventAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateChangeDataTriggerNotificationEventAttachmentResourceActionRequest" } }, "BatchDeleteChangeDataTriggerNotificationEventAttachmentResourceActionRequest": { "title": "BatchDeleteChangeDataTriggerNotificationEventAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteChangeDataTriggerNotificationEventAttachmentResourceActionRequest" } }, "ChangeChangeDataTriggerNotificationEventAttachmentIsActiveResourceActionRequest": { "title": "ChangeChangeDataTriggerNotificationEventAttachmentIsActiveResourceActionRequest", "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": "ChangeDataTriggerNotificationEventAttachment->IsActive" } ] } } }, "ChangeChangeDataTriggerNotificationEventAttachmentPermissionTreeResourceActionRequest": { "title": "ChangeChangeDataTriggerNotificationEventAttachmentPermissionTreeResourceActionRequest", "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": "ChangeDataTriggerNotificationEventAttachment->PermissionTree_Id" } ] } } }, "BatchChangeChangeDataTriggerNotificationEventAttachmentIsActiveResourceActionRequest": { "title": "BatchChangeChangeDataTriggerNotificationEventAttachmentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeChangeDataTriggerNotificationEventAttachmentIsActiveResourceActionRequest" } }, "BatchChangeChangeDataTriggerNotificationEventAttachmentPermissionTreeResourceActionRequest": { "title": "BatchChangeChangeDataTriggerNotificationEventAttachmentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeChangeDataTriggerNotificationEventAttachmentPermissionTreeResourceActionRequest" } }, "GetChangeDataTriggerNotificationEventAttachmentParameterResourceActionResponse": { "title": "GetChangeDataTriggerNotificationEventAttachmentParameterResourceActionResponse", "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": "GetChangeDataTriggerNotificationEventAttachmentParameterResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->PermissionTree_Description" }, "changeDataTriggerNotificationEventAttachmentId": { "title": "changeDataTriggerNotificationEventAttachmentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_Id" }, "changeDataTriggerNotificationEventAttachmentCode": { "title": "changeDataTriggerNotificationEventAttachmentCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_Code" }, "changeDataTriggerNotificationEventAttachmentReportName": { "title": "changeDataTriggerNotificationEventAttachmentReportName", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_ReportName" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->Notes" }, "parameterName": { "title": "parameterName", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->ParameterName" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->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" } } }, "GetChangeDataTriggerNotificationEventAttachmentParameterForChangeDataTriggerNotificationEventAttachmentCollectionResourceActionResponse": { "title": "GetChangeDataTriggerNotificationEventAttachmentParameterForChangeDataTriggerNotificationEventAttachmentCollectionResourceActionResponse", "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": "GetChangeDataTriggerNotificationEventAttachmentParameterForChangeDataTriggerNotificationEventAttachmentCollectionResourceActionResponseItem", "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": "GetChangeDataTriggerNotificationEventAttachmentParameterForChangeDataTriggerNotificationEventAttachmentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "changeDataTriggerNotificationEventAttachmentId": { "title": "changeDataTriggerNotificationEventAttachmentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_Id" }, "changeDataTriggerNotificationEventAttachmentCode": { "title": "changeDataTriggerNotificationEventAttachmentCode", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_Code" }, "parameterName": { "title": "parameterName", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->ParameterName" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->Value", "x-formatSpecifier": "DynamicValue" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->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" } } } }, "GetChangeDataTriggerNotificationEventAttachmentParameterCollectionResourceActionResponse": { "title": "GetChangeDataTriggerNotificationEventAttachmentParameterCollectionResourceActionResponse", "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": "GetChangeDataTriggerNotificationEventAttachmentParameterCollectionResourceActionResponseItem", "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": "GetChangeDataTriggerNotificationEventAttachmentParameterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "parameterName": { "title": "parameterName", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->ParameterName" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->Value", "x-formatSpecifier": "DynamicValue" }, "changeDataTriggerNotificationEventAttachmentId": { "title": "changeDataTriggerNotificationEventAttachmentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_Id" }, "changeDataTriggerNotificationEventAttachmentCode": { "title": "changeDataTriggerNotificationEventAttachmentCode", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_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" } } } }, "ChangeDataTriggerNotificationEventAttachmentParameterChangePermissionTreeLookupResourceActionResponse": { "title": "ChangeDataTriggerNotificationEventAttachmentParameterChangePermissionTreeLookupResourceActionResponse", "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": "ChangeDataTriggerNotificationEventAttachmentParameterChangePermissionTreeLookupResourceActionResponseItem", "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": "ChangeDataTriggerNotificationEventAttachmentParameterChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ChangeDataTriggerNotificationEventAttachmentParameterInsertPermissionTreeLookupResourceActionResponse": { "title": "ChangeDataTriggerNotificationEventAttachmentParameterInsertPermissionTreeLookupResourceActionResponse", "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": "ChangeDataTriggerNotificationEventAttachmentParameterInsertPermissionTreeLookupResourceActionResponseItem", "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": "ChangeDataTriggerNotificationEventAttachmentParameterInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ChangeDataTriggerNotificationEventAttachmentParameterChangeDataTriggerNotificationEventAttachmentLookupResourceActionResponse": { "title": "ChangeDataTriggerNotificationEventAttachmentParameterChangeDataTriggerNotificationEventAttachmentLookupResourceActionResponse", "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": "ChangeDataTriggerNotificationEventAttachmentParameterChangeDataTriggerNotificationEventAttachmentLookupResourceActionResponseItem", "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": "ChangeDataTriggerNotificationEventAttachmentParameterChangeDataTriggerNotificationEventAttachmentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->Code" }, "reportName": { "title": "reportName", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachment->ReportName", "x-NullExpression": "ChangeDataTriggerNotificationEventAttachment->AttachmentType eq 'Report'" } } }, "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" } } } }, "CreateChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest": { "title": "CreateChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "parameterName", "value", "changeDataTriggerNotificationEventAttachmentId" ], "properties": { "parameterName": { "title": "parameterName", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->ParameterName" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->PermissionTree_Id", "x-systemGenerated": true }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->Value", "x-formatSpecifier": "DynamicValue" }, "changeDataTriggerNotificationEventAttachmentId": { "title": "changeDataTriggerNotificationEventAttachmentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->ChangeDataTriggerNotificationEventAttachment_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest": { "title": "UpdateChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest", "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": "parameterName", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->ParameterName" }, { "title": "value", "format": "composite", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerNotificationEventAttachmentParameter->Notes" } ] } } }, "DeleteChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest": { "title": "DeleteChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest", "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 } } }, "BatchGetChangeDataTriggerNotificationEventAttachmentParameterResourceAction": { "title": "BatchGetChangeDataTriggerNotificationEventAttachmentParameterResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Change Data Trigger Notification Event Attachment Parameter entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Change Data Trigger Notification Event Attachment Parameter entities", "items": { "$ref": "#/definitions/GetChangeDataTriggerNotificationEventAttachmentParameterResourceActionResponse" } }, "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" } } }, "BatchCreateChangeDataTriggerNotificationEventAttachmentParameterRequest": { "title": "BatchCreateChangeDataTriggerNotificationEventAttachmentParameterRequest", "type": "array", "items": { "$ref": "#/definitions/CreateChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest" } }, "BatchUpdateChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest": { "title": "BatchUpdateChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest" } }, "BatchDeleteChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest": { "title": "BatchDeleteChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteChangeDataTriggerNotificationEventAttachmentParameterResourceActionRequest" } }, "ChangeChangeDataTriggerNotificationEventAttachmentParameterIsActiveResourceActionRequest": { "title": "ChangeChangeDataTriggerNotificationEventAttachmentParameterIsActiveResourceActionRequest", "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": "ChangeDataTriggerNotificationEventAttachmentParameter->IsActive" } ] } } }, "ChangeChangeDataTriggerNotificationEventAttachmentParameterPermissionTreeResourceActionRequest": { "title": "ChangeChangeDataTriggerNotificationEventAttachmentParameterPermissionTreeResourceActionRequest", "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": "ChangeDataTriggerNotificationEventAttachmentParameter->PermissionTree_Id" } ] } } }, "BatchChangeChangeDataTriggerNotificationEventAttachmentParameterIsActiveResourceActionRequest": { "title": "BatchChangeChangeDataTriggerNotificationEventAttachmentParameterIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeChangeDataTriggerNotificationEventAttachmentParameterIsActiveResourceActionRequest" } }, "BatchChangeChangeDataTriggerNotificationEventAttachmentParameterPermissionTreeResourceActionRequest": { "title": "BatchChangeChangeDataTriggerNotificationEventAttachmentParameterPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeChangeDataTriggerNotificationEventAttachmentParameterPermissionTreeResourceActionRequest" } }, "GetChangeDataTriggerOccurrenceLogResourceActionResponse": { "title": "GetChangeDataTriggerOccurrenceLogResourceActionResponse", "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": "GetChangeDataTriggerOccurrenceLogResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "changeDataTriggerId": { "title": "changeDataTriggerId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerOccurrenceLog->ChangeDataTrigger_Id" }, "changeDataTriggerCode": { "title": "changeDataTriggerCode", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerOccurrenceLog->ChangeDataTrigger_Code" }, "changeDataTriggerCriteriaId": { "title": "changeDataTriggerCriteriaId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerOccurrenceLog->ChangeDataTriggerCriteria_Id" }, "changeDataTriggerCriteriaDescription": { "title": "changeDataTriggerCriteriaDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerOccurrenceLog->ChangeDataTriggerCriteria_Description" }, "entityId": { "title": "entityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerOccurrenceLog->EntityId" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerOccurrenceLog->EntityType", "x-formatSpecifier": "EntityType" }, "nextOccurrenceDate": { "title": "nextOccurrenceDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataTriggerOccurrenceLog->NextOccurrenceDate" }, "occurrenceDate": { "title": "occurrenceDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataTriggerOccurrenceLog->OccurrenceDate" }, "recurrenceActive": { "title": "recurrenceActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerOccurrenceLog->RecurrenceActive" }, "recurrenceCount": { "title": "recurrenceCount", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerOccurrenceLog->RecurrenceCount" } } }, "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" } } }, "GetChangeDataTriggerOccurrenceLogCollectionResourceActionResponse": { "title": "GetChangeDataTriggerOccurrenceLogCollectionResourceActionResponse", "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": "GetChangeDataTriggerOccurrenceLogCollectionResourceActionResponseItem", "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": "GetChangeDataTriggerOccurrenceLogCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerOccurrenceLog->EntityType", "x-formatSpecifier": "EntityType" }, "entityId": { "title": "entityId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ChangeDataTriggerOccurrenceLog->EntityId" }, "changeDataTriggerCode": { "title": "changeDataTriggerCode", "type": "string", "x-nullable": false, "x-propertyPath": "ChangeDataTriggerOccurrenceLog->ChangeDataTrigger_Code" }, "occurrenceDate": { "title": "occurrenceDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataTriggerOccurrenceLog->OccurrenceDate" }, "nextOccurrenceDate": { "title": "nextOccurrenceDate", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ChangeDataTriggerOccurrenceLog->NextOccurrenceDate" } } }, "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" } } } }, "BatchGetChangeDataTriggerOccurrenceLogResourceAction": { "title": "BatchGetChangeDataTriggerOccurrenceLogResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Change Data Trigger Occurrence Log entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Change Data Trigger Occurrence Log entities", "items": { "$ref": "#/definitions/GetChangeDataTriggerOccurrenceLogResourceActionResponse" } }, "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" } } }, "GetClassificationResourceActionResponse": { "title": "GetClassificationResourceActionResponse", "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": "GetClassificationResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Classification->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Classification->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Classification->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Classification->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Classification->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Classification->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Classification->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Classification->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Classification->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Classification->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Classification->PermissionTree_Description" }, "classificationNumber": { "title": "classificationNumber", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "Classification->ClassificationNumber" }, "classificationType": { "title": "classificationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Classification->ClassificationType", "x-formatSpecifier": "ClassificationType" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Classification->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Classification->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" } } }, "GetClassificationCollectionResourceActionResponse": { "title": "GetClassificationCollectionResourceActionResponse", "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": "GetClassificationCollectionResourceActionResponseItem", "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": "GetClassificationCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Classification->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "Classification->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Classification->PermissionTree_Description" }, "classificationType": { "title": "classificationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Classification->ClassificationType", "x-formatSpecifier": "ClassificationType" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Classification->Description" }, "classificationNumber": { "title": "classificationNumber", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "Classification->ClassificationNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Classification->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" } } } }, "ClassificationChangePermissionTreeLookupResourceActionResponse": { "title": "ClassificationChangePermissionTreeLookupResourceActionResponse", "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": "ClassificationChangePermissionTreeLookupResourceActionResponseItem", "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": "ClassificationChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "UpdateClassificationResourceActionRequest": { "title": "UpdateClassificationResourceActionRequest", "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": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Classification->Description" }, { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Classification->PermissionTree_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Classification->Notes" } ] } } }, "BatchGetClassificationResourceAction": { "title": "BatchGetClassificationResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Classification entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Classification entities", "items": { "$ref": "#/definitions/GetClassificationResourceActionResponse" } }, "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" } } }, "BatchUpdateClassificationResourceActionRequest": { "title": "BatchUpdateClassificationResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateClassificationResourceActionRequest" } }, "ChangeClassificationPermissionTreeResourceActionRequest": { "title": "ChangeClassificationPermissionTreeResourceActionRequest", "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": "Classification->PermissionTree_Id" } ] } } }, "BatchChangeClassificationPermissionTreeResourceActionRequest": { "title": "BatchChangeClassificationPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeClassificationPermissionTreeResourceActionRequest" } }, "GetClassificationAllowedValueResourceActionResponse": { "title": "GetClassificationAllowedValueResourceActionResponse", "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": "GetClassificationAllowedValueResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ClassificationAllowedValue->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ClassificationAllowedValue->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->PermissionTree_Description" }, "classificationId": { "title": "classificationId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Classification_Id" }, "classificationDescription": { "title": "classificationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->Classification_Description" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->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" } } }, "GetClassificationAllowedValueCollectionResourceActionResponse": { "title": "GetClassificationAllowedValueCollectionResourceActionResponse", "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": "GetClassificationAllowedValueCollectionResourceActionResponseItem", "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": "GetClassificationAllowedValueCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->IsActive" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->SequenceNumber" }, "classificationId": { "title": "classificationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->Classification_Id" }, "classificationClassificationType": { "title": "classificationClassificationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Classification_ClassificationType", "x-formatSpecifier": "ClassificationType" }, "classificationDescription": { "title": "classificationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Classification_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" } } } }, "GetClassificationAllowedValueForClassificationCollectionResourceActionResponse": { "title": "GetClassificationAllowedValueForClassificationCollectionResourceActionResponse", "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": "GetClassificationAllowedValueForClassificationCollectionResourceActionResponseItem", "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": "GetClassificationAllowedValueForClassificationCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->IsActive" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Description" }, "classificationId": { "title": "classificationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->Classification_Id" }, "classificationClassificationType": { "title": "classificationClassificationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Classification_ClassificationType", "x-formatSpecifier": "ClassificationType" }, "classificationDescription": { "title": "classificationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Classification_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->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" } } } }, "ClassificationAllowedValueChangePermissionTreeLookupResourceActionResponse": { "title": "ClassificationAllowedValueChangePermissionTreeLookupResourceActionResponse", "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": "ClassificationAllowedValueChangePermissionTreeLookupResourceActionResponseItem", "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": "ClassificationAllowedValueChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "ClassificationAllowedValueClassificationLookupResourceActionResponse": { "title": "ClassificationAllowedValueClassificationLookupResourceActionResponse", "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": "ClassificationAllowedValueClassificationLookupResourceActionResponseItem", "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": "ClassificationAllowedValueClassificationLookupResourceActionResponseItemProperties", "type": "object", "properties": { "classificationType": { "title": "classificationType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Classification->ClassificationType", "x-formatSpecifier": "ClassificationType" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Classification->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" } } } }, "ClassificationAllowedValueInsertPermissionTreeLookupResourceActionResponse": { "title": "ClassificationAllowedValueInsertPermissionTreeLookupResourceActionResponse", "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": "ClassificationAllowedValueInsertPermissionTreeLookupResourceActionResponseItem", "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": "ClassificationAllowedValueInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateClassificationAllowedValueResourceActionRequest": { "title": "CreateClassificationAllowedValueResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateClassificationAllowedValueResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "classificationId" ], "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" }, "classificationId": { "title": "classificationId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Classification_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateClassificationAllowedValueResourceActionRequest": { "title": "UpdateClassificationAllowedValueResourceActionRequest", "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", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Code" }, { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ClassificationAllowedValue->Description" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "ClassificationAllowedValue->SequenceNumber" } ] } } }, "DeleteClassificationAllowedValueResourceActionRequest": { "title": "DeleteClassificationAllowedValueResourceActionRequest", "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 } } }, "BatchGetClassificationAllowedValueResourceAction": { "title": "BatchGetClassificationAllowedValueResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Classification Allowed Value entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Classification Allowed Value entities", "items": { "$ref": "#/definitions/GetClassificationAllowedValueResourceActionResponse" } }, "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" } } }, "BatchCreateClassificationAllowedValueResourceActionRequest": { "title": "BatchCreateClassificationAllowedValueResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateClassificationAllowedValueResourceActionRequest" } }, "BatchUpdateClassificationAllowedValueResourceActionRequest": { "title": "BatchUpdateClassificationAllowedValueResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateClassificationAllowedValueResourceActionRequest" } }, "BatchDeleteClassificationAllowedValueResourceActionRequest": { "title": "BatchDeleteClassificationAllowedValueResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteClassificationAllowedValueResourceActionRequest" } }, "ChangeClassificationAllowedValueIsActiveResourceActionRequest": { "title": "ChangeClassificationAllowedValueIsActiveResourceActionRequest", "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": "ClassificationAllowedValue->IsActive" } ] } } }, "ChangeClassificationAllowedValuePermissionTreeResourceActionRequest": { "title": "ChangeClassificationAllowedValuePermissionTreeResourceActionRequest", "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": "ClassificationAllowedValue->PermissionTree_Id" } ] } } }, "BatchChangeClassificationAllowedValueIsActiveResourceActionRequest": { "title": "BatchChangeClassificationAllowedValueIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeClassificationAllowedValueIsActiveResourceActionRequest" } }, "BatchChangeClassificationAllowedValuePermissionTreeResourceActionRequest": { "title": "BatchChangeClassificationAllowedValuePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeClassificationAllowedValuePermissionTreeResourceActionRequest" } }, "GetEmailTypeResourceActionResponse": { "title": "GetEmailTypeResourceActionResponse", "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": "GetEmailTypeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "EmailType->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "EmailType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "EmailType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "EmailType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "EmailType->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "EmailType->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "EmailType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "EmailType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "EmailType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "EmailType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "EmailType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "EmailType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "EmailType->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "EmailType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "EmailType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "EmailType->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" } } }, "GetEmailTypeCollectionResourceActionResponse": { "title": "GetEmailTypeCollectionResourceActionResponse", "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": "GetEmailTypeCollectionResourceActionResponseItem", "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": "GetEmailTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "EmailType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "EmailType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "EmailType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "EmailType->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "EmailType->IsActive" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "EmailType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "EmailType->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" } } } }, "EmailTypeChangePermissionTreeLookupResourceActionResponse": { "title": "EmailTypeChangePermissionTreeLookupResourceActionResponse", "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": "EmailTypeChangePermissionTreeLookupResourceActionResponseItem", "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": "EmailTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "EmailTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "EmailTypeInsertPermissionTreeLookupResourceActionResponse", "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": "EmailTypeInsertPermissionTreeLookupResourceActionResponseItem", "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": "EmailTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateEmailTypeResourceActionRequest": { "title": "CreateEmailTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateEmailTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "permissionTreeId" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "EmailType->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "EmailType->Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "EmailType->PermissionTree_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "EmailType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "EmailType->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateEmailTypeResourceActionRequest": { "title": "UpdateEmailTypeResourceActionRequest", "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": "EmailType->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "EmailType->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "EmailType->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "EmailType->Notes" } ] } } }, "DeleteEmailTypeResourceActionRequest": { "title": "DeleteEmailTypeResourceActionRequest", "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 } } }, "BatchGetEmailTypeResourceAction": { "title": "BatchGetEmailTypeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Email Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Email Type entities", "items": { "$ref": "#/definitions/GetEmailTypeResourceActionResponse" } }, "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" } } }, "BatchCreateEmailTypeResourceActionRequest": { "title": "BatchCreateEmailTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateEmailTypeResourceActionRequest" } }, "BatchUpdateEmailTypeResourceActionRequest": { "title": "BatchUpdateEmailTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateEmailTypeResourceActionRequest" } }, "BatchDeleteEmailTypeResourceActionRequest": { "title": "BatchDeleteEmailTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteEmailTypeResourceActionRequest" } }, "ChangeEmailTypeIsActiveResourceActionRequest": { "title": "ChangeEmailTypeIsActiveResourceActionRequest", "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": "EmailType->IsActive" } ] } } }, "ChangeEmailTypePermissionTreeResourceActionRequest": { "title": "ChangeEmailTypePermissionTreeResourceActionRequest", "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": "EmailType->PermissionTree_Id" } ] } } }, "BatchChangeEmailTypeIsActiveResourceActionRequest": { "title": "BatchChangeEmailTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeEmailTypeIsActiveResourceActionRequest" } }, "BatchChangeEmailTypePermissionTreeResourceActionRequest": { "title": "BatchChangeEmailTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeEmailTypePermissionTreeResourceActionRequest" } }, "GetLanguageResourceActionResponse": { "title": "GetLanguageResourceActionResponse", "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": "GetLanguageResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Language->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Language->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Language->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Language->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Language->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Language->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Language->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Language->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Language->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Language->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Language->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Language->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Language->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Language->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Language->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Language->SequenceNumber" }, "languageCode": { "title": "languageCode", "type": "string", "x-nullable": false, "x-propertyPath": "Language->LanguageCode" } } }, "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" } } }, "GetLanguageCollectionResourceActionResponse": { "title": "GetLanguageCollectionResourceActionResponse", "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": "GetLanguageCollectionResourceActionResponseItem", "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": "GetLanguageCollectionResourceActionResponseItemProperties", "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" }, "languageCode": { "title": "languageCode", "type": "string", "x-nullable": false, "x-propertyPath": "Language->LanguageCode" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Language->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Language->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" } } } }, "LanguageChangePermissionTreeLookupResourceActionResponse": { "title": "LanguageChangePermissionTreeLookupResourceActionResponse", "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": "LanguageChangePermissionTreeLookupResourceActionResponseItem", "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": "LanguageChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "LanguageInsertPermissionTreeLookupResourceActionResponse": { "title": "LanguageInsertPermissionTreeLookupResourceActionResponse", "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": "LanguageInsertPermissionTreeLookupResourceActionResponseItem", "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": "LanguageInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateLanguageResourceActionRequest": { "title": "CreateLanguageResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateLanguageResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "languageCode" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Language->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Language->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Language->Description" }, "languageCode": { "title": "languageCode", "type": "string", "maxLength": 8, "minLength": 2, "x-nullable": false, "x-propertyPath": "Language->LanguageCode" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Language->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Language->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateLanguageResourceActionRequest": { "title": "UpdateLanguageResourceActionRequest", "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": "Language->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Language->Description" }, { "title": "languageCode", "type": "string", "maxLength": 8, "minLength": 2, "x-nullable": false, "x-propertyPath": "Language->LanguageCode" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Language->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Language->Notes" } ] } } }, "DeleteLanguageResourceActionRequest": { "title": "DeleteLanguageResourceActionRequest", "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 } } }, "BatchGetLanguageResourceAction": { "title": "BatchGetLanguageResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Language entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Language entities", "items": { "$ref": "#/definitions/GetLanguageResourceActionResponse" } }, "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" } } }, "BatchCreateLanguageResourceActionRequest": { "title": "BatchCreateLanguageResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateLanguageResourceActionRequest" } }, "BatchUpdateLanguageResourceActionRequest": { "title": "BatchUpdateLanguageResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateLanguageResourceActionRequest" } }, "BatchDeleteLanguageResourceActionRequest": { "title": "BatchDeleteLanguageResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteLanguageResourceActionRequest" } }, "ChangeLanguagePermissionTreeResourceActionRequest": { "title": "ChangeLanguagePermissionTreeResourceActionRequest", "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": "Language->PermissionTree_Id" } ] } } }, "ChangeLanguageIsActiveResourceActionRequest": { "title": "ChangeLanguageIsActiveResourceActionRequest", "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": "Language->IsActive" } ] } } }, "BatchChangeLanguageIsActiveResourceActionRequest": { "title": "BatchChangeLanguageIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeLanguageIsActiveResourceActionRequest" } }, "BatchChangeLanguagePermissionTreeResourceActionRequest": { "title": "BatchChangeLanguagePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeLanguagePermissionTreeResourceActionRequest" } }, "GetLocalisationKeyResourceActionResponse": { "title": "GetLocalisationKeyResourceActionResponse", "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": "GetLocalisationKeyResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "LocalisationKey->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationKey->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationKey->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationKey->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LocalisationKey->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationKey->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationKey->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationKey->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LocalisationKey->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocalisationKey->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationKey->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationKey->PermissionTree_Description" }, "localisationSetId": { "title": "localisationSetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocalisationKey->LocalisationSet_Id" }, "localisationSetName": { "title": "localisationSetName", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationKey->LocalisationSet_Name" }, "localisationSetDescription": { "title": "localisationSetDescription", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationKey->LocalisationSet_Description" }, "localisationSetType": { "title": "localisationSetType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "LocalisationKey->LocalisationSet_Type", "x-formatSpecifier": "LocalisationSetType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationKey->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocalisationKey->SequenceNumber" }, "text": { "title": "text", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationKey->Text" } } }, "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" } } }, "GetLocalisationKeyCollectionResourceActionResponse": { "title": "GetLocalisationKeyCollectionResourceActionResponse", "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": "GetLocalisationKeyCollectionResourceActionResponseItem", "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": "GetLocalisationKeyCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "text": { "title": "text", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationKey->Text" }, "localisationSetId": { "title": "localisationSetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationKey->LocalisationSet_Id" }, "localisationSetName": { "title": "localisationSetName", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationKey->LocalisationSet_Name" }, "localisationSetDescription": { "title": "localisationSetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationKey->LocalisationSet_Description" }, "localisationSetType": { "title": "localisationSetType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "LocalisationKey->LocalisationSet_Type", "x-formatSpecifier": "LocalisationSetType" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationKey->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationKey->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationKey->PermissionTree_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocalisationKey->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "LocalisationKey->IsActive" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationKey->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" } } } }, "GetLocalisationKeyForLocalisationSetCollectionResourceActionResponse": { "title": "GetLocalisationKeyForLocalisationSetCollectionResourceActionResponse", "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": "GetLocalisationKeyForLocalisationSetCollectionResourceActionResponseItem", "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": "GetLocalisationKeyForLocalisationSetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "LocalisationKey->IsActive" }, "text": { "title": "text", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationKey->Text" }, "localisationSetId": { "title": "localisationSetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationKey->LocalisationSet_Id" }, "localisationSetName": { "title": "localisationSetName", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationKey->LocalisationSet_Name" }, "localisationSetDescription": { "title": "localisationSetDescription", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationKey->LocalisationSet_Description" }, "localisationSetType": { "title": "localisationSetType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "LocalisationKey->LocalisationSet_Type", "x-formatSpecifier": "LocalisationSetType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocalisationKey->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationKey->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" } } } }, "LocalisationKeyChangePermissionTreeLookupResourceActionResponse": { "title": "LocalisationKeyChangePermissionTreeLookupResourceActionResponse", "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": "LocalisationKeyChangePermissionTreeLookupResourceActionResponseItem", "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": "LocalisationKeyChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "LocalisationKeyInsertPermissionTreeLookupResourceActionResponse": { "title": "LocalisationKeyInsertPermissionTreeLookupResourceActionResponse", "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": "LocalisationKeyInsertPermissionTreeLookupResourceActionResponseItem", "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": "LocalisationKeyInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "LocalisationKeyLocalisationSetResourceActionResponse": { "title": "LocalisationKeyLocalisationSetResourceActionResponse", "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": "LocalisationKeyLocalisationSetResourceActionResponseItem", "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": "LocalisationKeyLocalisationSetResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationSet->Name" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationSet->Description" }, "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "LocalisationSet->Type", "x-formatSpecifier": "LocalisationSetType" }, "isSystem": { "title": "isSystem", "type": "boolean", "x-nullable": true, "x-propertyPath": "LocalisationSet->IsSystem" } } }, "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" } } } }, "CreateLocalisationKeyResourceActionRequest": { "title": "CreateLocalisationKeyResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateLocalisationKeyResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "text", "localisationSetId" ], "properties": { "text": { "title": "text", "type": "string", "maxLength": 512, "minLength": 2, "x-nullable": false, "x-propertyPath": "LocalisationKey->Text" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocalisationKey->PermissionTree_Id", "x-systemGenerated": true }, "localisationSetId": { "title": "localisationSetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocalisationKey->LocalisationSet_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationKey->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocalisationKey->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateLocalisationKeyResourceActionRequest": { "title": "UpdateLocalisationKeyResourceActionRequest", "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": "text", "type": "string", "maxLength": 512, "minLength": 2, "x-nullable": false, "x-propertyPath": "LocalisationKey->Text" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationKey->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocalisationKey->SequenceNumber" } ] } } }, "DeleteLocalisationKeyResourceActionRequest": { "title": "DeleteLocalisationKeyResourceActionRequest", "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 } } }, "BatchGetLocalisationKeyResourceAction": { "title": "BatchGetLocalisationKeyResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Localisation Key entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Localisation Key entities", "items": { "$ref": "#/definitions/GetLocalisationKeyResourceActionResponse" } }, "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" } } }, "BatchCreateLocalisationKeyResourceActionRequest": { "title": "BatchCreateLocalisationKeyResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateLocalisationKeyResourceActionRequest" } }, "BatchUpdateLocalisationKeyResourceActionRequest": { "title": "BatchUpdateLocalisationKeyResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateLocalisationKeyResourceActionRequest" } }, "BatchDeleteLocalisationKeyResourceActionRequest": { "title": "BatchDeleteLocalisationKeyResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteLocalisationKeyResourceActionRequest" } }, "ChangeLocalisationKeyIsActiveResourceActionRequest": { "title": "ChangeLocalisationKeyIsActiveResourceActionRequest", "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": "LocalisationKey->IsActive" } ] } } }, "ChangeLocalisationKeyPermissionTreeResourceActionRequest": { "title": "ChangeLocalisationKeyPermissionTreeResourceActionRequest", "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": "LocalisationKey->PermissionTree_Id" } ] } } }, "BatchChangeLocalisationKeyIsActiveResourceActionRequest": { "title": "BatchChangeLocalisationKeyIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeLocalisationKeyIsActiveResourceActionRequest" } }, "BatchChangeLocalisationKeyPermissionTreeResourceActionRequest": { "title": "BatchChangeLocalisationKeyPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeLocalisationKeyPermissionTreeResourceActionRequest" } }, "GetLocalisationSetResourceActionResponse": { "title": "GetLocalisationSetResourceActionResponse", "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": "GetLocalisationSetResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationSet->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationSet->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationSet->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LocalisationSet->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationSet->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationSet->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationSet->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LocalisationSet->ModifiedOn" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationSet->Description" }, "isSystem": { "title": "isSystem", "type": "boolean", "x-nullable": true, "x-propertyPath": "LocalisationSet->IsSystem" }, "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationSet->Name" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationSet->Notes" }, "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "LocalisationSet->Type", "x-formatSpecifier": "LocalisationSetType" } } }, "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" } } }, "GetLocalisationSetCollectionResourceActionResponse": { "title": "GetLocalisationSetCollectionResourceActionResponse", "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": "GetLocalisationSetCollectionResourceActionResponseItem", "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": "GetLocalisationSetCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "name": { "title": "name", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationSet->Name" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationSet->Description" }, "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "LocalisationSet->Type", "x-formatSpecifier": "LocalisationSetType" }, "isSystem": { "title": "isSystem", "type": "boolean", "x-nullable": true, "x-propertyPath": "LocalisationSet->IsSystem" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationSet->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" } } } }, "GetLocalisationTranslationResourceActionResponse": { "title": "GetLocalisationTranslationResourceActionResponse", "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": "GetLocalisationTranslationResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LocalisationTranslation->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LocalisationTranslation->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->PermissionTree_Description" }, "languageId": { "title": "languageId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->Language_Id" }, "languageCode": { "title": "languageCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->Language_Code" }, "languageDescription": { "title": "languageDescription", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->Language_Description" }, "localisationKeyId": { "title": "localisationKeyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->LocalisationKey_Id" }, "localisationKeyText": { "title": "localisationKeyText", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->LocalisationKey_Text" }, "localisationKeyLocalisationSetId": { "title": "localisationKeyLocalisationSetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->LocalisationKey_LocalisationSet_Id" }, "localisationKeyLocalisationSetName": { "title": "localisationKeyLocalisationSetName", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->LocalisationKey_LocalisationSet_Name" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->SequenceNumber" }, "translatedText": { "title": "translatedText", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->TranslatedText" } } }, "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" } } }, "GetLocalisationTranslationCollectionResourceActionResponse": { "title": "GetLocalisationTranslationCollectionResourceActionResponse", "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": "GetLocalisationTranslationCollectionResourceActionResponseItem", "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": "GetLocalisationTranslationCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "translatedText": { "title": "translatedText", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->TranslatedText" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->SequenceNumber" }, "languageId": { "title": "languageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->Language_Id" }, "languageCode": { "title": "languageCode", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->Language_Code" }, "languageDescription": { "title": "languageDescription", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->Language_Description" }, "languageLanguageCode": { "title": "languageLanguageCode", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->Language_LanguageCode" }, "localisationKeyId": { "title": "localisationKeyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->LocalisationKey_Id" }, "localisationKeyText": { "title": "localisationKeyText", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->LocalisationKey_Text" }, "localisationKeyLocalisationSetId": { "title": "localisationKeyLocalisationSetId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->LocalisationKey_LocalisationSet_Id" }, "localisationKeyLocalisationSetType": { "title": "localisationKeyLocalisationSetType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->LocalisationKey_LocalisationSet_Type", "x-formatSpecifier": "LocalisationSetType" }, "localisationKeyLocalisationSetName": { "title": "localisationKeyLocalisationSetName", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->LocalisationKey_LocalisationSet_Name" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->PermissionTree_Id" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->PermissionTree_Description" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->PermissionTree_Code" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LocalisationTranslation->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LocalisationTranslation->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" } } } }, "GetLocalisationTranslationForLanguageCollectionResourceActionResponse": { "title": "GetLocalisationTranslationForLanguageCollectionResourceActionResponse", "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": "GetLocalisationTranslationForLanguageCollectionResourceActionResponseItem", "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": "GetLocalisationTranslationForLanguageCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->IsActive" }, "translatedText": { "title": "translatedText", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->TranslatedText" }, "localisationKeyId": { "title": "localisationKeyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->LocalisationKey_Id" }, "localisationKeyText": { "title": "localisationKeyText", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->LocalisationKey_Text" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->SequenceNumber" }, "languageId": { "title": "languageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->Language_Id" }, "languageCode": { "title": "languageCode", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->Language_Code" }, "languageDescription": { "title": "languageDescription", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->Language_Description" }, "languageLanguageCode": { "title": "languageLanguageCode", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->Language_LanguageCode" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->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" } } } }, "GetLocalisationTranslationForLocalisationKeyCollectionResourceActionResponse": { "title": "GetLocalisationTranslationForLocalisationKeyCollectionResourceActionResponse", "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": "GetLocalisationTranslationForLocalisationKeyCollectionResourceActionResponseItem", "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": "GetLocalisationTranslationForLocalisationKeyCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->IsActive" }, "translatedText": { "title": "translatedText", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->TranslatedText" }, "localisationKeyId": { "title": "localisationKeyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->LocalisationKey_Id" }, "localisationKeyText": { "title": "localisationKeyText", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->LocalisationKey_Text" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->SequenceNumber" }, "languageId": { "title": "languageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->Language_Id" }, "languageCode": { "title": "languageCode", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->Language_Code" }, "languageDescription": { "title": "languageDescription", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->Language_Description" }, "languageLanguageCode": { "title": "languageLanguageCode", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->Language_LanguageCode" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->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" } } } }, "LocalisationTranslationChangePermissionTreeLookupResourceActionResponse": { "title": "LocalisationTranslationChangePermissionTreeLookupResourceActionResponse", "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": "LocalisationTranslationChangePermissionTreeLookupResourceActionResponseItem", "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": "LocalisationTranslationChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "LocalisationTranslationInsertPermissionTreeLookupResourceActionResponse": { "title": "LocalisationTranslationInsertPermissionTreeLookupResourceActionResponse", "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": "LocalisationTranslationInsertPermissionTreeLookupResourceActionResponseItem", "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": "LocalisationTranslationInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "LocalisationTranslationLanguageLookupResourceActionResponse": { "title": "LocalisationTranslationLanguageLookupResourceActionResponse", "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": "LocalisationTranslationLanguageLookupResourceActionResponseItem", "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": "LocalisationTranslationLanguageLookupResourceActionResponseItemProperties", "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" } } } }, "LocalisationTranslationLocalisationLookupResourceActionResponse": { "title": "LocalisationTranslationLocalisationLookupResourceActionResponse", "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": "LocalisationTranslationLocalisationLookupResourceActionResponseItem", "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": "LocalisationTranslationLocalisationLookupResourceActionResponseItemProperties", "type": "object", "properties": { "text": { "title": "text", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationKey->Text" }, "localisationSetName": { "title": "localisationSetName", "type": "string", "x-nullable": false, "x-propertyPath": "LocalisationKey->LocalisationSet_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" } } } }, "CreateLocalisationTranslationResourceActionRequest": { "title": "CreateLocalisationTranslationResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateLocalisationTranslationResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "translatedText", "languageId", "localisationKeyId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->PermissionTree_Id", "x-systemGenerated": true }, "translatedText": { "title": "translatedText", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": false, "x-propertyPath": "LocalisationTranslation->TranslatedText" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->SequenceNumber" }, "languageId": { "title": "languageId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->Language_Id" }, "localisationKeyId": { "title": "localisationKeyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->LocalisationKey_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateLocalisationTranslationResourceActionRequest": { "title": "UpdateLocalisationTranslationResourceActionRequest", "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": "translatedText", "type": "string", "maxLength": 512, "minLength": 1, "x-nullable": false, "x-propertyPath": "LocalisationTranslation->TranslatedText" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->SequenceNumber" }, { "title": "languageId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocalisationTranslation->Language_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocalisationTranslation->Notes" } ] } } }, "DeleteLocalisationTranslationResourceActionRequest": { "title": "DeleteLocalisationTranslationResourceActionRequest", "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 } } }, "BatchGetLocalisationTranslationResourceAction": { "title": "BatchGetLocalisationTranslationResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Localisation Translation entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Localisation Translation entities", "items": { "$ref": "#/definitions/GetLocalisationTranslationResourceActionResponse" } }, "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" } } }, "BatchCreateLocalisationTranslationResourceActionRequest": { "title": "BatchCreateLocalisationTranslationResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateLocalisationTranslationResourceActionRequest" } }, "BatchUpdateLocalisationTranslationResourceActionRequest": { "title": "BatchUpdateLocalisationTranslationResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateLocalisationTranslationResourceActionRequest" } }, "BatchDeleteLocalisationTranslationResourceActionRequest": { "title": "BatchDeleteLocalisationTranslationResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteLocalisationTranslationResourceActionRequest" } }, "ChangeLocalisationTranslationIsActiveResourceActionRequest": { "title": "ChangeLocalisationTranslationIsActiveResourceActionRequest", "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": "LocalisationTranslation->IsActive" } ] } } }, "ChangeLocalisationTranslationPermissionTreeResourceActionRequest": { "title": "ChangeLocalisationTranslationPermissionTreeResourceActionRequest", "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": "LocalisationTranslation->PermissionTree_Id" } ] } } }, "BatchChangeLocalisationTranslationIsActiveResourceActionRequest": { "title": "BatchChangeLocalisationTranslationIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeLocalisationTranslationIsActiveResourceActionRequest" } }, "BatchChangeLocalisationTranslationPermissionTreeResourceActionRequest": { "title": "BatchChangeLocalisationTranslationPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeLocalisationTranslationPermissionTreeResourceActionRequest" } }, "GeoJsonObject": { "type": "object", "discriminator": "type", "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3", "required": [ "type" ], "properties": { "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": false, "x-formatSpecifier": "GeoJsonObjectType", "x-enumNames": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection", "Feature", "FeatureCollection" ] }, "bbox": { "title": "bbox", "type": "array", "items": { "type": "number" } } } }, "Feature": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.2", "allOf": [ { "$ref": "#/definitions/GeoJsonObject" }, { "type": "object", "required": [ "geometry", "properties" ], "properties": { "geometry": { "allOf": [ { "x-nullable": true }, { "$ref": "#/definitions/Geometry" } ] }, "properties": { "type": "object", "x-nullable": true }, "id": { "oneOf": [ { "type": "number" }, { "type": "string" } ] } } } ] }, "FeatureCollection": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.3", "allOf": [ { "$ref": "#/definitions/GeoJsonObject" }, { "type": "object", "required": [ "features" ], "properties": { "features": { "type": "array", "items": { "$ref": "#/definitions/Feature" } } } } ] }, "LinearRing": { "type": "array", "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.6", "minItems": 4, "items": { "$ref": "#/definitions/Position" } }, "LineStringCoordinates": { "type": "array", "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.4", "minItems": 2, "items": { "$ref": "#/definitions/Position" } }, "Position": { "type": "array", "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.1", "maxItems": 3, "minItems": 2, "items": { "type": "number" } }, "GeometryElement": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1", "allOf": [ { "$ref": "#/definitions/Geometry" }, { "type": "object", "discriminator": "type", "required": [ "type" ], "properties": { "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": false, "x-formatSpecifier": "GeometryElementType", "x-enumNames": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon" ] } } } ] }, "GeometryCollection": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.8", "allOf": [ { "$ref": "#/definitions/Geometry" }, { "type": "object", "required": [ "geometries" ], "properties": { "geometries": { "type": "array", "items": { "$ref": "#/definitions/GeometryElement" } } } } ] }, "Geometry": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1", "allOf": [ { "$ref": "#/definitions/GeoJsonObject" }, { "type": "object", "discriminator": "type", "required": [ "type" ], "properties": { "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": false, "x-formatSpecifier": "GeometryType", "x-enumNames": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection" ] } } } ] }, "Point": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.2", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "$ref": "#/definitions/Position" } } } ] }, "MultiPoint": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.3", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "items": { "$ref": "#/definitions/Position" } } } } ] }, "LineString": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.4", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "$ref": "#/definitions/LineStringCoordinates" } } } ] }, "MultiLineString": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.5", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "items": { "$ref": "#/definitions/LineStringCoordinates" } } } } ] }, "Polygon": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.6", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "items": { "$ref": "#/definitions/LinearRing" } } } } ] }, "MultiPolygon": { "description": "Refer to https://tools.ietf.org/html/rfc7946#section-3.1.7", "allOf": [ { "$ref": "#/definitions/GeometryElement" }, { "type": "object", "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/definitions/LinearRing" } } } } } ] }, "GetLocationResourceActionResponse": { "title": "GetLocationResourceActionResponse", "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": "GetLocationResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Location->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Location->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Location->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Location->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Location->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Location->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Location->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Location->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Location->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Location->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Location->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Location->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Location->PermissionTree_Description" }, "geographicId": { "title": "geographicId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Location->GeographicId" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Location->GeographicEndPosition" }, "geographicEntityType": { "title": "geographicEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Location->GeographicEntityType", "x-formatSpecifier": "EntityType" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Location->GeographicLength" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "Location->GeographicLocation" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "Location->GeographicNotes" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Location->GeographicReferenceEntityId" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Location->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Location->GeographicStartPosition" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Location->GeographicUnitOfMeasurement_Id" }, "geographicUnitOfMeasurementDescription": { "title": "geographicUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Location->GeographicUnitOfMeasurement_Description" }, "geographicUnitOfMeasurementCode": { "title": "geographicUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "Location->GeographicUnitOfMeasurement_Code" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Location->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "Location->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Location->Site_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Location->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Location->Notes" }, "parentLocationId": { "title": "parentLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Location->ParentLocation_Id" }, "parentLocationCode": { "title": "parentLocationCode", "type": "string", "x-nullable": true, "x-propertyPath": "Location->ParentLocation_Code" }, "parentLocationDescription": { "title": "parentLocationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Location->ParentLocation_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Location->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" } } }, "GetLocationCollectionResourceActionResponse": { "title": "GetLocationCollectionResourceActionResponse", "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": "GetLocationCollectionResourceActionResponseItem", "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": "GetLocationCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Location->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Location->Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Location->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Location->SequenceNumber" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Location->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Location->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Location->Site_Description" }, "parentLocationId": { "title": "parentLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Location->ParentLocation_Id" }, "parentLocationCode": { "title": "parentLocationCode", "type": "string", "x-nullable": false, "x-propertyPath": "Location->ParentLocation_Code" }, "parentLocationDescription": { "title": "parentLocationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Location->ParentLocation_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" } } } }, "LocationChangePermissionTreeLookupResourceActionResponse": { "title": "LocationChangePermissionTreeLookupResourceActionResponse", "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": "LocationChangePermissionTreeLookupResourceActionResponseItem", "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": "LocationChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "LocationInsertPermissionTreeLookupResourceActionResponse": { "title": "LocationInsertPermissionTreeLookupResourceActionResponse", "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": "LocationInsertPermissionTreeLookupResourceActionResponseItem", "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": "LocationInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "LocationParentLocationLookupResourceActionResponse": { "title": "LocationParentLocationLookupResourceActionResponse", "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": "LocationParentLocationLookupResourceActionResponseItem", "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": "LocationParentLocationLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Location->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Location->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" } } } }, "LocationSiteLookupResourceActionResponse": { "title": "LocationSiteLookupResourceActionResponse", "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": "LocationSiteLookupResourceActionResponseItem", "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": "LocationSiteLookupResourceActionResponseItemProperties", "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" } } } }, "CreateLocationResourceActionRequest": { "title": "CreateLocationResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateLocationResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Location->Code" }, "description": { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "x-nullable": false, "x-propertyPath": "Location->Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Location->PermissionTree_Id", "x-systemGenerated": true }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Location->Site_Id" }, "parentLocationId": { "title": "parentLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Location->ParentLocation_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Location->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Location->Notes" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "Location->GeographicLocation" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Location->GeographicStartPosition" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Location->GeographicEndPosition" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Location->GeographicLength" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Location->GeographicUnitOfMeasurement_Id" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "Location->GeographicNotes" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Location->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Location->GeographicReferenceEntityId" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateLocationResourceActionRequest": { "title": "UpdateLocationResourceActionRequest", "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": "Location->Code" }, { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "x-nullable": false, "x-propertyPath": "Location->Description" }, { "title": "parentLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Location->ParentLocation_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Location->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Location->Notes" }, { "title": "geographicLocation", "x-nullable": true, "x-propertyPath": "Location->GeographicLocation" }, { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Location->GeographicStartPosition" }, { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Location->GeographicEndPosition" }, { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Location->GeographicLength" }, { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Location->GeographicUnitOfMeasurement_Id" }, { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "Location->GeographicNotes" }, { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Location->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Location->GeographicReferenceEntityId" } ] } } }, "DeleteLocationResourceActionRequest": { "title": "DeleteLocationResourceActionRequest", "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 } } }, "BatchGetLocationResourceAction": { "title": "BatchGetLocationResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Location entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Location entities", "items": { "$ref": "#/definitions/GetLocationResourceActionResponse" } }, "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" } } }, "BatchCreateLocationRequest": { "title": "BatchCreateLocationRequest", "type": "array", "items": { "$ref": "#/definitions/CreateLocationResourceActionRequest" } }, "BatchUpdateLocationResourceActionRequest": { "title": "BatchUpdateLocationResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateLocationResourceActionRequest" } }, "BatchDeleteLocationResourceActionRequest": { "title": "BatchDeleteLocationResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteLocationResourceActionRequest" } }, "ChangeLocationIsActiveResourceActionRequest": { "title": "ChangeLocationIsActiveResourceActionRequest", "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": "Location->IsActive" } ] } } }, "ChangeLocationPermissionTreeResourceActionRequest": { "title": "ChangeLocationPermissionTreeResourceActionRequest", "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": "Location->PermissionTree_Id" } ] } } }, "ChangeLocationSiteResourceActionRequest": { "title": "ChangeLocationSiteResourceActionRequest", "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": "Location->Site_Id" } ] } } }, "BatchChangeLocationIsActiveResourceActionRequest": { "title": "BatchChangeLocationIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeLocationIsActiveResourceActionRequest" } }, "BatchChangeLocationPermissionTreeResourceActionRequest": { "title": "BatchChangeLocationPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeLocationPermissionTreeResourceActionRequest" } }, "BatchChangeLocationSiteResourceActionRequest": { "title": "BatchChangeLocationSiteResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeLocationSiteResourceActionRequest" } }, "GetLocationAttributeResourceActionResponse": { "title": "GetLocationAttributeResourceActionResponse", "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": "GetLocationAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocationAttribute->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->Location_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LocationAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "LocationAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LocationAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocationAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocationAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "LocationAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "LocationAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "LocationAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "LocationAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "LocationAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocationAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "LocationAttribute->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" } } }, "GetLocationAttributeCollectionForLocationResourceActionResponse": { "title": "GetLocationAttributeCollectionForLocationResourceActionResponse", "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": "GetLocationAttributeCollectionForLocationResourceActionResponseItem", "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": "GetLocationAttributeCollectionForLocationResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocationAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "LocationAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "LocationAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "LocationAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "LocationAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "LocationAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LocationAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LocationAttribute->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" } } } }, "GetLocationAttributeCollectionResourceActionResponse": { "title": "GetLocationAttributeCollectionResourceActionResponse", "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": "GetLocationAttributeCollectionResourceActionResponseItem", "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": "GetLocationAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocationAttribute->SequenceNumber" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": false, "x-propertyPath": "LocationAttribute->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "LocationAttribute->Location_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "LocationAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "LocationAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "LocationAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "LocationAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "LocationAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LocationAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LocationAttribute->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" } } } }, "LocationAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "LocationAttributeAttributeAllowedValueLookupResourceActionResponse", "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": "LocationAttributeAttributeAllowedValueLookupResourceActionResponseItem", "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": "LocationAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "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" } } } }, "LocationAttributeAttributeLookupResourceActionResponse": { "title": "LocationAttributeAttributeLookupResourceActionResponse", "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": "LocationAttributeAttributeLookupResourceActionResponseItem", "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": "LocationAttributeAttributeLookupResourceActionResponseItemProperties", "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" } } } }, "LocationAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "LocationAttributeInsertPermissionTreeLookupResourceActionResponse", "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": "LocationAttributeInsertPermissionTreeLookupResourceActionResponseItem", "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": "LocationAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "LocationAttributeLocationLookupResourceActionResponse": { "title": "LocationAttributeLocationLookupResourceActionResponse", "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": "LocationAttributeLocationLookupResourceActionResponseItem", "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": "LocationAttributeLocationLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Location->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Location->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" } } } }, "CreateLocationAttributeResourceActionRequest": { "title": "CreateLocationAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateLocationAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "locationId", "attributeId" ], "properties": { "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocationAttribute->Location_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocationAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "LocationAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocationAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocationAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateLocationAttributeResourceActionRequest": { "title": "UpdateLocationAttributeResourceActionRequest", "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": "LocationAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocationAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocationAttribute->Notes" } ] } } }, "DeleteLocationAttributeResourceActionRequest": { "title": "DeleteLocationAttributeResourceActionRequest", "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 } } }, "BatchGetLocationAttributeResourceAction": { "title": "BatchGetLocationAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Location Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Location Attribute entities", "items": { "$ref": "#/definitions/GetLocationAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateLocationAttributeResourceActionRequest": { "title": "BatchCreateLocationAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateLocationAttributeResourceActionRequest" } }, "BatchUpdateLocationAttributeResourceActionRequest": { "title": "BatchUpdateLocationAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateLocationAttributeResourceActionRequest" } }, "BatchDeleteLocationAttributeResourceActionRequest": { "title": "BatchDeleteLocationAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteLocationAttributeResourceActionRequest" } }, "ChangeLocationAttributeIsActiveResourceActionRequest": { "title": "ChangeLocationAttributeIsActiveResourceActionRequest", "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": "LocationAttribute->IsActive" } ] } } }, "BatchChangeLocationAttributeIsActiveResourceActionRequest": { "title": "BatchChangeLocationAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeLocationAttributeIsActiveResourceActionRequest" } }, "GetLocationDocumentResourceActionResponse": { "title": "GetLocationDocumentResourceActionResponse", "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": "GetLocationDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocationDocument->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->Location_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "LocationDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LocationDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "LocationDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocationDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocationDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "LocationDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocationDocument->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" } } }, "GetLocationDocumentCollectionForLocationResourceActionResponse": { "title": "GetLocationDocumentCollectionForLocationResourceActionResponse", "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": "GetLocationDocumentCollectionForLocationResourceActionResponseItem", "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": "GetLocationDocumentCollectionForLocationResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocationDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "LocationDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "LocationDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "LocationDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->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" } } } }, "GetLocationDocumentCollectionResourceActionResponse": { "title": "GetLocationDocumentCollectionResourceActionResponse", "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": "GetLocationDocumentCollectionResourceActionResponseItem", "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": "GetLocationDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationDocument->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": false, "x-propertyPath": "LocationDocument->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "LocationDocument->Location_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocationDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "LocationDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "LocationDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "LocationDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "LocationDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->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" } } } }, "LocationDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "LocationDocumentChangePermissionTreeLookupResourceActionResponse", "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": "LocationDocumentChangePermissionTreeLookupResourceActionResponseItem", "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": "LocationDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "LocationDocumentDocumentLookupResourceActionResponse": { "title": "LocationDocumentDocumentLookupResourceActionResponse", "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": "LocationDocumentDocumentLookupResourceActionResponseItem", "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": "LocationDocumentDocumentLookupResourceActionResponseItemProperties", "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" } } } }, "LocationDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "LocationDocumentInsertPermissionTreeLookupResourceActionResponse", "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": "LocationDocumentInsertPermissionTreeLookupResourceActionResponseItem", "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": "LocationDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "LocationDocumentLocationLookupResourceActionResponse": { "title": "LocationDocumentLocationLookupResourceActionResponse", "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": "LocationDocumentLocationLookupResourceActionResponseItem", "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": "LocationDocumentLocationLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Location->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Location->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" } } } }, "CreateLocationDocumentResourceActionRequest": { "title": "CreateLocationDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateLocationDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "locationId", "documentRecordId" ], "properties": { "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocationDocument->Location_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocationDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "LocationDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "LocationDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateLocationDocumentResourceActionRequest": { "title": "UpdateLocationDocumentResourceActionRequest", "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": "LocationDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "LocationDocument->Notes" } ] } } }, "DeleteLocationDocumentResourceActionRequest": { "title": "DeleteLocationDocumentResourceActionRequest", "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 } } }, "BatchGetLocationDocumentResourceAction": { "title": "BatchGetLocationDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Location Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Location Document entities", "items": { "$ref": "#/definitions/GetLocationDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateLocationDocumentResourceActionRequest": { "title": "BatchCreateLocationDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateLocationDocumentResourceActionRequest" } }, "BatchUpdateLocationDocumentResourceActionRequest": { "title": "BatchUpdateLocationDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateLocationDocumentResourceActionRequest" } }, "BatchDeleteLocationDocumentResourceActionRequest": { "title": "BatchDeleteLocationDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteLocationDocumentResourceActionRequest" } }, "ChangeLocationDocumentIsActiveResourceActionRequest": { "title": "ChangeLocationDocumentIsActiveResourceActionRequest", "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": "LocationDocument->IsActive" } ] } } }, "ChangeLocationDocumentPermissionTreeResourceActionRequest": { "title": "ChangeLocationDocumentPermissionTreeResourceActionRequest", "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": "LocationDocument->PermissionTree_Id" } ] } } }, "BatchChangeLocationDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeLocationDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeLocationDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeLocationDocumentIsActiveResourceActionRequest": { "title": "BatchChangeLocationDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeLocationDocumentIsActiveResourceActionRequest" } }, "GetNotificationTemplateResourceActionResponse": { "title": "GetNotificationTemplateResourceActionResponse", "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": "GetNotificationTemplateResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "NotificationTemplate->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "NotificationTemplate->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplate->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplate->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "NotificationTemplate->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "NotificationTemplate->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplate->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplate->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "NotificationTemplate->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "NotificationTemplate->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplate->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplate->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "NotificationTemplate->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplate->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplate->Site_Description" }, "audience": { "title": "audience", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "NotificationTemplate->Audience", "x-formatSpecifier": "String" }, "audienceQuery": { "title": "audienceQuery", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->AudienceQuery", "x-NullExpression": "NotificationTemplate->UseAudienceQuery eq TRUE" }, "audienceQueryFilter": { "title": "audienceQueryFilter", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplate->AudienceQueryFilter" }, "bodyQuery": { "title": "bodyQuery", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->BodyQuery", "x-NullExpression": "NotificationTemplate->UseBodyQuery eq TRUE" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->Description" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationTemplate->EntityType", "x-formatSpecifier": "EntityType" }, "languageId": { "title": "languageId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "NotificationTemplate->Language_Id", "x-NullExpression": "NotificationTemplate->OutputLanguage eq 'Fixed'" }, "languageCode": { "title": "languageCode", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplate->Language_Code" }, "languageDescription": { "title": "languageDescription", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplate->Language_Description" }, "languageQuery": { "title": "languageQuery", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->LanguageQuery", "x-NullExpression": "NotificationTemplate->OutputLanguage eq 'Dynamic'" }, "messageBody": { "title": "messageBody", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->MessageBody" }, "messageSubject": { "title": "messageSubject", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->MessageSubject" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplate->Notes" }, "outputLanguage": { "title": "outputLanguage", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationTemplate->OutputLanguage", "x-formatSpecifier": "TemplateLanguage" }, "outputType": { "title": "outputType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationTemplate->OutputType", "x-formatSpecifier": "NotificationOutputType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "NotificationTemplate->SequenceNumber" }, "useAudienceQuery": { "title": "useAudienceQuery", "type": "boolean", "x-nullable": true, "x-propertyPath": "NotificationTemplate->UseAudienceQuery" }, "useBodyQuery": { "title": "useBodyQuery", "type": "boolean", "x-nullable": true, "x-propertyPath": "NotificationTemplate->UseBodyQuery" } } }, "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" } } }, "GetNotificationTemplateCollectionResourceActionResponse": { "title": "GetNotificationTemplateCollectionResourceActionResponse", "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": "GetNotificationTemplateCollectionResourceActionResponseItem", "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": "GetNotificationTemplateCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->Description" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationTemplate->EntityType", "x-formatSpecifier": "EntityType" }, "outputType": { "title": "outputType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationTemplate->OutputType", "x-formatSpecifier": "NotificationOutputType" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "NotificationTemplate->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" } } } }, "NotificationTemplateChangePermissionTreeLookupResourceActionResponse": { "title": "NotificationTemplateChangePermissionTreeLookupResourceActionResponse", "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": "NotificationTemplateChangePermissionTreeLookupResourceActionResponseItem", "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": "NotificationTemplateChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "NotificationTemplateInsertPermissionTreeLookupResourceActionResponse": { "title": "NotificationTemplateInsertPermissionTreeLookupResourceActionResponse", "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": "NotificationTemplateInsertPermissionTreeLookupResourceActionResponseItem", "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": "NotificationTemplateInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "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" } } } }, "CreateNotificationTemplateResourceActionRequest": { "title": "CreateNotificationTemplateResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateNotificationTemplateResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "entityType", "outputType", "outputLanguage", "messageSubject", "messageBody" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "NotificationTemplate->Code" }, "description": { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "x-nullable": false, "x-propertyPath": "NotificationTemplate->Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "NotificationTemplate->Site_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "NotificationTemplate->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "NotificationTemplate->SequenceNumber" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "NotificationTemplate->EntityType", "x-formatSpecifier": "EntityType" }, "outputType": { "title": "outputType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "NotificationTemplate->OutputType", "x-formatSpecifier": "NotificationOutputType" }, "useAudienceQuery": { "title": "useAudienceQuery", "type": "boolean", "x-nullable": true, "x-propertyPath": "NotificationTemplate->UseAudienceQuery" }, "audienceQuery": { "title": "audienceQuery", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->AudienceQuery", "x-NullExpression": "NotificationTemplate->UseAudienceQuery eq TRUE" }, "audienceQueryFilter": { "title": "audienceQueryFilter", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplate->AudienceQueryFilter" }, "useBodyQuery": { "title": "useBodyQuery", "type": "boolean", "x-nullable": true, "x-propertyPath": "NotificationTemplate->UseBodyQuery" }, "bodyQuery": { "title": "bodyQuery", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->BodyQuery", "x-NullExpression": "NotificationTemplate->UseBodyQuery eq TRUE" }, "outputLanguage": { "title": "outputLanguage", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "NotificationTemplate->OutputLanguage", "x-formatSpecifier": "TemplateLanguage" }, "languageQuery": { "title": "languageQuery", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->LanguageQuery", "x-NullExpression": "NotificationTemplate->OutputLanguage eq 'Dynamic'" }, "languageId": { "title": "languageId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "NotificationTemplate->Language_Id", "x-NullExpression": "NotificationTemplate->OutputLanguage eq 'Fixed'" }, "audience": { "title": "audience", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "NotificationTemplate->Audience", "x-formatSpecifier": "String" }, "messageSubject": { "title": "messageSubject", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->MessageSubject" }, "messageBody": { "title": "messageBody", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->MessageBody" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplate->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateNotificationTemplateResourceActionRequest": { "title": "UpdateNotificationTemplateResourceActionRequest", "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": "NotificationTemplate->Code" }, { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "x-nullable": false, "x-propertyPath": "NotificationTemplate->Description" }, { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "NotificationTemplate->Site_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "NotificationTemplate->SequenceNumber" }, { "title": "useAudienceQuery", "type": "boolean", "x-nullable": true, "x-propertyPath": "NotificationTemplate->UseAudienceQuery" }, { "title": "audienceQuery", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->AudienceQuery", "x-NullExpression": "NotificationTemplate->UseAudienceQuery eq TRUE" }, { "title": "audienceQueryFilter", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplate->AudienceQueryFilter" }, { "title": "useBodyQuery", "type": "boolean", "x-nullable": true, "x-propertyPath": "NotificationTemplate->UseBodyQuery" }, { "title": "bodyQuery", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->BodyQuery", "x-NullExpression": "NotificationTemplate->UseBodyQuery eq TRUE" }, { "title": "outputLanguage", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "NotificationTemplate->OutputLanguage", "x-formatSpecifier": "TemplateLanguage" }, { "title": "languageQuery", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->LanguageQuery", "x-NullExpression": "NotificationTemplate->OutputLanguage eq 'Dynamic'" }, { "title": "languageId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "NotificationTemplate->Language_Id", "x-NullExpression": "NotificationTemplate->OutputLanguage eq 'Fixed'" }, { "title": "audience", "type": "array", "format": "array", "x-nullable": true, "items": { "type": "string" }, "x-propertyPath": "NotificationTemplate->Audience", "x-formatSpecifier": "String" }, { "title": "messageSubject", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->MessageSubject" }, { "title": "messageBody", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->MessageBody" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplate->Notes" } ] } } }, "DeleteNotificationTemplateResourceActionRequest": { "title": "DeleteNotificationTemplateResourceActionRequest", "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 } } }, "BatchGetNotificationTemplateResourceAction": { "title": "BatchGetNotificationTemplateResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Notification Template entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Notification Template entities", "items": { "$ref": "#/definitions/GetNotificationTemplateResourceActionResponse" } }, "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" } } }, "BatchCreateNotificationTemplateRequest": { "title": "BatchCreateNotificationTemplateRequest", "type": "array", "items": { "$ref": "#/definitions/CreateNotificationTemplateResourceActionRequest" } }, "BatchUpdateNotificationTemplateResourceActionRequest": { "title": "BatchUpdateNotificationTemplateResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateNotificationTemplateResourceActionRequest" } }, "BatchDeleteNotificationTemplateResourceActionRequest": { "title": "BatchDeleteNotificationTemplateResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteNotificationTemplateResourceActionRequest" } }, "ChangeNotificationTemplatePermissionTreeResourceActionRequest": { "title": "ChangeNotificationTemplatePermissionTreeResourceActionRequest", "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": "NotificationTemplate->PermissionTree_Id" } ] } } }, "ChangeNotificationTemplateIsActiveResourceActionRequest": { "title": "ChangeNotificationTemplateIsActiveResourceActionRequest", "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": "NotificationTemplate->IsActive" } ] } } }, "BatchChangeNotificationTemplateIsActiveResourceActionRequest": { "title": "BatchChangeNotificationTemplateIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeNotificationTemplateIsActiveResourceActionRequest" } }, "BatchChangeNotificationTemplatePermissionTreeResourceActionRequest": { "title": "BatchChangeNotificationTemplatePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeNotificationTemplatePermissionTreeResourceActionRequest" } }, "GetNotificationTemplateParameterResourceActionResponse": { "title": "GetNotificationTemplateParameterResourceActionResponse", "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": "GetNotificationTemplateParameterResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "NotificationTemplateParameter->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "NotificationTemplateParameter->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->PermissionTree_Description" }, "expressionType": { "title": "expressionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->ExpressionType", "x-formatSpecifier": "NotificationTemplateParameterExpressionType" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->Notes" }, "notificationTemplateId": { "title": "notificationTemplateId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->NotificationTemplate_Id" }, "notificationTemplateDescription": { "title": "notificationTemplateDescription", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->NotificationTemplate_Description" }, "parameterName": { "title": "parameterName", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->ParameterName" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "NotificationTemplateParameter->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" } } }, "GetNotificationTemplateParameterCollectionResourceActionResponse": { "title": "GetNotificationTemplateParameterCollectionResourceActionResponse", "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": "GetNotificationTemplateParameterCollectionResourceActionResponseItem", "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": "GetNotificationTemplateParameterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "parameterName": { "title": "parameterName", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->ParameterName" }, "expressionType": { "title": "expressionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->ExpressionType", "x-formatSpecifier": "NotificationTemplateParameterExpressionType" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "NotificationTemplateParameter->Value", "x-formatSpecifier": "DynamicValue" }, "notificationTemplateId": { "title": "notificationTemplateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->NotificationTemplate_Id" }, "notificationTemplateDescription": { "title": "notificationTemplateDescription", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->NotificationTemplate_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" } } } }, "GetNotificationTemplateParameterForNotificationTemplateCollectionResourceActionResponse": { "title": "GetNotificationTemplateParameterForNotificationTemplateCollectionResourceActionResponse", "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": "GetNotificationTemplateParameterForNotificationTemplateCollectionResourceActionResponseItem", "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": "GetNotificationTemplateParameterForNotificationTemplateCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "notificationTemplateId": { "title": "notificationTemplateId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->NotificationTemplate_Id" }, "notificationTemplateDescription": { "title": "notificationTemplateDescription", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->NotificationTemplate_Description" }, "expressionType": { "title": "expressionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->ExpressionType", "x-formatSpecifier": "NotificationTemplateParameterExpressionType" }, "parameterName": { "title": "parameterName", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->ParameterName" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "NotificationTemplateParameter->Value", "x-formatSpecifier": "DynamicValue" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->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" } } } }, "NotificationTemplateParameterChangePermissionTreeLookupResourceActionResponse": { "title": "NotificationTemplateParameterChangePermissionTreeLookupResourceActionResponse", "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": "NotificationTemplateParameterChangePermissionTreeLookupResourceActionResponseItem", "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": "NotificationTemplateParameterChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "NotificationTemplateParameterInsertPermissionTreeLookupResourceActionResponse": { "title": "NotificationTemplateParameterInsertPermissionTreeLookupResourceActionResponse", "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": "NotificationTemplateParameterInsertPermissionTreeLookupResourceActionResponseItem", "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": "NotificationTemplateParameterInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "NotificationTemplateParametersChangeDataTriggerLookupResourceActionResponse": { "title": "NotificationTemplateParametersChangeDataTriggerLookupResourceActionResponse", "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": "NotificationTemplateParametersChangeDataTriggerLookupResourceActionResponseItem", "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": "NotificationTemplateParametersChangeDataTriggerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "NotificationTemplate->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" } } } }, "CreateNotificationTemplateParameterResourceActionRequest": { "title": "CreateNotificationTemplateParameterResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateNotificationTemplateParameterResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "parameterName", "expressionType", "value", "notificationTemplateId" ], "properties": { "parameterName": { "title": "parameterName", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->ParameterName" }, "expressionType": { "title": "expressionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->ExpressionType", "x-formatSpecifier": "NotificationTemplateParameterExpressionType" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->PermissionTree_Id", "x-systemGenerated": true }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "NotificationTemplateParameter->Value", "x-formatSpecifier": "DynamicValue" }, "notificationTemplateId": { "title": "notificationTemplateId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->NotificationTemplate_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateNotificationTemplateParameterResourceActionRequest": { "title": "UpdateNotificationTemplateParameterResourceActionRequest", "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": "parameterName", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->ParameterName" }, { "title": "expressionType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->ExpressionType", "x-formatSpecifier": "NotificationTemplateParameterExpressionType" }, { "title": "value", "format": "composite", "x-nullable": false, "x-propertyPath": "NotificationTemplateParameter->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "NotificationTemplateParameter->Notes" } ] } } }, "DeleteNotificationTemplateParameterResourceActionRequest": { "title": "DeleteNotificationTemplateParameterResourceActionRequest", "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 } } }, "BatchGetNotificationTemplateParameterResourceAction": { "title": "BatchGetNotificationTemplateParameterResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Notification Template Parameter entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Notification Template Parameter entities", "items": { "$ref": "#/definitions/GetNotificationTemplateParameterResourceActionResponse" } }, "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" } } }, "BatchCreateNotificationTemplateParameterRequest": { "title": "BatchCreateNotificationTemplateParameterRequest", "type": "array", "items": { "$ref": "#/definitions/CreateNotificationTemplateParameterResourceActionRequest" } }, "BatchUpdateNotificationTemplateParameterResourceActionRequest": { "title": "BatchUpdateNotificationTemplateParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateNotificationTemplateParameterResourceActionRequest" } }, "BatchDeleteNotificationTemplateParameterResourceActionRequest": { "title": "BatchDeleteNotificationTemplateParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteNotificationTemplateParameterResourceActionRequest" } }, "ChangeNotificationTemplateParameterIsActiveResourceActionRequest": { "title": "ChangeNotificationTemplateParameterIsActiveResourceActionRequest", "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": "NotificationTemplateParameter->IsActive" } ] } } }, "ChangeNotificationTemplateParameterPermissionTreeResourceActionRequest": { "title": "ChangeNotificationTemplateParameterPermissionTreeResourceActionRequest", "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": "NotificationTemplateParameter->PermissionTree_Id" } ] } } }, "BatchChangeNotificationTemplateParameterIsActiveResourceActionRequest": { "title": "BatchChangeNotificationTemplateParameterIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeNotificationTemplateParameterIsActiveResourceActionRequest" } }, "BatchChangeNotificationTemplateParameterPermissionTreeResourceActionRequest": { "title": "BatchChangeNotificationTemplateParameterPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeNotificationTemplateParameterPermissionTreeResourceActionRequest" } }, "GetPhoneNumberTypeResourceActionResponse": { "title": "GetPhoneNumberTypeResourceActionResponse", "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": "GetPhoneNumberTypeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PhoneNumberType->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PhoneNumberType->IsActive" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PhoneNumberType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PhoneNumberType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PhoneNumberType->PermissionTree_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PhoneNumberType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PhoneNumberType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PhoneNumberType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PhoneNumberType->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PhoneNumberType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PhoneNumberType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PhoneNumberType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PhoneNumberType->ModifiedOn" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PhoneNumberType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PhoneNumberType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PhoneNumberType->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" } } }, "GetPhoneNumberTypeCollectionResourceActionResponse": { "title": "GetPhoneNumberTypeCollectionResourceActionResponse", "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": "GetPhoneNumberTypeCollectionResourceActionResponseItem", "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": "GetPhoneNumberTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PhoneNumberType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PhoneNumberType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PhoneNumberType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PhoneNumberType->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PhoneNumberType->IsActive" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PhoneNumberType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PhoneNumberType->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" } } } }, "PhoneNumberTypeChangePermissionTreeLookupResourceActionResponse": { "title": "PhoneNumberTypeChangePermissionTreeLookupResourceActionResponse", "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": "PhoneNumberTypeChangePermissionTreeLookupResourceActionResponseItem", "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": "PhoneNumberTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PhoneNumberTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "PhoneNumberTypeInsertPermissionTreeLookupResourceActionResponse", "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": "PhoneNumberTypeInsertPermissionTreeLookupResourceActionResponseItem", "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": "PhoneNumberTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreatePhoneNumberTypeResourceActionRequest": { "title": "CreatePhoneNumberTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePhoneNumberTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "permissionTreeId" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "PhoneNumberType->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "PhoneNumberType->Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PhoneNumberType->PermissionTree_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PhoneNumberType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PhoneNumberType->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePhoneNumberTypeResourceActionRequest": { "title": "UpdatePhoneNumberTypeResourceActionRequest", "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": "PhoneNumberType->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "PhoneNumberType->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PhoneNumberType->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PhoneNumberType->Notes" } ] } } }, "DeletePhoneNumberTypeResourceActionRequest": { "title": "DeletePhoneNumberTypeResourceActionRequest", "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 } } }, "BatchGetPhoneNumberTypeResourceAction": { "title": "BatchGetPhoneNumberTypeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Phone Number Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Phone Number Type entities", "items": { "$ref": "#/definitions/GetPhoneNumberTypeResourceActionResponse" } }, "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" } } }, "BatchCreatePhoneNumberTypeResourceActionRequest": { "title": "BatchCreatePhoneNumberTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePhoneNumberTypeResourceActionRequest" } }, "BatchUpdatePhoneNumberTypeResourceActionRequest": { "title": "BatchUpdatePhoneNumberTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePhoneNumberTypeResourceActionRequest" } }, "BatchDeletePhoneNumberTypeResourceActionRequest": { "title": "BatchDeletePhoneNumberTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePhoneNumberTypeResourceActionRequest" } }, "ChangePhoneNumberTypeIsActiveResourceActionRequest": { "title": "ChangePhoneNumberTypeIsActiveResourceActionRequest", "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": "PhoneNumberType->IsActive" } ] } } }, "ChangePhoneNumberTypePermissionTreeResourceActionRequest": { "title": "ChangePhoneNumberTypePermissionTreeResourceActionRequest", "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": "PhoneNumberType->PermissionTree_Id" } ] } } }, "BatchChangePhoneNumberTypeIsActiveResourceActionRequest": { "title": "BatchChangePhoneNumberTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePhoneNumberTypeIsActiveResourceActionRequest" } }, "BatchChangePhoneNumberTypePermissionTreeResourceActionRequest": { "title": "BatchChangePhoneNumberTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePhoneNumberTypePermissionTreeResourceActionRequest" } }, "GetPreconfiguredReasonResourceActionResponse": { "title": "GetPreconfiguredReasonResourceActionResponse", "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": "GetPreconfiguredReasonResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PreconfiguredReason->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PreconfiguredReason->IsActive" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PreconfiguredReason->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "PreconfiguredReason->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "PreconfiguredReason->PermissionTree_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PreconfiguredReason->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PreconfiguredReason->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PreconfiguredReason->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PreconfiguredReason->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PreconfiguredReason->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PreconfiguredReason->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PreconfiguredReason->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PreconfiguredReason->ModifiedOn" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PreconfiguredReason->Description" }, "preconfiguredReasonType": { "title": "preconfiguredReasonType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PreconfiguredReason->PreconfiguredReasonType", "x-formatSpecifier": "PreconfiguredReasonType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PreconfiguredReason->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PreconfiguredReason->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" } } }, "GetPreconfiguredReasonCollectionResourceActionResponse": { "title": "GetPreconfiguredReasonCollectionResourceActionResponse", "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": "GetPreconfiguredReasonCollectionResourceActionResponseItem", "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": "GetPreconfiguredReasonCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PreconfiguredReason->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PreconfiguredReason->Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "PreconfiguredReason->IsActive" }, "preconfiguredReasonType": { "title": "preconfiguredReasonType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PreconfiguredReason->PreconfiguredReasonType", "x-formatSpecifier": "PreconfiguredReasonType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PreconfiguredReason->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" } } } }, "PreconfiguredReasonChangePermissionTreeLookupResourceActionResponse": { "title": "PreconfiguredReasonChangePermissionTreeLookupResourceActionResponse", "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": "PreconfiguredReasonChangePermissionTreeLookupResourceActionResponseItem", "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": "PreconfiguredReasonChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "PreconfiguredReasonInsertPermissionTreeLookupResourceActionResponse": { "title": "PreconfiguredReasonInsertPermissionTreeLookupResourceActionResponse", "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": "PreconfiguredReasonInsertPermissionTreeLookupResourceActionResponseItem", "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": "PreconfiguredReasonInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreatePreconfiguredReasonResourceActionRequest": { "title": "CreatePreconfiguredReasonResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePreconfiguredReasonResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "permissionTreeId", "preconfiguredReasonType" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "PreconfiguredReason->Code" }, "description": { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "x-nullable": false, "x-propertyPath": "PreconfiguredReason->Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PreconfiguredReason->PermissionTree_Id" }, "preconfiguredReasonType": { "title": "preconfiguredReasonType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PreconfiguredReason->PreconfiguredReasonType", "x-formatSpecifier": "PreconfiguredReasonType" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PreconfiguredReason->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PreconfiguredReason->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdatePreconfiguredReasonResourceActionRequest": { "title": "UpdatePreconfiguredReasonResourceActionRequest", "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": "PreconfiguredReason->Code" }, { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "x-nullable": false, "x-propertyPath": "PreconfiguredReason->Description" }, { "title": "preconfiguredReasonType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "PreconfiguredReason->PreconfiguredReasonType", "x-formatSpecifier": "PreconfiguredReasonType" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PreconfiguredReason->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "PreconfiguredReason->Notes" } ] } } }, "DeletePreconfiguredReasonResourceActionRequest": { "title": "DeletePreconfiguredReasonResourceActionRequest", "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 } } }, "BatchGetPreconfiguredReasonResourceAction": { "title": "BatchGetPreconfiguredReasonResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Preconfigured Reason entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Preconfigured Reason entities", "items": { "$ref": "#/definitions/GetPreconfiguredReasonResourceActionResponse" } }, "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" } } }, "BatchCreatePreconfiguredReasonResourceActionRequest": { "title": "BatchCreatePreconfiguredReasonResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePreconfiguredReasonResourceActionRequest" } }, "BatchUpdatePreconfiguredReasonResourceActionRequest": { "title": "BatchUpdatePreconfiguredReasonResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdatePreconfiguredReasonResourceActionRequest" } }, "BatchDeletePreconfiguredReasonResourceActionRequest": { "title": "BatchDeletePreconfiguredReasonResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeletePreconfiguredReasonResourceActionRequest" } }, "ChangePreconfiguredReasonIsActiveResourceActionRequest": { "title": "ChangePreconfiguredReasonIsActiveResourceActionRequest", "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": "PreconfiguredReason->IsActive" } ] } } }, "BatchChangePreconfiguredReasonIsActiveResourceActionRequest": { "title": "BatchChangePreconfiguredReasonIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangePreconfiguredReasonIsActiveResourceActionRequest" } }, "GetRequestTypeResourceActionResponse": { "title": "GetRequestTypeResourceActionResponse", "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": "GetRequestTypeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RequestType->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "RequestType->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RequestType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RequestType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RequestType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequestType->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "RequestType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "RequestType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "RequestType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequestType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RequestType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "RequestType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "RequestType->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RequestType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RequestType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RequestType->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" } } }, "GetRequestTypeCollectionResourceActionResponse": { "title": "GetRequestTypeCollectionResourceActionResponse", "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": "GetRequestTypeCollectionResourceActionResponseItem", "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": "GetRequestTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "RequestType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "RequestType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RequestType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RequestType->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequestType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "RequestType->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" } } } }, "RequestTypeChangePermissionTreeLookupResourceActionResponse": { "title": "RequestTypeChangePermissionTreeLookupResourceActionResponse", "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": "RequestTypeChangePermissionTreeLookupResourceActionResponseItem", "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": "RequestTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "RequestTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "RequestTypeInsertPermissionTreeLookupResourceActionResponse", "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": "RequestTypeInsertPermissionTreeLookupResourceActionResponseItem", "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": "RequestTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateRequestTypeResourceActionRequest": { "title": "CreateRequestTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateRequestTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "RequestType->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "RequestType->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RequestType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RequestType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RequestType->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateRequestTypeResourceActionRequest": { "title": "UpdateRequestTypeResourceActionRequest", "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": "RequestType->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "RequestType->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "RequestType->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "RequestType->Notes" } ] } } }, "DeleteRequestTypeResourceActionRequest": { "title": "DeleteRequestTypeResourceActionRequest", "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 } } }, "BatchGetRequestTypeResourceAction": { "title": "BatchGetRequestTypeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Request Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Request Type entities", "items": { "$ref": "#/definitions/GetRequestTypeResourceActionResponse" } }, "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" } } }, "BatchCreateRequestTypeResourceActionRequest": { "title": "BatchCreateRequestTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateRequestTypeResourceActionRequest" } }, "BatchUpdateRequestTypeResourceActionRequest": { "title": "BatchUpdateRequestTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateRequestTypeResourceActionRequest" } }, "BatchDeleteRequestTypeResourceActionRequest": { "title": "BatchDeleteRequestTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteRequestTypeResourceActionRequest" } }, "ChangeRequestTypeIsActiveResourceActionRequest": { "title": "ChangeRequestTypeIsActiveResourceActionRequest", "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": "RequestType->IsActive" } ] } } }, "ChangeRequestTypePermissionTreeResourceActionRequest": { "title": "ChangeRequestTypePermissionTreeResourceActionRequest", "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": "RequestType->PermissionTree_Id" } ] } } }, "BatchChangeRequestTypeIsActiveResourceActionRequest": { "title": "BatchChangeRequestTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRequestTypeIsActiveResourceActionRequest" } }, "BatchChangeRequestTypePermissionTreeResourceActionRequest": { "title": "BatchChangeRequestTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeRequestTypePermissionTreeResourceActionRequest" } }, "GetSiteResourceActionResponse": { "title": "GetSiteResourceActionResponse", "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": "GetSiteResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Code" }, "geographicId": { "title": "geographicId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->GeographicId" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Site->GeographicEndPosition" }, "geographicEntityType": { "title": "geographicEntityType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Site->GeographicEntityType", "x-formatSpecifier": "EntityType" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Site->GeographicLength" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "Site->GeographicLocation" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "Site->GeographicNotes" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Site->GeographicReferenceEntityId" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Site->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Site->GeographicStartPosition" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->GeographicUnitOfMeasurement_Id" }, "geographicUnitOfMeasurementDescription": { "title": "geographicUnitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Site->GeographicUnitOfMeasurement_Description" }, "geographicUnitOfMeasurementCode": { "title": "geographicUnitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "Site->GeographicUnitOfMeasurement_Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Site->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Site->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Site->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Site->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Site->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Site->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Site->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Site->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Site->PermissionTree_Description" }, "contentTranslate": { "title": "contentTranslate", "type": "boolean", "x-nullable": true, "x-propertyPath": "Site->ContentTranslate" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": true, "x-propertyPath": "Site->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Site->CostElement_Description" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Site->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "Site->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Site->Currency_Description" }, "dateFormat": { "title": "dateFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Site->DateFormat", "x-formatSpecifier": "SystemDateFormat" }, "dateSeparator": { "title": "dateSeparator", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Site->DateSeparator", "x-formatSpecifier": "SystemDateSeparator" }, "defaultLanguageId": { "title": "defaultLanguageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->DefaultLanguage_Id" }, "defaultLanguageCode": { "title": "defaultLanguageCode", "type": "string", "x-nullable": true, "x-propertyPath": "Site->DefaultLanguage_Code" }, "defaultLanguageDescription": { "title": "defaultLanguageDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Site->DefaultLanguage_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Description" }, "enableRequisitionApprovalWorkflow": { "title": "enableRequisitionApprovalWorkflow", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Site->EnableRequisitionApprovalWorkflow", "x-formatSpecifier": "ApprovalWorkflowOption" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->FinancialYearPeriod_Id" }, "financialYearPeriodCode": { "title": "financialYearPeriodCode", "type": "string", "x-nullable": true, "x-propertyPath": "Site->FinancialYearPeriod_Code" }, "financialYearPeriodDescription": { "title": "financialYearPeriodDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Site->FinancialYearPeriod_Description" }, "financialYearPeriodFinancialYearId": { "title": "financialYearPeriodFinancialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->FinancialYearPeriod_FinancialYear_Id" }, "financialYearPeriodFinancialYearCode": { "title": "financialYearPeriodFinancialYearCode", "type": "string", "x-nullable": true, "x-propertyPath": "Site->FinancialYearPeriod_FinancialYear_Code" }, "financialYearPeriodFinancialYearDescription": { "title": "financialYearPeriodFinancialYearDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Site->FinancialYearPeriod_FinancialYear_Description" }, "isVirtual": { "title": "isVirtual", "type": "boolean", "x-nullable": false, "x-propertyPath": "Site->IsVirtual" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Site->Notes" }, "parentSiteId": { "title": "parentSiteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Site->ParentSite_Id", "x-NullExpression": "Site->Id NE 1L" }, "parentSiteCode": { "title": "parentSiteCode", "type": "string", "x-nullable": true, "x-propertyPath": "Site->ParentSite_Code" }, "parentSiteDescription": { "title": "parentSiteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Site->ParentSite_Description" }, "reportServerReportLanguage": { "title": "reportServerReportLanguage", "type": "string", "x-nullable": true, "x-propertyPath": "Site->ReportServerReportLanguage" }, "reportServerReportLanguageDisplayName": { "title": "reportServerReportLanguageDisplayName", "type": "string", "x-nullable": true, "x-propertyPath": "Site->ReportServerReportLanguageDisplayName" }, "reportServerUILanguage": { "title": "reportServerUILanguage", "type": "string", "x-nullable": true, "x-propertyPath": "Site->ReportServerUILanguage" }, "reportServerUILanguageDisplayName": { "title": "reportServerUILanguageDisplayName", "type": "string", "x-nullable": true, "x-propertyPath": "Site->ReportServerUILanguageDisplayName" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Site->SequenceNumber" }, "siteTypeId": { "title": "siteTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Site->SiteType_Id" }, "siteTypeCode": { "title": "siteTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Site->SiteType_Code" }, "siteTypeDescription": { "title": "siteTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Site->SiteType_Description" }, "timeFormat": { "title": "timeFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Site->TimeFormat", "x-formatSpecifier": "SystemTimeFormat" }, "timeZoneOffset": { "title": "timeZoneOffset", "type": "number", "format": "float", "x-nullable": false, "x-propertyPath": "Site->TimeZoneOffset" }, "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->Warehouse_Id" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "x-nullable": true, "x-propertyPath": "Site->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Site->Warehouse_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" } } }, "GetSiteCollectionResourceActionResponse": { "title": "GetSiteCollectionResourceActionResponse", "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": "GetSiteCollectionResourceActionResponseItem", "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": "GetSiteCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "parentSiteId": { "title": "parentSiteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->ParentSite_Id" }, "parentSiteCode": { "title": "parentSiteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Site->ParentSite_Code" }, "parentSiteDescription": { "title": "parentSiteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Site->ParentSite_Description" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Site->SequenceNumber" }, "siteTypeId": { "title": "siteTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->SiteType_Id" }, "siteTypeCode": { "title": "siteTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "Site->SiteType_Code" }, "siteTypeDescription": { "title": "siteTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Site->SiteType_Description" }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->CostElement_Id" }, "costElementCode": { "title": "costElementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Site->CostElement_Code" }, "costElementDescription": { "title": "costElementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Site->CostElement_Description" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Currency_Description" }, "timeZoneOffset": { "title": "timeZoneOffset", "type": "number", "format": "float", "x-nullable": false, "x-propertyPath": "Site->TimeZoneOffset" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Site->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Site->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Site->ModifiedOn" }, "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->Warehouse_Id" }, "warehouseCode": { "title": "warehouseCode", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Warehouse_Code" }, "warehouseDescription": { "title": "warehouseDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Warehouse_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" } } } }, "SiteFinancialYearPeriodLookupResourceActionResponse": { "title": "SiteFinancialYearPeriodLookupResourceActionResponse", "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": "SiteFinancialYearPeriodLookupResourceActionResponseItem", "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": "SiteFinancialYearPeriodLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->Description" }, "financialYearId": { "title": "financialYearId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Id" }, "financialYearCode": { "title": "financialYearCode", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_Code" }, "financialYearDescription": { "title": "financialYearDescription", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYearPeriod->FinancialYear_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" } } } }, "SiteChangePermissionTreeLookupResourceActionResponse": { "title": "SiteChangePermissionTreeLookupResourceActionResponse", "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": "SiteChangePermissionTreeLookupResourceActionResponseItem", "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": "SiteChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SiteCostElementLookupResourceActionResponse": { "title": "SiteCostElementLookupResourceActionResponse", "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": "SiteCostElementLookupResourceActionResponseItem", "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": "SiteCostElementLookupResourceActionResponseItemProperties", "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" } } } }, "SiteCurrencyLookupResourceActionResponse": { "title": "SiteCurrencyLookupResourceActionResponse", "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": "SiteCurrencyLookupResourceActionResponseItem", "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": "SiteCurrencyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->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" } } } }, "SiteDefaultLanguageLookupResourceActionResponse": { "title": "SiteDefaultLanguageLookupResourceActionResponse", "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": "SiteDefaultLanguageLookupResourceActionResponseItem", "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": "SiteDefaultLanguageLookupResourceActionResponseItemProperties", "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" } } } }, "SiteFinancialYearLookupResourceActionResponse": { "title": "SiteFinancialYearLookupResourceActionResponse", "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": "SiteFinancialYearLookupResourceActionResponseItem", "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": "SiteFinancialYearLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYear->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "FinancialYear->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" } } } }, "SiteInsertPermissionTreeLookupResourceActionResponse": { "title": "SiteInsertPermissionTreeLookupResourceActionResponse", "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": "SiteInsertPermissionTreeLookupResourceActionResponseItem", "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": "SiteInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SiteParentSiteLookupResourceActionResponse": { "title": "SiteParentSiteLookupResourceActionResponse", "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": "SiteParentSiteLookupResourceActionResponseItem", "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": "SiteParentSiteLookupResourceActionResponseItemProperties", "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" } } } }, "SiteSiteTypeLookupResourceActionResponse": { "title": "SiteSiteTypeLookupResourceActionResponse", "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": "SiteSiteTypeLookupResourceActionResponseItem", "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": "SiteSiteTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "SiteType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "SiteType->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" } } } }, "SiteWarehouseLookupResourceActionResponse": { "title": "SiteWarehouseLookupResourceActionResponse", "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": "SiteWarehouseLookupResourceActionResponseItem", "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": "SiteWarehouseLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Warehouse->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Warehouse->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" } } } }, "CreateSiteResourceActionRequest": { "title": "CreateSiteResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSiteResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "siteTypeId", "timeZoneOffset" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->PermissionTree_Id", "x-systemGenerated": true }, "parentSiteId": { "title": "parentSiteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Site->ParentSite_Id", "x-NullExpression": "Site->Id NE 1L" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Site->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Site->Description" }, "isVirtual": { "title": "isVirtual", "type": "boolean", "x-nullable": false, "x-propertyPath": "Site->IsVirtual" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Site->SequenceNumber" }, "siteTypeId": { "title": "siteTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Site->SiteType_Id" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Site->Currency_Id", "x-systemGenerated": true }, "costElementId": { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->CostElement_Id" }, "financialYearPeriodId": { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->FinancialYearPeriod_Id" }, "defaultLanguageId": { "title": "defaultLanguageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->DefaultLanguage_Id" }, "warehouseId": { "title": "warehouseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->Warehouse_Id" }, "timeZoneOffset": { "title": "timeZoneOffset", "type": "number", "format": "float", "x-nullable": false, "x-propertyPath": "Site->TimeZoneOffset" }, "contentTranslate": { "title": "contentTranslate", "type": "boolean", "x-nullable": true, "x-propertyPath": "Site->ContentTranslate" }, "dateFormat": { "title": "dateFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Site->DateFormat", "x-formatSpecifier": "SystemDateFormat" }, "dateSeparator": { "title": "dateSeparator", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Site->DateSeparator", "x-formatSpecifier": "SystemDateSeparator" }, "timeFormat": { "title": "timeFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Site->TimeFormat", "x-formatSpecifier": "SystemTimeFormat" }, "reportServerUILanguage": { "title": "reportServerUILanguage", "type": "string", "maxLength": 50, "x-nullable": true, "x-propertyPath": "Site->ReportServerUILanguage" }, "reportServerReportLanguage": { "title": "reportServerReportLanguage", "type": "string", "maxLength": 50, "x-nullable": true, "x-propertyPath": "Site->ReportServerReportLanguage" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Site->Notes" }, "enableRequisitionApprovalWorkflow": { "title": "enableRequisitionApprovalWorkflow", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Site->EnableRequisitionApprovalWorkflow", "x-formatSpecifier": "ApprovalWorkflowOption" }, "geographicLocation": { "title": "geographicLocation", "x-nullable": true, "$ref": "#/definitions/Geometry", "x-propertyPath": "Site->GeographicLocation" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Site->GeographicStartPosition" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Site->GeographicEndPosition" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Site->GeographicLength" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->GeographicUnitOfMeasurement_Id" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "Site->GeographicNotes" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Site->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Site->GeographicReferenceEntityId" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSiteResourceActionRequest": { "title": "UpdateSiteResourceActionRequest", "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": "Site->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Site->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Site->SequenceNumber" }, { "title": "siteTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Site->SiteType_Id" }, { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Site->Currency_Id" }, { "title": "costElementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->CostElement_Id" }, { "title": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->FinancialYearPeriod_Id" }, { "title": "defaultLanguageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->DefaultLanguage_Id" }, { "title": "warehouseId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->Warehouse_Id" }, { "title": "timeZoneOffset", "type": "number", "format": "float", "x-nullable": false, "x-propertyPath": "Site->TimeZoneOffset" }, { "title": "contentTranslate", "type": "boolean", "x-nullable": true, "x-propertyPath": "Site->ContentTranslate" }, { "title": "dateFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Site->DateFormat", "x-formatSpecifier": "SystemDateFormat" }, { "title": "dateSeparator", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Site->DateSeparator", "x-formatSpecifier": "SystemDateSeparator" }, { "title": "timeFormat", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Site->TimeFormat", "x-formatSpecifier": "SystemTimeFormat" }, { "title": "reportServerUILanguage", "type": "string", "maxLength": 50, "x-nullable": true, "x-propertyPath": "Site->ReportServerUILanguage" }, { "title": "reportServerReportLanguage", "type": "string", "maxLength": 50, "x-nullable": true, "x-propertyPath": "Site->ReportServerReportLanguage" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Site->Notes" }, { "title": "enableRequisitionApprovalWorkflow", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Site->EnableRequisitionApprovalWorkflow", "x-formatSpecifier": "ApprovalWorkflowOption" }, { "title": "geographicLocation", "x-nullable": true, "x-propertyPath": "Site->GeographicLocation" }, { "title": "geographicStartPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Site->GeographicStartPosition" }, { "title": "geographicEndPosition", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Site->GeographicEndPosition" }, { "title": "geographicLength", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Site->GeographicLength" }, { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->GeographicUnitOfMeasurement_Id" }, { "title": "geographicNotes", "type": "string", "x-nullable": true, "x-propertyPath": "Site->GeographicNotes" }, { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Site->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Site->GeographicReferenceEntityId" } ] } } }, "DeleteSiteResourceActionRequest": { "title": "DeleteSiteResourceActionRequest", "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 } } }, "BatchGetSiteResourceAction": { "title": "BatchGetSiteResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Site entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Site entities", "items": { "$ref": "#/definitions/GetSiteResourceActionResponse" } }, "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" } } }, "BatchCreateSiteResourceActionRequest": { "title": "BatchCreateSiteResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSiteResourceActionRequest" } }, "BatchUpdateSiteResourceActionRequest": { "title": "BatchUpdateSiteResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSiteResourceActionRequest" } }, "BatchDeleteSiteResourceActionRequest": { "title": "BatchDeleteSiteResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSiteResourceActionRequest" } }, "ChangeSiteIsActiveResourceActionRequest": { "title": "ChangeSiteIsActiveResourceActionRequest", "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": "Site->IsActive" } ] } } }, "ChangeSitePermissionTreeResourceActionRequest": { "title": "ChangeSitePermissionTreeResourceActionRequest", "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": "Site->PermissionTree_Id" } ] } } }, "MoveSiteResourceActionRequest": { "title": "MoveSiteResourceActionRequest", "type": "object", "properties": { "properties": { "title": "MoveSiteResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "sourceId", "targetId" ], "properties": { "sourceId": { "title": "sourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MoveEntity->SourceId" }, "targetId": { "title": "targetId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MoveEntity->TargetId" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangeSiteIsActiveResourceActionRequest": { "title": "BatchChangeSiteIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSiteIsActiveResourceActionRequest" } }, "BatchChangeSitePermissionTreeResourceActionRequest": { "title": "BatchChangeSitePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSitePermissionTreeResourceActionRequest" } }, "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 } } }, "MatchUpdateSiteResourceActionRequest": { "title": "MatchUpdateSiteResourceActionRequest", "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": "financialYearPeriodId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->FinancialYearPeriod_Id" } ] } } }, "GetSiteAttributeResourceActionResponse": { "title": "GetSiteAttributeResourceActionResponse", "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": "GetSiteAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteAttribute->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->Site_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "SiteAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "SiteAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SiteAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SiteAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SiteAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SiteAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SiteAttribute->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" } } }, "GetSiteAttributeCollectionForSiteResourceActionResponse": { "title": "GetSiteAttributeCollectionForSiteResourceActionResponse", "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": "GetSiteAttributeCollectionForSiteResourceActionResponseItem", "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": "GetSiteAttributeCollectionForSiteResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SiteAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SiteAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SiteAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteAttribute->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" } } } }, "GetSiteAttributeCollectionResourceActionResponse": { "title": "GetSiteAttributeCollectionResourceActionResponse", "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": "GetSiteAttributeCollectionResourceActionResponseItem", "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": "GetSiteAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteAttribute->SequenceNumber" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteAttribute->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteAttribute->Site_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SiteAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SiteAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SiteAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteAttribute->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" } } } }, "SiteAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "SiteAttributeAttributeAllowedValueLookupResourceActionResponse", "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": "SiteAttributeAttributeAllowedValueLookupResourceActionResponseItem", "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": "SiteAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "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" } } } }, "SiteAttributeAttributeLookupResourceActionResponse": { "title": "SiteAttributeAttributeLookupResourceActionResponse", "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": "SiteAttributeAttributeLookupResourceActionResponseItem", "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": "SiteAttributeAttributeLookupResourceActionResponseItemProperties", "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" } } } }, "SiteAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "SiteAttributeInsertPermissionTreeLookupResourceActionResponse", "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": "SiteAttributeInsertPermissionTreeLookupResourceActionResponseItem", "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": "SiteAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SiteAttributeSiteLookupResourceActionResponse": { "title": "SiteAttributeSiteLookupResourceActionResponse", "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": "SiteAttributeSiteLookupResourceActionResponseItem", "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": "SiteAttributeSiteLookupResourceActionResponseItemProperties", "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" } } } }, "CreateSiteAttributeResourceActionRequest": { "title": "CreateSiteAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSiteAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "siteId", "attributeId" ], "properties": { "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteAttribute->Site_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SiteAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSiteAttributeResourceActionRequest": { "title": "UpdateSiteAttributeResourceActionRequest", "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": "SiteAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteAttribute->Notes" } ] } } }, "DeleteSiteAttributeResourceActionRequest": { "title": "DeleteSiteAttributeResourceActionRequest", "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 } } }, "BatchGetSiteAttributeResourceAction": { "title": "BatchGetSiteAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Site Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Site Attribute entities", "items": { "$ref": "#/definitions/GetSiteAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateSiteAttributeResourceActionRequest": { "title": "BatchCreateSiteAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSiteAttributeResourceActionRequest" } }, "BatchUpdateSiteAttributeResourceActionRequest": { "title": "BatchUpdateSiteAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSiteAttributeResourceActionRequest" } }, "BatchDeleteSiteAttributeResourceActionRequest": { "title": "BatchDeleteSiteAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSiteAttributeResourceActionRequest" } }, "ChangeSiteAttributeIsActiveResourceActionRequest": { "title": "ChangeSiteAttributeIsActiveResourceActionRequest", "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": "SiteAttribute->IsActive" } ] } } }, "BatchChangeSiteAttributeIsActiveResourceActionRequest": { "title": "BatchChangeSiteAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSiteAttributeIsActiveResourceActionRequest" } }, "GetSiteContactAddressResourceActionResponse": { "title": "GetSiteContactAddressResourceActionResponse", "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": "GetSiteContactAddressResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "SiteContactAddress->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteContactAddress->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactAddress->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactAddress->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactAddress->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteContactAddress->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactAddress->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactAddress->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactAddress->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactAddress->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactAddress->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactAddress->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactAddress->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactAddress->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactAddress->Site_Description" }, "addressTypeId": { "title": "addressTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactAddress->AddressType_Id" }, "addressTypeCode": { "title": "addressTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactAddress->AddressType_Code" }, "addressTypeDescription": { "title": "addressTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactAddress->AddressType_Description" }, "body": { "title": "body", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactAddress->Body" }, "country": { "title": "country", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactAddress->Country" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactAddress->Notes" }, "postalCode": { "title": "postalCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactAddress->PostalCode" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteContactAddress->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" } } }, "GetSiteContactAddressCollectionResourceActionResponse": { "title": "GetSiteContactAddressCollectionResourceActionResponse", "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": "GetSiteContactAddressCollectionResourceActionResponseItem", "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": "GetSiteContactAddressCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteContactAddress->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactAddress->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactAddress->Site_Description" }, "addressTypeId": { "title": "addressTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteContactAddress->AddressType_Id" }, "addressTypeCode": { "title": "addressTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactAddress->AddressType_Code" }, "addressTypeDescription": { "title": "addressTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactAddress->AddressType_Description" }, "body": { "title": "body", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactAddress->Body" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteContactAddress->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactAddress->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactAddress->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactAddress->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" } } } }, "GetSiteContactAddressForSiteCollectionResourceActionResponse": { "title": "GetSiteContactAddressForSiteCollectionResourceActionResponse", "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": "GetSiteContactAddressForSiteCollectionResourceActionResponseItem", "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": "GetSiteContactAddressForSiteCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "addressTypeId": { "title": "addressTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteContactAddress->AddressType_Id" }, "addressTypeCode": { "title": "addressTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactAddress->AddressType_Code" }, "addressTypeDescription": { "title": "addressTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactAddress->AddressType_Description" }, "body": { "title": "body", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactAddress->Body" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteContactAddress->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactAddress->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactAddress->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactAddress->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" } } } }, "SiteContactAddressAddressTypeLookupResourceActionResponse": { "title": "SiteContactAddressAddressTypeLookupResourceActionResponse", "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": "SiteContactAddressAddressTypeLookupResourceActionResponseItem", "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": "SiteContactAddressAddressTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AddressType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AddressType->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" } } } }, "SiteContactAddressInsertPermissionTreeLookupResourceActionResponse": { "title": "SiteContactAddressInsertPermissionTreeLookupResourceActionResponse", "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": "SiteContactAddressInsertPermissionTreeLookupResourceActionResponseItem", "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": "SiteContactAddressInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SiteContactAddressSiteLookupResourceActionResponse": { "title": "SiteContactAddressSiteLookupResourceActionResponse", "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": "SiteContactAddressSiteLookupResourceActionResponseItem", "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": "SiteContactAddressSiteLookupResourceActionResponseItemProperties", "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" } } } }, "CreateSiteContactAddressResourceActionRequest": { "title": "CreateSiteContactAddressResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSiteContactAddressResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "siteId", "addressTypeId" ], "properties": { "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactAddress->Site_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactAddress->PermissionTree_Id", "x-systemGenerated": true }, "addressTypeId": { "title": "addressTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactAddress->AddressType_Id" }, "body": { "title": "body", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactAddress->Body" }, "postalCode": { "title": "postalCode", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "SiteContactAddress->PostalCode" }, "country": { "title": "country", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "SiteContactAddress->Country" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteContactAddress->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactAddress->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSiteContactAddressResourceActionRequest": { "title": "UpdateSiteContactAddressResourceActionRequest", "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": "addressTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactAddress->AddressType_Id" }, { "title": "body", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactAddress->Body" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteContactAddress->SequenceNumber" }, { "title": "postalCode", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "SiteContactAddress->PostalCode" }, { "title": "country", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "SiteContactAddress->Country" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactAddress->Notes" } ] } } }, "DeleteSiteContactAddressResourceActionRequest": { "title": "DeleteSiteContactAddressResourceActionRequest", "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 } } }, "BatchGetSiteContactAddressResourceAction": { "title": "BatchGetSiteContactAddressResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Site Contact Address entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Site Contact Address entities", "items": { "$ref": "#/definitions/GetSiteContactAddressResourceActionResponse" } }, "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" } } }, "BatchCreateSiteContactAddressResourceActionRequest": { "title": "BatchCreateSiteContactAddressResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSiteContactAddressResourceActionRequest" } }, "BatchUpdateSiteContactAddressResourceActionRequest": { "title": "BatchUpdateSiteContactAddressResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSiteContactAddressResourceActionRequest" } }, "BatchDeleteSiteContactAddressResourceActionRequest": { "title": "BatchDeleteSiteContactAddressResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSiteContactAddressResourceActionRequest" } }, "ChangeSiteContactAddressIsActiveResourceActionRequest": { "title": "ChangeSiteContactAddressIsActiveResourceActionRequest", "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": "SiteContactAddress->IsActive" } ] } } }, "BatchChangeSiteContactAddressIsActiveResourceActionRequest": { "title": "BatchChangeSiteContactAddressIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSiteContactAddressIsActiveResourceActionRequest" } }, "GetSiteContactEmailResourceActionResponse": { "title": "GetSiteContactEmailResourceActionResponse", "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": "GetSiteContactEmailResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "SiteContactEmail->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteContactEmail->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactEmail->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactEmail->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactEmail->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteContactEmail->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactEmail->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactEmail->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactEmail->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactEmail->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactEmail->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactEmail->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactEmail->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactEmail->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactEmail->Site_Description" }, "email": { "title": "email", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactEmail->Email" }, "emailTypeId": { "title": "emailTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactEmail->EmailType_Id" }, "emailTypeCode": { "title": "emailTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactEmail->EmailType_Code" }, "emailTypeDescription": { "title": "emailTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactEmail->EmailType_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactEmail->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteContactEmail->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" } } }, "GetSiteContactEmailCollectionResourceActionResponse": { "title": "GetSiteContactEmailCollectionResourceActionResponse", "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": "GetSiteContactEmailCollectionResourceActionResponseItem", "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": "GetSiteContactEmailCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteContactEmail->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactEmail->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactEmail->Site_Description" }, "emailTypeId": { "title": "emailTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteContactEmail->EmailType_Id" }, "emailTypeCode": { "title": "emailTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactEmail->EmailType_Code" }, "emailTypeDescription": { "title": "emailTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactEmail->EmailType_Description" }, "email": { "title": "email", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactEmail->Email" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteContactEmail->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactEmail->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactEmail->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactEmail->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" } } } }, "GetSiteContactEmailForSiteCollectionResourceActionResponse": { "title": "GetSiteContactEmailForSiteCollectionResourceActionResponse", "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": "GetSiteContactEmailForSiteCollectionResourceActionResponseItem", "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": "GetSiteContactEmailForSiteCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "emailTypeId": { "title": "emailTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteContactEmail->EmailType_Id" }, "emailTypeCode": { "title": "emailTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactEmail->EmailType_Code" }, "emailTypeDescription": { "title": "emailTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactEmail->EmailType_Description" }, "email": { "title": "email", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactEmail->Email" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteContactEmail->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactEmail->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactEmail->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactEmail->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" } } } }, "SiteContactEmailEmailTypeLookupResourceActionResponse": { "title": "SiteContactEmailEmailTypeLookupResourceActionResponse", "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": "SiteContactEmailEmailTypeLookupResourceActionResponseItem", "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": "SiteContactEmailEmailTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "EmailType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "EmailType->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" } } } }, "SiteContactEmailInsertPermissionTreeLookupResourceActionResponse": { "title": "SiteContactEmailInsertPermissionTreeLookupResourceActionResponse", "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": "SiteContactEmailInsertPermissionTreeLookupResourceActionResponseItem", "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": "SiteContactEmailInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SiteContactEmailSiteLookupResourceActionResponse": { "title": "SiteContactEmailSiteLookupResourceActionResponse", "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": "SiteContactEmailSiteLookupResourceActionResponseItem", "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": "SiteContactEmailSiteLookupResourceActionResponseItemProperties", "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" } } } }, "CreateSiteContactEmailResourceActionRequest": { "title": "CreateSiteContactEmailResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSiteContactEmailResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "siteId", "emailTypeId", "email" ], "properties": { "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactEmail->Site_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactEmail->PermissionTree_Id", "x-systemGenerated": true }, "emailTypeId": { "title": "emailTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactEmail->EmailType_Id" }, "email": { "title": "email", "type": "string", "maxLength": 255, "x-nullable": false, "x-propertyPath": "SiteContactEmail->Email" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteContactEmail->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactEmail->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSiteContactEmailResourceActionRequest": { "title": "UpdateSiteContactEmailResourceActionRequest", "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": "emailTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactEmail->EmailType_Id" }, { "title": "email", "type": "string", "maxLength": 255, "x-nullable": false, "x-propertyPath": "SiteContactEmail->Email" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteContactEmail->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactEmail->Notes" } ] } } }, "DeleteSiteContactEmailResourceActionRequest": { "title": "DeleteSiteContactEmailResourceActionRequest", "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 } } }, "BatchGetSiteContactEmailResourceAction": { "title": "BatchGetSiteContactEmailResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Site Contact Email entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Site Contact Email entities", "items": { "$ref": "#/definitions/GetSiteContactEmailResourceActionResponse" } }, "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" } } }, "BatchCreateSiteContactEmailResourceActionRequest": { "title": "BatchCreateSiteContactEmailResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSiteContactEmailResourceActionRequest" } }, "BatchUpdateSiteContactEmailResourceActionRequest": { "title": "BatchUpdateSiteContactEmailResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSiteContactEmailResourceActionRequest" } }, "BatchDeleteSiteContactEmailResourceActionRequest": { "title": "BatchDeleteSiteContactEmailResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSiteContactEmailResourceActionRequest" } }, "ChangeSiteContactEmailIsActiveResourceActionRequest": { "title": "ChangeSiteContactEmailIsActiveResourceActionRequest", "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": "SiteContactEmail->IsActive" } ] } } }, "BatchChangeSiteContactEmailIsActiveResourceActionRequest": { "title": "BatchChangeSiteContactEmailIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSiteContactEmailIsActiveResourceActionRequest" } }, "GetSiteContactPhoneNumberResourceActionResponse": { "title": "GetSiteContactPhoneNumberResourceActionResponse", "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": "GetSiteContactPhoneNumberResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactPhoneNumber->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactPhoneNumber->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->Site_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->Notes" }, "phoneNumber": { "title": "phoneNumber", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->PhoneNumber" }, "phoneNumberTypeId": { "title": "phoneNumberTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->PhoneNumberType_Id" }, "phoneNumberTypeCode": { "title": "phoneNumberTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->PhoneNumberType_Code" }, "phoneNumberTypeDescription": { "title": "phoneNumberTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->PhoneNumberType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->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" } } }, "GetSiteContactPhoneNumberCollectionResourceActionResponse": { "title": "GetSiteContactPhoneNumberCollectionResourceActionResponse", "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": "GetSiteContactPhoneNumberCollectionResourceActionResponseItem", "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": "GetSiteContactPhoneNumberCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->Site_Description" }, "phoneNumberTypeId": { "title": "phoneNumberTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->PhoneNumberType_Id" }, "phoneNumberTypeCode": { "title": "phoneNumberTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->PhoneNumberType_Code" }, "phoneNumberTypeDescription": { "title": "phoneNumberTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->PhoneNumberType_Description" }, "phoneNumber": { "title": "phoneNumber", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->PhoneNumber" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactPhoneNumber->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactPhoneNumber->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" } } } }, "GetSiteContactPhoneNumberForSiteCollectionResourceActionResponse": { "title": "GetSiteContactPhoneNumberForSiteCollectionResourceActionResponse", "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": "GetSiteContactPhoneNumberForSiteCollectionResourceActionResponseItem", "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": "GetSiteContactPhoneNumberForSiteCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "phoneNumberTypeId": { "title": "phoneNumberTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->PhoneNumberType_Id" }, "phoneNumberTypeCode": { "title": "phoneNumberTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->PhoneNumberType_Code" }, "phoneNumberTypeDescription": { "title": "phoneNumberTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->PhoneNumberType_Description" }, "phoneNumber": { "title": "phoneNumber", "type": "string", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->PhoneNumber" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactPhoneNumber->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteContactPhoneNumber->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" } } } }, "SiteContactPhoneNumberInsertPermissionTreeLookupResourceActionResponse": { "title": "SiteContactPhoneNumberInsertPermissionTreeLookupResourceActionResponse", "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": "SiteContactPhoneNumberInsertPermissionTreeLookupResourceActionResponseItem", "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": "SiteContactPhoneNumberInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SiteContactPhoneNumberPhoneNumberTypeLookupResourceActionResponse": { "title": "SiteContactPhoneNumberPhoneNumberTypeLookupResourceActionResponse", "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": "SiteContactPhoneNumberPhoneNumberTypeLookupResourceActionResponseItem", "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": "SiteContactPhoneNumberPhoneNumberTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PhoneNumberType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PhoneNumberType->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" } } } }, "SiteContactPhoneNumberSiteLookupResourceActionResponse": { "title": "SiteContactPhoneNumberSiteLookupResourceActionResponse", "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": "SiteContactPhoneNumberSiteLookupResourceActionResponseItem", "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": "SiteContactPhoneNumberSiteLookupResourceActionResponseItemProperties", "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" } } } }, "CreateSiteContactPhoneNumberResourceActionRequest": { "title": "CreateSiteContactPhoneNumberResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSiteContactPhoneNumberResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "siteId", "phoneNumberTypeId", "phoneNumber" ], "properties": { "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->Site_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->PermissionTree_Id", "x-systemGenerated": true }, "phoneNumberTypeId": { "title": "phoneNumberTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->PhoneNumberType_Id" }, "phoneNumber": { "title": "phoneNumber", "type": "string", "maxLength": 30, "minLength": 1, "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->PhoneNumber" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSiteContactPhoneNumberResourceActionRequest": { "title": "UpdateSiteContactPhoneNumberResourceActionRequest", "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": "phoneNumberTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->PhoneNumberType_Id" }, { "title": "phoneNumber", "type": "string", "maxLength": 30, "minLength": 1, "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "x-nullable": false, "x-propertyPath": "SiteContactPhoneNumber->PhoneNumber" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteContactPhoneNumber->Notes" } ] } } }, "DeleteSiteContactPhoneNumberResourceActionRequest": { "title": "DeleteSiteContactPhoneNumberResourceActionRequest", "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 } } }, "BatchGetSiteContactPhoneNumberResourceAction": { "title": "BatchGetSiteContactPhoneNumberResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Site Contact Phone Number entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Site Contact Phone Number entities", "items": { "$ref": "#/definitions/GetSiteContactPhoneNumberResourceActionResponse" } }, "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" } } }, "BatchCreateSiteContactPhoneNumberResourceActionRequest": { "title": "BatchCreateSiteContactPhoneNumberResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSiteContactPhoneNumberResourceActionRequest" } }, "BatchUpdateSiteContactPhoneNumberResourceActionRequest": { "title": "BatchUpdateSiteContactPhoneNumberResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSiteContactPhoneNumberResourceActionRequest" } }, "BatchDeleteSiteContactPhoneNumberResourceActionRequest": { "title": "BatchDeleteSiteContactPhoneNumberResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSiteContactPhoneNumberResourceActionRequest" } }, "ChangeSiteContactPhoneNumberIsActiveResourceActionRequest": { "title": "ChangeSiteContactPhoneNumberIsActiveResourceActionRequest", "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": "SiteContactPhoneNumber->IsActive" } ] } } }, "BatchChangeSiteContactPhoneNumberIsActiveResourceActionRequest": { "title": "BatchChangeSiteContactPhoneNumberIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSiteContactPhoneNumberIsActiveResourceActionRequest" } }, "GetSiteDocumentResourceActionResponse": { "title": "GetSiteDocumentResourceActionResponse", "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": "GetSiteDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteDocument->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->Site_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "SiteDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "SiteDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteDocument->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" } } }, "GetSiteDocumentCollectionForSiteResourceActionResponse": { "title": "GetSiteDocumentCollectionForSiteResourceActionResponse", "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": "GetSiteDocumentCollectionForSiteResourceActionResponseItem", "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": "GetSiteDocumentCollectionForSiteResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "SiteDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->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" } } } }, "GetSiteDocumentCollectionResourceActionResponse": { "title": "GetSiteDocumentCollectionResourceActionResponse", "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": "GetSiteDocumentCollectionResourceActionResponseItem", "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": "GetSiteDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteDocument->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteDocument->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteDocument->Site_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "SiteDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->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" } } } }, "SiteDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "SiteDocumentChangePermissionTreeLookupResourceActionResponse", "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": "SiteDocumentChangePermissionTreeLookupResourceActionResponseItem", "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": "SiteDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SiteDocumentDocumentLookupResourceActionResponse": { "title": "SiteDocumentDocumentLookupResourceActionResponse", "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": "SiteDocumentDocumentLookupResourceActionResponseItem", "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": "SiteDocumentDocumentLookupResourceActionResponseItemProperties", "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" } } } }, "SiteDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "SiteDocumentInsertPermissionTreeLookupResourceActionResponse", "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": "SiteDocumentInsertPermissionTreeLookupResourceActionResponseItem", "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": "SiteDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SiteDocumentSiteLookupResourceActionResponse": { "title": "SiteDocumentSiteLookupResourceActionResponse", "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": "SiteDocumentSiteLookupResourceActionResponseItem", "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": "SiteDocumentSiteLookupResourceActionResponseItemProperties", "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" } } } }, "CreateSiteDocumentResourceActionRequest": { "title": "CreateSiteDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSiteDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "siteId", "documentRecordId" ], "properties": { "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteDocument->Site_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSiteDocumentResourceActionRequest": { "title": "UpdateSiteDocumentResourceActionRequest", "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": "SiteDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteDocument->Notes" } ] } } }, "DeleteSiteDocumentResourceActionRequest": { "title": "DeleteSiteDocumentResourceActionRequest", "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 } } }, "BatchGetSiteDocumentResourceAction": { "title": "BatchGetSiteDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Site Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Site Document entities", "items": { "$ref": "#/definitions/GetSiteDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateSiteDocumentResourceActionRequest": { "title": "BatchCreateSiteDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSiteDocumentResourceActionRequest" } }, "BatchUpdateSiteDocumentResourceActionRequest": { "title": "BatchUpdateSiteDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSiteDocumentResourceActionRequest" } }, "BatchDeleteSiteDocumentResourceActionRequest": { "title": "BatchDeleteSiteDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSiteDocumentResourceActionRequest" } }, "ChangeSiteDocumentIsActiveResourceActionRequest": { "title": "ChangeSiteDocumentIsActiveResourceActionRequest", "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": "SiteDocument->IsActive" } ] } } }, "ChangeSiteDocumentPermissionTreeResourceActionRequest": { "title": "ChangeSiteDocumentPermissionTreeResourceActionRequest", "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": "SiteDocument->PermissionTree_Id" } ] } } }, "BatchChangeSiteDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeSiteDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSiteDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeSiteDocumentIsActiveResourceActionRequest": { "title": "BatchChangeSiteDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSiteDocumentIsActiveResourceActionRequest" } }, "GetSiteResourceResourceActionResponse": { "title": "GetSiteResourceResourceActionResponse", "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": "GetSiteResourceResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "SiteResource->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteResource->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteResource->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SiteResource->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteResource->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteResource->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteResource->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SiteResource->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteResource->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteResource->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteResource->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteResource->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteResource->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteResource->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteResource->Site_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteResource->Notes" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteResource->Resource_Code" }, "resourceContextId": { "title": "resourceContextId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteResource->ResourceContext_Id" }, "resourceContextCode": { "title": "resourceContextCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteResource->ResourceContext_Code" }, "resourceContextDescription": { "title": "resourceContextDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteResource->ResourceContext_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" } } }, "GetSiteResourceForSiteCollectionResourceActionResponse": { "title": "GetSiteResourceForSiteCollectionResourceActionResponse", "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": "GetSiteResourceForSiteCollectionResourceActionResponseItem", "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": "GetSiteResourceForSiteCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteResource->Resource_Code" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteResource->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteResource->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteResource->PermissionTree_Description" }, "resourceContextId": { "title": "resourceContextId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteResource->ResourceContext_Id" }, "resourceContextCode": { "title": "resourceContextCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteResource->ResourceContext_Code" }, "resourceContextDescription": { "title": "resourceContextDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteResource->ResourceContext_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" } } } }, "GetSiteResourceCollectionResourceActionResponse": { "title": "GetSiteResourceCollectionResourceActionResponse", "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": "GetSiteResourceCollectionResourceActionResponseItem", "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": "GetSiteResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteResource->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteResource->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteResource->Site_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteResource->Resource_Code" }, "resourceContextId": { "title": "resourceContextId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteResource->ResourceContext_Id" }, "resourceContextCode": { "title": "resourceContextCode", "type": "string", "x-nullable": false, "x-propertyPath": "SiteResource->ResourceContext_Code" }, "resourceContextDescription": { "title": "resourceContextDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SiteResource->ResourceContext_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteResource->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteResource->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteResource->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" } } } }, "SiteResourceChangePermissionTreeLookupResourceActionResponse": { "title": "SiteResourceChangePermissionTreeLookupResourceActionResponse", "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": "SiteResourceChangePermissionTreeLookupResourceActionResponseItem", "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": "SiteResourceChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SiteResourceInsertPermissionTreeLookupResourceActionResponse": { "title": "SiteResourceInsertPermissionTreeLookupResourceActionResponse", "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": "SiteResourceInsertPermissionTreeLookupResourceActionResponseItem", "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": "SiteResourceInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SiteResourceResourceContextLookupResourceActionResponse": { "title": "SiteResourceResourceContextLookupResourceActionResponse", "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": "SiteResourceResourceContextLookupResourceActionResponseItem", "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": "SiteResourceResourceContextLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceContext->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceContext->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" } } } }, "SiteResourceResourceLookupResourceActionResponse": { "title": "SiteResourceResourceLookupResourceActionResponse", "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": "SiteResourceResourceLookupResourceActionResponseItem", "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": "SiteResourceResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->Description" }, "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" } } } }, "SiteResourceSiteLookupResourceActionResponse": { "title": "SiteResourceSiteLookupResourceActionResponse", "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": "SiteResourceSiteLookupResourceActionResponseItem", "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": "SiteResourceSiteLookupResourceActionResponseItemProperties", "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" } } } }, "CreateSiteResourceResourceActionRequest": { "title": "CreateSiteResourceResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSiteResourceResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "siteId", "resourceId", "resourceContextId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteResource->PermissionTree_Id" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteResource->Site_Id" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteResource->Resource_Id" }, "resourceContextId": { "title": "resourceContextId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteResource->ResourceContext_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteResource->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSiteResourceResourceActionRequest": { "title": "UpdateSiteResourceResourceActionRequest", "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": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteResource->Resource_Id" }, { "title": "resourceContextId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteResource->ResourceContext_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteResource->Notes" } ] } } }, "DeleteSiteResourceResourceActionRequest": { "title": "DeleteSiteResourceResourceActionRequest", "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 } } }, "BatchGetSiteResourceResourceAction": { "title": "BatchGetSiteResourceResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Site Resource entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Site Resource entities", "items": { "$ref": "#/definitions/GetSiteResourceResourceActionResponse" } }, "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" } } }, "BatchCreateSiteResourceResourceActionRequest": { "title": "BatchCreateSiteResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSiteResourceResourceActionRequest" } }, "BatchUpdateSiteResourceResourceActionRequest": { "title": "BatchUpdateSiteResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSiteResourceResourceActionRequest" } }, "BatchDeleteSiteResourceResourceActionRequest": { "title": "BatchDeleteSiteResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSiteResourceResourceActionRequest" } }, "ChangeSiteResourceIsActiveResourceActionRequest": { "title": "ChangeSiteResourceIsActiveResourceActionRequest", "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": "SiteResource->IsActive" } ] } } }, "ChangeSiteResourcePermissionTreeResourceActionRequest": { "title": "ChangeSiteResourcePermissionTreeResourceActionRequest", "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": "SiteResource->PermissionTree_Id" } ] } } }, "ChangeSiteResourceSiteResourceActionRequest": { "title": "ChangeSiteResourceSiteResourceActionRequest", "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": "SiteResource->Site_Id" } ] } } }, "BatchChangeSiteResourceIsActiveResourceActionRequest": { "title": "BatchChangeSiteResourceIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSiteResourceIsActiveResourceActionRequest" } }, "BatchChangeSiteResourcePermissionTreeResourceActionRequest": { "title": "BatchChangeSiteResourcePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSiteResourcePermissionTreeResourceActionRequest" } }, "BatchChangeSiteResourceSiteResourceActionRequest": { "title": "BatchChangeSiteResourceSiteResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSiteResourceSiteResourceActionRequest" } }, "GetSiteTreePathMapResourceActionResponse": { "title": "GetSiteTreePathMapResourceActionResponse", "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" } } }, "GetSiteTreePathMapResourceAction": { "title": "GetSiteTreePathMapResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Site Tree entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Site Tree entities", "items": { "$ref": "#/definitions/GetSiteTreePathMapResourceActionResponse" } }, "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" } } } }, "GetSiteTypeResourceActionResponse": { "title": "GetSiteTypeResourceActionResponse", "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": "GetSiteTypeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "SiteType->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SiteType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteType->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "SiteType->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SiteType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SiteType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SiteType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SiteType->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "SiteType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteType->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" } } }, "GetSiteTypeCollectionResourceActionResponse": { "title": "GetSiteTypeCollectionResourceActionResponse", "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": "GetSiteTypeCollectionResourceActionResponseItem", "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": "GetSiteTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "SiteType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "SiteType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteType->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "SiteType->IsActive" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteType->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SiteType->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" } } } }, "SiteTypeChangePermissionTreeLookupResourceActionResponse": { "title": "SiteTypeChangePermissionTreeLookupResourceActionResponse", "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": "SiteTypeChangePermissionTreeLookupResourceActionResponseItem", "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": "SiteTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SiteTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "SiteTypeInsertPermissionTreeLookupResourceActionResponse", "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": "SiteTypeInsertPermissionTreeLookupResourceActionResponseItem", "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": "SiteTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateSiteTypeResourceActionRequest": { "title": "CreateSiteTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSiteTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SiteType->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "SiteType->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "SiteType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteType->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSiteTypeResourceActionRequest": { "title": "UpdateSiteTypeResourceActionRequest", "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": "SiteType->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "SiteType->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SiteType->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SiteType->Notes" } ] } } }, "DeleteSiteTypeResourceActionRequest": { "title": "DeleteSiteTypeResourceActionRequest", "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 } } }, "BatchGetSiteTypeResourceAction": { "title": "BatchGetSiteTypeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Site Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Site Type entities", "items": { "$ref": "#/definitions/GetSiteTypeResourceActionResponse" } }, "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" } } }, "BatchCreateSiteTypeResourceActionRequest": { "title": "BatchCreateSiteTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSiteTypeResourceActionRequest" } }, "BatchUpdateSiteTypeResourceActionRequest": { "title": "BatchUpdateSiteTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSiteTypeResourceActionRequest" } }, "BatchDeleteSiteTypeResourceActionRequest": { "title": "BatchDeleteSiteTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSiteTypeResourceActionRequest" } }, "ChangeSiteTypeIsActiveResourceActionRequest": { "title": "ChangeSiteTypeIsActiveResourceActionRequest", "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": "SiteType->IsActive" } ] } } }, "ChangeSiteTypePermissionTreeResourceActionRequest": { "title": "ChangeSiteTypePermissionTreeResourceActionRequest", "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": "SiteType->PermissionTree_Id" } ] } } }, "BatchChangeSiteTypeIsActiveResourceActionRequest": { "title": "BatchChangeSiteTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSiteTypeIsActiveResourceActionRequest" } }, "BatchChangeSiteTypePermissionTreeResourceActionRequest": { "title": "BatchChangeSiteTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSiteTypePermissionTreeResourceActionRequest" } }, "GetSupplierResourceActionResponse": { "title": "GetSupplierResourceActionResponse", "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": "GetSupplierResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Supplier->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Supplier->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Supplier->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Supplier->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Supplier->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Supplier->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Supplier->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Supplier->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Supplier->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Supplier->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Supplier->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Supplier->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Supplier->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "Supplier->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Supplier->Site_Description" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Supplier->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "Supplier->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Supplier->Currency_Description" }, "currencyIsoCode": { "title": "currencyIsoCode", "type": "string", "x-nullable": true, "x-propertyPath": "Supplier->Currency_IsoCode" }, "defaultTaxRatePercentageId": { "title": "defaultTaxRatePercentageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Supplier->DefaultTaxRatePercentage_Id" }, "defaultTaxRatePercentageTaxRate": { "title": "defaultTaxRatePercentageTaxRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Supplier->DefaultTaxRatePercentage_TaxRate" }, "defaultTaxRatePercentageBuyingSiteId": { "title": "defaultTaxRatePercentageBuyingSiteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Supplier->DefaultTaxRatePercentage_BuyingSite_Id" }, "defaultTaxRatePercentageBuyingSiteCode": { "title": "defaultTaxRatePercentageBuyingSiteCode", "type": "string", "x-nullable": true, "x-propertyPath": "Supplier->DefaultTaxRatePercentage_BuyingSite_Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Description" }, "discountPercentage": { "title": "discountPercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Supplier->DiscountPercentage" }, "isApproved": { "title": "isApproved", "type": "boolean", "x-nullable": false, "x-propertyPath": "Supplier->IsApproved" }, "isContractLabourSupplier": { "title": "isContractLabourSupplier", "type": "boolean", "x-nullable": false, "x-propertyPath": "Supplier->IsContractLabourSupplier" }, "isMaterialSupplier": { "title": "isMaterialSupplier", "type": "boolean", "x-nullable": false, "x-propertyPath": "Supplier->IsMaterialSupplier" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Supplier->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Supplier->SequenceNumber" }, "taxNumber": { "title": "taxNumber", "type": "string", "x-nullable": true, "x-propertyPath": "Supplier->TaxNumber" } } }, "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" } } }, "GetSupplierCollectionResourceActionResponse": { "title": "GetSupplierCollectionResourceActionResponse", "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": "GetSupplierCollectionResourceActionResponseItem", "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": "GetSupplierCollectionResourceActionResponseItemProperties", "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" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Supplier->Site_Code" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Supplier->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Supplier->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Supplier->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Supplier->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" } } } }, "SupplierChangePermissionTreeLookupResourceActionResponse": { "title": "SupplierChangePermissionTreeLookupResourceActionResponse", "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": "SupplierChangePermissionTreeLookupResourceActionResponseItem", "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": "SupplierChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SupplierCurrencyLookupResourceActionResponse": { "title": "SupplierCurrencyLookupResourceActionResponse", "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": "SupplierCurrencyLookupResourceActionResponseItem", "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": "SupplierCurrencyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->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" } } } }, "SupplierDefaultTaxRateLookupResourceActionResponse": { "title": "SupplierDefaultTaxRateLookupResourceActionResponse", "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": "SupplierDefaultTaxRateLookupResourceActionResponseItem", "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": "SupplierDefaultTaxRateLookupResourceActionResponseItemProperties", "type": "object", "properties": { "buyingSiteCode": { "title": "buyingSiteCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierTaxRate->BuyingSite_Code" }, "taxRate": { "title": "taxRate", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "SupplierTaxRate->TaxRate" } } }, "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" } } } }, "SupplierInsertPermissionTreeLookupResourceActionResponse": { "title": "SupplierInsertPermissionTreeLookupResourceActionResponse", "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": "SupplierInsertPermissionTreeLookupResourceActionResponseItem", "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": "SupplierInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SupplierSiteLookupResourceActionResponse": { "title": "SupplierSiteLookupResourceActionResponse", "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": "SupplierSiteLookupResourceActionResponseItem", "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": "SupplierSiteLookupResourceActionResponseItemProperties", "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" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Currency_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" } } } }, "CreateSupplierResourceActionRequest": { "title": "CreateSupplierResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSupplierResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "siteId" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Supplier->Code" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Supplier->Currency_Id", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Supplier->Description" }, "discountPercentage": { "title": "discountPercentage", "type": "number", "format": "decimal", "maximum": 100.0, "minimum": 0.0, "x-nullable": false, "x-propertyPath": "Supplier->DiscountPercentage", "x-systemGenerated": true }, "isApproved": { "title": "isApproved", "type": "boolean", "x-nullable": false, "x-propertyPath": "Supplier->IsApproved" }, "isContractLabourSupplier": { "title": "isContractLabourSupplier", "type": "boolean", "x-nullable": false, "x-propertyPath": "Supplier->IsContractLabourSupplier" }, "isMaterialSupplier": { "title": "isMaterialSupplier", "type": "boolean", "x-nullable": false, "x-propertyPath": "Supplier->IsMaterialSupplier" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Supplier->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Supplier->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Supplier->SequenceNumber" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Supplier->Site_Id" }, "taxNumber": { "title": "taxNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "Supplier->TaxNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSupplierResourceActionRequest": { "title": "UpdateSupplierResourceActionRequest", "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": "Supplier->Code" }, { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Supplier->Currency_Id" }, { "title": "defaultTaxRatePercentageId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Supplier->DefaultTaxRatePercentage_Id" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Supplier->Description" }, { "title": "discountPercentage", "type": "number", "format": "decimal", "maximum": 100.0, "minimum": 0.0, "x-nullable": false, "x-propertyPath": "Supplier->DiscountPercentage" }, { "title": "isApproved", "type": "boolean", "x-nullable": false, "x-propertyPath": "Supplier->IsApproved" }, { "title": "isContractLabourSupplier", "type": "boolean", "x-nullable": false, "x-propertyPath": "Supplier->IsContractLabourSupplier" }, { "title": "isMaterialSupplier", "type": "boolean", "x-nullable": false, "x-propertyPath": "Supplier->IsMaterialSupplier" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Supplier->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Supplier->SequenceNumber" }, { "title": "taxNumber", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "Supplier->TaxNumber" } ] } } }, "DeleteSupplierResourceActionRequest": { "title": "DeleteSupplierResourceActionRequest", "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 } } }, "BatchGetSupplierResourceAction": { "title": "BatchGetSupplierResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Supplier entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Supplier entities", "items": { "$ref": "#/definitions/GetSupplierResourceActionResponse" } }, "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" } } }, "BatchCreateSupplierResourceActionRequest": { "title": "BatchCreateSupplierResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSupplierResourceActionRequest" } }, "BatchUpdateSupplierResourceActionRequest": { "title": "BatchUpdateSupplierResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSupplierResourceActionRequest" } }, "BatchDeleteSupplierResourceActionRequest": { "title": "BatchDeleteSupplierResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSupplierResourceActionRequest" } }, "ChangeSupplierIsActiveResourceActionRequest": { "title": "ChangeSupplierIsActiveResourceActionRequest", "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": "Supplier->IsActive" } ] } } }, "ChangeSupplierPermissionTreeResourceActionRequest": { "title": "ChangeSupplierPermissionTreeResourceActionRequest", "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": "Supplier->PermissionTree_Id" } ] } } }, "ChangeSupplierSiteResourceActionRequest": { "title": "ChangeSupplierSiteResourceActionRequest", "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": "Supplier->Site_Id" } ] } } }, "BatchChangeSupplierIsActiveResourceActionRequest": { "title": "BatchChangeSupplierIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSupplierIsActiveResourceActionRequest" } }, "BatchChangeSupplierPermissionTreeResourceActionRequest": { "title": "BatchChangeSupplierPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSupplierPermissionTreeResourceActionRequest" } }, "BatchChangeSupplierSiteResourceActionRequest": { "title": "BatchChangeSupplierSiteResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSupplierSiteResourceActionRequest" } }, "GetSupplierAttributeResourceActionResponse": { "title": "GetSupplierAttributeResourceActionResponse", "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": "GetSupplierAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierAttribute->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->Supplier_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "SupplierAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "SupplierAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SupplierAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SupplierAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SupplierAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SupplierAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SupplierAttribute->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" } } }, "GetSupplierAttributeCollectionForSupplierResourceActionResponse": { "title": "GetSupplierAttributeCollectionForSupplierResourceActionResponse", "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": "GetSupplierAttributeCollectionForSupplierResourceActionResponseItem", "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": "GetSupplierAttributeCollectionForSupplierResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SupplierAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SupplierAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SupplierAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierAttribute->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" } } } }, "GetSupplierAttributeCollectionResourceActionResponse": { "title": "GetSupplierAttributeCollectionResourceActionResponse", "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": "GetSupplierAttributeCollectionResourceActionResponseItem", "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": "GetSupplierAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierAttribute->SequenceNumber" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierAttribute->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierAttribute->Supplier_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SupplierAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SupplierAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SupplierAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierAttribute->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" } } } }, "SupplierAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "SupplierAttributeAttributeAllowedValueLookupResourceActionResponse", "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": "SupplierAttributeAttributeAllowedValueLookupResourceActionResponseItem", "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": "SupplierAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "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" } } } }, "SupplierAttributeAttributeLookupResourceActionResponse": { "title": "SupplierAttributeAttributeLookupResourceActionResponse", "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": "SupplierAttributeAttributeLookupResourceActionResponseItem", "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": "SupplierAttributeAttributeLookupResourceActionResponseItemProperties", "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" } } } }, "SupplierAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "SupplierAttributeInsertPermissionTreeLookupResourceActionResponse", "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": "SupplierAttributeInsertPermissionTreeLookupResourceActionResponseItem", "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": "SupplierAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SupplierAttributeSupplierLookupResourceActionResponse": { "title": "SupplierAttributeSupplierLookupResourceActionResponse", "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": "SupplierAttributeSupplierLookupResourceActionResponseItem", "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": "SupplierAttributeSupplierLookupResourceActionResponseItemProperties", "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" } } } }, "CreateSupplierAttributeResourceActionRequest": { "title": "CreateSupplierAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSupplierAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "supplierId", "attributeId" ], "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierAttribute->Supplier_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "SupplierAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSupplierAttributeResourceActionRequest": { "title": "UpdateSupplierAttributeResourceActionRequest", "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": "SupplierAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierAttribute->Notes" } ] } } }, "DeleteSupplierAttributeResourceActionRequest": { "title": "DeleteSupplierAttributeResourceActionRequest", "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 } } }, "BatchGetSupplierAttributeResourceAction": { "title": "BatchGetSupplierAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Supplier Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Supplier Attribute entities", "items": { "$ref": "#/definitions/GetSupplierAttributeResourceActionResponse" } }, "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" } } }, "BatchCreateSupplierAttributeResourceActionRequest": { "title": "BatchCreateSupplierAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSupplierAttributeResourceActionRequest" } }, "BatchUpdateSupplierAttributeResourceActionRequest": { "title": "BatchUpdateSupplierAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSupplierAttributeResourceActionRequest" } }, "BatchDeleteSupplierAttributeResourceActionRequest": { "title": "BatchDeleteSupplierAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSupplierAttributeResourceActionRequest" } }, "ChangeSupplierAttributeIsActiveResourceActionRequest": { "title": "ChangeSupplierAttributeIsActiveResourceActionRequest", "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": "SupplierAttribute->IsActive" } ] } } }, "BatchChangeSupplierAttributeIsActiveResourceActionRequest": { "title": "BatchChangeSupplierAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSupplierAttributeIsActiveResourceActionRequest" } }, "GetSupplierContactAddressResourceActionResponse": { "title": "GetSupplierContactAddressResourceActionResponse", "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": "GetSupplierContactAddressResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactAddress->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactAddress->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->PermissionTree_Description" }, "addressTypeId": { "title": "addressTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->AddressType_Id" }, "addressTypeCode": { "title": "addressTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->AddressType_Code" }, "addressTypeDescription": { "title": "addressTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->AddressType_Description" }, "body": { "title": "body", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->Body" }, "country": { "title": "country", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->Country" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->Notes" }, "postalCode": { "title": "postalCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->PostalCode" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->SequenceNumber" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->Supplier_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" } } }, "GetSupplierContactAddressCollectionResourceActionResponse": { "title": "GetSupplierContactAddressCollectionResourceActionResponse", "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": "GetSupplierContactAddressCollectionResourceActionResponseItem", "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": "GetSupplierContactAddressCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->Supplier_Description" }, "addressTypeId": { "title": "addressTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->AddressType_Id" }, "addressTypeCode": { "title": "addressTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->AddressType_Code" }, "addressTypeDescription": { "title": "addressTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->AddressType_Description" }, "body": { "title": "body", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->Body" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactAddress->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactAddress->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" } } } }, "GetSupplierContactAddressForSupplierCollectionResourceActionResponse": { "title": "GetSupplierContactAddressForSupplierCollectionResourceActionResponse", "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": "GetSupplierContactAddressForSupplierCollectionResourceActionResponseItem", "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": "GetSupplierContactAddressForSupplierCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "addressTypeId": { "title": "addressTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->AddressType_Id" }, "addressTypeCode": { "title": "addressTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->AddressType_Code" }, "addressTypeDescription": { "title": "addressTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->AddressType_Description" }, "body": { "title": "body", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->Body" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactAddress->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactAddress->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" } } } }, "SupplierContactAddressAddressTypeLookupResourceActionResponse": { "title": "SupplierContactAddressAddressTypeLookupResourceActionResponse", "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": "SupplierContactAddressAddressTypeLookupResourceActionResponseItem", "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": "SupplierContactAddressAddressTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "AddressType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "AddressType->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" } } } }, "SupplierContactAddressInsertPermissionTreeLookupResourceActionResponse": { "title": "SupplierContactAddressInsertPermissionTreeLookupResourceActionResponse", "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": "SupplierContactAddressInsertPermissionTreeLookupResourceActionResponseItem", "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": "SupplierContactAddressInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SupplierContactAddressSupplierLookupResourceActionResponse": { "title": "SupplierContactAddressSupplierLookupResourceActionResponse", "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": "SupplierContactAddressSupplierLookupResourceActionResponseItem", "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": "SupplierContactAddressSupplierLookupResourceActionResponseItemProperties", "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" } } } }, "CreateSupplierContactAddressResourceActionRequest": { "title": "CreateSupplierContactAddressResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSupplierContactAddressResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "supplierId", "addressTypeId" ], "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->Supplier_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->PermissionTree_Id", "x-systemGenerated": true }, "addressTypeId": { "title": "addressTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->AddressType_Id" }, "body": { "title": "body", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->Body" }, "postalCode": { "title": "postalCode", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "SupplierContactAddress->PostalCode" }, "country": { "title": "country", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "SupplierContactAddress->Country" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSupplierContactAddressResourceActionRequest": { "title": "UpdateSupplierContactAddressResourceActionRequest", "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": "addressTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->AddressType_Id" }, { "title": "body", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactAddress->Body" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->SequenceNumber" }, { "title": "postalCode", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "SupplierContactAddress->PostalCode" }, { "title": "country", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": true, "x-propertyPath": "SupplierContactAddress->Country" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactAddress->Notes" } ] } } }, "DeleteSupplierContactAddressResourceActionRequest": { "title": "DeleteSupplierContactAddressResourceActionRequest", "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 } } }, "BatchGetSupplierContactAddressResourceAction": { "title": "BatchGetSupplierContactAddressResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Supplier Contact Address entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Supplier Contact Address entities", "items": { "$ref": "#/definitions/GetSupplierContactAddressResourceActionResponse" } }, "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" } } }, "BatchCreateSupplierContactAddressResourceActionRequest": { "title": "BatchCreateSupplierContactAddressResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSupplierContactAddressResourceActionRequest" } }, "BatchUpdateSupplierContactAddressResourceActionRequest": { "title": "BatchUpdateSupplierContactAddressResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSupplierContactAddressResourceActionRequest" } }, "BatchDeleteSupplierContactAddressResourceActionRequest": { "title": "BatchDeleteSupplierContactAddressResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSupplierContactAddressResourceActionRequest" } }, "ChangeSupplierContactAddressIsActiveResourceActionRequest": { "title": "ChangeSupplierContactAddressIsActiveResourceActionRequest", "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": "SupplierContactAddress->IsActive" } ] } } }, "BatchChangeSupplierContactAddressIsActiveResourceActionRequest": { "title": "BatchChangeSupplierContactAddressIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSupplierContactAddressIsActiveResourceActionRequest" } }, "GetSupplierContactEmailResourceActionResponse": { "title": "GetSupplierContactEmailResourceActionResponse", "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": "GetSupplierContactEmailResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "SupplierContactEmail->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactEmail->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactEmail->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactEmail->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->PermissionTree_Description" }, "email": { "title": "email", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactEmail->Email" }, "emailTypeId": { "title": "emailTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactEmail->EmailType_Id" }, "emailTypeCode": { "title": "emailTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->EmailType_Code" }, "emailTypeDescription": { "title": "emailTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->EmailType_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->SequenceNumber" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactEmail->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->Supplier_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" } } }, "GetSupplierContactEmailCollectionResourceActionResponse": { "title": "GetSupplierContactEmailCollectionResourceActionResponse", "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": "GetSupplierContactEmailCollectionResourceActionResponseItem", "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": "GetSupplierContactEmailCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactEmail->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactEmail->Supplier_Description" }, "emailTypeId": { "title": "emailTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->EmailType_Id" }, "emailTypeCode": { "title": "emailTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactEmail->EmailType_Code" }, "emailTypeDescription": { "title": "emailTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactEmail->EmailType_Description" }, "email": { "title": "email", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactEmail->Email" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactEmail->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactEmail->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" } } } }, "GetSupplierContactEmailForSupplierCollectionResourceActionResponse": { "title": "GetSupplierContactEmailForSupplierCollectionResourceActionResponse", "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": "GetSupplierContactEmailForSupplierCollectionResourceActionResponseItem", "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": "GetSupplierContactEmailForSupplierCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "emailTypeId": { "title": "emailTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->EmailType_Id" }, "emailTypeCode": { "title": "emailTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactEmail->EmailType_Code" }, "emailTypeDescription": { "title": "emailTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactEmail->EmailType_Description" }, "email": { "title": "email", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactEmail->Email" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactEmail->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactEmail->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" } } } }, "SupplierContactEmailEmailTypeLookupResourceActionResponse": { "title": "SupplierContactEmailEmailTypeLookupResourceActionResponse", "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": "SupplierContactEmailEmailTypeLookupResourceActionResponseItem", "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": "SupplierContactEmailEmailTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "EmailType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "EmailType->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" } } } }, "SupplierContactEmailInsertPermissionTreeLookupResourceActionResponse": { "title": "SupplierContactEmailInsertPermissionTreeLookupResourceActionResponse", "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": "SupplierContactEmailInsertPermissionTreeLookupResourceActionResponseItem", "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": "SupplierContactEmailInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SupplierContactEmailSupplierLookupResourceActionResponse": { "title": "SupplierContactEmailSupplierLookupResourceActionResponse", "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": "SupplierContactEmailSupplierLookupResourceActionResponseItem", "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": "SupplierContactEmailSupplierLookupResourceActionResponseItemProperties", "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" } } } }, "CreateSupplierContactEmailResourceActionRequest": { "title": "CreateSupplierContactEmailResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSupplierContactEmailResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "supplierId", "emailTypeId", "email" ], "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactEmail->Supplier_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactEmail->PermissionTree_Id", "x-systemGenerated": true }, "emailTypeId": { "title": "emailTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactEmail->EmailType_Id" }, "email": { "title": "email", "type": "string", "maxLength": 255, "x-nullable": false, "x-propertyPath": "SupplierContactEmail->Email" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSupplierContactEmailResourceActionRequest": { "title": "UpdateSupplierContactEmailResourceActionRequest", "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": "emailTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactEmail->EmailType_Id" }, { "title": "email", "type": "string", "maxLength": 255, "x-nullable": false, "x-propertyPath": "SupplierContactEmail->Email" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactEmail->Notes" } ] } } }, "DeleteSupplierContactEmailResourceActionRequest": { "title": "DeleteSupplierContactEmailResourceActionRequest", "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 } } }, "BatchGetSupplierContactEmailResourceAction": { "title": "BatchGetSupplierContactEmailResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Supplier Contact Email entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Supplier Contact Email entities", "items": { "$ref": "#/definitions/GetSupplierContactEmailResourceActionResponse" } }, "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" } } }, "BatchCreateSupplierContactEmailResourceActionRequest": { "title": "BatchCreateSupplierContactEmailResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSupplierContactEmailResourceActionRequest" } }, "BatchUpdateSupplierContactEmailResourceActionRequest": { "title": "BatchUpdateSupplierContactEmailResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSupplierContactEmailResourceActionRequest" } }, "BatchDeleteSupplierContactEmailResourceActionRequest": { "title": "BatchDeleteSupplierContactEmailResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSupplierContactEmailResourceActionRequest" } }, "ChangeSupplierContactEmailIsActiveResourceActionRequest": { "title": "ChangeSupplierContactEmailIsActiveResourceActionRequest", "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": "SupplierContactEmail->IsActive" } ] } } }, "BatchChangeSupplierContactEmailIsActiveResourceActionRequest": { "title": "BatchChangeSupplierContactEmailIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSupplierContactEmailIsActiveResourceActionRequest" } }, "GetSupplierContactPhoneNumberResourceActionResponse": { "title": "GetSupplierContactPhoneNumberResourceActionResponse", "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": "GetSupplierContactPhoneNumberResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactPhoneNumber->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactPhoneNumber->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->PermissionTree_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->Notes" }, "phoneNumber": { "title": "phoneNumber", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->PhoneNumber" }, "phoneNumberTypeId": { "title": "phoneNumberTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->PhoneNumberType_Id" }, "phoneNumberTypeCode": { "title": "phoneNumberTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->PhoneNumberType_Code" }, "phoneNumberTypeDescription": { "title": "phoneNumberTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->PhoneNumberType_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->SequenceNumber" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->Supplier_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" } } }, "GetSupplierContactPhoneNumberCollectionResourceActionResponse": { "title": "GetSupplierContactPhoneNumberCollectionResourceActionResponse", "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": "GetSupplierContactPhoneNumberCollectionResourceActionResponseItem", "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": "GetSupplierContactPhoneNumberCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->Supplier_Description" }, "phoneNumberTypeId": { "title": "phoneNumberTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->PhoneNumberType_Id" }, "phoneNumberTypeCode": { "title": "phoneNumberTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->PhoneNumberType_Code" }, "phoneNumberTypeDescription": { "title": "phoneNumberTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->PhoneNumberType_Description" }, "phoneNumber": { "title": "phoneNumber", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->PhoneNumber" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactPhoneNumber->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactPhoneNumber->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" } } } }, "GetSupplierContactPhoneNumberForSupplierCollectionResourceActionResponse": { "title": "GetSupplierContactPhoneNumberForSupplierCollectionResourceActionResponse", "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": "GetSupplierContactPhoneNumberForSupplierCollectionResourceActionResponseItem", "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": "GetSupplierContactPhoneNumberForSupplierCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "phoneNumberTypeId": { "title": "phoneNumberTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->PhoneNumberType_Id" }, "phoneNumberTypeCode": { "title": "phoneNumberTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->PhoneNumberType_Code" }, "phoneNumberTypeDescription": { "title": "phoneNumberTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->PhoneNumberType_Description" }, "phoneNumber": { "title": "phoneNumber", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->PhoneNumber" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactPhoneNumber->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierContactPhoneNumber->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" } } } }, "SupplierContactPhoneNumberInsertPermissionTreeLookupResourceActionResponse": { "title": "SupplierContactPhoneNumberInsertPermissionTreeLookupResourceActionResponse", "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": "SupplierContactPhoneNumberInsertPermissionTreeLookupResourceActionResponseItem", "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": "SupplierContactPhoneNumberInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SupplierContactPhoneNumberPhoneNumberTypeLookupResourceActionResponse": { "title": "SupplierContactPhoneNumberPhoneNumberTypeLookupResourceActionResponse", "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": "SupplierContactPhoneNumberPhoneNumberTypeLookupResourceActionResponseItem", "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": "SupplierContactPhoneNumberPhoneNumberTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PhoneNumberType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PhoneNumberType->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" } } } }, "SupplierContactPhoneNumberSupplierLookupResourceActionResponse": { "title": "SupplierContactPhoneNumberSupplierLookupResourceActionResponse", "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": "SupplierContactPhoneNumberSupplierLookupResourceActionResponseItem", "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": "SupplierContactPhoneNumberSupplierLookupResourceActionResponseItemProperties", "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" } } } }, "CreateSupplierContactPhoneNumberResourceActionRequest": { "title": "CreateSupplierContactPhoneNumberResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSupplierContactPhoneNumberResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "supplierId", "phoneNumberTypeId", "phoneNumber" ], "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->Supplier_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->PermissionTree_Id", "x-systemGenerated": true }, "phoneNumberTypeId": { "title": "phoneNumberTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->PhoneNumberType_Id" }, "phoneNumber": { "title": "phoneNumber", "type": "string", "maxLength": 30, "minLength": 1, "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->PhoneNumber" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSupplierContactPhoneNumberResourceActionRequest": { "title": "UpdateSupplierContactPhoneNumberResourceActionRequest", "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": "phoneNumberTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->PhoneNumberType_Id" }, { "title": "phoneNumber", "type": "string", "maxLength": 30, "minLength": 1, "pattern": "^(?:\\+\\d{1,3})?\\s*(?:\\(?\\d{1,5}\\))?\\s?[\\d\\s-]{4,14}(\\s?\\#(\\d{4}|\\d{3}))?$", "x-nullable": false, "x-propertyPath": "SupplierContactPhoneNumber->PhoneNumber" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierContactPhoneNumber->Notes" } ] } } }, "DeleteSupplierContactPhoneNumberResourceActionRequest": { "title": "DeleteSupplierContactPhoneNumberResourceActionRequest", "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 } } }, "BatchGetSupplierContactPhoneNumberResourceAction": { "title": "BatchGetSupplierContactPhoneNumberResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Supplier Contact Phone Number entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Supplier Contact Phone Number entities", "items": { "$ref": "#/definitions/GetSupplierContactPhoneNumberResourceActionResponse" } }, "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" } } }, "BatchCreateSupplierContactPhoneNumberResourceActionRequest": { "title": "BatchCreateSupplierContactPhoneNumberResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSupplierContactPhoneNumberResourceActionRequest" } }, "BatchUpdateSupplierContactPhoneNumberResourceActionRequest": { "title": "BatchUpdateSupplierContactPhoneNumberResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSupplierContactPhoneNumberResourceActionRequest" } }, "BatchDeleteSupplierContactPhoneNumberResourceActionRequest": { "title": "BatchDeleteSupplierContactPhoneNumberResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSupplierContactPhoneNumberResourceActionRequest" } }, "ChangeSupplierContactPhoneNumberIsActiveResourceActionRequest": { "title": "ChangeSupplierContactPhoneNumberIsActiveResourceActionRequest", "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": "SupplierContactPhoneNumber->IsActive" } ] } } }, "BatchChangeSupplierContactPhoneNumberIsActiveResourceActionRequest": { "title": "BatchChangeSupplierContactPhoneNumberIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSupplierContactPhoneNumberIsActiveResourceActionRequest" } }, "GetSupplierDocumentResourceActionResponse": { "title": "GetSupplierDocumentResourceActionResponse", "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": "GetSupplierDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierDocument->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->Supplier_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "SupplierDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "SupplierDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierDocument->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" } } }, "GetSupplierDocumentCollectionForSupplierResourceActionResponse": { "title": "GetSupplierDocumentCollectionForSupplierResourceActionResponse", "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": "GetSupplierDocumentCollectionForSupplierResourceActionResponseItem", "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": "GetSupplierDocumentCollectionForSupplierResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "SupplierDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->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" } } } }, "GetSupplierDocumentCollectionResourceActionResponse": { "title": "GetSupplierDocumentCollectionResourceActionResponse", "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": "GetSupplierDocumentCollectionResourceActionResponseItem", "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": "GetSupplierDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierDocument->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierDocument->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierDocument->Supplier_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "SupplierDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->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" } } } }, "SupplierDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "SupplierDocumentChangePermissionTreeLookupResourceActionResponse", "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": "SupplierDocumentChangePermissionTreeLookupResourceActionResponseItem", "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": "SupplierDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SupplierDocumentDocumentLookupResourceActionResponse": { "title": "SupplierDocumentDocumentLookupResourceActionResponse", "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": "SupplierDocumentDocumentLookupResourceActionResponseItem", "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": "SupplierDocumentDocumentLookupResourceActionResponseItemProperties", "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" } } } }, "SupplierDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "SupplierDocumentInsertPermissionTreeLookupResourceActionResponse", "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": "SupplierDocumentInsertPermissionTreeLookupResourceActionResponseItem", "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": "SupplierDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SupplierDocumentSupplierLookupResourceActionResponse": { "title": "SupplierDocumentSupplierLookupResourceActionResponse", "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": "SupplierDocumentSupplierLookupResourceActionResponseItem", "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": "SupplierDocumentSupplierLookupResourceActionResponseItemProperties", "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" } } } }, "CreateSupplierDocumentResourceActionRequest": { "title": "CreateSupplierDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSupplierDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "supplierId", "documentRecordId" ], "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierDocument->Supplier_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSupplierDocumentResourceActionRequest": { "title": "UpdateSupplierDocumentResourceActionRequest", "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": "SupplierDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierDocument->Notes" } ] } } }, "DeleteSupplierDocumentResourceActionRequest": { "title": "DeleteSupplierDocumentResourceActionRequest", "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 } } }, "BatchGetSupplierDocumentResourceAction": { "title": "BatchGetSupplierDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Supplier Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Supplier Document entities", "items": { "$ref": "#/definitions/GetSupplierDocumentResourceActionResponse" } }, "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" } } }, "BatchCreateSupplierDocumentResourceActionRequest": { "title": "BatchCreateSupplierDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSupplierDocumentResourceActionRequest" } }, "BatchUpdateSupplierDocumentResourceActionRequest": { "title": "BatchUpdateSupplierDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSupplierDocumentResourceActionRequest" } }, "BatchDeleteSupplierDocumentResourceActionRequest": { "title": "BatchDeleteSupplierDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSupplierDocumentResourceActionRequest" } }, "ChangeSupplierDocumentIsActiveResourceActionRequest": { "title": "ChangeSupplierDocumentIsActiveResourceActionRequest", "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": "SupplierDocument->IsActive" } ] } } }, "ChangeSupplierDocumentPermissionTreeResourceActionRequest": { "title": "ChangeSupplierDocumentPermissionTreeResourceActionRequest", "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": "SupplierDocument->PermissionTree_Id" } ] } } }, "BatchChangeSupplierDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeSupplierDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSupplierDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeSupplierDocumentIsActiveResourceActionRequest": { "title": "BatchChangeSupplierDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSupplierDocumentIsActiveResourceActionRequest" } }, "GetSupplierFileAttachmentResourceActionResponse": { "title": "GetSupplierFileAttachmentResourceActionResponse", "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": "GetSupplierFileAttachmentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->Supplier_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierFileAttachment->CreatedOn" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "SupplierFileAttachment->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->ContentVersion" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->EntityType", "x-formatSpecifier": "EntityType" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->FileCategory_Description" }, "fileCategoryAutoIsRestricted": { "title": "fileCategoryAutoIsRestricted", "type": "boolean", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->FileCategory_AutoIsRestricted" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->FileFullName" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->FileName" }, "fileTypeId": { "title": "fileTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->FileType_Id" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->IsRestricted" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierFileAttachment->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->PermissionTree_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" } } }, "GetSupplierFileAttachmentCollectionForSupplierResourceActionResponse": { "title": "GetSupplierFileAttachmentCollectionForSupplierResourceActionResponse", "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": "GetSupplierFileAttachmentCollectionForSupplierResourceActionResponseItem", "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": "GetSupplierFileAttachmentCollectionForSupplierResourceActionResponseItemProperties", "type": "object", "properties": { "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->Content_SizeInMb" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierFileAttachment->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" } } } }, "GetSupplierFileAttachmentCollectionResourceActionResponse": { "title": "GetSupplierFileAttachmentCollectionResourceActionResponse", "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": "GetSupplierFileAttachmentCollectionResourceActionResponseItem", "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": "GetSupplierFileAttachmentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->Supplier_Code" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->FileFullName" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->Content_SizeInMb" }, "fileTypeExtension": { "title": "fileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->FileType_Extension" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->IsRestricted" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->FileCategory_Id" }, "fileCategoryCode": { "title": "fileCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->FileCategory_Code" }, "fileCategoryDescription": { "title": "fileCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->FileCategory_Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->PermissionTree_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierFileAttachment->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierFileAttachment->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" } } } }, "CreateSupplierFileAttachmentResourceActionRequest": { "title": "CreateSupplierFileAttachmentResourceActionRequest", "type": "object", "required": [ "supplierId" ], "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->Supplier_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "string", "format": "binary" } } }, "UpdateSupplierFileAttachmentContentResourceActionRequest": { "title": "UpdateSupplierFileAttachmentContentResourceActionRequest", "type": "object", "required": [ "version" ], "properties": { "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->Version" }, "file": { "type": "string", "format": "binary" } } }, "UpdateSupplierFileAttachmentResourceActionRequest": { "title": "UpdateSupplierFileAttachmentResourceActionRequest", "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": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->FileCategory_Id" }, { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->FileName" }, { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->IsRestricted" } ] } } }, "DeleteSupplierFileAttachmentResourceResourceActionRequest": { "title": "DeleteSupplierFileAttachmentResourceResourceActionRequest", "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 } } }, "BatchGetSupplierFileAttachmentResourceAction": { "title": "BatchGetSupplierFileAttachmentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Supplier File Attachment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Supplier File Attachment entities", "items": { "$ref": "#/definitions/GetSupplierFileAttachmentResourceActionResponse" } }, "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" } } }, "GetSupplierFileAttachmentContentHistoryResourceActionResponse": { "title": "GetSupplierFileAttachmentContentHistoryResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Id" }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Version" }, "contentId": { "title": "contentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_Id" }, "contentFileLocationId": { "title": "contentFileLocationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Id" }, "contentFileLocationDescription": { "title": "contentFileLocationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_Description" }, "contentFileLocationFileLocationType": { "title": "contentFileLocationFileLocationType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_FileLocationType", "x-formatSpecifier": "FileContentStoreLocationType" }, "contentFileLocationOnKeyFileStoreId": { "title": "contentFileLocationOnKeyFileStoreId", "type": "string", "format": "uuid", "x-nullable": true, "example": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", "x-propertyPath": "FileAttachmentContentHistory->Content_FileLocation_OnKeyFileStoreId" }, "contentSizeInBytes": { "title": "contentSizeInBytes", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInBytes" }, "contentSizeInKb": { "title": "contentSizeInKb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInKb" }, "contentSizeInMb": { "title": "contentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->Content_SizeInMb" }, "contentVersion": { "title": "contentVersion", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->ContentVersion" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "FileAttachmentContentHistory->CreatedOn" }, "fileAttachmentId": { "title": "fileAttachmentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "FileAttachmentContentHistory->FileAttachment_Id" } } }, "GetSupplierFileAttachmentContentHistoryResourceAction": { "title": "GetSupplierFileAttachmentContentHistoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Supplier File Attachment entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Supplier File Attachment entities", "items": { "$ref": "#/definitions/GetSupplierFileAttachmentContentHistoryResourceActionResponse" } }, "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" } } }, "BatchCreateSupplierFileAttachmentResourceActionRequest": { "title": "BatchCreateSupplierFileAttachmentResourceActionRequest", "type": "object", "required": [ "supplierId" ], "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->Supplier_Id" }, "isRestricted": { "title": "isRestricted", "type": "boolean", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->IsRestricted" }, "fileName": { "title": "fileName", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->FileName" }, "fileCategoryId": { "title": "fileCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierFileAttachment->FileCategory_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierFileAttachment->PermissionTree_Id", "x-systemGenerated": true }, "file": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "BatchUpdateSupplierFileAttachmentResourceActionRequest": { "title": "BatchUpdateSupplierFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSupplierFileAttachmentResourceActionRequest" } }, "BatchDeleteSupplierFileAttachmentResourceActionRequest": { "title": "BatchDeleteSupplierFileAttachmentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSupplierFileAttachmentResourceResourceActionRequest" } }, "GetSupplierResourceResourceActionResponse": { "title": "GetSupplierResourceResourceActionResponse", "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": "GetSupplierResourceResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "SupplierResource->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierResource->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierResource->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierResource->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierResource->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierResource->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierResource->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierResource->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierResource->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierResource->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierResource->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierResource->PermissionTree_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierResource->Notes" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierResource->Resource_Code" }, "resourceContextId": { "title": "resourceContextId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierResource->ResourceContext_Id" }, "resourceContextCode": { "title": "resourceContextCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierResource->ResourceContext_Code" }, "resourceContextDescription": { "title": "resourceContextDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierResource->ResourceContext_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierResource->SequenceNumber" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierResource->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierResource->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierResource->Supplier_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" } } }, "GetSupplierResourceCollectionResourceActionResponse": { "title": "GetSupplierResourceCollectionResourceActionResponse", "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": "GetSupplierResourceCollectionResourceActionResponseItem", "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": "GetSupplierResourceCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierResource->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierResource->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierResource->Supplier_Description" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierResource->Resource_Code" }, "resourceContextId": { "title": "resourceContextId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierResource->ResourceContext_Id" }, "resourceContextCode": { "title": "resourceContextCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierResource->ResourceContext_Code" }, "resourceContextDescription": { "title": "resourceContextDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierResource->ResourceContext_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierResource->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierResource->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierResource->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" } } } }, "GetSupplierResourceForSupplierCollectionResourceActionResponse": { "title": "GetSupplierResourceForSupplierCollectionResourceActionResponse", "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": "GetSupplierResourceForSupplierCollectionResourceActionResponseItem", "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": "GetSupplierResourceForSupplierCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierResource->Resource_Id" }, "resourceCode": { "title": "resourceCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierResource->Resource_Code" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierResource->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierResource->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierResource->PermissionTree_Description" }, "resourceContextId": { "title": "resourceContextId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierResource->ResourceContext_Id" }, "resourceContextCode": { "title": "resourceContextCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierResource->ResourceContext_Code" }, "resourceContextDescription": { "title": "resourceContextDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierResource->ResourceContext_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" } } } }, "SupplierResourceChangePermissionTreeLookupResourceActionResponse": { "title": "SupplierResourceChangePermissionTreeLookupResourceActionResponse", "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": "SupplierResourceChangePermissionTreeLookupResourceActionResponseItem", "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": "SupplierResourceChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SupplierResourceInsertPermissionTreeLookupResourceActionResponse": { "title": "SupplierResourceInsertPermissionTreeLookupResourceActionResponse", "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": "SupplierResourceInsertPermissionTreeLookupResourceActionResponseItem", "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": "SupplierResourceInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SupplierResourceResourceContextLookupResourceActionResponse": { "title": "SupplierResourceResourceContextLookupResourceActionResponse", "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": "SupplierResourceResourceContextLookupResourceActionResponseItem", "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": "SupplierResourceResourceContextLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceContext->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "ResourceContext->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" } } } }, "SupplierResourceResourceLookupResourceActionResponse": { "title": "SupplierResourceResourceLookupResourceActionResponse", "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": "SupplierResourceResourceLookupResourceActionResponseItem", "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": "SupplierResourceResourceLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Resource->Code" }, "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "Resource->Description" }, "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" } } } }, "SupplierResourceSupplierLookupResourceActionResponse": { "title": "SupplierResourceSupplierLookupResourceActionResponse", "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": "SupplierResourceSupplierLookupResourceActionResponseItem", "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": "SupplierResourceSupplierLookupResourceActionResponseItemProperties", "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" } } } }, "CreateSupplierResourceResourceActionRequest": { "title": "CreateSupplierResourceResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSupplierResourceResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "supplierId", "resourceId", "resourceContextId" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierResource->PermissionTree_Id", "x-systemGenerated": true }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierResource->Supplier_Id" }, "resourceId": { "title": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierResource->Resource_Id" }, "resourceContextId": { "title": "resourceContextId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierResource->ResourceContext_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierResource->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierResource->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSupplierResourceResourceActionRequest": { "title": "UpdateSupplierResourceResourceActionRequest", "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": "resourceId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierResource->Resource_Id" }, { "title": "resourceContextId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierResource->ResourceContext_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierResource->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierResource->Notes" } ] } } }, "DeleteSupplierResourceResourceActionRequest": { "title": "DeleteSupplierResourceResourceActionRequest", "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 } } }, "BatchGetSupplierResourceResourceAction": { "title": "BatchGetSupplierResourceResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Supplier Resource entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Supplier Resource entities", "items": { "$ref": "#/definitions/GetSupplierResourceResourceActionResponse" } }, "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" } } }, "BatchCreateSupplierResourceResourceActionRequest": { "title": "BatchCreateSupplierResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSupplierResourceResourceActionRequest" } }, "BatchUpdateSupplierResourceResourceActionRequest": { "title": "BatchUpdateSupplierResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSupplierResourceResourceActionRequest" } }, "BatchDeleteSupplierResourceResourceActionRequest": { "title": "BatchDeleteSupplierResourceResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSupplierResourceResourceActionRequest" } }, "ChangeSupplierResourceIsActiveResourceActionRequest": { "title": "ChangeSupplierResourceIsActiveResourceActionRequest", "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": "SupplierResource->IsActive" } ] } } }, "ChangeSupplierResourcePermissionTreeResourceActionRequest": { "title": "ChangeSupplierResourcePermissionTreeResourceActionRequest", "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": "SupplierResource->PermissionTree_Id" } ] } } }, "BatchChangeSupplierResourceIsActiveResourceActionRequest": { "title": "BatchChangeSupplierResourceIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSupplierResourceIsActiveResourceActionRequest" } }, "BatchChangeSupplierResourcePermissionTreeResourceActionRequest": { "title": "BatchChangeSupplierResourcePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSupplierResourcePermissionTreeResourceActionRequest" } }, "GetSupplierTaxRateResourceActionResponse": { "title": "GetSupplierTaxRateResourceActionResponse", "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": "GetSupplierTaxRateResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "SupplierTaxRate->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierTaxRate->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierTaxRate->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierTaxRate->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->PermissionTree_Description" }, "applicableFrom": { "title": "applicableFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierTaxRate->ApplicableFrom" }, "applicableTo": { "title": "applicableTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierTaxRate->ApplicableTo" }, "buyingSiteId": { "title": "buyingSiteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierTaxRate->BuyingSite_Id" }, "buyingSiteCode": { "title": "buyingSiteCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->BuyingSite_Code" }, "buyingSiteDescription": { "title": "buyingSiteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->BuyingSite_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->SequenceNumber" }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierTaxRate->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->Supplier_Description" }, "taxRate": { "title": "taxRate", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "SupplierTaxRate->TaxRate" } } }, "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" } } }, "GetSupplierTaxRateCollectionResourceActionResponse": { "title": "GetSupplierTaxRateCollectionResourceActionResponse", "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": "GetSupplierTaxRateCollectionResourceActionResponseItem", "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": "GetSupplierTaxRateCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->Supplier_Id" }, "supplierCode": { "title": "supplierCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierTaxRate->Supplier_Code" }, "supplierDescription": { "title": "supplierDescription", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierTaxRate->Supplier_Description" }, "buyingSiteCode": { "title": "buyingSiteCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierTaxRate->BuyingSite_Code" }, "taxRate": { "title": "taxRate", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "SupplierTaxRate->TaxRate" } } }, "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" } } } }, "GetTaxRateForSupplierCollectionResourceActionResponse": { "title": "GetTaxRateForSupplierCollectionResourceActionResponse", "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": "GetTaxRateForSupplierCollectionResourceActionResponseItem", "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": "GetTaxRateForSupplierCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "buyingSiteId": { "title": "buyingSiteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->BuyingSite_Id" }, "buyingSiteCode": { "title": "buyingSiteCode", "type": "string", "x-nullable": false, "x-propertyPath": "SupplierTaxRate->BuyingSite_Code" }, "taxRate": { "title": "taxRate", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "SupplierTaxRate->TaxRate" } } }, "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" } } } }, "SupplierTaxRateBuyingSiteLookupResourceActionResponse": { "title": "SupplierTaxRateBuyingSiteLookupResourceActionResponse", "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": "SupplierTaxRateBuyingSiteLookupResourceActionResponseItem", "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": "SupplierTaxRateBuyingSiteLookupResourceActionResponseItemProperties", "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" } } } }, "SupplierTaxRateChangePermissionTreeLookupResourceActionResponse": { "title": "SupplierTaxRateChangePermissionTreeLookupResourceActionResponse", "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": "SupplierTaxRateChangePermissionTreeLookupResourceActionResponseItem", "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": "SupplierTaxRateChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SupplierTaxRateInsertPermissionTreeLookupResourceActionResponse": { "title": "SupplierTaxRateInsertPermissionTreeLookupResourceActionResponse", "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": "SupplierTaxRateInsertPermissionTreeLookupResourceActionResponseItem", "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": "SupplierTaxRateInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "SupplierTaxRateSupplierLookupResourceActionResponse": { "title": "SupplierTaxRateSupplierLookupResourceActionResponse", "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": "SupplierTaxRateSupplierLookupResourceActionResponseItem", "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": "SupplierTaxRateSupplierLookupResourceActionResponseItemProperties", "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" } } } }, "CreateSupplierTaxRateResourceActionRequest": { "title": "CreateSupplierTaxRateResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateSupplierTaxRateResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "buyingSiteId", "supplierId", "taxRate" ], "properties": { "applicableFrom": { "title": "applicableFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierTaxRate->ApplicableFrom" }, "applicableTo": { "title": "applicableTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierTaxRate->ApplicableTo" }, "buyingSiteId": { "title": "buyingSiteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierTaxRate->BuyingSite_Id" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierTaxRate->PermissionTree_Id", "x-systemGenerated": true }, "supplierId": { "title": "supplierId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierTaxRate->Supplier_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->SequenceNumber" }, "taxRate": { "title": "taxRate", "type": "number", "format": "decimal", "maximum": 100.0, "minimum": 0.0, "x-nullable": false, "x-propertyPath": "SupplierTaxRate->TaxRate" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateSupplierTaxRateResourceActionRequest": { "title": "UpdateSupplierTaxRateResourceActionRequest", "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": "applicableFrom", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierTaxRate->ApplicableFrom" }, { "title": "applicableTo", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "SupplierTaxRate->ApplicableTo" }, { "title": "buyingSiteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "SupplierTaxRate->BuyingSite_Id" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "SupplierTaxRate->SequenceNumber" }, { "title": "taxRate", "type": "number", "format": "decimal", "maximum": 100.0, "minimum": 0.0, "x-nullable": false, "x-propertyPath": "SupplierTaxRate->TaxRate" } ] } } }, "DeleteSupplierTaxRateResourceActionRequest": { "title": "DeleteSupplierTaxRateResourceActionRequest", "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 } } }, "BatchGetSupplierTaxRateResourceAction": { "title": "BatchGetSupplierTaxRateResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Supplier Tax Rate entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Supplier Tax Rate entities", "items": { "$ref": "#/definitions/GetSupplierTaxRateResourceActionResponse" } }, "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" } } }, "BatchCreateSupplierTaxRateResourceActionRequest": { "title": "BatchCreateSupplierTaxRateResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateSupplierTaxRateResourceActionRequest" } }, "BatchUpdateSupplierTaxRateResourceActionRequest": { "title": "BatchUpdateSupplierTaxRateResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateSupplierTaxRateResourceActionRequest" } }, "BatchDeleteSupplierTaxRateResourceActionRequest": { "title": "BatchDeleteSupplierTaxRateResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteSupplierTaxRateResourceActionRequest" } }, "ChangeSupplierTaxRateIsActiveResourceActionRequest": { "title": "ChangeSupplierTaxRateIsActiveResourceActionRequest", "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": "SupplierTaxRate->IsActive" } ] } } }, "ChangeSupplierTaxRatePermissionTreeResourceActionRequest": { "title": "ChangeSupplierTaxRatePermissionTreeResourceActionRequest", "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": "SupplierTaxRate->PermissionTree_Id" } ] } } }, "BatchChangeSupplierTaxRateIsActiveResourceActionRequest": { "title": "BatchChangeSupplierTaxRateIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSupplierTaxRateIsActiveResourceActionRequest" } }, "BatchChangeSupplierTaxRatePermissionTreeResourceActionRequest": { "title": "BatchChangeSupplierTaxRatePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeSupplierTaxRatePermissionTreeResourceActionRequest" } }, "GetUnitOfMeasurementResourceActionResponse": { "title": "GetUnitOfMeasurementResourceActionResponse", "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": "GetUnitOfMeasurementResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UnitOfMeasurement->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UnitOfMeasurement->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->PermissionTree_Description" }, "basedOnUnitId": { "title": "basedOnUnitId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->BasedOnUnit_Id", "x-NullExpression": "UnitOfMeasurement->IsBaseUnit ne NULL and UnitOfMeasurement->IsBaseUnit eq TRUE" }, "basedOnUnitCode": { "title": "basedOnUnitCode", "type": "string", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->BasedOnUnit_Code" }, "basedOnUnitDescription": { "title": "basedOnUnitDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->BasedOnUnit_Description" }, "convertFactor": { "title": "convertFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->ConvertFactor", "x-NullExpression": "UnitOfMeasurement->IsBaseUnit ne NULL and UnitOfMeasurement->IsBaseUnit eq TRUE" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" }, "isBaseUnit": { "title": "isBaseUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->IsBaseUnit" }, "measurementType": { "title": "measurementType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->MeasurementType", "x-formatSpecifier": "MeasurementType" }, "measurementTypeQuantity": { "title": "measurementTypeQuantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->MeasurementTypeQuantity", "x-NullExpression": "UnitOfMeasurement->MeasurementType ne 'Duration'" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->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" } } }, "GetUnitOfMeasurementCollectionResourceActionResponse": { "title": "GetUnitOfMeasurementCollectionResourceActionResponse", "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": "GetUnitOfMeasurementCollectionResourceActionResponseItem", "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": "GetUnitOfMeasurementCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->IsActive" }, "isBaseUnit": { "title": "isBaseUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->IsBaseUnit" }, "basedOnUnitId": { "title": "basedOnUnitId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->BasedOnUnit_Id" }, "basedOnUnitCode": { "title": "basedOnUnitCode", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->BasedOnUnit_Code" }, "basedOnUnitDescription": { "title": "basedOnUnitDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->BasedOnUnit_Description" }, "convertFactor": { "title": "convertFactor", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->ConvertFactor", "x-NullExpression": "UnitOfMeasurement->IsBaseUnit ne NULL and UnitOfMeasurement->IsBaseUnit eq TRUE" }, "measurementType": { "title": "measurementType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->MeasurementType", "x-formatSpecifier": "MeasurementType" }, "measurementTypeQuantity": { "title": "measurementTypeQuantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->MeasurementTypeQuantity", "x-NullExpression": "UnitOfMeasurement->MeasurementType ne 'Duration'" } } }, "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" } } } }, "UnitOfMeasurementBasedOnUnitLookupResourceActionResponse": { "title": "UnitOfMeasurementBasedOnUnitLookupResourceActionResponse", "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": "UnitOfMeasurementBasedOnUnitLookupResourceActionResponseItem", "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": "UnitOfMeasurementBasedOnUnitLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->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" } } } }, "UnitOfMeasurementChangePermissionTreeLookupResourceActionResponse": { "title": "UnitOfMeasurementChangePermissionTreeLookupResourceActionResponse", "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": "UnitOfMeasurementChangePermissionTreeLookupResourceActionResponseItem", "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": "UnitOfMeasurementChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "UnitOfMeasurementInsertPermissionTreeLookupResourceActionResponse": { "title": "UnitOfMeasurementInsertPermissionTreeLookupResourceActionResponse", "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": "UnitOfMeasurementInsertPermissionTreeLookupResourceActionResponseItem", "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": "UnitOfMeasurementInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "CreateUnitOfMeasurementResourceActionRequest": { "title": "CreateUnitOfMeasurementResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateUnitOfMeasurementResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description", "isBaseUnit" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->SequenceNumber" }, "isBaseUnit": { "title": "isBaseUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->IsBaseUnit" }, "basedOnUnitId": { "title": "basedOnUnitId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->BasedOnUnit_Id", "x-NullExpression": "UnitOfMeasurement->IsBaseUnit ne NULL and UnitOfMeasurement->IsBaseUnit eq TRUE" }, "convertFactor": { "title": "convertFactor", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->ConvertFactor", "x-NullExpression": "UnitOfMeasurement->IsBaseUnit ne NULL and UnitOfMeasurement->IsBaseUnit eq TRUE" }, "measurementType": { "title": "measurementType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->MeasurementType", "x-formatSpecifier": "MeasurementType" }, "measurementTypeQuantity": { "title": "measurementTypeQuantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->MeasurementTypeQuantity", "x-NullExpression": "UnitOfMeasurement->MeasurementType ne 'Duration'" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateUnitOfMeasurementResourceActionRequest": { "title": "UpdateUnitOfMeasurementResourceActionRequest", "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": "UnitOfMeasurement->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->Notes" }, { "title": "isBaseUnit", "type": "boolean", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->IsBaseUnit" }, { "title": "basedOnUnitId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->BasedOnUnit_Id", "x-NullExpression": "UnitOfMeasurement->IsBaseUnit ne NULL and UnitOfMeasurement->IsBaseUnit eq TRUE" }, { "title": "measurementType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->MeasurementType", "x-formatSpecifier": "MeasurementType" }, { "title": "measurementTypeQuantity", "type": "integer", "format": "int32", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->MeasurementTypeQuantity", "x-NullExpression": "UnitOfMeasurement->MeasurementType ne 'Duration'" }, { "title": "convertFactor", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "UnitOfMeasurement->ConvertFactor", "x-NullExpression": "UnitOfMeasurement->IsBaseUnit ne NULL and UnitOfMeasurement->IsBaseUnit eq TRUE" } ] } } }, "DeleteUnitOfMeasurementResourceActionRequest": { "title": "DeleteUnitOfMeasurementResourceActionRequest", "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 } } }, "BatchGetUnitOfMeasurementResourceAction": { "title": "BatchGetUnitOfMeasurementResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Unit Of Measurement entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Unit Of Measurement entities", "items": { "$ref": "#/definitions/GetUnitOfMeasurementResourceActionResponse" } }, "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" } } }, "BatchCreateUnitOfMeasurementResourceActionRequest": { "title": "BatchCreateUnitOfMeasurementResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateUnitOfMeasurementResourceActionRequest" } }, "BatchUpdateUnitOfMeasurementResourceActionRequest": { "title": "BatchUpdateUnitOfMeasurementResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateUnitOfMeasurementResourceActionRequest" } }, "BatchDeleteUnitOfMeasurementResourceActionRequest": { "title": "BatchDeleteUnitOfMeasurementResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteUnitOfMeasurementResourceActionRequest" } }, "ChangeUnitOfMeasurementIsActiveResourceActionRequest": { "title": "ChangeUnitOfMeasurementIsActiveResourceActionRequest", "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": "UnitOfMeasurement->IsActive" } ] } } }, "ChangeUnitOfMeasurementPermissionTreeResourceActionRequest": { "title": "ChangeUnitOfMeasurementPermissionTreeResourceActionRequest", "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": "UnitOfMeasurement->PermissionTree_Id" } ] } } }, "BatchChangeUnitOfMeasurementIsActiveResourceActionRequest": { "title": "BatchChangeUnitOfMeasurementIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUnitOfMeasurementIsActiveResourceActionRequest" } }, "BatchChangeUnitOfMeasurementPermissionTreeResourceActionRequest": { "title": "BatchChangeUnitOfMeasurementPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUnitOfMeasurementPermissionTreeResourceActionRequest" } }, "GetUserSiteApprovalRoleResourceActionResponse": { "title": "GetUserSiteApprovalRoleResourceActionResponse", "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": "GetUserSiteApprovalRoleResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserSiteApprovalRole->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "UserSiteApprovalRole->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->PermissionTree_Description" }, "allSites": { "title": "allSites", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->AllSites" }, "approvalRoleId": { "title": "approvalRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->ApprovalRole_Id" }, "approvalRoleCode": { "title": "approvalRoleCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->ApprovalRole_Code" }, "approvalRoleDescription": { "title": "approvalRoleDescription", "type": "string", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->ApprovalRole_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->SequenceNumber" }, "siteIds": { "title": "siteIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "UserSiteApprovalRole->SiteIds", "x-formatSpecifier": "Int64" }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->User_Id" }, "userCode": { "title": "userCode", "type": "string", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->User_Code" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->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" } } }, "GetUserSiteApprovalRoleSiteCollectionResourceActionResponse": { "title": "GetUserSiteApprovalRoleSiteCollectionResourceActionResponse", "type": "object", "properties": { "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->Id" }, "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Site->IsActive" } } }, "GetUserSiteApprovalRoleSiteCollectionResourceAction": { "title": "GetUserSiteApprovalRoleSiteCollectionResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Site Approval Role entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Site Approval Role entities", "items": { "$ref": "#/definitions/GetUserSiteApprovalRoleSiteCollectionResourceActionResponse" } }, "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" } } }, "GetUserSiteApprovalRoleCollectionResourceActionResponse": { "title": "GetUserSiteApprovalRoleCollectionResourceActionResponse", "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": "GetUserSiteApprovalRoleCollectionResourceActionResponseItem", "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": "GetUserSiteApprovalRoleCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "allSites": { "title": "allSites", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->AllSites" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->SequenceNumber" }, "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" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->PermissionTree_Description" }, "userFullName": { "title": "userFullName", "type": "string", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->User_FullName" }, "siteIds": { "title": "siteIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "UserSiteApprovalRole->SiteIds", "x-formatSpecifier": "Int64" } } }, "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" } } } }, "UserSiteApprovalRoleApprovalRoleLookupResourceActionResponse": { "title": "UserSiteApprovalRoleApprovalRoleLookupResourceActionResponse", "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": "UserSiteApprovalRoleApprovalRoleLookupResourceActionResponseItem", "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": "UserSiteApprovalRoleApprovalRoleLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "ApprovalRole->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "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" } } } }, "UserSiteApprovalRoleChangePermissionTreeLookupResourceActionResponse": { "title": "UserSiteApprovalRoleChangePermissionTreeLookupResourceActionResponse", "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": "UserSiteApprovalRoleChangePermissionTreeLookupResourceActionResponseItem", "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": "UserSiteApprovalRoleChangePermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "UserSiteApprovalRoleInsertPermissionTreeLookupResourceActionResponse": { "title": "UserSiteApprovalRoleInsertPermissionTreeLookupResourceActionResponse", "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": "UserSiteApprovalRoleInsertPermissionTreeLookupResourceActionResponseItem", "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": "UserSiteApprovalRoleInsertPermissionTreeLookupResourceActionResponseItemProperties", "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" } } } }, "UserSiteApprovalRoleSiteLookupResourceActionResponse": { "title": "UserSiteApprovalRoleSiteLookupResourceActionResponse", "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": "UserSiteApprovalRoleSiteLookupResourceActionResponseItem", "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": "UserSiteApprovalRoleSiteLookupResourceActionResponseItemProperties", "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" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Site->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" } } } }, "UserSiteApprovalRoleUserLookupResourceActionResponse": { "title": "UserSiteApprovalRoleUserLookupResourceActionResponse", "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": "UserSiteApprovalRoleUserLookupResourceActionResponseItem", "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": "UserSiteApprovalRoleUserLookupResourceActionResponseItemProperties", "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" } } } }, "CreateUserSiteApprovalRoleResourceActionRequest": { "title": "CreateUserSiteApprovalRoleResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateUserSiteApprovalRoleResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "userId", "approvalRoleId", "allSites" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->PermissionTree_Id", "x-systemGenerated": true }, "userId": { "title": "userId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->User_Id" }, "approvalRoleId": { "title": "approvalRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->ApprovalRole_Id" }, "allSites": { "title": "allSites", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->AllSites" }, "siteIds": { "title": "siteIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "UserSiteApprovalRole->SiteIds", "x-formatSpecifier": "Int64" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateUserSiteApprovalRoleResourceActionRequest": { "title": "UpdateUserSiteApprovalRoleResourceActionRequest", "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": "approvalRoleId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->ApprovalRole_Id" }, { "title": "allSites", "type": "boolean", "x-nullable": false, "x-propertyPath": "UserSiteApprovalRole->AllSites" }, { "title": "siteIds", "type": "array", "format": "array", "x-nullable": false, "items": { "type": "integer" }, "x-propertyPath": "UserSiteApprovalRole->SiteIds", "x-formatSpecifier": "Int64" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "UserSiteApprovalRole->SequenceNumber" } ] } } }, "DeleteUserSiteApprovalRoleResourceActionRequest": { "title": "DeleteUserSiteApprovalRoleResourceActionRequest", "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 } } }, "BatchGetUserSiteApprovalRoleResourceAction": { "title": "BatchGetUserSiteApprovalRoleResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of User Site Approval Role entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of User Site Approval Role entities", "items": { "$ref": "#/definitions/GetUserSiteApprovalRoleResourceActionResponse" } }, "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" } } }, "BatchCreateUserSiteApprovalRoleResourceActionRequest": { "title": "BatchCreateUserSiteApprovalRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateUserSiteApprovalRoleResourceActionRequest" } }, "BatchUpdateUserSiteApprovalRoleResourceActionRequest": { "title": "BatchUpdateUserSiteApprovalRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateUserSiteApprovalRoleResourceActionRequest" } }, "BatchDeleteUserSiteApprovalRoleResourceActionRequest": { "title": "BatchDeleteUserSiteApprovalRoleResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteUserSiteApprovalRoleResourceActionRequest" } }, "ChangeUserSiteApprovalRoleIsActiveResourceActionRequest": { "title": "ChangeUserSiteApprovalRoleIsActiveResourceActionRequest", "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": "UserSiteApprovalRole->IsActive" } ] } } }, "ChangeUserSiteApprovalRolePermissionTreeResourceActionRequest": { "title": "ChangeUserSiteApprovalRolePermissionTreeResourceActionRequest", "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": "UserSiteApprovalRole->PermissionTree_Id" } ] } } }, "BatchChangeUserSiteApprovalRoleIsActiveResourceActionRequest": { "title": "BatchChangeUserSiteApprovalRoleIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUserSiteApprovalRoleIsActiveResourceActionRequest" } }, "BatchChangeUserSiteApprovalRolePermissionTreeResourceActionRequest": { "title": "BatchChangeUserSiteApprovalRolePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeUserSiteApprovalRolePermissionTreeResourceActionRequest" } } }, "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": "Address Type" }, { "name": "Approval" }, { "name": "Approval Role" }, { "name": "Approval Workflow" }, { "name": "Approval Workflow Expression" }, { "name": "Approval Workflow Expression Approval Role" }, { "name": "Attribute" }, { "name": "Attribute Allowed Value" }, { "name": "Calendar" }, { "name": "Calendar Day" }, { "name": "Calendar Day Hour" }, { "name": "Calendar Exception" }, { "name": "Change Data Trigger" }, { "name": "Change Data Trigger Criteria" }, { "name": "Change Data Trigger Criteria Evaluation" }, { "name": "Change Data Trigger Criteria Parameter" }, { "name": "Change Data Trigger Notification Event" }, { "name": "Change Data Trigger Notification Event Attachment" }, { "name": "Change Data Trigger Notification Event Attachment Parameter" }, { "name": "Change Data Trigger Occurrence Log" }, { "name": "Classification" }, { "name": "Classification Allowed Value" }, { "name": "Email Type" }, { "name": "Language" }, { "name": "Localisation Key" }, { "name": "Localisation Set" }, { "name": "Localisation Translation" }, { "name": "Location" }, { "name": "Location Attribute" }, { "name": "Location Document" }, { "name": "Notification Template" }, { "name": "Notification Template Parameter" }, { "name": "Phone Number Type" }, { "name": "Preconfigured Reason" }, { "name": "Request Type" }, { "name": "Site" }, { "name": "Site Attribute" }, { "name": "Site Contact Address" }, { "name": "Site Contact Email" }, { "name": "Site Contact Phone Number" }, { "name": "Site Document" }, { "name": "Site Resource" }, { "name": "Site Tree" }, { "name": "Site Type" }, { "name": "Supplier" }, { "name": "Supplier Attribute" }, { "name": "Supplier Contact Address" }, { "name": "Supplier Contact Email" }, { "name": "Supplier Contact Phone Number" }, { "name": "Supplier Document" }, { "name": "Supplier File Attachment" }, { "name": "Supplier Resource" }, { "name": "Supplier Tax Rate" }, { "name": "Unit Of Measurement" }, { "name": "User Site Approval Role" } ], "x-tagGroups": [ { "name": "GEN", "tags": [ "Address Type", "Approval", "Approval Role", "Approval Workflow", "Approval Workflow Expression", "Approval Workflow Expression Approval Role", "Attribute", "Attribute Allowed Value", "Calendar", "Calendar Day", "Calendar Day Hour", "Calendar Exception", "Change Data Trigger", "Change Data Trigger Criteria", "Change Data Trigger Criteria Evaluation", "Change Data Trigger Criteria Parameter", "Change Data Trigger Notification Event", "Change Data Trigger Notification Event Attachment", "Change Data Trigger Notification Event Attachment Parameter", "Change Data Trigger Occurrence Log", "Classification", "Classification Allowed Value", "Email Type", "Language", "Localisation Key", "Localisation Set", "Localisation Translation", "Location", "Location Attribute", "Location Document", "Notification Template", "Notification Template Parameter", "Phone Number Type", "Preconfigured Reason", "Request Type", "Site", "Site Attribute", "Site Contact Address", "Site Contact Email", "Site Contact Phone Number", "Site Document", "Site Resource", "Site Tree", "Site Type", "Supplier", "Supplier Attribute", "Supplier Contact Address", "Supplier Contact Email", "Supplier Contact Phone Number", "Supplier Document", "Supplier File Attachment", "Supplier Resource", "Supplier Tax Rate", "Unit Of Measurement", "User Site Approval Role" ] } ] }